Integrating Third-Party Device Types

Scenario: You want to integrate a third party device type with the Management Platform.

 

Reference: For background information, see the reference section.

 

Workflow diagram:

 

 

Prerequisites:

  • You have logged into the Desigo CC Client and have configured a user group and assigned Scope rights and application rights to the user group for working with the powermanager extension. (See Assign Scope to a User Group in Security)
  • You have created a network driver started it.
  • You have associated the network driver with the network.
  • You have created the application for Web services and D3 Visualization in the SMC and their respective URLs are available.
  • System Manager is in Engineering mode.
  • In System Browser, Application View is selected.
  • You have configured and saved the JSON file consisting of the device type configuration of the third party device type.

 

Steps:

1 – Import Device Type
  1. Select Applications > Powermanager.
  • The System tab displays.
  1. Select the Import Device Type expander and proceed as follows:
    a. Drag and drop the library to the Library Name field.
    b. Click Browse to select the JSON file.
    c. In the Open dialog box, select the required JSON file from the location and click Open.
    NOTE: A JSON file created using a previous version of the Powermanager Device Engineer tool has to be upgraded. Open and save the file using the tool to upgrade the same.
    d. Click Create Device Type.
  • The third party device type is created.

 

2 – Create an Area
  1. Select Applications > Powermanager.
  1. Click the System tab.
  1. Click Create and select Create area.
  1. In the New object dialog box, enter a name and description for the area.
  1. Click OK.
  • The area is created, displays in System Browser under the Powermanager root node and is selected by default.

 

3 – (Optional) Create a Sector
  1. Select Applications > Powermanager > [area].
  1. Click the Area tab.
  1. Click Create and select Create Sector.
  1. In the New object dialog box, enter a name and description.
  1. Click OK.
  • The sector is created and selected by default.

 

4 – Create, Configure, and Save an Imported Device Type

You can create a new imported device type in an area or within a sector that you have created. Alternatively, you can copy an existing device.

  1. Select Applications > Powermanager > [area] OR [sector].
  1. Click the Area/Sector tab.
  1. Click Create and select Create Device.
  • A list of device groups display in a tabular format. By default, Power Devices is selected.
  1. Select the Third Party Devices tab.
  • The list of available third party device types is displayed.
  1. Select the third party device type and configure the parameters for the device by entering information in the expanders in the Area tab.
  1. Click Save .
  • The Save Object As dialog box displays.
  1. Enter a name and description for the device. Do not use the characters “ / ” or “ \ ” in the device name.
  • The device is created and configured and is added to the System Browser under the selected area or sector.
  1. Navigate back to Applications > Powermanager.
  • The System tab displays.
  1. Configure the following expanders in the System tab, if required.
  • Favorites
  • Poll Groups
  • Synchronization
  • Tariff
  1. Click Save .
  • The third party device configuration is complete.

As a next step, you need to establish the communication between the management platform and devices.


To work with the libraries you should have the required customization level access. You can drag and drop a library only if the following nodes are available under the library.
GMS_PM_ConfigurationFolder
GMS_PM_DeviceDefinitionFolder
GMS_ObjectModel_Folder
GMS_MODBUS_CustomRules

Any property changes made to an existing third party device type JSON file will be applicable only to the new devices created under this device type when the modified JSON file is used.

We highly recommend not to change the property name or data type of the third party device type, if the JSON file is used in powermanager and instances are created for that device type. All functions using this device as the source will be disrupted.

Two JSON template file for Powermanager Device Engineer creation are available. These files can be found in the below mentioned path:
…\GmsMainproject\AddSW\PowermanagerDeviceEngineer\SampleFiles

These files are made available after the installation is completed. Types of JSON templates provided:

Single Phase Third Party Type

Three Phase Third Party Type.

You can create a third party device type from an active project in a single server distributed system.

You cannot create a third party device type from a remote server project in a separate server distributed system.

In case of third-party devices in distributed systems, a new device has to be created in the same system where the device type is created. You cannot create a new device of a device type created in the any other system part of the same distribution network.