Apis Click&Trace Message Library Content

MaterialEnter

The MaterialEnter message is used to register the event of a single discrete material entity entering an equipment location. If e.g. the physical event involves several discrete materials, a number of MaterialEnter messages must be created in order to register all the distinct material entities separately. The MaterialEnter message does not say anything about from where the material entity originates, it will only register the fact that a material enters a physical location. The MaterialEnter message is designed so that it is possible to register material attributes at the same time as the fact of material movement is registered.

Message content:

• Native transaction id (mandatory)
• Event time (mandatory)
• Equipment location name (mandatory)
• Attributes 
  • Quality (optional)
  • Article (optional)
  • Identifiers (mandatory) One identifier is necessary in order to identify the material to enter.
  • Data (optional)
  • Attribute keys (optional)
• Amount (optional) If not provided, the amount 1.0 will be assumed.

MaterialExit

The MaterialExit message is used to register the event of a single discrete material entity leaving an equipment location. If e.g. the physical event involves several discrete materials, a number of MaterialExit messages must be created in order to register all the distinct material entities separately. The MaterialExit message does not say anything about the destination of the material leaving the physical location, it will only register the fact that a material leaves. The MaterialExit message is designed so that it is possible to register material attributes at the same time as the fact of material movement is registered.

Message content:

• Native transaction id (mandatory)
• Event time (mandatory)
• Equipment location name (mandatory)
• Attributes 
  • Quality (optional)
  • Article (optional)
  • Identifiers (mandatory) One identifier is necessary in order to identify the material to exit.
  • Data (optional)
  • Attribute keys (optional)

RegisterMaterialAttributes

The RegisterMaterialAttributes message is used to register attributes on a specific material entity residing at a specific equipment location. As ACT Messages have one and only one event time, the RegisterMaterialAttributes message is limited to register a set of attributes that share the same time stamp. To register attributes with different time stamps, several RegisterMaterialAttributes messages have to be used.

Message content:

• Native transaction id (mandatory)
• Event time (mandatory)
• Equipment location name (mandatory)
• Attributes 
  • Quality (optional)
  • Article (optional)
  • Identifiers (mandatory) One identifier is necessary in order to identify the material for which to register attributes.
  • Data (optional)
  • Attribute keys (optional)

RegisterInterimMaterialAttributes

The RegisterInterimMaterialAttributes message is used to register attributes where the material reference is temporarily unknown. The RegisterInterimMaterialAttributes message is thus an alternative to the RegisterMaterialAttributes message that can be used when the material reference is unknown. Instead of relating the attribute to the material, the attribute is registered independently with an attribute key, which is used later for relating the attribute to a material. As ACT Messages have one and only one event time, the RegisterInterimMaterialAttributes message is limited to register attributes that share the same time stamp. To register attributes with different time stamps, several RegisterInterimMaterialAttributes messages have to be used.

Message content:

• Native transaction id (mandatory)
• Event time (mandatory)
• Equipment location name (mandatory)
• Attribute key (mandatory)
• Attributes 
  • Quality (optional)
  • Article (optional)
  • Identifiers (optional)
  • Data (optional)

GroupMaterial

The GroupMaterial message is used to register group membership for a discrete material entity residing at a specific equipment location.

Message content:

• Native transaction id (mandatory)
• Event time (mandatory)
• Equipment location name (mandatory)
• Attributes 
  • Identifiers (mandatory) Two identifiers are necessary, the identifier of the material and the group identifier identifying the material as a part of the group.

UngroupMaterial

The UngroupMaterial message is used to remove a discrete material entity residing at a specific equipment location from a material group and optionally register a new tracking identifier for the material.

Message content:

• Native transaction id (mandatory)

• Event time (mandatory)

• Equipment location name (mandatory)

• Attributes 

• Identifiers (mandatory) The group identifier is mandatory, and if the tracking identifier is to be changed, the new tracking identifier must also be provided.

MaterialGroupRelease

The MaterialGroupRelease message is used to remove all materials from a material group.

Message content:

• Native transaction id (mandatory)

• Event time (mandatory)

• Equipment location name (mandatory)

• Attributes 

• Identifiers (mandatory). One identifier identifying the group is necessary.

MaterialGroupEnter

The MaterialGroupEnter message is used to register the event of a common identified group of discrete materials entering an equipment location. The MaterialGroupEnter message does not say anything about from where the material group originates, it will only register the fact that a material group enters a physical location. The MaterialGroupEnter message is designed so that it is possible to register material attributes at the same time as the fact of material movement is registered.

Message content:

• Native transaction id (mandatory)
• Event time (mandatory)
• Equipment location name (mandatory)
• Attributes 
  • Quality (optional)
  • Article (optional)
  • Identifiers (mandatory) One identifier is necessary in order to identify the material group to enter.
  • Data (optional)
  • Attribute keys (optional)

MaterialGroupExit

The MaterialGroupExit message is used to register the event of a common identified group of discrete materials leaving an equipment location. The MaterialGroupExit message does not say anything about the destination of the material group leaving the physical location, it will only register the fact that a material group leaves a physical location. The MaterialGroupExit message is designed so that it is possible to register material attributes at the same time as the fact of material movement is registered.

Message content:

• Native transaction id (mandatory)
• Event time (mandatory)
• Equipment location name (mandatory)
• Attributes 
  • Quality (optional)
  • Article (optional)
  • Identifiers (mandatory) One identifier is necessary in order to identify the material group to exit.
  • Data (optional)
  • Attribute keys (optional)

RegisterMaterialGroupAttributes

The RegisterMaterialGroupAttributes message is used to register attributes on a group of material entities residing at a specific equipment location. This message type is an alternative to the RegisterMaterialAttributes message that can be used when materials are identified by a common group identifier. As ACT Messages has one and only one event time, the RegisterMaterialGroupAttributes message is limited to register attributes that share the same time stamp. To register attributes with different time stamps, several RegisterMaterialGroupAttributes messages have to be used.

Message content:

• Native transaction id (mandatory)
• Event time (mandatory)
• Equipment location name (mandatory)
• Attributes 
  • Quality (optional)
  • Article (optional)
  • Identifiers (mandatory) One identifier is necessary in order to identify the material group.
  • Data (optional)
  • Attribute keys (optional)

AlterTrackingIdentifier

This message is used to alter the tracking identifier of a specific material. In this message, the material is referenced by its original tracking identifier. The result of the message is that the value of the tracking identifier is changed, so that after the arrival of this message the material has to be referenced by its new tracking identifier.

Message content:

• Native transaction id (mandatory)
• Event time (mandatory)
• Equipment location name (mandatory)
• Attributes 
  • Identifiers (mandatory) Two identifiers are necessary, the original tracking identifier and the new tracking identifier.

RegisterEquipmentState

The RegisterEquipmentState message is used to register information about the state of equipment in terms of KPI reporting. The interpretation of the message is that the state provided in the message is valid from the point in time provided by the event time of the message.

Message content:

• Native transaction id (mandatory)
• Event time (mandatory)
• Equipment location name (mandatory)
• Equipment state (mandatory)