DEX: OperationalData DEX - Business Information Model

The OperationalData DEX: Business overview section provided a high level overview of the business information that can be represented by this DEX. This section provides a more detailed overview of that information. A description of how to represent this information using ISO 10303-239 PLCS is provided in OperationalData DEX: PLCS PSM Representation.

NOTE The information shown in the SysML Block Definition diagram in Figure 3 is intended to illustrate the type of information that can be represented by the DEX. It does not imply that all exchanges must contain all this information.

NOTE The information shown in the SysML Block Definition diagram in Figure 4 is intended to illustrate the Information needed to exchange Operational Data using this DEX.

Model Diagrams

../../../../../data/contexts/SwedishDefence/dexs/OperationalData/images/OperationalDataBoM.png

Figure 3 - SysML Block Definition diagram representing the Operational Data BoM

../../../../../data/contexts/SwedishDefence/dexs/OperationalData/images/MessageOperationalDataBoM.png

Figure 4 - SysML Block Definition diagram representing the Message Operational Data BoM

Class Descriptions

The section describes the different classes used for Exchange according to this DEX.

ActualOperatingMode

A description of how to represent the actual operating mode that describes the use and application of the item of supply individuals.

Attribute	Description
individual	Relationship to an item of supply individual that the actual operating mode is applied.
modeEndTime	End time of the operating mode.
modeStartTime	Start time of the actual operating mode.
operatingMode	Relationship to a operating model which is the reference operating model for the actual operation mode.

Table 2 -ActualOperatingMode

BinaryValueFile

A description of how to represent any file that contains at least some data that consists of sequences of bits that do not represent plain text.

Attribute	Description
binaryField	A field that contains binary numbers which is capable of holding any information, including data.
protocol	A specific set of computer communication rules.

Table 3 -BinaryValueFile

FaultCode

The approved fault code for a type, indicating one or more fault modes. Depends on protocol, i.e. the fault code may differ between protocols.

Attribute	Description
consequenceDescription	Description of possible consequences of the FaultCode.
DTC-Code	Identification of a fault code.
faultCodeDescription	Description of fault code.
faultCodeGeneratedBy	Relationship to the meter individual that is the meter individual generates the fault code.
faultCodeName	undefined
FMI-Code	Identification of a fault code.

Table 4 -FaultCode

FaultModeDefinition

A description of how to represent a possible fault. Indicates in what ways a specific ItemDefinition may brake or malfunction, e.g. too low battery voltage. A fault mode is always related to a component.

NOTE A fault mode may be rectified by given task methods.

Attribute	Description
faultModeDescription	Description of fault mode.
faultModeId	Identifies a specific fault mode.
meanTimeBetweenFailure	Mean Time Between Failure is used for simulation and planning. It indicates how often the fault may occur in the concerned location (MTBF).
operatingMode	The operating mode(s) for which the fault mode definition (and associated mean time between failure) has been defined.

Table 5 -FaultModeDefinition

ItemIndividual

A description of how to represent a specific individual supply item, that is affected by maintenance tasks etc. An ItemIndividual can be both the top supply item, or a contained component that is managed individually. ItemIndividual is identified by e.g. serial number or registration number (for vehicles), etc.

Attribute	Description
batchNumber	Product as individual identification code that identifies a product as individual as part of a batch, or lot.
individualFollowsConfiguration	Relationship to the product configuration that governs the individual.
individualOfType	Relationship to the item definition that was used when the item of supply individual was created or modified.
itemOfSupplyIndState	State of the item of supply individual.
serialNumber	Product as individual identification code that identifies a product as individual in a local scope, e.g. within a company or in a battalion.

Table 6 -ItemIndividual

FailureOccurence

A description of how to represent occurrence of the failure in ItemOfSupplyIndividual.

Attribute	Description
hasMonitoringTermValue	Relationship to a term value of the monitoring term to compare if a failure occurrence happens during the monitoring term.
failureInSuperiorIndividual	Relationship to a superior item of supply individual that the failure occurrence is applied to.
failureLocation	Relationship to a physical element to indicate what location in the physical breakdown structure that a failure occurrence is applied to.
failureOccurrenceIdentifier	Identification of specific failure occurrence.
failureOccurrenceStatus	Relationship to state assertion that indicates the state of the failure.
failureOnIndividual	Relationship to an item of supply individual on which a failure occurrence is applied to.
failureOnItem	Relationship to an item definition to indicate which item of supply or part definition that a failure occurrence is applied to.
failureTriggerMeterReading	Relationship to a meter reading activity to record a relationship between a failure occurrence and an operational property.
faultMode	Identified fault.
occurrenceDate	Occurrence date of the failure.

Table 7 -FailureOccurence

MessageOperationalData

The MessageOperationalData template describes how to represent a message concerning individual item of supplies.

Attribute	Description
dateMessageSent	The date time when the message is sent.
messageId	The identifier for the message.
messagePurpose	The purpose of the message.
messageSentBy	The organization that sends the message.
messageSentTo	The organization that receives the message.
securityClassification	The security classification for the message.
contents	The item of supplies contained within the message.

Table 8 -MessageOperationalData

MeterIndividual

A description of how to represent a ItemOfSupplyIndividual that represents an individual item of supply that represents a meter, that measures specific operational properties.

Attribute	Description
belongsToIndividual	Relationship to an individual item of supply that the meter individual belongs to.
itemDefinition	Relationship to the item definition that was used when the meter individual was created or modified.
meterIndividualIdentifier	The Identifier of the meter individual.
ofType	Relationship to a physical meter element that the meter individual is realized.

Table 9 -MeterIndividual

MeterReading

A description of how to represent a measurement record of a specific operational property of a MeterIndividual.

Attribute	Description
individualMeterRead	The individual meter used.
meterReadingFaultCode	Specific fault code that the meter may display.
meterReadingIdentifier	Identifier of the meter reading.
meterReadingValue	Specific value that the meter is displayed.
protocolValue	Relationship to a binary value file that presents the protocol value of the meter reading.
readingTime	Time of reading of the meter individual.
sequenceNumber	Number indicates the sequence of the meter reading.

Table 10 -MeterReading

MeterReadingActivity

A description of how to represent an action or a set of actions that consume time and resources, when and whose performance is necessary to do a MeterReading for a ItemOfSupplyIndividual.

Attribute	Description
cause	Description of the cause of the meter reading activity.
meterReadingActivityId	Identifier of the meter reading activity.
meterReadings	Relationship to a meter reading that the meter reading activity acts to.
personReporting	Relationship to a person who execute the mater reading activity.
readingForIndividual	Relationship to a individual item of supply that the meter reading activity is applied to.

Table 11 -MeterReadingActivity

MonitoringTerm

A description of how to represent a term to supervise and ensure a ProductConfiguration is meeting the predefined performance targets.

Attribute	Description
approvedTermValues	undefined
belongsToProductConfiguration	undefined
mandatory	Instances of property definition assignment that is mandatory or optional.
termName	Name of the monitoring term.

Table 12 -MonitoringTerm

OperatingMode

A description of how to represent the conditions that arise from the use and application of the equipment, infrastructure or system.

Attribute	Description
operatingModeEnvironment	Description of the environment of the operating mode.
operatingModeIdentifier	Identifier of the operating mode.
operatingModeIntensity	Assumed intensity of the operation mode.
operatingModePhase	Usage phase (e.g. warranty, usage or settlement).
operatingModeValue	Value of the operating mode, i.e. inUse and inStorage.

Table 13 -OperatingMode

OperationalPropertyDefinition

A description of how to represent an operational property definition, that will be measured and given property values later on in the operative and maintenance phases.

Attribute	Description
allowedUnits	A set of external units (OWL individuals) that may be used for the property value.
propertyName	Reference to OWL individual that provides the definition of the property.

Table 14 -OperationalPropertyDefinition

PhysicalElement

A position (or a "hole") in the physical structure. The position (structural element) may have an "applicability", i.e. a list of valid ItemOfSupplies that can be used at this position.

Attribute	Description
breakdown	Relationship to the physical structure that contains the physical structure element.
hasProperties	undefined
inZone	The location of the Physical Object within a zone.
physicalElementId	Identifies the physical element uniquely (within a physical structure).
physicalElementName	Name of the physical meter element.
physicalElementVersionId	Identifies a physical meter element version uniquely (within the physical element).

Table 15 -PhysicalElement

PhysicalMeterElement

A description of how to represent a physical structure element that represents a meter, that measures specific operational properties..

Attribute	Description
isVirtual	Classification of the meter as being a virtual meter (as opposed to a real, physical meter in the product).
measures	The properties measured by the Physical Meter Element.
physicalElementId	Identifies the physical element uniquely (within a physical structure).
physicalElementName	Name of the physical meter element.
physicalElementVersionId	Identifies a physical meter element version uniquely (within the physical element).

Table 16 -PhysicalMeterElement

TermValue

The value of the monitoring term. Typically fetched when where is a failure on an ItemIndividual or ItemDefinition being subject to special follow-up.

Attribute	Description
monitoringTerm	Relationship to a monitoring term that the term value is related to.
termValue	Identifier of the term value.

Table 17 -TermValue