×

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

    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