×

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

    Trigger a process

    On RunMyProcess, a process can be launched in several ways. Each solution for triggering a process has strong implications on the input variables passed to the process and the link to instances. in this pages, we will review each solution

    Schedule a process with a Timer

    You can schedule a process : it will be launched automatically at a predefined frequency (@see Process Start Event).

    In order to trigger a process with a Timer, you have to configure certain parameters.

    (1) Choose Timer as Trigger.

    (2) Choose the number of repetitions of launches. Click "Unlimited" if you want the process scheduling to loop indefinitely.

    (3) Delay between two launches of the process. Choose the delay between responses days, hours and minutes.

    When a process is triggered with timer configuration, initial parameters are not configured.

    Trigger a process by email

    You can also trigger a process by sending an email to our platform (@see Process Start Event).

    (1) Choose Trigger Message

    (2) Message box address : Email address to launch the process. You can click on link to copy Live email address needed to launch the process. Format of email address is the following :

    process+{customerid}.{processid}@runmyprocess.com to launch process in Live state and

    process+{customerid}.{processid}.TEST@runmyprocess.com to launch process in Test state.

    (3) You can map the subject of your email to an input variable of the process.

    (4) The content of your email can be associated to an input variable of the process.

    (5) You can map also the cc field to a variable.

    (6) The attachement of your email can be associated to a variable of the process.

    You can manage messages through the flex IDE

    (@see Messages Monitoring)

    Please note that the user who launches the process must belong to the lane of the process.

    Trigger a process from a Web Interface

    You can launch a process using a Web Interface.

    (1) Create a Button and choose Start Process as Action.

    (2) Choose the process you want to launch.

    (3) You can define On click action after pushing the button :

    • Show pop-up message after pushing the button.
    • Close the window opened.
    • Show the message and then close the window.
    • Redirect to another page.
    • Reload the same screen after button pushed.
    • Load next screen.

    The variables of the web interface will be considered as initial parameters of your process.

    This is the most common way to launch a process. Using this solution brings many advantages

    • the measures of the process launched will be transmitted to the instances (web interface instanciation)
    • globally the process is linked to the instance which means for example that you can retrieve the generated manual task url in the process execution

    Subprocesses

    In order to factorize tasks, you can include a process in another process. The included process will be called a subprocess.

    A subprocess is always launched synchroneously with respect to the main process, which means that the main process will only be resumed once the subprocess execution is over.

    A subprocess can be executed as a different process (case by default) or as a nested process.

    When a subprocess is confgured as a nested process it means that the subprocess ans the main process will share the same execution context. The parameters will be shared and the history (@see Web Interface History and Comments Widget) too. On the other hand, when a subprocess is not configured as a nested process, one can define precisely which variables are going to be passed from the main process to the subprocess and vice-versa.

    Last a launched subprocess will be linked with the launched main process. The main request is said to be the parent of the subrequest.

    For more information on subprocess configuration @see Subprocess

    Process Listener

    A process can be launched from a web interface without being linked to it ( meaning that the measures defined on the process will not be passed to the web interface ) using the process listener feature.

    Launching a process as a process listener can also be used to launch several process from the same web interface.

    All the variables from the web interface will be passed to the process listener.

    A process listener can be configured as shown in the link below (section process listener) : (@see Process Listener).

    Trigger a process directly by Web Service

    You can trigger a process directly by Web Service.

    When done using a connector in a process, it can be considered as aysnchroneous. In this case, the triggered process parent will have no parent to be linked to.

    Here is the API to launch a process by web service.

     1
     2
     3
     4
     5
     6
     7
     8
     9
    10
    11
    POST https://live.runmyprocess.com/live/${P_customer}/process/${process_id}?P_mode=${execution_mode}&P_version=${version_id}
    Content-Type : application/*
    
    <?xml version="1.0" encoding="UTF-8"?>
    <feed xmlns="http://www.w3.org/2005/Atom" xml:base="https://live.runmyprocess.com/">
        <title>Title</title>
        <entry>
            <title>Title</title>
            <content type="text/base64">${encrypt('BASE64',initial_parameters)}</content>
        </entry>
    </feed>
    

    with input params a JSON object containing the parameters to be passed to the process

    1
    {"my_var_1":"foo","my_var_2":"bar"}