Connector Windows Service

Installation

This install script will install connector as Windows service which will be running under virtual Windows account NT Service\\2Ring [instanceName] [connectorName]. Script will also assign this account all required rights and permission needed for this service to run.

Navigate to the connector installation package and run install.ps1 as Administrator.

Use a non-core version of the Powershell (e.g Powershell 5.1).

Through the whole installation process, you can accept default values in parentheses by pressing Enter.

1. Enter the 2Ring DW application instance name.

   Figure 1: Connector Windows Service Installation

   

2. Enter the connector name.

   Figure 2: Connector Windows Service Installation

   

3. Enter the name of the database that will be used by connector.

   Figure 3: Connector Windows Service Installation

   

4. Enter the server address of the SQL server.

   Figure 4: Connector Windows Service Installation

   

5. Choose whether an integrated security should be used when installing the database.

   • If “Yes” is chosen, windows credentials are used for the installation purpose.

   • If “No” is chosen, an Administrative database user and a password has to be provided. This user is used for running the installation.

   These credentials are only used during the installation process and are not stored anywhere.

   The SQL Server login must have sysadmin rights.

   Figure 5: Connector Windows Service Installation

   

6. Choose whether SQL certificate should be trusted.

   If you choose not to trust the SQL certificate, make sure that it is located in the Trusted Root Certification Authorities folder on the system the installation script is running from.

   Figure 6: Connector Windows Service Installation

   

7. Choose whether to use an additional connection string settings for a database connection.

   • If “Yes” is chosen, define the additional connection string settings.

   Figure 7: Connector Windows Service Installation

   

8. In case when a connector database does not exist yet, choose whether you want to install the database or skip this step. In case when a connector database already exists, choose whether you want to upgrade the database or skip this step.

   The script automatically detects if the connector database exists.

   Figure 8: Connector Windows Service Installation

   

9. Enter a database user for the connector. This user is used by the connector to connect to database during runtime.

   The password for the user is auto generated and will be listed in the installation summary after the connector is successfully installed.

   Figure 9: Connector Windows Service Installation

   

10. Enter the address of the SQL Server, that contains the primary AWDB database.

Figure 10: Connector Windows Service Installation

11. Enter the name of the AWDB database on node 1 to retrieve data from.

Figure 11: Connector Windows Service Installation

12. Enter the username of a SQL user with read privileges to both AWDB and HDS databases, that will be used to access the primary AWDB database.

Figure 12: Connector Windows Service Installation

13. Enter the password of the SQL user.

Figure 13: Connector Windows Service Installation

14. Enter the address of the SQL Server, that contains the secondary AWDB database.

If secondary node does not exist, leave the address blank.

Figure 14: Connector Windows Service Installation

15. Enter the name of the AWDB database on node 2 to retrieve data from.

If secondary node does not exist, leave the field blank.

Figure 15: Connector Windows Service Installation

16. Enter the username of a SQL user with read privileges to both AWDB and HDS databases, that will be used to access the secondary AWDB database.

If secondary node does not exist, leave the field blank.

Figure 16: Connector Windows Service Installation

17. Enter the password of the SQL user.

If secondary node does not exist, leave the field blank.

Figure 17: Connector Windows Service Installation

18. Confirm previously entered values by pressing ENTER.

Figure 18: Connector Windows Service Installation

19. Choose whether a connector service should be installed.

Figure 19: Connector Windows Service Installation

20. Enter the connector instance directory.

Figure 20: Connector Windows Service Installation

21. Enter the API URL of the 2Ring DW application instance.

Figure 21: Connector Windows Service Installation

22. Enter the API key of the 2Ring DW application instance.

Figure 22: Connector Windows Service Installation

23. UCCE connector Windows service has been successfully installed.

Figure 23: Connector Windows Service Installation

The connector windows service has to be manually started after the installation.

Running connector via command prompt

The connector can also run via the command line. To run the connector in the command line, open it and navigate to the connector deploy folder and run the following command:

ConnectorHost.exe --connector=Ucce

Never run more than one instance of the same connector simultaneously, or the data may get corrupted. It is recommended to use the Windows service in a production environment and only use the command line mode for troubleshooting purposes. Do not forget to stop the service before running the command line mode.