×

Please give details of the problem

Docs

Find

    Developer Guide

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

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