×

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

    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!
    }