value.ospp

Value property

type	object
properties
delay	Delay to wait before forwarding the value when it changes see value pipeline ↗️
	DurationConfigurationEntity
description	The description of the value
	type	string
inputType	The inputType corresponds to the original type of the value before the pre-transform is applied. For example, if a module publishes a value of type TEXT and a pre-transform converts it into BOOLEAN, the resulting value type is BOOLEAN (this final type is the one used by all modules in OnSphere). However, the inputType remains TEXT, since the module needs to know the original type in order to apply the appropriate transformations.
	type	string
	enum	BOOLEAN, INTEGER, DECIMAL, TEXT
isTemplateGeneratedByOspComposer	Name of the playbook that generated this file. If present, the file is managed by the Composer and may be overwritten on regeneration. Used for selective clean. Do not edit or set manually.
	type	string
name	The name of the value used for logging
	type	string
onWireMessageTTL	Define the Time-to-Live (TTL) of the value once it is published to other modules. All message will have at most a TTL of 7 days. It is only valid for a CHANGE. The RETRANSMISSION and INITIALIZATION mode have a TTL of 10 minutes. In any case, the message queues are limited to 100000 messages, once this limit reach the oldest message will be dropped. see On wire message TTL ↗️
	DurationConfigurationEntity
postTransform	The transformation to apply to the value. This is applied after the smooth, pulse, and delay. If the transform map multiple data to one, it will generate a value for each change of the source. The reset value of a pulse will be transformed. The “PULSE_ON_READ”, “PULSE_ON_CHANGE” and “ignoreReset” will be applied to the original data. see value pipeline ↗️ see transformation ↗️
	TransformConfigurationEntity
preTransform	The transformation to apply to the value. This is applied before the smooth, pulse, and delay. If the transform map multiple data to one, it will not generate a value for each change of the source. The reset value of a pulse will not be transformed. The “PULSE_ON_READ”, “PULSE_ON_CHANGE” and “ignoreReset” will be applied to the transformed value. see value pipeline ↗️ see transformation ↗️
	TransformConfigurationEntity
pulse	Pulse of the value (i.e. the duration for holding the value before resetting it) see value pipeline ↗️
	PulseConfigurationEntity
retention	Retention of the value content (i.e. STEADY for states, FIRE_AND_FORGET for events) STEADY (state): The value is cached by the module. When a module is started, it will be able to get the last value. FIRE_AND_FORGET (event): The value is published only once and when a module starts it will not receive the last state of the value. see value pipeline ↗️ Default value is [“STEADY”]
	type	string
	enum	STEADY, FIRE_AND_FORGET
	default	STEADY
smooth	Delay after which the value is considered stable and produced see value pipeline ↗️
	DurationConfigurationEntity
startupErrorTimeout	The delay during which the error are not published when the module is starting or the value configuration has changed. When a value without an error is publish the delay will be remove immediately. The following errors will not be delayed. This also concern the uninitialized value. During this period, any republish request will generate an uninitialized value. This configuration override the one define in the module configuration. see Startup error timeout ↗️
	DurationConfigurationEntity
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
type	The type of the value
	type	string
	enum	BOOLEAN, INTEGER, DECIMAL, TEXT
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
additionalProperties	False

DurationConfigurationEntity

type	object
properties
unit	The unit of time expressed
	type	string
	enum	NANOSECONDS, MICROSECONDS, MILLISECONDS, SECONDS, MINUTES, HOURS, DAYS
value	The amount of time expressed with the unit
	type	integer
additionalProperties	False

TransformConfigurationEntity

type	object
properties
transform	The transformation to apply. see transformation ↗️
	type	string
transformType	The type of the value after the transformation. If this is the final transformation step, the value must be equals to the value.ospp type. see value pipeline ↗️ see transformation ↗️
	type	string
	enum	BOOLEAN, INTEGER, DECIMAL, TEXT
additionalProperties	False

PulseConfigurationEntity

type	object
properties
duration	Duration of the pulse (i.e. duration for holding the value before resetting it)
	DurationConfigurationEntity
ignoreReset	If the pulse should ignore its reset value (i.e. if the pulse should wait for its duration before resetting when the value changes to its reset value) Default value is [false]
	type	boolean
	default	False
reset	The reset value after the pulse delay is expired
type	The type of the value (i.e. pulse when value changes or every time the value is updated) Default value is [“PULSE_ON_CHANGE”]
	type	string
	enum	PULSE_ON_READ, PULSE_ON_CHANGE
	default	PULSE_ON_CHANGE
additionalProperties	False