Map IO References

The IO Map tab of the Equipment details page allows you to map your Equipment Parameters, Variables, and Capabilities Parameters as well as control, status, checksum to IO references. In the case of any missing required IO map references, a warning icon appears on the summary and details page of the Equipment. To remove this warning icon, simply map the missing required IO references. The Equipment must be checked out to make any changes to the IO map.

NOTE: The IO Map tab is available only if you are using the AVEVA Recipe Management in the Standalone mode. If you are using the AVEVA Recipe Management in the Integrated mode (non-standalone), the IO Map tab is hidden, and you must configure the IO Map using the AVEVA Integrated Development Environment.

The following is a list of IO references per Equipment/Capability Parameters:

(*) - Configuring IO for this will potentially require additional IO to be configured. For example, if ControlHold is defined then StatusHeld and ControlRestart become required.

(**) – These IOs are mandatory unless configured to be optional.

The following are some rules for defining IO References:

• The existence of the various Capability control/status IO References is controlled by the configuration of the Capability. For more information, see the Setting Up Control/Status section of the Capability configuration.

• Each Equipment variable defined will need an IO reference defined.

• Parameter minimum and maximum IO references are only available for double and integer parameters.

• Some IO References are optional, and others are required. Refer to the table above for the specific rules.

  NOTE: Make sure you map the Equipment Variable IO References to data types such as Boolean, String, Integer, and Double which are supported by AVEVA Recipe Management. If you map the Equipment Variable IO References to non-supported data types, then they are treated as strings while evaluating the transition/loop expressions during Recipe execution.

In Application Object mode, the IO References are shown in the App Objects IO Map editor. You can edit the IO References column or browse for references. If the format of an IO Reference is not valid, then the Application Objects encounters validation errors.

If you are using AVEVA Recipe Management in the standalone mode, the format for an IO Reference must start with the scope name, which you define when you configured the OPC UA Client service and then the value. For example, TopServer:MySampleTagValue. For more information, see the AVEVA Recipe Management Installation Guide.

IO References exist at the Equipment and Capability level for checksum support. For more information, see Using a Checksum.

If you require custom fields for the parameter, you can add Parameter Extensions. Set up your Parameter Extensions before editing, exporting, or importing IO References, so the extensions are available in the editor and/or .csv file. Parameter Extensions assigned to the "All Groups" apply to all the parameters and other extensions apply to parameters with the matching group. Parameter Extension value is written to IO at the start of the Capability or (Formula Download) only when Parameter Extension has a non-blank value, and the IO is mapped. For information on setting up parameters extensions, see Parameter Extensions.

If Capabilities or Parameters on your Equipment are added, changed, or deleted, these changes are updated in your IO Map automatically but may require additional editing.

The IO Reference value for an extension IO Map is preserved on Equipment upgrade if the extension group was set to "All Groups" and changed to a group that matches the Equipment parameter group.

The total number of IO references is shown at the bottom of the IO Map grid unless you have used filters to limit the references displayed. If you perform a filter operation, the filter icon appears at the bottom of the grid. You can filter the unmapped (required) IO references by using the Show missing required IO references Advanced filter option. The Show missing required IO references option is only available when the system is in standalone mode. For more information, see Filtering.

You can export and import IO references. For more information, see Exporting and Importing IO References.

To set up an IO map

1. From the Equipment details screen, click the IO Map tab.
   The IO Map page appears. The Capabilities parameters, Equipment parameters, and Equipment variables you set up for your piece of Equipment appear along with their reference type. The Capability name, parameter name, variable, group, and reference type are not editable.

2. Click Edit beside an Equipment parameter, Capabilities parameter, or variable name which requires an IO map reference, and then enter the name of the IO reference to which you want to map the parameters. The missing required IO reference cells are highlighted with yellow color.

   NOTE: Make sure that the scope value for the required IO reference that you enter is in the <ScopeName>:<TagName> format. Otherwise, a warning message appears when you check in the Equipment, and an error message appears when you approve Equipment with an incorrect scope value for required IO references.

3. Click Update. After you have clicked the Update button, you can still Edit the parameters.

4. Once you have added all your IO references, check in your Equipment by clicking the Check In button.

5. After you check in your Equipment, you can change the state of your Equipment by clicking the Set State button.