Deployment

Deploy OT Connect for the First Time

Before You Begin

The following table outlines the steps that you must complete to deploy and configure this module for the first time. These instructions assume that you have completed the steps for deploying the basic system architecture.

These tasks may be completed by multiple people in your organization. GE Vernova recommends, however, that the tasks be completed in the order in which they are listed.

Results


Step	Task	Notes
1	Ensure that your OT Connect Process Data Server and process historian are configured according to the OT Connect System Requirements.	This step is required.
2	On the OT Connect Process Data Server, Install OT Connect Adapter Service.	This step is required. The OPC Server must be on the same machine as the OT Connect Adapter Service. You must provide a unique name for each OT Connect Adapter Service on an OT Connect Process Data Server.
3	On the OT Connect Process Data Server, Configure OT Connect Adapter Service to update the OT Connect Adapter Service configuration file to include the required properties.	This step is required. The configuration file for an OT Connect Adapter Service is located in C:\Program Files\Meridium\OTConnect\Adapters\{name}\appsettings.json.
4	On the OT Connect Process Data Server, start the OT Connect Adapter Service.	This step is required. When you start the service, the OT Connect Adapter Service attempts to connect and logs any errors. The log file for this service is located in C:\Program Files\Meridium\OTConnect\Adapters\{name}\Logs.
5	On the APM server, verify the Message Bus Settings.	Configure ActiveMQ Configure Redis
6	On the APM server, Install OT Connect Conductor Service.	This step is required. Note: The Conductor does not require any additional configuration.
7	On the APM server, start or restart the OT Connect Conductor Service.	This step is required. You may review the log files for this service at `C:\ProgramData\Meridium\Logs`.
8	In APM, Assign Security Users to one or more of the Security Groups and Roles.	This step is required.
9	In APM, Create an OT Source to the OPC-compliant system from which you want to retrieve data.	This step is required.
10	In APM, Check Source Connection to verify the status of the configured OT Source.	This step is required. The status includes Connection Status to all the required components for the OT Source Connection Status. If the status returns with errors, follow <OT Connect Troubleshooting Guide> for help.
11	In APM, Manually trigger a Tag Synchronization for the OT Source.	This step is required. You can monitor the status of the Source Tag Synchronization Connection Status.
12	In APM, Visualize a Trend Chart for a desired Source Tag.	This step is optional.
13	Complete desired content commissioning as necessary to manage the Source Tags imported into APM. For example, create Health Indicators through the OT AHI Connector page, or attach Source Tags to Policy Instances through Policy Designer. For more information, refer to the respective documentation.	This step is optional.

Upgrade from PDI to OT Connect

About This Task

The initial release of OT Connect is in APM Version 4.4.0. Although OT Connect is a new module, there are a number of customers who were using the Process Data Integration module in an older version of APM. As these customers upgrade to APM Version 4.4.0, they will want to upgrade their existing OPC Tags and any Health Indicators or Policies that utilize those tags.

OT Connect includes the OT Connect Upgrade Utility, a console application that can be used to migrate content that previously relied upon Process Data Integration.

During the database upgrade to APM Version 4.4.0, the content of the OPC Systems will be migrated to OT Sources, and OPC Tags will be migrated to Source Tags, if they are in use by Health Indicators or Policy Instances. After the database upgrade, and before using Health, Policy or OT Connect, you must run this utility. This utility performs the following:

Updates the OT Source Ids
Updates the Source Tag Ids
Creates Content Map records for every Health Indicator that is linked to an OPC Tag and upgrades those Health Indicators
Upgrades Policies that use the OPC Tag node to use the OT Connect Tag node
Creates Content Map records for all Policy Instances that reference OPC Tags in OPC Tag nodes and upgrades those Policy Instances.

Note:

Policies that use obsolete fields from the OPC Tag node will be upgraded automatically, however these Policies may no longer function as expected and will be deactivated. You can open such upgraded Policies in Policy Designer to review the obsolete field usage and reconfigure the Policies.
Policies that reference OPC Tag records in Entity nodes or Policy Instances that reference OPC Tag records in Point Value nodes are NOT upgraded automatically.
The upgrade process identifies any Policies and Policy Instances that cannot be upgraded automatically and adds a warning to the log. Please contact GE Vernova Support for advice on modifying any such Policies or Policy Instances to work with the OT Connect module.

Results


Step	Task	Notes
1	In APM, ensure that your new APM OT Connect license has been applied.	This step is required. Apply and verify licenses in Operations Manager > Activate Licenses. Note: Your new license must show that APM OT Connect is ACTIVE. And if upgrading from PDI, the OPC Interfaces must also show as ACTIVE.
2	On the APM Server, invoke the OTConnectUpgradeUtility.exe executable from the Windows Command Prompt.	This step is required. Locate the OTConnectUpgradeUtility.exe in `C:\Program Files\Meridium\OTConnect\Upgrade.` Execute the following command, replacing <datasource_id> with the name of the APM Datasource that you wish to connect to and upgrade. Please note that there is a space after datasource. `.\OTConnectUpgradeUtility.exe datasource: <datasource_id>`
3	On the APM Server, review the upgrade log and ensure that no errors were logged during the upgrade process.	This step is required. Locate OTConnectUpgradeUtility_APM_<date>.log in C:\ProgramData\Meridium\Logs. You may also need to look into the following two log entries: `Upgrading 312 Health Indicators.` `312 Health Indicators were upgraded.` If those two numbers do not match in your log, then some errors have occurred that have prevented the upgrade utility from successfully completing all of the required tasks. Note: After resolving any issues reported in the log, re-run the Utility. Warnings will be added to the log in the following circumstances: A Policy uses an obsolete field in an OPC Tag node. The policy will be inactivated. A Policy uses an Entity node configured to reference the OPC Tag family. The policy will be inactivated. A Policy Instance references an OPC Tag record in a Point Value node. A Policy Instance references a record (not limited to OPC Tag records) which is not found in the APM Database. Usually this means that the referenced record was deleted after the Policy Instance was last saved. The invalid reference will be removed. You may need to redesign the Policy or reconfigure the Policy Instance to work with the OT Connect module, after the upgrade is completed. Consult GE Vernova Support for advice.
4	Migrate additional datasources.	Repeat steps 2 and 3 for each datasource that you want to migrate.
5	Once the log has been reviewed and no errors have occurred, the Upgrade is complete.	You are now ready to Deploy OT Connect for the First Time.