×

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

    Composite API

    A composite API is a sequence of tasks that runs synchronously and which execution path is not persisted.

    Definition

    Composite APIs are best described by comparing them with processes :

    • Both processes and composite APIS are a sequence of tasks
    • Composite APIs run synchronously unlike processes : the result of triggering of a Composite API is the result of the execution, not the request that will contain the result of the execution once it is finished.
    • Each composite API can be triggered by calling its API.
    • A composite API execution is never paused, which implies that a composite API cannot contains manual tasks nor subprocesses tasks unlike a process.
    • A composite API execution path is not persisted unlike a process which enables it to run more quickly.

    Triggering a Composite API

    A composite API can be triggered in the following ways:

    • As a task in a process.
    • As a listener in a web interface.
    • Directly via its exposed API (from a third-party).

    Use cases

    A composite API may be used :

    • To speed up the execution of a sequence of tasks.
    • To improve listeners performance in web interfaces.
    • To compose an API by creating a sequence of web services calls that is meaningful.

    Design

    The design of a composite API includes the design of the sequence of tasks like in a process and the design of its exposed API.
    Contrary to a process, the corresponding REST API of a Composite API can be configured. You can configure :

    • The Method : the HTTP verb.
    • The Accept media type : the media type of the input.
    • The Result media type : the media type of the output.

    It is important to note that a Composite API which is triggered from a web interface must be configured with its Accept media type set to application/json.

    A good practice is to choose the HTTP verb that matches what the composite API does :

    • GET if it only retrieves information
    • PUT if it modifies something
    • POST if it creates something
    • DELETE it it deletes something

    Debugging and Maintenance

    Since the composite API execution path is not persisted, the test and debug should be thought very differently from what is done with processes.

    Retrieving the error

    An unhandled error launched during the execution of a Composite API will appear in the customer logs which have been introduced with the mogador release. They can be accessed in the Logs Application.

    When the execution of a composite API fails, the error is logged in the Custom Logs with the following information :

    • Date : Date and time of the error
    • Log Level : An unhandled error that aborts the execution of a Composite API will always be SEVERE
    • Message : The error message
    • Process ID / Composite API ID : ID of the Composite API
    • Project ID : ID of the context project. For a composite API belonging to a project B, subproject of a project A, that is launched by a process or a web interface from project A, the context project will be project A.
    • Request ID : Unique ID of the Composite API execution.

    In addition and depending on how the Composite API was launched, the error message can also be retrieved in the execution context

    • Composite API launched from a process : The error message is returned to the request P_message variable.
    • Composite API launched from a web interface : The error message is returned in a P_error variable.

    Throwing your own errors

    The platform provides a freemarker method throw that enables you to throw an error and abort the execution of the Composite API.

    This method enables you to define a error message, that will be returned into the execution context as seen above.

    Handle errors

    Composite API can handle errors exactly in the same way as process by using error handlers in their design. Error handlers enable you to capture errors and deal with them.

    Debugging

    The Logs Application can also be used to track the execution of composite API by using the P_log function within the composite API. This method can be quite useful for debugging.

    (@see Composite API Example)