How to Migrate to Version 2.0 Connector from earlier versions

Connectors installed prior to version 2.0 cannot be upgraded and the configuration must be migrated onto a new version 2.0 connector installation.

Export Configuration

Prior to installing the Version 2 Connector log into the existing connector, navigate to the Import/Export screen within the Administration module and export all the configuration (queries, jobs, schedules, etc.) to an XML file by selecting the Download button in the far right-hand column.

Migrating Credentials

If available, all existing credentials files for the connector should be identified. The credentials files are not compatible with the version 2.0 Connectors but the contents are required to help create the new versions. Any custom properties set in the "<existing_install_dir>/jettybase/etc/credentials.xml" file will also need to be sourced. 

You will be required to prepare a new set of Version 2.0 format credentials files based on the existing credentials files and custom properties form the old connector. You will need to upload these credentials into the new connector after the installation.

This article maps each of the potential entries from credentials.xml to the new credentials file and the property set.

As part of the migration a new S3 credentials file must be requested from EnergySys for each EnergySys instance that you will be using the version 2 Connectors with.

Client Certificates

Client certificates will need to be created for use with the new Connectors.

Connector Installation

Install the new connector the following the steps in this article: How to Install a New Connector, which also covers the import of the credentials and certificate files.

Migrate Configuration

Import the configuration XML file (exported from the existing connector at the start of this article) into the new connector using the Import/Export Screen

Testing

Manually test the execution of jobs in the new installation by selecting the Play icon. You can navigate to the Event Log screen to see whether the job execution results was a SUCCESS or FAIL.

Once testing is complete navigate to the Scheduled Jobs screen to Disable the jobs on the existing connector and Enable the jobs on the new connector. The "Is Active" will contain a check mark if the job is enabled and a blank box if the job is disabled.

Decommission Old Connector

Once the new Connector is ready to be used the old Connector can be shut down. The Windows Service can be stopped for the existing connector by following the steps below:

Step 1: Navigate to the WIndows Service screen

Step 2: Select the connector that you want to shut down

Step 3: Right-click and select "Stop"

You may choose to delete the previous connector installation folder if you require.