×

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

    Project Collections Tab

    Allows you to add a collection to your project.

    Access
    A collection can be :

    • Public (no authentication needed) or private (authentication needed to be accessed)
    • Read only (users with access right "user" on project [i.e. P_user in a process or P_connected_user in a web interface] won't be able to modify it) or not

    Name
    Name of collection.

    URL
    URL of collection to be used within REST API.

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

    Keys
    Allows you to retrieve the first level keys of your collection.

    Import/Export of Collections

    A MongoDB collection can both be exported as well as imported. You can do so via the corresponding actions in the collection tab as shown below.

    info2

    When exporting a collection, you can select one of the three runtime modes (Test, Acceptance, Live) as source collection. You also have the choice between an export in JSON or BSON 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 will be 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, you may prefer the JSON format instead.

    info3

    Both the import and export procedures are asynchronous. Depending on the size of the collection, it could take several minutes to perform these actions. Upon triggering an export of a collection, the platform will "just" acknowledge the request. Upon completion of the export procedure, you will receive an email. The email will also contain a link to your 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.

    info4

    Vice versa it is possible to import a dump file. You can, again, choose between one of the different modes (Test, Acceptance, Live) as target and you have to specify the import format (JSON/BSON). Additionally you can select whether the target collection should be dropped (cleansed) prior of the actual import. Finally you have to select the source dump file from the project's file storage.

    info5

    As already mentioned, it may take a while till the data is available. You will be informed via email again.

    info6 Please note that MongoDB doesn't provide transactions (thus also no rollbacks). If your import fails at some stage during the import procedure, your collection will be in an partially reconstructed state! An import should therefore be handled with the necessary care. Please also note that MongoDB recommends to use 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 of 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.