×

Please give details of the problem

Docs

Find

    Developer Guide

    1. Composite API Example
      1. Scripted Lanes
      2. Compound Organization Hierarchy
      3. Dynamic Lanes
      4. Delegation
      5. Access Rights
      6. Runtime Lanes
        1. Todo Validation
      1. Release Your User Login
      1. Collections To Array
      2. Collections To List
      3. Collections BackOffice
      4. Collection JS Freemarker
          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 Applications
        3. 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. CSS Examples
        2. CSS Personalization
      1. Performance
        1. Logout
        2. Redirection ExecutionMode
        3. Information Tags
        4. Basket
        5. Menu Bar
        6. Header
        7. Custom Login Page
        8. Mobile Devices
          1. homepage.css
          2. homepage.js
        1. Inject JSONObject
        2. Google Tables
        3. ArrayJSON to JSONArray
        4. Label Modification
        5. Number Currency Format
        6. Launch Process JQuery
        7. Date
        8. JQuery
        9. Round
        10. Holidays
        11. Array From WS
        12. Column Inactivation
        13. Print JSONObject
        14. Initialization Widget Date
        15. Invalid Fields
        16. List Reinitialization
        1. Tags
        2. Dialog Window
        3. Dynamic List
        4. User Lane Picker
          1. Report Chart
          2. Google Visualization
          3. Chart Dashboard
          4. Chart Dashboard Collection
        5. API Listener
        6. JavaScript Report
        7. Retrieving Variables Values
        8. Collection
        9. File Preview
        10. Autocomplete Widget
        11. Summing Array
      1. Trigger
      2. Markdown Template
        1. Task Reminder Email
        2. JavaScript Inclusion
        3. PDF
        4. SubProcess
        5. Backloop
        6. Variable Mapping
        1. Salesforce Computation
        2. Number Currency Format
        3. List Hash Sequence
        4. JSONObject Creation
        5. Freemarker Container Test
        6. JSONObject Concatenation
        7. Metadata
        8. Special Freemarker Characters
        9. List 1000+ Objects
        10. Dynamic Variable
        11. File Visibility
        12. Number Test
        13. JSONObject Keys Values
        14. Lock
        15. JSONArray Conversion
        16. Error Handling
        17. Loop
        18. Array To List
      1. Process Reporting API
      1. Offline
      2. Mobile

    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)