MultipleUnitConversion

An activity which performs unit conversion on multiple attributes by calling the OpenSpirit unit service.

General

The General tab contains the following fields. The attribute configuration table allows definition of multiple attributes to be converted.

Field Module Property? Description
Name No The name to be displayed as the label for the activity in the process.
Attribute Name No User assigned name for an attribute. The name must start with a letter and can only contain letters, digits or underscores.
Attribute Type No Type of the attribute. Selectable from predefined types.
From Unit No The unit for the source value. Required if attribute type is not a quantity or quantity series. Selectable from predefined units.
To Unit No The target unit. Selectable from predefined units.
Null Value No Optional value used to represent a null value. Not used when the attribute type is quantity series where null value can be specified as part of the series.

Description

Provide a short description for the activity.

Input

The following is the input for the activity.

Input Item Data Type Description
Parameters Complex Root element for all input elements
<AttributeName> Complex The element name is the attribute name as configured. Multiple elements with the same name can appear. An ID should be supplied to differentiate the converted output.
- Id String Optional Identifier associated with the attribute to be converted. If supplied the ID will be echoed in the output. Only applicable when the attribute type is not a quantity or quantity series.
- FloatValue float The float value to be converted. Applicable for attribute type ‘FLOAT’
- DoubleValue double The double value to be converted. Applicable for attribute type ‘DOUBLE’
- FloatValues OspFloatArray Applicable for attribute type ‘FLOAT_ARRAY’. Either a JSON string of float values (“Values”) or a repeating sequence of float values (“Value”) to be converted.
- DoubleValues OspDoubleArray Applicable for attribute type ‘DOUBLE_ARRAY’. Either a JSON string of double values (“Values”) or a repeating sequence of double values (“Value”) to be converted.
- FloatQuantity OspFloatQuantity An OpenSpirit FloatQuantity (float value plus unit) to be converted. Applicable for attribute type ‘FLOAT_QUANTITY’
- DoubleQuantity OspDoubleQuantity An OpenSpirit DoubleQuantity (float value plus unit) to be converted. Applicable for attribute type ‘DOUBLE_QUANTITY’
- FloatQuantitySeries OspFloatQuantitySeries An OpenSpirit FloatQuantitySeries (float values plus unit and optional null value) to be converted. Applicable for attribute type ‘FLOAT_QUANTITY_SERIES’
- DoubleQuantitySeries OspDoubleQuantitySeries An OpenSpirit DoubleQuantitySeries (double values plus unit and optional null value) to be converted. Applicable for attribute type ‘DOUBLE_QUANTITY_SERIES’
- Source Unit OspUnit The unit for the input value. Only applicable when the attribute type is not a quantity or quantity series. If supplied this unit will override any source unit selected in the attribute configuation table.
- Target Unit OspUnit The unit that the input should be converted to. This must have the same base unit as the input unit(s). E.g. one can convert from feet to meters but not from feet to seconds. If supplied this unit will override any target unit selected in the attribute configuation table.
- Null Value float/double An optional input used to specify what float/double value should be consider to represent a null value. Null values will NOT be unit converted. Only applicable when the attribute type is not a quantity series.

Output

The following is the output for the activity. The output for this activity mirrors the input but all supplied input values have now been converted to the TargetUnit and all units are now equal to the TargetUnit.

Output Item Data Type Description
OspOutput Complex Root element for all output elements
<AttributeName> Complex The element name is the attribute name as configured. Multiple elements with the same name can appear on the output. An ID should be supplied on the input and echoed here to differentiate the conerted values.
- Id String The Identifier associated with the converted attribute, if supplied on input.
- FloatValue float The float value (if supplied in input) converted to TargetUnit
- DoubleValue double The double value (if supplied in input) converted to TargetUnit
- FloatValues OspFloatArray The float values (if supplied in input) converted to TargetUnit
- DoubleValues OspDoubleArray The double values (if supplied in input) converted to TargetUnit
- FloatQuantity OspFloatQuantity An OpenSpirit FloatQuantity (float value plus unit) that has been converted to the TargetUnit (only present if supplied in input)
- DoubleQuantity OspDoubleQuantity An OpenSpirit DoubleQuantity (double value plus unit) that has been converted to the TargetUnit (only present if supplied in input)
- FloatQuantitySeries OspFloatQuantitySeries An OpenSpirit FloatQuantitySeries (float values plus unit and optional null value) that has been converted to the TargetUnit (only present if supplied in input)
- DoubleQuantitySeries OspDoubleQuantitySeries An OpenSpirit DoubleQuantitySeries (double values plus unit and optional null value) that has been converted to the TargetUnit (only present if supplied in input)
- TargetUnit OspUnit The unit that the attribute has been converted to.
- NullValue float/double Float/double value that is to be considered a null value for the attribute (only present id supplied in input)

Fault

The Fault tab lists exceptions that are thrown by this activity.

Error Schema Element Datatype Description
msg string The error message returned by the plug-in.
msgCode string The error code returned by the plug-in
Fault Thrown When...