×

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

    Project Collections Tab

    This page allows you to create, populate and mange a project's collections. Collections are custom MongoDB databases that you can use in your projects.

    1. Viewing Collection Information

    Collections

    Summary data is displayed for each existing collection. This information includes:

    Field Description
    Access A collection can have Publlic or Private access. Public access requires no authentication whereas Private access does.
    Name The name given to the collection
    Storage Used (Live) The percentage of this collection's permissible storage space that is being used in the Live environment.
    Sorage Used (Acceptance) The percentage of this collection's permissible storage space that is being used in the Acceptance environment.
    Storage Used (Test) The percentage of this collection's permissible storage space that is being used in the Test environment.

    To view more detailed information about a collection click on its name.

    DetailedInformation

    The additional information includes:

    Name Description
    Read Only This is checked if the collection data is read only.
    URL The URL of the collection - to be used within REST based API calls. Clicking on the link icon in the menu bar will copy the URL to the clipboard.
    Id The unique identifier given to the collection.
    Statistics This shows statistics for this collection in each of the three environments: Live, Acceptance and Test. The statistics include the percentage of its storage allocation that is being used, the size of the collection, the number of objects in the collection and the average object size.

    Clicking on Keys allows you to retrieve the first level keys for your collection.

    The menu bar on this page allows you to access further collection functionality such as exporting the data from the collection, importing data into the collection and editing the collection's details.

    2. Adding a New Collection

    Clicking on the New Collection button will allow you to configure a new collection.

    AddCollection

    You will be asked for the following information:

    Field Description
    Name The name of the collection, this is a compulsory field.
    Public Access This should be checked if no authentication will be required to view the collection data.
    Read Only This should be checked if the collection data will be read only.

    Click on the Save icon to create your empty collection.

    info8 A collection created or imported while in Test mode cannot then be accessed in Live mode

    3. Exporting and Importing Collection Data

    It is possible to import data into your collection and to export data from it. This functionality is available from the menu bar at the top of the collection detail page.

    MenuBar

    3.1. Exporting Collection Data

    When exporting a collection, you can select one of the three runtime modes (Test, Acceptance or Live) as the source collection. You have the choice of exporting in JSON or BSON format and you can choose if the data can be compressed (to ZIP format). The native storage format in MongoDB is BSON, a binary JSON format. BSON is also supported by the native MongoDB mongodump tool. Thus if you want to restore a collection in an external MongoDB, BSON is the format of choice. BSON should also be used for backup/restore purposes within RunMyProcess. If you want to post-process a collection via a script, however, you may prefer to use the JSON format.

    Export

    Both the import and export procedures are asynchronous. Depending on the size of the collection, it could take several minutes to perform the export. After triggering the export of a collection, the platform will acknowledge the request. Upon completion of the export procedure, you will receive an email which will also contain a link to the dump file in the file storage of the parent project.

    The filename has the following format: collection_{collectionId}_{mode}_{date}.{json|bson}. An example is shown below:

    File

    3.2. Importing Collection Data

    It is possible to import data from a dump file into a collection. You can choose between the different modes (Test, Acceptance or Live) as the target and you have to specify the import format (JSON/BSON). Additionally, you can select whether the target collection should be dropped (emptied) prior of the actual import. Finally you have to select the source dump file from the project's file storage and can specify whether or not the file needs to be Uncompressed (from ZIP format).

    info5

    The import process is asynchronous therefore the data may not be available immediately. You will be informed via email when the import is complete.

    info6 Please note that MongoDB does not support ACID transactions (therefore no rollback). If your import fails during the import procedure, it is likely that your collection will be in a partially constructed state. An import should therefore be handled with care. Please also note that MongoDB recommends the use of BSON data for import. If you have to work with a dump file in JSON format, you should generate an additional dump in BSON format prior to performing the import.

    info7 While it is technically possible to import/export a collection on a "hot" application or process, it is best practice to stop all potential activities on the collection prior of performing these actions.

    info9 A collection created or imported while in Test mode cannot then be accessed in Live mode