Installing, Setting, and Starting the OZW Adapter

Scenario: You want to connect Desigo CC to the OZW building management equipment.

 

Reference: For background information, see the reference section.

 

Workflow diagram:

 

 

Prerequisites:

  • After installation, the OZWAdapterSetup.msi installer package is available in
    [Installation Drive]:\[Installation Folder]\GMSMainProject\AddSW\OZW_150 locally or over the network.

 

Steps:

1 – Configure OZW User in the Credential Manager
  • A user account must exist and be enabled in the OZW that can be used to connect the adapter (OZW user account). A user security configuration is required in the Credential Manager of the computer where the OZW adapter will be installed.
    NOTE: You can install the OZW adapter software on any networked computer that can connect to the OZW device and to Desigo CC. Typically, you want to install it on the Desigo CC server station.
  1. Press the Windows key on the keyboard or click the Windows Start icon or open the Windows Control Panel.
  1. Start typing (in Control Panel, search for) credential manager, and select the Credential Manager icon .
  • The Credential Manager window displays.
  1. If multiple credential vault icons display, make sure to select WindowsVault:
  1. Select Add a generic credential.
  1. select WindowsVault
  1. Select Add a generic credential.
  1. In the Add a Generic Credential page, do one of the following:
  • In the Internet or network address field, enter the User name, then enter User name (again) and Password of the OZW user account, and click OK.
    NOTE: Indicating the user name in the Internet or network address field results in the same account being used for all OZW devices (which must all be configured to allow connection from the same user account).
  • In the Internet or network address field, enter the full network path of the OZW device (for instance https://192.168.1.100), then enter User name and Password of the OZW user account, and click OK.
    NOTE: Indicating a specific OZW device in the Internet or network address field results in the account being used for that OZW device only. This individual setting overrides the previous broad setting that you may also add as an additional credential, for instance if a you have a number of OZW devices with the same user name and password and one that requires a different user name and/or password.
  1. Close the Credential Manager window.

 

2 – Install the Adapter Software

You can install the adapter software service on any networked computer that can connect to the OZW adapter and to Desigo CC. Typically, it is installed on the Desigo CC server station.

  1. Run OZWAdapterSetup.msi.
  1. Follow the wizard instructions to complete the installation.
    NOTE: The default installation folder is C:\Program Files (x86)\Siemens\OZW Adapter. Note down your installation folder if you modify the default destination.

 

3 – Create the OZW CSV File
  1. From the Additional SW folder on the installation disk, run OZWExporter.exe.
  • The OZW Configuration Exporter window displays.
  1. Select URL, Username and Password to access OZW, and then select OK.
  • The data tree displays.
  1. Select the data tree items you want to be managed by Desigo CC.
  1. Save the CSV file:
    a. Select File > Export > CSV.
    b. Browse to the Adapter OZWConfigurations folder (by default C:\Program Files (x86)\Siemens\OZW Adapter\OZWConfigurations).
    c. (Optional) Modify the CSV file name (by default <IPaddress_Port>.CSV).
    d. Click OK.

 

4 – Start the Adapter as a Windows Service
NOTICE

The use of HTTPS protocol is strongly recommended to ensure a secure communication over public networks. Failing to use HTTPS increases the vulnerability to cyberattacks when using an open or badly secured network.

  • Once the configuration is in place, you can start the OZW adapter as a service and let it run in the background. Note that connection faults are reported in Desigo CC Event List.
  1. If still open, close the OZW adapter console window.
  1. From the adapter installation folder, run one of the following batch files:
  • Install_AdapterAsService_HTTP, to run the HTTP service on port 8080
  • Install_AdapterAsService_HTTPS, to run the HTTPS service on port 443
    NOTE: HTTP or HTTPS refers to the protocol applied between Desigo CC and the OZW adapter.
  • The adapter service starts with the new configuration.
  1. In Windows Services, do the following:
    a. Right-click the Siemens OZW Adapter service, and select Properties.
    b. In the Log On tab, select This account, and then enter (or select via the Browse option) an administrator-level user account that can access to the adapter installation folder.

NOTE: You can run Uninstall_AdapterAsService.bat to remove the service. You can also run the adapter in console mode with the following batch files:
- StartAdapter_HTTP.bat
- StartAdapter_HTTPS.bat

 

For more details about certificates, in SORIS, see Secure Communication.