×

Please give details of the problem

Docs

Find

    Developer Guide

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

    Process Start Event

    The Start Event allows you to configure the way the process will be triggered. There are several ways that a process can be launched - through the submission of a form, by meeting a condition, by an email or by a timer. To view or edit the configuration of a process start event, click on the event in your process design and choose to edit it by clicking on the pencil. The pop up window is divided into two taps - one for the start event and one for the output variables.

    1 Event

    The Event tab is where you can configure the start event. It has the following fields:

    Field Name Description
    Name The Name of the task - this is defaulted to 'Start'.
    ID The unique ID of the task. The ID is generated and cannot be modified.
    Event type The event type is START, this cannot be modified.
    Trigger Choose the trigger for launching the process; each option is described bellow.

    1.1 Web Trigger

    After choosing "None" from the Trigger options to specify that the process can be triggered by a POST request (i.e. a web service call) or a RunMyProcess Web Interface, the following configuration options are made available:

    Field Name Description
    Redirect to This allows you to choose a web interface or an HTML file that will be sent as a result when the process has started successfully.
    Description A description of the task.

    info A process can be started through the submission of a basic HTML form (if the process is public); all parameters sent will be available as the initial parameters of your process. Here is an example:

    1
    2
    3
    4
    5
    6
    7
    8
    9
    <html>
    <form name="RMP" method="POST" action="https://live.runmyprocess.com/live/${customer_id}/process/${process_id}">
    <input name="IDENTIFIER" value="a" />
    <input name="HASH" value="${my_hash}" />
    <input name="OPERATIONTYPE" value="payment" />
    <input name="CLIENTIDENT" value="${client_id}" />
    <input type="submit" name="ok" value="RMP" />
    </form>
    </html>
    

    1.2 Message Trigger

    After choosing "Message" from the Trigger options to specify that the process can be triggered by an email, the following additional configuration options are available:

    Field Name Description
    Message box address This is the email address used to launch the process. In the Live environment, clicking on link will copy the email address to the clipboard, it can then be pasted into this field.
    The format of the email address is:
    process+{customerid}.{processid}.{key}@runmyprocess.com
    to launch the process in Live state and
    process+{customerid}.{processid}.{key}.TEST@runmyprocess.com
    to launch the process in Test state.
    Please note that when launching your process in Test, the last saved version of the process will be used as process versioning is not available in Test.
    The mailbox is pulled every five minutes.
    Map subject to Specify which process input variable (see: Process Input tab) will contain the subject (object) of the email.
    Map content to Specify which process input variable (see: Process Input tab) will contain the content (message) of the email.
    Map cc to Specify which process input variable (see: Process Input tab) will contain any email addresses that were specified in the CC field of the email that triggered the process. The email addresses will be held in a JSON array e.g ["Thibault Granie <tgranie@runmyprocess.com>","Maria Thomas <mthomas@runmyprocess.com>"]
    Map reply-to Specify which process input variable (see: Process Input tab) will contain the reply-to attribute from the email that triggered the process. This can be used to send an email to this person later in the process.
    Map attachment to Specify which process input variable (see: Process Input tab) will contain the id of the attachment files downloaded to the RunMyProcess server. If there are several attachments, the variable will be an array of IDs.
    Parsing format If you want RunMyProcess to parse the content of your email before injecting it into a "Map content to" variable, choose a different content format to the default one (Text).
    Use HTML format if exists Check this box if you want the HTML body of the email to be mapped to your "Map content to" variable.
    Description A description of the task.

    info For security reasons, the sender of the email (from) must belong to the lane of the event start (with the exception of public processes).

    1.3 Timer Trigger

    The timer trigger enables the process to be scheduled to launch itself automatically at a predefined frequency.

    After choosing "Timer" from the Trigger options, the following configuration options are made available:

    Field Name Description
    Start Date Specify the date and time on which to start the scheduling of the process. Click "Now" if you want the scheduling process to start immediately.
    Repetitions Number The number of repetitions. Click "Unlimited" if you want the process scheduling to loop indefinitely.
    Delay between reps Specify any delay you require between launches of the process - the default is one day.
    Description A description of the task.

    As an example, if you would like to schedule a process to launch automatically every day at 11am; set the Start Date to be today's date and the time to be 11am, set the Repetitions Number to be Unlimited and the Delay to be one day.

    info A process can only be launched by a Timer when it is used in a project version in Live state.

    info Scheduling will become effective after you have saved a version of the scheduled process and released it into the Production environment.

    info The period of a timer can be set up to a year (365 days).

    info Please note that the time is displayed in the user's local timezone but is stored in Coordinated Universal Time (UTC). This can cause confusion during the change from / to Daylight Saving Time as the server scheduler does not take into account the change. If you experience problems with your scheduled process following a time change, we recommend that you amend the start date of the trigger to a date where the time change has already taken place (e.g. the day after the time change).

    1.4 Condition Trigger

    After choosing "Condition" from the Trigger options to specify that the process can be triggered if a Condition is met (evaluates to True), the following additional configuration options are available:

    Field Name Description
    Execution Frequency (min) Specify how frequent you want the condition to be evaluated.
    Composite API Specify the Composite API which will evaluate and return the result of the condition (True or False).
    Description A description of the task.

    2 Output variables

    This tab allows you to initialize variables at the beginning of the process. You can find more information about output variables here.