×

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

    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)