×

Please give details of the problem

Docs

Find

    User Guide

  1. Usage Report
  2. Logs Application
  3. Easy Builder
  4. FAQ
  5. User Management
        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 Tasks
      3. My Applications
      4. 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. RunMyApp for Android
    2. RunMyApp for iOS
    3. RunMyApp for Windows
  6. My Settings
  7. App Translator

Web Interface API Listener Tab

Allows you to launch a Composite API or a Connector or a Process without leaving your web interface (to initialise it with external data or to search dynamically external data according to current user input)

API Call
An API Call allows you to launch a Composite API or a Connector or a Process from a given screen of a web interface on given events (ie. without clicking on launch button) and wait for a given state of the process or Composite API/Connector result, to perform an action in your current screen. Example : on screen loading, launch a Composite APIs that will fetch in a Google Spreadsheet information about P_connected_user and add them in a custom list to be displayed in current screen.

cog_add Add an API
Allows you to add an API. An API can be : a Composite API or a Connector or a Process to your application

closetab Delete button
Allows you to delete current API

trash4 Delete all API(s) button
Allows you to delete all API(s) of your application

API
Thanks to "Choose a composite API" or "Other" button, choose a Composite API or a Connector or a Process to launch or Create a new one thanks to "New Composite API/Connector/Process" button

info Only Composite API/Connector/Process that belongs to same project as your web interface (or a project included in web interface project) will be displayed

info Click on "gear" icon to open corresponding API

Available
Check box if you want the API to be available for current selected screen (top right).

cog_go Open choosen API defintion
Allows you to open API definition from your web interface

Launch even read-only
API will be executed even if manual task has been validated (cf. read-only mode).

Launch API event
Allows you to choose which event will trigger the launch of chosen API. 3 events are available:

  • Screen initialized: API will be launched when loading web page,
  • Listened variable changed: API will be launched when variable(s) value typed in "Listen to variables" field will change (variables' separator is "," : a,b for instance),
  • Screen closed: API will be launched when closing web page thanks to a widget button .

Listened events
On each event of a given Composite API/Connector/Process, you can define different actions (script) to be performed within your web page. The following event can trigger actions:

  • Started: API has started successfully (flashy green icon). It is only available for process (listener)
  • Completed: API execution has finished successfully (green icon).
  • Not started: process can't be started (ex: input variable is missing to launch your process). It is only available for process (listener)
  • Waiting: process is in progress or waiting for a manual task (orange icon). It is only available for process (listener)
  • Cancelled: process has been cancelled by a user in a manual task (black icon). It is only available for process (listener)
  • Aborted/Failed: API has failed (red icon).

info To wait until a process reaches a given manual task, use "Waiting" event and check in your script "Internal parameters" P_task.id=id of your manual task (var jsonresult = eval('('+internal+')');if (jsonresult.P\_task.id==6) {};).

Script
In the scripting zone, the following variables from the launched process are accessible:

  • Id: id of your process (ex: 19150).
  • initial: initial parameters of your launched process. To get them in json format instead of string format, write the following line : var jsonresult = eval('('+initial+')'). It is only available for process (listener)
  • computed: computed parameters of your launched process. To get them in json, write the following line : var jsonresult = P_computed.
  • internal: internal parameters of your launched process. To get them in json format instead of string format, write the following line : var jsonresult = eval('('+internal+')'). It is only available for process (listener)