×

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

    Collection

    Note: First read How to: Create a backoffice to manage collections tutorial.
    Note2: WI = Web Interface

    Example

    Here's a Car Booking application. There's a section to select a car. You want end users to be able to find the desired car in a proper RunMyProcess report then automatically inject corresponding car details in the booking form.

    View of Car Booking WI:

    2012-12-21_125914

    The end user will click on 'SELECT A CAR' button. That will open a new tab:

    2012-12-21_130116

    In this tab, we can use filter bar, pagination, sorting, to find the desired car. Then we select the corresponding row (1), and hit 'SELECT THIS CAR' button (2).
    The tab will be automatically shut down and information regarding selected row will be passed to the Car Booking WI (3):

    2012-12-21_130205

    How to configure this widget

    Configure 'Car Booking' WI

    First plug the collection cars to the web interface (id : col_cars):
    2012-12-21_132149

    Then switch to Design tab:
    2012-12-21_131841

    (1) : Create a button action 'Execute script'. Enter js code below:

    Code

    1
    window.open("https://live.runmyprocess.com/live/621199258/appli/67197?P_mode=${P_mode}&lookup=yes");
    

    the url of the WI mentioned above (https://live.runmyprocess.com/live/621199258/appli/67197) will have to be replaced by your own one. This WI wil display the nice collection report to select a car.

    (2) You have to create the text/number/date fields you want to display. You have to think about what field/keys from the collection will have to be passed to the WI.

    Best Practice is to use the same names for the widget variables as for the keys in the collection.

    (3) Create a hidden split widget

    (4) Create a js widget. Enter code below (definitions of js functions)

    Code

     1
     2
     3
     4
     5
     6
     7
     8
     9
    10
    11
    12
    13
    14
    function load_ok(json) {  
    //inject details from collection to the webinterface  
    for (var i in json[0]) {  
    RMPApplication.setVariable(i, json[0][i]);  
    }  
    }  
    function load_ko(result) {  
    alert("Error while loading car");  
    }  
    function load_car_details() {  
    var my_pattern = {};  
    my_pattern.car_id = RMPApplication.get("car_id");  
    col_cars.listCallback(my_pattern, {}, load_ok, load_ko);  
    }
    

    (5) Create a js widget that listens js_load_car_details. Enter js code below:

    Code

    1
    load_car_details();
    

    The expect behaviour is: when js_load_car_details variable changes, load_car_details() function is executed, and will retrieve all details regarding car_id value from collection.

    Configure 'Car lookup report' WI

    You can extend your existing Backoffice WI to configure the lookup feature. See How to: Create a backoffice to manage collections tutorial.

    2012-12-21_134305

    In that WI, ensure you put id_report as identifier for the report widget:

    2012-12-21_134456

    Above the report widget, you'll configure a 'SELECT THIS CAR' button:

    2012-12-21_134608

    This button has action 'Execute Script'. JS code below:

    Code

    1
    2
    3
    4
    5
    6
    7
    8
    var my_selection = id_report.getSelectedLinesValues();  
    if (my_selection.length > 0) {  
    window.opener.RMPApplication.set("car_id", my_selection[0].car_id);  
    window.opener.RMPApplication.set("js_load_car_details", Math.random());  
    window.close();  
    } else {  
    alert("Please select a car!");  
    }
    

    This code will:
    get car_id field of the selected row (my_selection[0].car_id). You'll have to replace car_id by the field containing the unique identifier for items in your collection.
    inject car_id variable into the father WI Car Booking: window.opener.RMPApplication.set("car_id",...)
    * inject js_load_car_details variable with a random value in the father WI

    Let's make this button visible only if the WI is used as lookup widget. Enter as visibility rule:

    Code

    1
    "[[lookup]]" == "yes"
    

    Note: if you open 'Car report / lookup' WI directly from its url, 'SELECT THIS CAR' button will be hidden since lookup variable doesn't exist.

    Save the 2 WIs, you're done!