×

Please give details of the problem

Docs

Find

    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. Custom Lists
          1. Web Interface Stylesheet Tab
          2. Web Interface Analytics Tab
          3. Web Interface Implementation Tab
          4. Web Interface Collection Tab
          5. Web Interface API Tab
          6. Web Interface Design Tab
          7. Web Interface JS Tab
            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. Version
          2. Project Version Tab
          3. Project Definition Tab
          4. Project Description Tab
          5. Project Rights Tab
          6. Project Versioned Files Tab
          7. Project Collection Tab
          8. Project Files Tab
        2. Collections
          1. Providers
          2. Processes
          3. Connectors
        3. Revision
          1. Composite API Configuration Tab
          2. Composite API Design Tab
          1. Process Input Tab
          2. Process General Tab
          3. Process Measures Tab
          4. Process Variables Tab
            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
          5. Process Design
          1. Organization
          2. Roles entities
        1. My Applications
        2. Files
        3. Home
        1. Process Examples
        2. Connectors
        1. Web Interface Reports
          1. Parameters
          2. Runtime Users
          3. Execution Path
          4. Measuring
        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

    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)