×

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

    Development with Metadata and preferences

    The metadata and preferences are a set of data configured for each user of the account.

    Using metadata and preferences with the resources

    URI

    The uri are of the following format:

    • /config/{customer_id}/user/{user_id}/metadata/{path}?P_mode={mode}
    • /config/{customer_id}/user/{user_id}/preferences/{path}?P_mode={mode}

    with

    • customer_id: the id of the customer (the id of the account)
    • user_id: the id of the user
    • path (optional): the path of the data you want to manage
    • mode : the execution mode where you want to see or update the data

    Content-Type and Accept type

    Those resources will communicate only in JSON. It's why you have to set the Content-Type and the Accept properties to application/json in the header of your HTTP request.

    Methods

    The resources accept the following methods:

    • GET: To get the data
    • PUT or POST: To update or create data
    • DELETE: To remove one key of the data

    info_1 For each action, the rights will be checked

    Samples

    For our example the account (123) is configured with the following metadata:

    1
    2
    3
    4
        identity <structure>
            age  : <number>
            name : <string>
            items: <array of string>
    

    The user (456) will have, for instance, the following values:

    1
    2
    3
    4
    5
    6
        {"identity":{
            "age" : 20,
            "name": "John Doe",
            "items": ["plate", "knife", "fork"]
            }
        }
    

    REQUEST: GET http://live.runmyprocess.com/config/123/user/456/metadata/identity/age
    RESPONSE: {"data":20}

    REQUEST: GET http://live.runmyprocess.com/config/123/user/456/metadata/identity/items
    RESPONSE: {"data":["plate", "knife", "fork"]}

    REQUEST: GET http://live.runmyprocess.com/config/123/user/456/metadata/identity/items/1
    RESPONSE: {"data":"knife"}

    REQUEST: PUT http://live.runmyprocess.com/config/123/user/456/metadata/identity/items/0
    POST DATA: {"data":"cup"}
    RESPONSE: {"data":{"identity":{ "age" : 20, "name": "John Doe", "items": ["cup", "knife", "fork"] } }}

    Freemarker methods

    According to the resources, two methods allow to change metadata or preferences of user with a path.

    • P_change_metadata : Like the resource, you can specify a path to change specificly a key of the metadata.
    • P_change_preferences : Like the resource, you can specify a path to change specificly a key of the preferences.