×

Please give details of the problem

Docs

Find

    Developer Guide

    1. Composite API Example
      1. Scripted Lanes
      2. Compound Organization Hierarchy
      3. Dynamic Lanes
      4. Delegation
      5. Access Rights
      6. Runtime Lanes
        1. Todo Validation
      1. Release Your User Login
      1. Collections To Array
      2. Collections To List
      3. Collections BackOffice
      4. Collection JS Freemarker
          1. Composite API Design Tab
          2. Composite API Configuration Tab
          1. Providers
          2. Connectors
          3. Processes
          1. Roles entities
          2. Organization
        1. Collections
          1. Project Files Tab
          2. Project Definition Tab
          3. Project Versioned Files Tab
          4. Project Version Tab
          5. Project Description Tab
          6. Version
          7. Project Rights Tab
          8. Project Collection Tab
          1. Web Interface JS Tab
          2. Web Interface Design Tab
            1. Image Widget
            2. FileUpload Widget
            3. StaticText Widget
            4. ProgressBar Widget
            5. TextInput Widget
            6. JavaScript Widget
            7. Section Widget
            8. Geolocation Widget
            9. Checkbox Widget
            10. RadioButton Widget
            11. Tree Widget
            12. Spinner Widget
            13. History Widget
            14. URLInput Widget
            15. Tab Widget
            16. List Widget
            17. Array Widget
            18. HTML Editor Widget
            19. Report Widget
            20. Button Widget
            21. Custom Widget
            22. Captcha Widget
            23. HTML Widget
            24. Multi Checkbox Widget
          3. Web Interface Analytics Tab
          4. Web Interface Collection Tab
          5. Web Interface Implementation Tab
          6. Web Interface API Tab
          7. Web Interface Stylesheet Tab
        2. Revision
        3. Custom Lists
          1. Process Variables Tab
          2. Process Measures Tab
              1. Process Timer Event
              2. Process Start Event
              3. Process Intermediary Event
            1. Gate
              1. Process Task Loop Tab
              2. Process Task Manual Tab
              3. Process Task Email Tab
              4. Process Task Connector Tab
              5. Process Task SubProcess Tab
              6. Process Task Functional Tab
              7. Process Task Script Tab
            2. Process Step Output Variables
            3. Process Step Testing Variables
            4. Process Step Input Variables
          3. Process General Tab
          4. Process Design
          5. Process Input Tab
        1. Home
        2. My Applications
        3. Files
      1. Customer Management
        1. Messages
        2. Scheduled Process
        1. Process Examples
        2. Connectors
        1. Users
        2. Configuration
        3. Usage
        1. Web Interface Reports
          1. Measuring
          2. Runtime Users
          3. Execution Path
          4. Parameters
        1. CSS Examples
        2. CSS Personalization
      1. Performance
        1. Logout
        2. Redirection ExecutionMode
        3. Information Tags
        4. Basket
        5. Menu Bar
        6. Header
        7. Custom Login Page
        8. Mobile Devices
          1. homepage.css
          2. homepage.js
        1. Inject JSONObject
        2. Google Tables
        3. ArrayJSON to JSONArray
        4. Label Modification
        5. Number Currency Format
        6. Launch Process JQuery
        7. Date
        8. JQuery
        9. Round
        10. Holidays
        11. Array From WS
        12. Column Inactivation
        13. Print JSONObject
        14. Initialization Widget Date
        15. Invalid Fields
        16. List Reinitialization
        1. Tags
        2. Dialog Window
        3. Dynamic List
        4. User Lane Picker
          1. Report Chart
          2. Google Visualization
          3. Chart Dashboard
          4. Chart Dashboard Collection
        5. API Listener
        6. JavaScript Report
        7. Retrieving Variables Values
        8. Collection
        9. File Preview
        10. Autocomplete Widget
        11. Summing Array
      1. Trigger
      2. Markdown Template
        1. Task Reminder Email
        2. JavaScript Inclusion
        3. PDF
        4. SubProcess
        5. Backloop
        6. Variable Mapping
        1. Salesforce Computation
        2. Number Currency Format
        3. List Hash Sequence
        4. JSONObject Creation
        5. Freemarker Container Test
        6. JSONObject Concatenation
        7. Metadata
        8. Special Freemarker Characters
        9. List 1000+ Objects
        10. Dynamic Variable
        11. File Visibility
        12. Number Test
        13. JSONObject Keys Values
        14. Lock
        15. JSONArray Conversion
        16. Error Handling
        17. Loop
        18. Array To List
      1. Process Reporting API
      1. Offline
      2. Mobile

    Process Design

    Allows you to graphically design a process.

    info_1 A process can only be edited by a designer of the Project this process belongs to (or a user with an Administrator profile).

    Top buttons

    disk Save
    Save your current process

    disk_multiple Save as
    Duplicate your process

    info_2 Measures are not duplicated.

    arrow_undo Undo
    Revert to your last saved process

    feed Atom Feed
    Display corresponding Atom feed of your process

    arrow_refresh Refresh
    Savings' Revision of your process

    package_link Attach/detach a process
    Allows you to attach/detach your process to/from a project

    package_unlink Attach a process Allows you to attach your process to a project

    info_3 This icon only appears if your project does not belong to a project.

    info_4 If your process does not belong to a project, you won't be able to save it.

    package_go Open project
    Open project process belongs to

    application_form_add New Web interface
    Click this button to create a new web interface to launch your process.

    info_5 This button is available if no web interface has been defined to launch your process.

    application_go Open
    If the process is launched by a web interface, this link opens the corresponding web interface (see Web interfaces).

    info_6 This button is only available if a web interface has been defined to launch your process.

    plugin Open corresponding connector
    Each process can be seen as a connector (ie. web service). This link opens the corresponding connector definition of the process: it gives you the URL of the process and the content to POST to this URL to launch the process from another system.

    bug Launch Test
    It allows you to launch process in a TEST mode.

    Vertical tabs

    plus_tab {Organization/Role or Entity}
    Click this button to add an organization or role/entity to the current process.

    suppress {Organization/Role or Entity}
    Click this button to suppress an organization or role/entity to the current process. It is only possible if no task belongs to this Organization/Role or Entity

    collapse {Organization/Role or Entity}
    Click this button to collapse a Organization/Role or Entity

    expand {Organization/Role or Entity}
    Click this button to expand a Organization/Role or Entity

    Process start, timer and end

    proc_start Process Start
    This symbol represents the process start point. The start point is mandatory and cannot be removed. This process can only be launched through a POST request from a RunMyProcess web interface or an external application.

    event_start_mail Process Start (email)
    This symbol represents the process start point. The start point is mandatory and cannot be removed. This process can be launched through an e-mail or a POST request from a RunMyProcess web interface or an external application.

    Process_Screenevent_start_timer Process Start (timer)
    This symbol represents the process start point. The start point is mandatory and cannot be removed. This process has been scheduled to be launched automatically. It can also be launched through a POST request from a RunMyProcess web interface or an external application.

    timer Process Timer
    This symbol represents a timer task: process will pause execution for a given time.

    proc_end Process End
    This symbol represents the process end point. The end point is mandatory. In the event of choices or parallel tasks that do not rejoin in the end, each branch of the process must end with its own end point.

    Simple tasks (Activity)

    action_simple_symb Simple task
    This symbol represents a task. It can be sending an email, using a connector, launching sub-processes, asking for a human intervention (manual task) or doing nothing.

    loop_simple_symb While looping task
    This symbol represents a looping task which will stop on a defined condition (i.e. while I have not found USD rate change, I will continue browsing the exchange rate table).

    Drag the loop_simple icon to insert this step in the process or modify a simple task to a while looping task in Functional Tab.

    loop_multi_symb Multi-instance looping task This symbol with vertical bars represents looping tasks that can be run simultaneously for a given array (i.e. for each value of an array, do something). The same symbol with horizontal bars means that the looping tasks will be run sequentially.

    Drag the loop_multi icon to insert this step in the process or modify a simple task to a Multi-instance looping task in Functional Tab.

    Task type icons

    Depending on the type of task set in the Task tab, the task symbol will display an icon on the lower right corner:

    • None This task does not perform any action but it can evaluate input or output variable.
    • connector This task is a using a Connector.
    • email This task is a sending Email.
    • subprocess This task is a calling Sub-process.
    • manual_task This task is a Manual task (human interaction).
    • script This task can either execute a JS file (Javascript) or a FTL file (Freemarker) or generate a PDF document.

    Intermediary events

    event_inter_cancel Event Cancel
    This symbol allows you to start a new branch for a process directly from a task in case this task is cancelled (see Manual task). It should only be used on a Manual Task.

    event_inter_error Event Error
    This symbol allows you to start a new branch for a process directly from a task in case this task is failing for whatever error (for any type of task, in Freemarker script...).

    event_inter_timer Event Timer
    This symbol allows you to start a new branch for a process directly from a task in case this task times out . It should only be used on a Manual Task and Subprocess task.

    info_7 If you need to go back to main process after your new branch, use "End choice" symbol to join main process and new branch.

    escalation

    escalation2

    Parallel tasks

    debut_parallel_symb Start parallel tasks (Split And)
    This symbol allows you to run several tasks in parallel. Each task will be performed independently from one another. You can choose to gather the results of the different tasks at the end, using the next symbol, or end each branch independently.
    Drag the parallel_start icon to insert this step in the process.

    fin_parallel_symb End parallel tasks (Join And)
    This symbol allows you to resynchronize the results of different parallel tasks (branch) after the tasks have been fulfilled. You can choose to resynchronize all results, or just some of them.

    info_8 Don't forget that all branches must end with a process end point.

    Drag the icon parallel_fin to insert this step in the process.

    Choice

    debut_choix_symb Start choice (Split Exclusive or)
    This symbol allows you to insert a choice in the process. For instance, if variable's value is equal to "OK", then go through branch with first link named 'A' if it's not equal to "OK", then go through branch with first link named 'B'.
    Drag the icon choix_start to insert this step in the process.

    fin_choix_symb End choice (Join Exclusive or)
    This symbol allows you to resynchronize the results of a choice task after a branch has been executed.

    info_9 Don't forget that all branches must end with a process end point.

    Drag the icon choix_fin to insert this step in the process.

    info_10 End choice icon allows you to loop back in your process as in the following example :

    loopback

    Annotation

    annotation

    This symbol allows you to write an annotation wherever you want in the process Drag the "Annotation" icon to insert if in the process.

    Top icons

    key world Private/public access
    Click on this icon to set process' access to private or to public. By default, your process is private.

    page_no_edit page_edit Click this icon to lock or unlock your process design screen. By default, your process is locked to avoid unwanted modification on process screen.

    info_11When process is locked, you can still modify scripts, variables, tasks' type... but you can't modify the process design.

    shape_align_leftshape_align_centershape_align_right Horizontal alignment
    Select symbols in designer and click on an icon to align them horizontally (left, center, right).

    shape_align_bottomshape_align_middleshape_align_top Vertical alignment
    Select symbols in designer and click on an icon to align them vertically (bottom, middle, top).

    zoom_refresh Magifier_zoom_out magnifier_zoom_in Zoom
    Click these icons to respectively reset the zoom to its original size or zoom out or zoom in

    page_white_acrobat Print
    Click this icon to display a PDF version of the process.

    info_12 You must save the process before you can create a PDF view.

    error This print option does not work seamlessly on Chrome. To download the PDF version of the process on Chrome you will have to disable Chrome PDF Viewer (to do so type "about:plugins" in the address bar of Google Chrome) which will force Chrome to use Adobe.

    Customization icons

    bloc_txt This symbol allows you to add a name to a link or a symbol except for tasks where names are typed directly in the Task tab.

    proc_define This symbol allows you to open the Task tab to configure a symbol.

    The arrows between each task are called links. You can do several modifications on these links:

    • Hover the border of a task until you see a little circle and click, then drag this line to another task border until you see a little circle and click to add a link between these two tasks.
    • Click a link to edit its name.
    • Use the keyboard shortcuts below to do more operations on the links

    Keyboard options

    CTRL + SHIFT + CLICK
    Allows you to add a broken angle to a link: this is simply a presentation option, and does not alter the process.

    DEL (or 'Fn'+'Backspace' on a Mac)
    Allows you to remove a task or link.

    ESC
    Allows you to abort the current operation.

    SHIFT + CLICK
    Allows you to select several tasks.

    info_14 If you want to insert a task in your process between two linked tasks, you must delete the link between these two tasks and click on the task which has now no successor to get the toolbox back.

    See also: