×

Please give details of the problem

Docs

Find

    Developer Guide

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

    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