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 delete a collection, use the Delete icon in the last column. Note that deleting a collection erases all collection data.
To view more information about a collection, click its name. The following additional collection information is displayed:
| Option | Description |
|---|---|
| Read only | This is checked if the collection data is read only. |
| Access restricted | This is checked if the API access is restricted. If checked for Test, the access to the collection is restricted to users with Designer access rights in the Test environment. If checked for Acceptance or Live, the access is restricted to users with Supervisor access rights in the Acceptance and Live environment. Note that Administrators are excluded. They can always access the collection data in all three environments. |
| 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/importing collection data 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. |
| Access restricted | Check this option for the invidvidual environments if access to the collection data is to be restricted. If you check the option for Test, the access to the collection is restricted to users with Designer access rights in the Test environment. If you check it for Acceptance or Live, the access is restricted to users with Supervisor access rights in the Acceptance and Live environment. Note that this option is not relevant for Administrators. They can always access the collection data in all three environments. |
Save the collection details to create your empty collection.
When you create a collection, you actually create separate collection data for each execution mode, so that for example Live data is not mixed with Test data. If you open your web interface in Live mode and get objects from your collection, the source will be the Live collection data.
3. Exporting and Importing Collection Data
Use the options in the menu bar at the top of the collection detail window to import data to and export data from your collection.
3.1. Exporting Collection Data
When exporting collection data, you have to select one of the three execution modes as source collection. You have the choice of exporting the data 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 to an external MongoDB, BSON is the format of your 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 with a link to the dump file in the file storage of the parent project.
The dump file name has the following format: collection_{collectionId}_{mode}_{date}.{json|bson}. Example:
3.2. Importing Collection Data
You can import data from a dump file to a collection. You have to define the target of the import operation (either Test, Acceptance, or Live mode), 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 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.
Please give details of the problem