×

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

    Roles/Entities

    This page allows you to create, view, edit or delete both roles and entities. This page can be found by navigating from the Toolbox, to Organization and choosing the Roles / Entities tab.

    1 Creating new roles and entities

    Click the relevant button at the top of the page to add a role or an entity to an existing organization. You will be required to choose the organization that the new role or entity belongs to before entering the details (outlined in Section 4).

    2 Viewing existing roles or entities

    Summary details for all exiting roles and entities are displayed in a table. The details shown are:

    Name Description
    Path The organisation that the role / entity belongs to
    Type Role or Entity
    Id The unique identifier
    Name The name given to the role / entity
    Everybody? This is checked if this role / entity is an everybody one
    Script If the role is a scripted one (membership determined by a script), this will show the current script.

    Click the filter icon on the grid headers to search for a particular role or an entity by its path, name, script or everybody configuration.

    3 Editing existing roles or entities

    To change the details of a role or entity click on the pencil icon next to the relevant role / entity in the table. A pop up window will appear from where you can edit the details (outlined in Section 4).

    4 Role and Entity Information

    The page for creating and editing a role or entity is divided into two sections - Implementation and Users. When creating a new role or entity you will be required to choose the organisation it belongs to before entering the details.

    4.1 Implementation

    In this section you can manage the following role /entity information:

    Name Description
    Name The name of the role/entity. This field is mandatory.
    ID The unique ID of the role/entity. The ID is generated and cannot be modified.
    Description A short description of the role/entity.
    Parent The parent that the new role/entity belongs to. It cannot be modified.
    Share Static, Scripted & Everybody roles can be shared so that they are available in Easy Builder as lanes to assign tasks to.
    Allow everybody Check this box if you want to add all users created on your account to this role/entity. If this box is checked, you will not be able to add a user in the Users section since all users will belong to this role/entity.
    Dynamic role This box should be checked if you want to define a role as a group of possible roles. The final role will be defined dynamically within a manual task of a process, in the field "Assign to lane". N.B. Once a role has been defined as dynamic, you can no longer modify it. This field is only visible if you have created a role and not an entity.
    Runtime role Check this box if you want to define the users of the role during runtime. N.B. If this box is checked, you won't be able to add a user in the Users section since membership is defined at runtime. This field is only visible if you have created a role and not an entity.
    Role script Add a formula to auto-populate the membership based on Users' Metadata, preferences or lane membership. A role or an entity that has a script is considered a scripted lane. Once you have created your script it can be checked, the result will tell you how many users meet the criteria (and so will be members of the lane) and how long the query took. To find out more about writing scripts click here. You won't be able to add a user in the Users section if you have configured a script role.

    info_7 N.B. Roles and Lanes are essentially the same thing. Role is generally used in a User context while Lane is used in a Process context i.e. a Role becomes a Lane in a process context.

    4.2 Users

    This section allows you to manage which users are assigned to the current role. There are two sections - Authorized Users and Acceptance Users.

    The Authorized Users section lists the users that currently belong to the role in LIVE mode. Membership is determined by the type of role. If it is a 'scripted' one then membership is determined by the script, if it is an 'everybody' role then all users will be members, if it is a 'runtime' role then no users will be shown as this is determined per process instance. Please note that you can only edit the user list for 'standard' roles.

    The Acceptance Users section lists the users that currently belong to the role in ACCEPTANCE mode. For ACCEPTANCE mode, you can edit the list of users for standard, everybody and dynamic roles.

    info_8 Once a lane/entity is used within a project only users with access rights designer or supervisor can modify it.