(Optional) Configuring SORIS Manually

Scenario: You want to integrate proprietary subsystem devices into Desigo CC.

 

Reference: For background information, see the reference section.

 

Workflow Diagram:

 

 

Prerequisite:

  • System Manager is in Engineering mode.

 

Steps:

1 – Add a SORIS Driver
  1. In System Browser, select Management View.
  1. Depending on where the SORIS driver is required (Desigo CC server or FEP station), select one of the following:
  • Project > Management System > Servers > Main Server > Drivers
  • Project > Management System > FEPs > [FEP station] > Drivers
  • Object Configurator displays.
  1. In the Object Configurator tab, click New and select New SORIS Driver.
  1. In the New object dialog box, enter a description.
  1. Click OK.
  • The SORIS Driver object appears in System Browser but is not running.
  1. Click the Extended Operation tab.
  1. In the State property row, click Start.
  • The SORIS driver starts and is now ready to use.

 

2 – Add a SORIS Network
  1. In System Browser, select Management View.
  1. Select Project > Field Networks.
  1. Click the Object Configurator tab.
  1. Click New and select New SORIS Network.
  1. In the New object dialog box, enter the name and the description.
  1. Click OK.

 

3 – Assign the SORIS Driver to the SORIS Network
  • A SORIS network has been created.
  1. In System Browser, select Management View.
  1. Select Project > Field Networks > [network name].
  1. Click the SORIS tab.
  1. In the Monitored by driver field, click the drop-down list, and then select the name of driver.
  1. Click Save .

 

4 – Add a SORIS Adapter
  1. In System Browser, select Management View.
  1. Select Project > Field Networks > [network name].
  1. Click the Object Configurator tab.
  1. Click New and select New SORIS Adapter.
  1. In the New object dialog box, enter the desired name and description of the adapter.
  1. Click OK.
  1. Select the SORIS tab.
  1. In Windows Explorer, navigate to and open SORIS_Adapter_Settings.txt, which is installed in one of three locations:
    NOTE: Depending on how the adapter was installed, the path may or may not contain a Bin directory.
  • [drive:]\Siemens\[adapter name]\Bin\Logs
  • [drive:]\Program Files(x86)\Siemens\[adapter name]\Bin\Logs
  • [Installation Drive]:\[Installation Folder]\GMSMainProject\Siemens\[adapter name]\Bin\Logs
  1. In the last line of the file, copy the SORIS Address.
    Example:

    NOTE: To enter a URL other than the default, follow the instructions in the Configure Adapter Windows Service topic that follows.
  1. Paste the address in the URL field.
  1. (Optional) If a client certificate is required—that is, the adapter is running on a remote client—expand the Security section, and then do the following:
  • If you have a C# Adapter and you are not using a self-signed certificate, select the Validate Server Certificate with CA check box. If you are using a self-signed certificate, do not check the check box.
    NOTE: If you have a Java Adapter, do not select the Validate Server Certificate with CA check box. Desigo CC is not able to validate a CA server certificate in this scenario.
  • Click Browse, and select the desired certificate from the Select Certificate dialog box.
  • Click OK.
  1. Click Save .
  1. Verify that the adapter is connected by viewing the Online property in the Extended Operation tab. If it is not connected, click Discover in the URL property row.
  • In System Browser, your subsystem devices appear under Project > Field Networks > [network name] > [adapter name].

 

5 – (Optional) Configure Adapter Windows Service

Select the adapter procedure needed for your project:

To Install the Adapter as a Service for a C# Adapter

  1. Start the Task Manager, and select the Processes tab.
  1. Right-click the ThingSharp [adapter name] process, and click End Task.
  1. Right-click the Command Prompt, and click Run as Administrator.
  1. Change to the directory where the adapter is installed—for example [drive:]\ProgramFiles (x86)\Siemens\[adapter name]\Bin.
    NOTE: Depending on how the adapter was installed, the path may or may not contain a Bin directory.
  1. Enter the following command to set the new IP address, port number, and Windows service:
    [adapter name].exe -ip:xxx.xxx.xxx.xxx -port:xxxx -wsport:xxxx
    -service

To Install the Adapter as a Service for a Java Adapter

  1. Install the third-party tool called winsw. For more information, see https://www.bhupeshsingh.com/2019/08/how-to-run-any-java-application-as-windows-service.
  1. Create the winsw.xml file that describes your service:
    <service>
    <id>MyService</id>
    <name>My Service App</name>
    <description>Java adapter windows service</description>
    <executable>java</executable>
    <arguments>-myadapter.jar</arguments>
    </service>
  1. From the command line where you installed winsw, add the service.
  1. Run winsw.exe install.

NOTE: For additional configuration options, run the adapter from the Command Prompt and enter the following: [adapter name] -?