Upgrading the Axeda Compatibility Extension (ACE) from Version 2.4.17
Prior to upgrading ACE from version 2.4.17, a migrator extension must be installed to pre-configure your ThingWorx Platform. When upgrading any other version of ACE, these steps are not necessary.
 |
If you installed the v.1.2.0 PREVIEW release of the Axeda Compatibility Package, there is NO migration path. You must perform a new installation of the ACE.
|
Background
After ACE version 2.4.17 was released, the GASModel base Thing Template was updated to extend RemoteThing as opposed to RemoteThingWithTunnelsAndFileTransfer. The ThingWorx Platform restricts extension entities from having their base Thing Template changed during an upgrade or at any other time. As a result, a migrator extension has been introduced to enable upgrading the ACE. With the newer release of ACE, the AxedaCompatibilityExtension-x.x.x-migrator.zip extension will be incorporated with the Axeda Compatibility Package (ACP). Note that the x.x.x represents the version number of both the ACE and the migrator. Refer to the release notes for your version of the Axeda Compatibility Package for these version numbers. The steps below outline the process to execute the migrator with this extension.
Upgrade Process
|
|
Before you can import any extensions, you must modify settings in the platform-settings.json configuration file for the platform and restart it. Refer to the following topics in the ThingWorx Platform Help Center for details:
|
Follow these steps to migrate from v. 2.4.17 of the ACE to the current version:
1. Before importing the new version of ACE, import the AxedaCompatibilityExtension-x.x.x-migrator.zip.
2. To view logging related to this migration, you must restart your ThingWorx Platform. If you do not need logging information, you can skip this step.
3. Navigate to the Resources view and open the GasModelMigrator Resource.
4. Click Services.
5. Locate the RemoveGasModel service and click Execute.
|
|
You cannot undo this removal. Once the GASModel Thing Template is deleted, there is no back-out. Deleting this Thing Template has no functional impact on the rest of the extension, if you decide after running the migrator to not upgrade.
|
6. Verify that the following response appears: Successfully removed GASModel
◦ If you had previously run this service and the GASModel no longer extends from RemoteThingWithTunnelsAndFileTransfer the following message appears:
GASModel does not extend fromRemoteThingWithTunnelsAndFileTransfer
◦ If you run this service more than one time consecutively, the following message appears:
GASModel does not exist
7. Verify the GASModel Thing Template no longer exists.
8. If you followed Step 2 and restarted your ThingWorx Platform after importing the migrator extension, check that the following INFO messages appear in the Application Log:
◦ Start running GASModelMigrator
◦ Thing Deleted: <Thing Name Extending From GasModel> (This message will appear in the log exactly once for each Thing that had extended from GASModel).
◦ Finished running GASModelMigrator
9. Import the new version of ACE.
 |
If you had not run the RemoveGasModel service the following error message would appear when you attempt to import the new ACE:
AxedaCompatibilityExtension-3.0.29
Cannot update existing Extension Package [AxedaCompatibilityExtension] because it is trying to change the template of the following Entities:[entity: GASModel]. |
10. Verify that the GASModel Thing Template was re-created and that its base Thing Template is RemoteThing.
|
|
As mentioned in step 8, the GASModel Thing Template and all Things that extend from that Thing Template are deleted during this upgrade process. These Things are NOT automatically created as part of the migration process, but WILL be re-created as each Axeda Global Access Server re-registers with the ThingWorx Platform.
|