×

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

    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)