Please give details of the problem



    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. Roles Entities
          2. Organization
          1. Project Definition
          2. Versions
          3. New Version
          4. Version Management Log
          5. Access Rights
          6. Collections
          7. Versioned Files
          8. Files
          9. Description
            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. Implementation
          2. Design
          3. Collections
          4. Stylesheet
          5. JavaScript
          6. API Listener
          7. Google Analytics
          1. Process Design
            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
          2. General
          3. Input
          4. Variables
          5. Measures
          1. Connectors
          2. Processes
          3. Providers
        1. Custom Lists
        2. Collections
          1. Design
          2. Configuration
        3. Revision
        1. My Applications
        2. Files
        3. Home
        1. Process Examples
        2. Connectors
        1. Web Interface Reports
          1. Execution Path
          2. Measuring
          3. Parameters
          4. Runtime Users
        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

    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 :


    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


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


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


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

    Create the list of currencies by configuring a custom list.


    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)


    • 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).


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


    • Go to Process listeners tab


    • 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).


    • 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)



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

    • Completed : put the following script


    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

      alert("Error while retrieving fx rate. Contact your administrator");  

    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.