Create Automation Driver Definition#

Creating a new Automation Driver definition is the necessary step to make a new equipment interface data available to use within the automation environment.

As an Automation Driver Definition is a versioned entity, the information created will persist while present and used in the system, and it is not possible to change it, unless a new version is created.

This section explains how to create a completely new Automation Driver Definition.

The creation, like with all other entities of the system, is done through a wizard page.

Sequence of Steps#

There are several ways to create a new versioned object. Depending on the level, follow these steps to get started:

• Entity - In the landing page of this entity type in the Business Data menu or in the details page of an existing entity of the same type, select New on the top ribbon. For more information see Creating Entity Objects.
• Revision - If you want to create a new revision, go to the New dropdown button on the top ribbon and select Revision. For more information, see Revisions.
• Version - If you want to create a version associated to an existing revision, go to the New dropdown button on the top ribbon and select Version. For more information, see Versions.

Change Set#

In the first page, a Change Set is required (or bypassed if such setting is defined in the Entities Administration).

General Data#

In the second page, enter the Name, Revision Name, Description, Type (only for classification purposes), select the Automation Protocol that will be used to communicate with the equipment and the Entity Type that will be used as a context for this implementation, usually a Resource.

After the general data is filled in, it is necessary to define the equipment entities: properties, events and commands.

Properties#

In the third page, the equipment properties can be defined. For more information, see Automation Property for more information on this topic.

After is selected a new line appears in the grid and the property data should be filled in.

Enter the following attributes:

• Name - a unique name should be entered.
• Description - any description that explains what this property means in the equipment.
• Property Device ID - the identifier of the property in the equipment.
• Type - the data type of the property in the system.
• Writable and Readable - the accessibility of the property in the equipment.
• Protocol data type - the data type of the property in the equipment.
• From this point forward, the protocol, chosen in the second page, can define any extra data to be entered in each property (see here for each communication driver extended data information).

Events#

In the fourth page, the equipment events can be defined. For more information, see Automation Events.

After is selected a new line appears in the grid and the event data should be filled in.

Enter the following attributes:

• Name - a unique name should be entered.
• Description - any description that explains what this event means in the equipment.
• Event Device Id - the identifier of the event in the equipment.
• Enabled - the state of the event in the system, if false the system will ignore the event.
• From this point forward, the protocol, chosen in the second page, can define any extra data to be entered in each event (see here for each communication driver extended data information).

Event Properties#

In the fifth page, the relation between events and properties can be defined, meaning that you need to define all the properties that are required and valid when the event is fired.

For each event listed, after is selected a new line appears in the grid and the event property data should be filled in.

Select one of the properties entered in the third page and the extended data if any was defined for the protocol chosen in the second page (see here for each communication driver extended data information).

Commands#

In the sixth page, the commands can be defined. For more information, see Automation Command.

After is selected a new line appears in the grid and the event data should be filled in.

Enter the following attributes:

• Name - a unique name should be entered.
• Description - any description that explains what this command means in the equipment.
• Command Device Id - the identifier of the command in the equipment.
• From this point forward, the protocol, chosen in the second page, can define any extra data to be entered in each command (see here for each communication driver extended data information).

Command Parameters#

In the seventh page, some command parameters can be defined. For each command listed, after is selected a new line appears in the grid and the command parameter data should be filled in.

Enter the following attributes:

• Name - a unique name should be entered.
• Description - any description that explains what this parameter means in the equipment.
• Type - the data type of the parameter in the system.
• Default value - the default value of the parameter.
• Mandatory - if this parameter is mandatory or optional.
• Protocol data type - the data type of the parameter in the equipment.
• From this point forward, the protocol, chosen in the second page, can define any extra data to be entered in each property (see here for each communication driver extended data information).

Create#

Select the Create button.

The Automation Driver Definition will now be available in the Created state.