Understanding the Scenario Service Document Properties

The Scenario Service is organized as a hierarchy of MongoDB documents that are used to represent scenarios, scenario links, folders, workspaces, views and dashboards. They are defined as follows:

  • id - Internal MongoDB ID

  • pathType - the element type among ROOT, APPLICATION, WORKSPACE, FOLDER, SCENARIO, SCENARIO_LINK, CUSTOM_DASHBOARD, CUSTOM_VIEW. For more details, please refer to Section Understanding the Scenario Service Path Types.

  • uuid - a unique identifier used by the application to refer to the path documents

  • parentUuid - the parent path document identifier

  • name - the element name

  • owner - the user owner of the element

  • creationDate - the element creation date

  • modificationDate - the last modification date

  • modificationUser - the user that made the latest modifications

  • deleted - set to true when the element is considered as deleted in the application

  • userLock (optional) - user lock information, when a user sets a lock on the element, as described in Section Understanding Scenario Locks (only applies to SCENARIO type elements)

  • systemLock (optional) - system lock information, when the system set a lock on the element, as described in Section Understanding Scenario Locks (only applies to SCENARIO type elements)

  • dataStatus- the scenario current data status (only applies to SCENARIO type elements)

  • dataStatusDate- the date when the latest data status check occurred (only applies to SCENARIO type elements)

  • properties - a list of custom properties used to store data associated to an element.