×

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. Parameters
          2. Runtime Users
          3. Execution Path
          4. Measuring
        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

    Report Widget

    1. Overview

    This widget allows you to present either a web interface report, a process report, a collection or a custom source of data (JavaScript report) to the end user on a web interface.

    application_report

    2. Configuring a Report

    There are three tabs for configuring the report - Properties, Layout and Rules.

    2.1 Properties

    The first thing you must decide is the type of report you wish to display - collection, web interface report, process report or a JavaScript report. It is defaulted to collection but you can change this by choosing the Other Report option.

    ReportType

    You can choose to either use an existing report that is already defined in your web interface project or to create a new one (not possible for JavaScript reports). Choosing to create a new report will enable you to design and save a new report before returning to configure the widget.

    picto_wrench: click on this icon, to configure the columns displayed in the report. You can define the width (in pixels) of each column, set a column as visible or not and add a calculated column. To define the content of a calculated column, enter your javascript : ${P_user.name} "[[mycolumname]]" and "[[propertyname]]" and "[[MEASURE_1]]" at index "[[_row_]]" or if("[[myvar]]"=="0"){"bad";}else{"good";}.

    info_3 You can't filter on a calculated column and calculated column won't be exported.

    info_4 You can use "P_index" to get the index of the current row.

    Most of the properties that can be configured from the Properties tab are common to all types of reports but some are specific to the type of report you are configuring.

    2.1.1 Collection Properties

    The following properties are specific to collection reports:

    Property Description
    Collection URL The URL for the collection
    Query Enter a query to be run on your collection. If empty, all records will be displayed. The query is a pattern : {"lastname":"Smith"} or {"$and":[{"field1":"value1"}, {"field2":value2}]}. The Query can also contain a more advanced pattern (display all records that match a given pattern, order by a given key : {"$query":{"field":value},"$orderby":{ "field":1}}.
    Aggregate This allows you to perform an aggregation query on your collection. For example, {"$group":{"_id":{"service":"$uo"}}},{"$project":{"service":"$_id.service","_id":0}} will display unique "service" of your collection.
    Post loaded script This allows you to execute a script when the report is completely loaded in the web page. For example, you could set a javascript filter on your report. For more information, please refer to the JavaScript report tutorial. An example is id_report.addMeasureFilter("mymeasure",RMP_FilterOperator.EQUAL,"myvalue");id_report.refresh(); Please note that the post loaded script of a report used in a web interface created after the Lifou v3 release is executed each time the report's data is refreshed (after a reset filter, manual or dynamic refresh etc )

    Learn more about collections here.

    2.1.2 Process and Web Interface Report Properties

    The following properties are specific to process and web interface reports:

    Property Description
    Name column name This property allows you to change the title of the first column of your report. This is available for process and web interface reports.
    Post loaded script This allows you to execute a script when the report is completely loaded in the web page. For example, you could set a javascript filter on your report. For more information, please refer to the JavaScript report tutorial. An example is id_report.addMeasureFilter("mymeasure",RMP_FilterOperator.EQUAL,"myvalue");id_report.refresh(); Please note that the post loaded script of a report used in a web interface created after the Lifou v3 release is executed each time the report's data is refreshed (after a reset filter, manual or dynamic refresh etc )

    2.1.3 JavaScript Report Properties

    The following properties are specific to JavaScript reports:

    Property Description
    Loading data script This allows you to define a script that will enable the display of data from any source as long as they are formatted as a JSONArray.
    Export by email If you want to export all of the data you will need to create a process to do this for you (or you may already have one). Once you have this process configured, you can attach it to your JavaScript report here.

    For more information, visit the JavaScript Report page.

    2.1.4 Shared Report Properties

    The following properties are common to each type of report - collection, process, web interface and JavaScript.

    Property Description
    Open links in the same window Choose this if you want users to remain in the same window (or iframe) when they click on a link (instead of opening a new tab with manual task web page).
    Enable filters Choose this if you want to allow user to filter your report. This field must not be checked if you are using Javascript to filter your report.
    Show filter at start Check this box if you want to open the filter section when opening the web interface.
    Sortable Check this box if you want to allow the users to sort on a column of your report.
    Visible items The maximum number of lines displayed on a screen report (it is linked to the Table height).
    Table height The height in pixels of your report.
    Allow users to select rows You can choose to allow users to select "Only One" or "All" rows from the report. When the user makes a selection the JavaScript declared in the "On row select / deselect" field will run. Choosing "None" here will disable this functionality.
    On row select / deselect This option is enabled only if you have chosen to allow users to select rows (one or all). Enter the JavaScript that will be triggered when a user selects or deselects a row from the report or when running dedicated JavaScript functions (refresh, selectAll...). JavaScript function getLatestSelectedLineValues() will return the values of the selected line or null if the lastest action was the deselection of a line.
    Date format Allows you to customize the date format used to display the date fields in your report and when exporting the data. The format must follow the ISO 8601 format.
    Listen to variables Populate this field with a variable name that should be listened to.
    Identifier The id of the widget. This is only needed if you intend to use Javascript functions in your web page.

    info_7 Please note that if a widget report is "Active" (cf. Rules tab), the end users will be able to modify the configuration of the report directly from their web interface without using the RunMyProcess back office interface.

    2.2 Layout

    The Layout tab enables you to tailor the look of your report.

    2.3 Rules

    The rules tab enables you to set rules for the availability of the report widget.

    3. Filtering on Process Status

    When presented with a process report on a Web Interface, the user can choose to filter on process status (if enable filtering has been set on the report widget properties). Here is the list of the status available for filtering by:

    Status ID Server Description Web Interface Label Description
    0 NONE Initialized The process is in a queue for processing but has not started yet.
    100 READY Processing Process step is being processed (Temporary status).
    102 WAITING Waiting The process is waiting for en external action to restart (e.g. a Manual Task)
    103 WAITING RESUME Waiting (Resume) The process is in waiting resume state.
    201 COMPLETED Completed The process has completed.
    301 ABORDED Aborted The process has been aborted.
    302 KILLED Killed The process has been killed.
    400 CANCELLED Cancelled The process was cancelled by a user.
    401 OUTDATED Outdated The Process has ended because it has timed out.

    All status are included as default.