×

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

    API Listener

    In a web interface you can retrieve data or perform action by executing API listeners. An API Listener is both a resource that you can launch from a web interface and how this resource is launched. This page will present the various options that you can use to add complex interactivity in your web interfaces.

    API Listener configuration

    API listeners types

    In a web interface, you can trigger and launch

    Composite APIs and connectors are executed synchronously whereas processes are executed asynchronously. Composite APIs and connectors should be configured with their Accept-type equals to application/json otherwise triggering them will fail.

    Launch events

    The following launch process events are available

    • Screen initialized : the listener is triggered at the web interface opening.
    • Listened variable changed : the listener is triggered when one of the specified variable is changed (separator is coma, e.g: currency,variable1,variable2)
    • Application closed : the listener is triggered when the web interface is closed (e.g : submission of a webform that triggers a workflow process, validation of a manual task)
    • Manually via JavaScript : the listener is triggered by the execution of the trigger javascript function. In this case you should also configure an identifier which will be used as the WidgetID on which to call the trigger function.

    Retrieving and making good use of the listener's result

    Configuring an API listener in a web interface implies configuring the behaviour of the interface when the listener succeeds or fails.
    To do so, you should fill in respectively the Completed and Failed scripts.

    In those scripts, you can use the following variables :

    • P_computed : this variable contains the output of the listener (e.g : the computed parameters of a composite API) and is only available if the listener has succeeded.
    • P_error : this variable contains the potential error generated during the listener execution and therefore can only be accessed in the Failed script.

    The "Manually via JavaScript" trigger excepts as both scripts are replaced by the definition of callback functions.

    Process Listener Example

    This example will show you how to configure a process listener. We will design a web interface that displays a list of currencies. When selecting a particular currency, the exchange rate of the currency against the € will be retrieved from the European Central Bank and displayed in the web interface.

    In the web interface design environment, the Process Listeners tab is now called API call :

    2012-01-11_153047

    Step 1 : Create the process that will be triggered as a process listener

    • Import the connector from library : European Central Bank > Daily Euro Rate Exchange

    • As output variable of the activity, create fx_rate = ${P_result.rate[currency]} with currency the name of the variable to configure in your webform

    • Need a more step by step connector configuration? read this tutorial

    2012-01-11_150856

    Let's test the process by injecting an input parameter :

    2012-01-11_151004

    After the process is completed, you should see fx_rate in the computed parameters :

    2012-01-11_151114

    Step 2 : Create the list of currencies and the web interface

    Create the list of currencies by configuring a custom list.

    2012-01-11_151523

    Design the web interface :

    • add a spinner, put an identifier (e.g : id_spinner in the rest of the example), then go to Rules tab and untick Visible (4)

    2012-01-11_153110

    • Add the list widget (1), name the value variable currency (2), label variable is optional (3), choose type custom list (4) and select your list (5).

    2012-01-11_153542

    • Add a number input (1), name the variable my_fx_rate (2) and select type "Number" (3)

    2012-01-11_153733

    • Go to Process listeners tab

    2012-01-11_153936

    • Click on "Add process listener" (1), then "Choose a process" and select get fx rate (2), choose "Listened variable changed" for the Launch process event (3) and currency for the listened variable (4).

    2012-01-11_155619

    • Then enter the following scripts (5 - 6 -7 above):

      • Started : tick the box (1), click on Script (2), enter your script (3) and click on Ok (4)

    2012-01-11_160012

    1
    id_spinner.setVisible(true);
    

    This code will get executed when the process is launched and will display the spinner.

    • Completed : put the following script

      1
      2
      RMPApplication.setVariable("my_fx_rate",P_computed.fx_rate);  
      id_spinner.setVisible(false);
      

    This code will get executed when the process is completed. It will retrieve the computed parameter fx_rate from the completed process and assign the web interface variable my_fx_rate with this retrieved value. It will also hide the spinner.

    • Aborted : put the following script

      1
      2
      alert("Error while retrieving fx rate. Contact your administrator");  
      id_spinner.setVisible(false);
      

    This code will get executed when the process fails. It will display an error message and hide the spinner.

    Save your web interface and preview it :

    If you select a currency, the following scenario will get executed :

    • The spinner appears which means that the process has been launched.
    • The My fx rate input is filled with the retrieved value and the spinner is disappears : the process has completed and the "Completed" associated script has been executed.

    2012-01-11_160923