Create Automation Driver Definition#

AutomationDriverDefinition.Create

Overview#

This operation is used to create a new Automation Driver Definition that defines the interface data for equipment communication within the automation environment.

Setup#

No specific setup is required other than to meet the preconditions of the operation.

Preconditions#

• An Automation Protocol has been created and approved for the equipment communication type.
• The user has appropriate permissions to create Automation Driver Definitions.
• The equipment interface specifications (properties, events, commands) are documented and available.

Sequence of Steps#

Step 1: Start the New Driver Definition Wizard#

1. Navigate to the Automation Driver Definition page.

2. Select New on the top ribbon.

3. Choose the version level to create:

   • Entity - Create a completely new driver definition
   • Revision - Create a new revision of an existing driver definition
   • Version - Create a version associated to an existing revision

For more information, see Creating Entity Objects, Revisions, and Versions.

Step 2: Configure Change Set#

1. Specify the Change Set field on the first page of the wizard.
2. Alternatively, bypass this field if it's already defined in Entities Administration.

Step 3: Enter General Data#

1. Provide a Name for the Automation Driver Definition.

2. Specify the Revision Name.

3. Optionally, provide a Description explaining the driver's purpose.

4. Select a Type for classification purposes.

5. Select the Automation Protocol that will be used to communicate with the equipment.

6. Choose the Entity Type that will be used as context for this implementation (typically a Resource).

Step 4: Define Equipment Properties#

1. Click the sign to add a new property to the grid.

2. Fill in the following attributes for each property:

   • Name - Unique identifier for the property
   • Description - Explanation of the property's purpose in the equipment
   • Property Device ID - Equipment-specific identifier for this property
   • Type - Data type of the property in the system
   • Writable and Readable - Property accessibility permissions in the equipment
   • Protocol Data Type - Equipment-specific data type for this property

3. Configure any protocol-specific extended data as required by your selected Automation Protocol. For details, see Protocol-Specific Information.

For detailed information about properties, see Automation Property.

Step 5: Define Equipment Events#

1. Click the sign to add a new event to the grid.

2. Fill in the following attributes for each event:

   • Name - Unique identifier for the event
   • Description - Explanation of what this event represents in the equipment
   • Event Device ID - Equipment-specific identifier for this event
   • Enabled - Whether the system should process this event (set to false to ignore)

3. Configure any protocol-specific extended data as required. For details, see Protocol-Specific Information.

For detailed information about events, see Automation Events.

Step 6: Map Event Properties#

1. For each event listed, click the sign to add associated properties.

2. Select one of the properties defined in Step 4 that should be included when this event fires.

3. Configure any protocol-specific extended data as required. For details, see Protocol-Specific Information.

Step 7: Define Equipment Commands#

1. Click the sign to add a new command to the grid.

2. Fill in the following attributes for each command:

   • Name - Unique identifier for the command
   • Description - Explanation of what this command does in the equipment
   • Command Device ID - Equipment-specific identifier for this command

3. Configure any protocol-specific extended data as required. For details, see Protocol-Specific Information.

For detailed information about commands, see Automation Command.

Step 8: Configure Command Parameters#

1. For each command listed, click the sign to add parameters.

2. Fill in the following attributes for each parameter:

   • Name - Unique identifier for the parameter
   • Description - Explanation of what this parameter controls
   • Type - Data type of the parameter in the system
   • Default Value - Default value for the parameter
   • Mandatory - Whether this parameter is required or optional
   • Protocol Data Type - Equipment-specific data type for this parameter

3. Configure any protocol-specific extended data as required. For details, see Protocol-Specific Information.

Step 9: Create the Driver Definition#

1. Select the Create button to complete the process.

2. The Automation Driver Definition will be created with Created status and is ready for use.