×

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 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. This page is divided into two sections - one for the 'Event' and one for the 'Output Variables'.

    1 Event

    The Event tab is where you can configure the event.

    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, the options are:

    • None: the process can only be launched through a POST request (ie a web service call) or by a RunMyProcess Web Interface.
    • Message: the process can be launched by an email.
    • Timer: the process can be scheduled to launch itself automatically at a predefined frequency.
    • Condition: the process can be launched when a condition is met.

    1.1 Web Trigger

    After choosing "None" from the Trigger options to specify that the process can be triggered by a POST request or a RunMyProcess Web Interface, the following configuration options are made available:

    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.

    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>
    

    Description

    A description of the task.

    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:

    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:

    1
    process+{customerid}.{processid}.{key}@runmyprocess.com
    

    to launch the process in Live state and

    1
    process+{customerid}.{processid}.{key}.TEST@runmyprocess.com
    

    to launch the process in Test state.

    info When launching your process in Test, the last saved version of the process will be used as process versioning is not available in Test). 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).

    info The mailbox is pulled every five minutes.

    Map subject to

    The input variable of the process (see: Process Input tab) that will contain subject (object) of the email.

    Map content to

    The input variable of the process (see: Process Input tab) that will contain content (message) of the email.

    Map cc to

    The input variable of the process (see: Process Input tab) that will contain email copy of the email.

    Map attachment to

    The input variable of the process (see: Process Input tab) that 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.

    1.3 Timer Trigger

    After choosing "Timer" from the Trigger options to specify that the process can be triggered by a timer, the following configuration options are made available:

    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.

    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).

    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.

    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.

    Description

    A description of the task.

    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).

    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:

    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.