×

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

    Progress Bar

    Progress bar is a widget which allows to manage the progress of a request. The request is splitted in ordered steps which are displayed, actived or inactived following the state of the request.

    Configuration

    Progress Bar configuration

    There are two ways to use the progress bar widget, automatically using the configuration of the web-interface and manually by specifying a configuration and a process variable.

    Automatically configuration

    For this configuration, you only have to configure the widget. The progression of the bar will be managed by the motor of the process. To configure the progress bar widget you have to associate each manual task to one step (see image).

    info_1 One step can be linked to one or several manual tasks

    Manually update

    For this configuration, you have to check the box "custom configuration" (see image) and to provide a JSONArray configuration. The JSONArray have to contain a list of JSONObject with the following keys:

    • reference: <integer> it's the ordered number of the step
    • title: <string> title of the step
    • subtitle: <string> subtitle of the step
    • number: <string> the indicator inside the circle of the step (you can ignore it or use auto value to have an automatic, incremental number)
    • state: <string> the state of the step (default is next, it can take the values: active, previous, hidden, next)
    • screen: <array> list of the reference of the manual task (optional)

    Sample:

    1
    2
    3
        [{"reference":0,"title":"Items order"},
         {"reference":1,"title":"Validation"},
         {"reference":2,"title":"Comptability"}]
    

    You will have also to handle a variable inside your process. This variable will contain the state of the progress bar. The state of the progress bar is a JSONObject containing the information reference:state.

    Sample:

    1
        {"0":"previous", "1": "active"} // This is to activate the second step which is in our example "validation"
    

    The state can take the following values:

    • active: for the "active" step, the current step where the request is waiting for
    • next : for the steps which are still not reached
    • previous: for the steps achieved
    • hidden: for the hidden steps, you can "show" these steps with the method setState descripted in the "Advanced features" chapter.

    info_1 Don't forget to precise the name of the variable in the configuration of the progress bar

    Advanced features

    To complete this widget, there is a set of javascript methods to pilot it easily.

    • setTitle(reference, title): Change the title of the step identified by its reference.
    • setSubTitle(reference, subtitle): Change the subtitle of the step identified by its reference.
    • setNumber(reference, number): Change the number of the step identified by its reference.
    • setState(reference, state): Change the state of the step identified by its reference.

    info_1 As all the widgets, these methods are called with id_widget.method_name

    API Reference

    Web interface configuration

    Widgets