Skip to main content

Structure

Internally, every scenario consists of the following data entries:

  • name: Name of the scenario (we recommend using a short one, to keep the output tidy when it gets displayed by tools such as ctx-scan).
  • compatible_with: Specifies the platform versions that can load a given scenario. It follows SemVer comparison and can be left empty when adding a new scenario - the platform will automatically determine the required version based on the provided ContexQL queries.
  • creator: Name of the scenario's creator. In Contextal Console it will be automatically set to the current user's e-mail address (or admin for the default account).
  • description: Text description of the scenario.
  • local_query: ContexQL query applied to the graph generated for the entry object (i.e. it's local to the current graph).
  • context: Optional structure, used for a global context.
  • action: Name of the action, which will be reported if the scenario matches on a given object.