×

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. Roles Entities
          2. Organization
          1. Project Definition
          2. Versions
          3. New Version
          4. Version Management Log
          5. Access Rights
          6. Collections
          7. Versioned Files
          8. Files
          9. Description
            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. Implementation
          2. Design
          3. Collections
          4. Stylesheet
          5. JavaScript
          6. API Listener
          7. Google Analytics
          1. Process Design
            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
          2. General
          3. Input
          4. Variables
          5. Measures
          1. Connectors
          2. Processes
          3. Providers
        1. Custom Lists
        2. Collections
          1. Design
          2. Configuration
        3. Revision
        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

    Projects/Collections Tab

    Allows you to create, populate, and manage a project's collections.

    1. Viewing Collection Information

    The following information is displayed for each collection on the Collections tab:

    Column Description
    Access A collection can be public or private. Public access requires no authentication whereas private access does.
    Name The name of the collection.
    Storage used (Live) The percentage of permissible storage space used by the collection in the Live environment.
    Storage used (Acceptance) The percentage of permissible storage space used by the collection in the Acceptance environment.
    Storage used (Test) The percentage of permissible storage space used by the collection in the Test environment.

    To view more information about a collection, click its name.

    DetailedInformation

    The following additional information is displayed:

    Option Description
    Read only This is checked if the collection data is read only.
    URL The URL of the collection. This is to be used within REST-based API calls. Clicking the link icon in the menu bar copies the URL to the clipboard.
    ID The unique identifier of the collection.
    Statistics Statistics on the three environments: Live, Acceptance, and Test. The statistics include the percentage of storage allocated to the collection, the size of the collection, the number of objects in the collection, and the average object size.

    Use Load first level keys to retrieve the first level keys for your collection.

    Use the menu bar to access further collection functionality such as exporting the data from the collection, importing data into the collection, or editing the collection's details.

    2. Adding a Collection

    Use New Collection to configure a new collection. For a new collection, the following options are provided:

    Option Description
    Name The name of the collection (mandatory).
    Public access Check this option if no authentication is to be required to view the collection data.
    Read only Check this option if the collection data is to be read only.

    Use the Save icon to create your empty collection.

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

    3. Exporting and Importing Collection Data

    You can import data into your collection and export data from it. This functionality is available from the menu bar at the top of the collection detail window.

    MenuBar

    3.1. Exporting Collection Data

    When exporting a collection, you can select one of the three runtime modes (Test, Acceptance, or Live) as source collection. You have the choice of exporting in JSON or BSON format and you can choose if the data is to 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.

    The export operation is asynchronous. Depending on the size of the collection, it can take several minutes. After triggering the export, the platform acknowledges the request. Upon completion of the export, you receive an email which contains 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}. Example:

    File

    3.2. Importing Collection Data

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

    Note that the data may not be available instantly since the import operation is also asynchronous. You are 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 operation, it is likely that your collection is 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 starting the import operation.

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

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