owner.collections

Collection owner

type

object

properties

  • templateId

The id of the template to use for this file

type

string

  • templateVariables

The variables and their values to be replaced from the template

type

object

additionalProperties

  • variablesFiles

The variables files to use to replace the variables. The first file of the list will take precedence over the following one. Template variables take precedence over the contents of the files.

type

array

items

type

string

  • isTemplateGeneratedByOspComposer

If the value is set to true, manual editing of this file should be avoided, as the composer will override the value in the next generation.

type

boolean

  • schemaId

The reference (ie. root.collections.device) to the collection (schema.ospp) used by this owner. One owner is only linked to one collection. Each time an entry of that collection changes, it triggers an update of the value with the updated entry.

type

string

  • filterId

A filter id listed on the schema.ospp configuration file referenced by schemaId. Adds a filter to the collection changes notifier. When an entry changes, it update the value with the updated entry only if the updated entry match the filter.

type

string

  • watchList

List of the fields on which to trigger a change of the value when the collection changes. When an entry of the collections changes, the value is updated only if it matches the filter and if the updated or removed fields are present in watchList. If empty or not defined, every change will trigger an update of the value.

type

array

items

type

string

  • type

The type of value to extract from the filter

type

string

enum

ON_COLLECTION

  • scope

Scope of the document transmitted to the value. Three options are available:

  • FULL_DOCUMENT: Set the content of the value directly with the full updated document. Meaning you can access a property (i.e. property name of the collection) like content.name. Note that you have no way to know which properties changed with the last update, which is the reason behind the next scope option.

  • CHANGES_ONLY: Set the content of the value with a map that contains two entries:

    • updatedFields: a map with keys that represent the properties changed by the update with their updated values.

    • removedFields: list of properties that were deleted.

  • BOTH: Mixed of the two previous options. Set the content of the value with a map that contains three entries:

    • fullDocument: complete document of the collection.

    • updatedFields: a map with keys that represent the properties changed by the update with their updated values.

    • removedFields: list of properties that were deleted.

Use either of these options to set the content of the value as you like.

type

string

enum

FULL_DOCUMENT, CHANGES_ONLY, BOTH

default

FULL_DOCUMENT

  • targetProperty

Target property meant to be set as the value content. Instead of setting the value content with the full document, the value is set with the content of the target property only.

Target is represented by a JsonPath, letting you precisely choose which field to target. If the target is not found within the full document, an error is set to the value instead. The content is checked in order to guarantee that it matches the value type. If not, an error is thrown as well.

Only works when using scope FULL_DOCUMENT, as we need it to access the target.

type

string

additionalProperties

False