×

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

    Retrieving Variables Values : RMPApplication.get() vs "[[ ]]"

    These syntaxes are used to retrieve variable values, and both have a specific behavior. Let's see when and why you should or shouldn't use them.

    Let's take 4 examples of widgets:

    • A text input widget, variable firstname.
    • A number input widget, variable amount.
    • A multi selection list widget, whose value variable is product_ids.
    • An array widget, whose variable is items_t

    RMPApplication.get() syntax

    How to use it

    Technically, you expect to have firstname being a string, amount being a number, product_ids being an array and items_t being a json.

    You have to keep in mind that RMPApplication.get("xxx") will always return a string, so you will have to cast it to a number, array or json in your scripts:

    1
    2
    3
    4
    RMPApplication.get("firstname"); //returns a string
    parseFloat(RMPApplication.get("amount")); //returns a float/number
    JSON.parse(RMPApplication.get("product_ids")); //returns an array
    JSON.parse(RMPApplication.get("items_t")); //returns a json
    

    Where to use it

    • in js widgets
    • in prelaunch scripts on buttons
    • in .js files

    Where/When you shouldn't use it

    Don't use this syntax in JS dynamic rules on widgets, because it will be executed only once (see section on "[[ ]]" syntax for more details).

    "[[ ]]" syntax

    How to use it

    Technically [[myvar]] will be replaced by the characters as value of myvar.

    If you expect a string variable, then you must use "[[ ]]" syntax. Ex:

    1
    "[[firstname]]"; //returns "John", if you've entered John in the text input => it's a string
    

    If you expect a variable that is NOT a string (it's a number, or an array, or a json), you must use [[ ]] syntax instead (note that there is no double quotes " "). Ex:

    1
    2
    3
    [[amount]]; //returns 1.234 if you've entered 1.234 in the number widget => it's a number
    [[product_ids]]; //returns an array
    [[items_t]]; //returns a json
    

    If you don't follow above rules:

    1
    2
    3
    4
    [[firstname]]; //returns John. JS engine will understand you try to call John variable and will lead to an error.
    "[[amount]]"; //returns "1.234". You'll have to use parseFloat() to get a number
    "[[product_ids]]"; //this is wrong, it returns an array surrounded by double quotes
    "[[items_t]]"; //this is wrong, it returns a json surrounded by double quotes
    

    Where to use it

    Keep "[[ ]]" syntax for the dynamic rules on widgets: it not only means you intend to retrieve a variable value, but also you are listening to this variable.

    Where/When you shouldn't use it

    • Special characters

    If the RunMyProcess variable is a string and contains any special characters (ex: carriage return), you should't use "[[ ]]" syntax since you'll get a JS execution error.

    Ex: if you configure a multi-rows text input address, and enter a value with carriage returns: Street\n\City\nCountry :

    1
    2
    3
    4
    5
    "[[address]]"; //will be replaced by
    
    "Street
    City
    Country"; //and this will lead to a JS execution error
    

    So in that case, do rather use:

    1
    RMPApplication.get("address"); //returns "Street\n\City\nCountry"
    
    • In a definition of a function

    If you intend to create a function that calls firstname variable and display it:

    1
    2
    3
    function display_firstname() {
        alert("[[firstname]]"); //Wrong!
    }
    

    If you call the function above, you will get the value firstname had at the moment you defined the function. So you must use this definition instead:

    1
    2
    3
    function display_firstname() {
        alert(RMPApplication.get("firstname")); //Right!
    }