Create Automation Protocol#
Creating a new automation protocol is the step necessary to make a new communication protocol available to use within the automation environment.
By being a versioned entity, it means the information created will persist while present and used in the system, not being possible to change it, unless a new version is created.
This section explains how to create a completely new Automation Protocol.
The creation, like with all other entities of the system, is done using 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.
In the first page, a Change Set is required (or bypassed if such setting is defined in the Entities Administration).
In the second page, enter the name, revision name, description, type (only for classification purposes), and select the package and version that will be used to communicate with the equipment.
Info
If you are creating a new version, the revision that was selected when you started the process will be the revision to which this version will be associated. If you are creating a new entity or revision (with a new version associated to it), provide a name for the revision or it will be automatically generated for you. For more information on revision naming, see Revision Naming.
Warning
The package must exist in the NPM server configured in the administration configuration: /Cmf/System/Configuration/ConnectIoT/RepositoryLocation.
Based on the package selected in the previous page, all communication/configuration parameters are listed here where you can override the package default values to the ones you find more adequate. The values can be later changed to specific equipments using the workflow designer.
Warning
The Restore button changes the value to the package default value.
This final page is only to information the protocol-specific data types as well as the protocol-specific extended properties that will be available to customize the driver definitions.
Automation Protocol will now be available in Created state.
