ID Stores

An ID store is a set of databases and file directories to which Syntasa apps write data. ID stores are used to provide a logical subdivision between your apps on the backend, as well as letting you define your data storage locations. They also differentiate between your development and production data. ID stores are only populated upon data creation and are insubstantial until they are used. They are required for any app created with the "ID Graph" template, so make sure you have at least one before attempting to create an app.

The ID Stores page is available from the main menu ( mceclip3.png ) and selecting the submenu items ID Stores or if already within the Resources pages via the ID stores icon (ID_Stores_Icon.png).

ID_Stores.png

All apps require a store, either an event store or ID store, to be specified. It is recommended to have one event store per Synthesizer app but it is not necessary.

Most ID stores will have the following three databases and three file storage directories.

  • development (dev) - Within the development environment, the user is able to test new configurations and settings before deploying to production.
  • production (prod) - Within the production environment live data is processed and stored.
  • snapshot (snap) - Snapshots of configurations are stored in the event a rollback to an earlier configuration is needed.

ID_Store_Edit.png

Adding a New ID Store

  1. Open the ID Stores page.
  2. Click the plus icon (Plus_Icon.png) to add a new ID store.
  3. An ID store creation box will appear.
  4. Provide the new store with a unique name.
  5. Fill out the path and database details for each environment.
  6. Click 'Create'.
  7. A new ID store entry will appear in the list on the screen and available to use.

mceclip0.png

Configurations

  • Name - Distinct name of the ID store.
  • Key - Auto-populated from the ID store name; suggested leaving as is.
  • Development - Location where app testing data gets written.
    • Path - File location where any resultant files are stored from processing.
    • Database - Name of the database where processed data is stored.
  • Production - Location where production data gets written.
    • Path - File location where any resultant files are stored from processing.
    • Database - Name of the database where processed data is stored.
  • Snapshot - Location where snapshots allowing for rollbacks get written.
    • Path - File location where any resultant files are stored from processing.
    • Database - Name of the database where processed data is stored.

Expected Output

An entry gets created in the ID Store screen with a Name, Created At time, and Updated At time.

The ID Store reference is available to use with an ID Graph app. After processing an app, data will be available in defined locations.