×

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

    Use Process Reporting APIs

    When you submit a webinterface and trigger a process, you create process instances. Those instances are stored within a RunMyProcess internal database, and you can query them by configuring process reports from IDE, or by using the Process Reporting APIs.

    In this tutorial, we will explain step by step how to configure a Composite API to query the Process Reporting API. This will enable you to create charts dashboards, to use the reporting data in a RunMyProcess application or to expose it to a third-party application.

    Technically, configuring a process report by adding columns and filters will build a specific url so you can retrieve the process instances matching criterias. The purpose of this tutorial is to understand how this url is built, how the parameters are passed, so you can retrieve process instances via APIs without using native reports (and inject that information in Webinterfaces for example).

    Basic Use Case

    Let's assume a simple use case for the sole purpose of this tutorial.

    You have developped a car purchase application in which every instance is an order associated to an amount and some car details. If the application is supposed to manage stocks, then you'll need to compare how many cars were available in the first place in a specific country with how many were purchased in that country. Comparing those numbers will give you the remaining ones, available for purchase in this country.

    The goal is to be able to display the number of remaning cars to a end user that is willing to order a new car to prevent him from purchasing non-available cars.

    In that case, the "number of cars purchased for a specific country" can be retrieved using Process Reporting APIs since all the necessary data is already present in process instances.

    Process and report configuration

    After drawing your process, you had configured measures to be used as custom columns or filters in your webinterface and process reports.

    Here's the list of measures in our example process:

    main_process_v1

    Here's a process report displaying process instances:

    main_process_v1

    This process report can have static filters and can also filter on connected user's metadata. You could save it and embed it into your webinterfaces.

    Let's add the filters car_country == "Italy" and car_price < 500000:

    main_process_v1

    Then click on RSS feed icon (1). That should open a new tab in your browser. Url looks like:

    1
    2
    3
    4
    5
    6
    7
    https://live.runmyprocess.com/live/118401407363362072/request?
    nb=20&
    first=0&
    column=name%20status%20measure_1%20measure_1%20measure_3%20measure_4%20measure_5&
    filter=PROJECT%20MODE%20MEASURE_1%20MEASURE_4%20PARENT%20PROCESS
    operator=EE%20EE%20EE%20LT%20IS%20EE&
    value=85524%20TEST%20Italy%20500000%20NULL%20109611&
    

    and xml content looks like:

    main_process_v1

    Every entry node is a process instance. So a process report actually calls the report feed url, then parse the xml feed and render it in a table view.

    Process Reporting API

    Let's have a closer look to the report feed url:

    nb is the number of items to retrieve

    first is the starting index of the query

    column is the list of custom columns (=measures) to be displayed.

    1
    name%20status%20measure_1%20measure_1%20measure_3%20measure_4%20measure_5
    

    name and status are system measures, whereas measure_x are the custom measures you've created:

    main_process_v1

    filter is the list of measures you're filtering on

    1
    2
    3
    4
    5
    6
    PROJECT:    filter on instances that belong to a specific project (by default it's the current project)
    MODE:       filter on execution mode (TEST/ACCEPTANCE/LIVE)
    MEASURE_1:  filter on car_country
    MEASURE_4:  filter on car_price
    PARENT:     filter on instances related to a subprocess (PARENT = ANY) or to father processes only (PARENT = NULL)
    PROCESS:    filter on process id
    

    operator is the list of operators to be applied on filters

    1
    2
    3
    4
    5
    6
    7
    8
    EE  means Equal(=)
    LT  means Lower Than (only for numeric measures)
    GT  means Greater Than (only for numeric measures)
    IS  means Equal (only for system measures)
    CONTAINS means Contains (designed for strings)
    NOT_CONTAINS means Doesn't contain (designed for strings)
    IN means Appears In the following list separated by coma (ex : country IN France,USA
    NOT_IN means opposite of IN
    

    value is the list of values to be applied on related filters & operators

    So basically the query we try to perform is:

    1
    2
    3
    4
    5
    6
    PROJECT     EE  85524
    MODE        EE  TEST
    PARENT      IS  NULL
    PROCESS     IS  109611
    MEASURE_1   EE  Italy
    MEASURE_4   LT  500000
    

    Configure a Composite API to perform queries on process instances

    Let's build a Composite API that will accept as input parameters country and max_price and that will return the list of matching cars as JSON.

    Create the provider.

    Create a new Provider. For the 3 environments, fill in url with https://live.runmyprocess.com/ and Authentication scheme with RunMyProcess Secured Connection.

    bad_design_main_process

    Create the connector

    From the provider, create a new Connector. Connector url is

    1
    2
    3
    4
    5
    6
    7
    live/118401407363362072/request?
    nb=20&
    first=0&
    column=name%20status%20measure_1%20measure_3%20measure_4%20measure_5&
    operator=EE%20EE%20EE%20LT%20IS%20EE&
    value=85524%20TEST%20${country}%20${max_price}%20NULL%20109611&
    filter=PROJECT%20MODE%20MEASURE_1%20MEASURE_4%20PARENT%20PROCESS
    

    Result format is XML, and Accept media type is application/atom+xml.

    Notice MEASURE_1 and MEASURE_4 values have been replaced by ${country} and ${max_price}.

    bad_design_main_process

    You should then be able to test your connector and pass input parameters:

    bad_design_main_process

    Create the Composite API

    Create a Composite API. Configuration tab:

    bad_design_main_process

    In Design tab, plug the connector you've created (1):

    bad_design_main_process

    then go to Output variables (2):

    bad_design_main_process

    Here's the freemarker script to parse raw XML ouput and create cars jsonArray variable:

     1
     2
     3
     4
     5
     6
     7
     8
     9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    21
    22
    23
    24
    <#assign entries = P_to_array(P_result.feed,"entry")>
    <#assign cars = []>
    <#list entries as x>
        <#assign categories = P_to_array(x,"category")>
        <#assign car = {}>
        <#list categories as x>
            <#switch x.@term>
                <#case "MEASURE_1">
                    <#assign car = P_json_put(car,"country",x.@label)>
                    <#break>
                <#case "MEASURE_3">
                    <#assign car = P_json_put(car,"id",x.@label)>
                    <#break>
                <#case "MEASURE_4">
                    <#assign car = P_json_put(car,"price",x.@label?number)>
                    <#break>
                <#case "MEASURE_5">
                    <#assign car = P_json_put(car,"purchase_date",get_date(x.@label?number,"yyyy-MM-dd HH:mm:ss z"))>
                    <#break>
            </#switch>
        </#list>
        <#assign cars = cars + [car]>
    </#list>
    ${cars}
    

    Save your Composite API and test it:

    bad_design_main_process

    Congratulations! You've just built a custom webservice relying on a Composite API, to search process instances based on country and max_price, with JSON output format.

    Note: this Composite API can be plugged to a RunMyProcess webinterface to configure an autocomplete widget, or a chart dashboard. You can also call this Composite API from a third party system.

    For more information, you can also consult the following pages