Skip to content

Edit Automation Protocol#

🔒 AutomationProtocol.Edit

Overview#

This operation is used to edit an existing Automation Protocol. Because the Automation Protocol is a versioned entity, it is only possible to edit while it is in the Created state. When editing, you can modify all configuration screens available during creation, including general data, protocol parameters, and package settings.

Setup#

Ensure that any new communication protocol packages are available in the configured NPM repository if you plan to change the package selection.

Preconditions#

  • The Automation Protocol exists in the system.
  • The Automation Protocol must be in the Created state.
  • The user has appropriate permissions to edit Automation Protocols.

Sequence of Steps#

The Edit Automation Protocol wizard can be called from the Automation Protocol page within the Business Data Group.

Step 1: Access Edit Function#

  1. Navigate to the Automation Protocol page.
  2. Select the automation protocol you want to edit.
  3. Click on the Edit button to open the edit wizard with all configuration screens.

Step 2: Modify General Data#

  1. Update the Description explaining the protocol's purpose as needed.
  2. Change the Type for classification purposes if required.

  3. Select a different communication Package and Version if necessary.

    Package Changes

    Changing the package will reset protocol parameters. Ensure the new package exists in the NPM server configured at /Cmf/System/Configuration/ConnectIoT/RepositoryLocation.

Edit1

Step 3: Configure Protocol Parameters#

  1. Review and modify the communication and configuration parameters as needed.
  2. Override any default parameter values for your specific implementation requirements.

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

    Parameter Impact

    Changes to parameters will affect equipment communication behavior. Ensure compatibility with existing driver definitions.

Step 4: Review Protocol Data Types#

  1. Review the updated protocol-specific data types that will be available.
  2. Note any changes to protocol-specific extended properties.
  3. Consider the impact on existing driver definitions that use this protocol.

Step 5: Apply Changes#

  1. Review all modifications made across all configuration screens.
  2. Click the Edit button to apply the changes.
  3. Verify that the modifications have been saved successfully and the protocol remains in Created state.