Create Automation Protocol#

AutomationProtocol.Create

Overview#

This operation is used to create a new Automation Protocol that defines communication specifications for equipment integration within the automation environment.

Setup#

Ensure that the required communication protocol package is available in the configured NPM repository before creating the protocol.

Preconditions#

• The communication protocol package exists in the NPM server configured at /Cmf/System/Configuration/ConnectIoT/RepositoryLocation.
• The user has appropriate permissions to create Automation Protocols.
• Communication protocol specifications and parameters are documented.

Sequence of Steps#

Step 1: Start the New Protocol Wizard#

1. Navigate to the Automation Protocol page.

2. Select New on the top ribbon.

3. Choose the version level to create:

   • Entity - Create a completely new protocol
   • Revision - Create a new revision of an existing protocol
   • 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 Protocol.

2. Specify the Revision Name.

   Revision Naming

   If creating a new version, the selected revision will be used. If creating a new entity or revision, provide a revision name or it will be automatically generated. For details, see Revision Naming.

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

4. Select a Type for classification purposes.

5. Select the communication Package and Version for equipment communication.

   Package Availability

   The package must exist in the NPM server configured at /Cmf/System/Configuration/ConnectIoT/RepositoryLocation.

Step 4: Configure Protocol Parameters#

1. Review the communication and configuration parameters automatically loaded from the selected package.

2. Override any default parameter values as needed for your specific implementation.

3. Use the Restore button to reset any parameter back to its package default value.

   Parameter Customization

   These values can be further customized for specific equipment using the workflow designer.

Step 5: Review Protocol Data Types#

1. Review the protocol-specific data types that will be available for use.

2. Note the protocol-specific extended properties that can be used to customize driver definitions.

3. This information is provided for reference and planning purposes.

Step 6: Create the Protocol#

1. Select the Create button to complete the process.

2. The Automation Protocol will be created with Created status and is ready for use in driver definitions.