×

Please give details of the problem

Docs

Find

    Developer Guide

        1. Todo Validation
      1. Release Your User Login
      1. Process Reporting API
        1. CSS Examples
        2. CSS Personalization
      1. Performance
        1. List Reinitialization
        2. Holidays
        3. Number Currency Format
        4. Label Modification
        5. Array From WS
        6. Launch Process JQuery
        7. Column Inactivation
        8. Date
        9. Print JSONObject
        10. ArrayJSON to JSONArray
        11. Invalid Fields
        12. Round
        13. Initialization Widget Date
        14. JQuery
        15. Inject JSONObject
        16. Google Tables
        1. Summing Array
        2. API Listener
        3. User Lane Picker
        4. Retrieving Variables Values
          1. Chart Dashboard
          2. Report Chart
          3. Google Visualization
          4. Chart Dashboard Collection
        5. Tags
        6. Collection
        7. File Preview
        8. Dynamic List
        9. Dialog Window
        10. JavaScript Report
        11. Autocomplete Widget
          1. homepage.js
          2. homepage.css
        1. Logout
        2. Custom Login Page
        3. Header
        4. Mobile Devices
        5. Basket
        6. Redirection ExecutionMode
        7. Menu Bar
        8. Information Tags
      1. Composite API Example
      1. Markdown Template
        1. Task Reminder Email
        2. SubProcess
        3. PDF
        4. JavaScript Inclusion
        5. Variable Mapping
        6. Backloop
      2. Trigger
        1. File Visibility
        2. Number Currency Format
        3. Error Handling
        4. JSONObject Concatenation
        5. Loop
        6. Dynamic Variable
        7. List 1000+ Objects
        8. Metadata
        9. Freemarker Container Test
        10. JSONObject Keys Values
        11. List Hash Sequence
        12. Special Freemarker Characters
        13. Salesforce Computation
        14. Array To List
        15. JSONArray Conversion
        16. Lock
        17. JSONObject Creation
        18. Number Test
      1. Customer Management
        1. Messages
        2. Scheduled Process
        1. Custom Lists
          1. Web Interface Stylesheet Tab
          2. Web Interface Analytics Tab
          3. Web Interface Implementation Tab
          4. Web Interface Collection Tab
          5. Web Interface API Tab
          6. Web Interface Design Tab
          7. Web Interface JS Tab
            1. Report Widget
            2. List Widget
            3. JavaScript Widget
            4. History Widget
            5. RadioButton Widget
            6. FileUpload Widget
            7. StaticText Widget
            8. HTML Editor Widget
            9. ProgressBar Widget
            10. Section Widget
            11. Spinner Widget
            12. Image Widget
            13. Multi Checkbox Widget
            14. Tab Widget
            15. Tree Widget
            16. HTML Widget
            17. Checkbox Widget
            18. Button Widget
            19. Custom Widget
            20. URLInput Widget
            21. TextInput Widget
            22. Array Widget
            23. Captcha Widget
            24. Geolocation Widget
          1. Version
          2. Project Version Tab
          3. Project Definition Tab
          4. Project Description Tab
          5. Project Rights Tab
          6. Project Versioned Files Tab
          7. Project Collection Tab
          8. Project Files Tab
        2. Collections
          1. Providers
          2. Processes
          3. Connectors
        3. Revision
          1. Composite API Configuration Tab
          2. Composite API Design Tab
          1. Process Input Tab
          2. Process General Tab
          3. Process Measures Tab
          4. Process Variables Tab
            1. Gate
            2. Process Step Output Variables
              1. Process Task Functional Tab
              2. Process Task Connector Tab
              3. Process Task Script Tab
              4. Process Task Loop Tab
              5. Process Task SubProcess Tab
              6. Process Task Manual Tab
              7. Process Task Email Tab
            3. Process Step Input Variables
            4. Process Step Testing Variables
              1. Process Intermediary Event
              2. Process Start Event
              3. Process Timer Event
          5. Process Design
          1. Organization
          2. Roles entities
        1. My Applications
        2. Files
        3. Home
        1. Process Examples
        2. Connectors
        1. Web Interface Reports
          1. Execution Path
          2. Measuring
          3. Parameters
          4. Runtime Users
        1. Configuration
        2. Users
        3. Usage
      1. Mobile
      2. Offline
      1. Collections BackOffice
      2. Collections To List
      3. Collections To Array
      4. Collection JS Freemarker
      1. Access Rights
      2. Delegation
      3. Compound Organization Hierarchy
      4. Dynamic Lanes
      5. Scripted Lanes
      6. Runtime Lanes

    Basket

    The basket (or basket of tasks) is the generic name used to define the list of classified tasks of one connected user. Basically, the basket aggregates a list of tasks done, to be done or cancelled assigned to the user and a list of tasks done, to be done or cancelled requested by the user.

    Basket definition

    The basket has 3 main parts:

    1. Basket alert

    basket_alert_in_the_header

    The basket alert appears on the top right of the header (see figure below). It shows the number of opened tasks assigned to the connected user.

    info_1 The number inside the basket alert turns to red and bounces 3 times when the number changes (and after loading)

    info_1 The number inside the basket alert appears also in the title of the web page (only if positive)

    2. Basket popup

    The basket popup (see figure below) appears and disappears when you click on the basket alert.

    basket_popup

    The basket popup contains the following information:

    • Under "My Tasks" you will find the number of tasks assigned to the connected user:

      • Pending: Number of opened tasks waiting for an action from the connected user (this number is also the number of the basket alert)
      • Completed: Number of tasks completed
      • Cancelled: Number of tasks cancelled
      • Overdue: Number of tasks in overdue
    • Under "My Requests" you will find the number of tasks requested by the connected user:

      • Opened: Number of opened tasks (the process is not yet started or is waiting for a validation)
      • Completed: Number of tasks completed
      • Cancelled: Number of tasks cancelled
      • Overdue: Number of tasks in overdue
    • "See all" option, when checked the numbers are concerning all the web interfaces. If not checked, the numbers concerns only the current web interface

    info_1 Only task's category with positive number are clickable

    3. Tasks list popup

    The tasks list popup appears when you click on a task's category in the basket popup. It contains the detail of the tasks (see figure below).

    Tasks list Basket

    You can find in this popup:

    • Name: The name of the task and the name configured in the header of the web interface (if exists)
    • Lane: The name of the lane concerned by this task or simply a dash ['-'] if the task concerns only the user
    • Priority: The priority of the task (! means low, !! means medium, !!! means high)
    • Creation date: The creation date of the task
    • Updated date: The last updated date of the task
    • Due date: The due date of the task

    info_1 The list is ordered by updated date and paginated (20 tasks maximum)

    How to configure the basket

    In the first tab of the configuration of the web interface, when the checkbox "Display the header" is checked, you can click on the icon (see figure below) to configure the basket.

    Configuration of the basket

    You have 4 possibilities for the basket (see figure below):

    • "All instances": the basket will display the information about all applications (equals to "See all" option checked)
    • "Current web interface instances": the basket will display the information only related to the current application (equals to "See all" option unchecked)
    • "None": The basket will not appear for this web interface
    • "Another web interface instances": The basket will display the instance of the chosen application (this case is typically used for the reporting web interfaces which have no instance but which refer to instances of another web interfaces).

    Configuration of the basket

    info_1 The basket uses jQuery-ui, this library is automatically added to your user interface but you should not remove it.

    Basket synchronisation latency

    To optimize the response time of the basket some information are pre-calculated and some not. For this reason, you may have sometime differences between the popup basket (number of tasks) and list basket (list of tasks). It's due to

    • The tasks numbers are asynchronous (it may take several second to be update)
    • The tasks lists are synchronous, you directly query the dabatase to have the exact list at any time
    • The user interfaces refresh automatically their basket every 5 minutes, but you can also reload the interfaces to get updated data

    i18n of the basket

    The basket can be translated using the Application Translator. You will find some specific entries in your dictionary dedicated to the basket.

    Handle basket with javascript

    This part is for javascript developer.

    You can bind your user interface javascript method with the input data of the basket. The basket comes with 3 javascript methods.

    RMP_basket.addListener(fct): This method allows to bind a method (fct) to the input data of the basket. fct will be called every 5 minutes (each refresh of the basket) even if there is no modification of the basket's data

    RMP_basket.popup(id, filter, status): This method allows to open the tasks list basket.

    • id <Number>: Id of the application used to filter the tasks list
    • filter <String>: "ASSIGNED_TO" to filter by "My Tasks", "INITIATED_BY" to filter by "My Requests"
    • status <Number>: Filter on the category of the task:
      • 1 - OPENED
      • 2 - CLOSED
      • 3 - CANCELLED
      • 4 - OVERDUE

    RMP_basket.setApplicationId(id): This method allows to associate the basket with another application than the current one (id <Number> is the id of the application used to filter the tasks list).

    Let's see how it works with an example. The example below will invite the user to see its pending tasks for application id = 123

     1
     2
     3
     4
     5
     6
     7
     8
     9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    21
    function notify(data){
        if (!data) return;
    
        // Filter the data assigned to the connected user.
        var assignedData = data['ASSIGNED_TO'];
        if (!assignedData) return;
    
        // Filter the data for pending tasks
        var pendingData = assignedTo['1'];
        if (!pendingData) return;
    
        // Filter the data for 123 application
        var applicationData = pendingData['123'];
        if (!applicationData) return;
    
        if (confirm('Do you want to see tasks list for 123?')){
            // Open the tasks list popup
            RMP_basket.popup(123, 'ASSIGNED_TO', 1);
        }       
    }
    RMP_basket.addListener(notify);
    

    The data input of listener functions is a JSONOBJECT with following structure:

     1
     2
     3
     4
     5
     6
     7
     8
     9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    21
    22
    23
    24
    25
    26
    27
    28
    29
    30
    31
    32
    33
    34
    35
    36
    37
    38
    39
    40
    41
    42
    43
    44
    45
    46
    47
    {
    'ASSIGNED_TO':
        {
        1:                          // Pending
            {
            web-interface-id: number of tasks ...
            }
        }
        2:                          // Closed
            {
            web-interface-id: number of tasks ...
            }
        }
        3:                          // Cancelled
            {
            web-interface-id: number of tasks ...
            }
        }
        4:                          // Overdue
            {
            web-interface-id: number of tasks ...
            }
        },
    'INITIATED_BY':
        {
        1:                          // Opened
            {
            web-interface-id: number of tasks ...
            }
        }
        2:                          // Closed
            {
            web-interface-id: number of tasks ...
            }
        }
        3:                          // Cancelled
            {
            web-interface-id: number of tasks ...
            }
        }
        4:                          // Overdue
            {
            web-interface-id: number of tasks ...
            }
        }
    
    }
    

    How to create an homepage

    Header and Menu Bar

    Application Translator