Using an Existing SQL Server Installation

In case you are using an existing SQL server installation, note the following:

  1. The SQL Server is accessed with the credentials of the respective Windows service, in the standard case with the SYSTEM account. If the arivis Hub DMS services and SQL server are installed on the same PC and arivis Hub DMS is trying to use the SYSTEM account, the SQL Server needs the required access rights for the SYSTEM account as well.
  2. For access to a remote instance, this is not possible. You either have to adapt the connection string (User Id=...;Password=... instead of Integrated Security=SSPI), or the service must be reconfigured so that it runs under a (technical) user account.

 

Configuration of arivis Hub DMS

During installation, the shortcut arivis Hub Setup is created and added to the Windows start menu in the folder for Carl Zeiss Microscopy. This entry can be used to configure arivis Hub DMS after the installation and initial setup and offers the functionality of the Configure and Run tab.

  1. You have defined the action for the components on the Install tab.
  2. You are on the Configure tab.
  1. For Host Name or IP Address, select the server name or IP address, under which the services are accessible in your network, from the dropdown list. If the default localhost is used, the services are only accessible from the local server machine. We recommend using the server hostname, or its primary/public IP address.
  2. For Hosting Scheme, select if you want to set up your server communication with the http or the https protocol.
  3. If you select https, the SSL Certificate option is displayed. If you want to use https (which is highly recommended for security reasons), your server has to be prepared for it. This is usually done by installing an appropriate server certificate (including the private keys used for SSL encryption) into the machine wide certificate store of the Windows server. The server name in the certificate must match the public DNS name under which the server is reachable (configured in the server host name field of the Settings tab). For details, contact your IT department.
  4. For SSL Certificate, select the respective SSL certificate. A list of available certificates is displayed in the dropdown menu. Note that this list displays the (unique) names of the SSL certificates installed on the local computer/machine. For questions or information about SSL certificates, contact your IT department. Note that the SSL certificate needs to be installed in the Personal folder of the local computer certificate store, and that the so-called Root Authority Certificate has to be installed in the Trusted Root Certification Authorities folder of all clients!
  5. For Data Path, enter the name of the directory where the File Server stores its files. To use environment variables, enclose them in percent signs, e.g. %ProgramData%. Make sure you have enough disk space to save the desired files. When you use external workers, the Data Path setting of the central server must be identical to the Data Path setting of every worker, see Setup with Multiple Workers.
  6. For License Key Id, you can enter a license key and only the licenses from this key are taken into account. If you do not define a key here, arivis Hub DMS consumes licenses from any of the available keys. Available license key ids can be found on the license manager web interface at http://localhost:1947 after the arivis License Tool component has been installed and the license key has been activated.
  7. For Application Server Port, enter the TCP port number of the Application Server service. We recommend using the default (8081) unless there is a conflict with other services running on the server.
  8. For Application Server Connection String, enter the connection string of the Application Server database. This needs to be adjusted when an existing SQL Server instance is used. Ask your database administrator for the connection string.
  9. For Keycloak Server Port, enter the TCP port number of the Keycloak Server service. We recommend using the default (8080) unless there is a conflict with other services running on the server.
  10. For Keycloak Server Connection String, enter the connection string of the Keycloak Server database. Adjust this when an existing SQL Server instance is used. Ask your database administration for the connection string.
  11. For Management Server Port, enter the TCP port number of the Management Server service configured with http. We recommend using the default (8088) unless there is a conflict with other services running on the server.
  12. For Object Server Port, enter the TCP port number of the Object Server service. We recommend using the default (8083) unless there is a conflict with other services running on the server.
  13. For arivis Hub Pipeline Server Port, enter the TCP port number of the Pipeline Server service. We recommend using the default (8866) unless there is a conflict with other services running on the server.
  14. For Temporal Server Port, enter the TCP port number of the Temporal Server service. We recommend using the default (8085) unless there is a conflict with other services running on the server.
  15. For Temporal UI Port, enter the TCP port number for the user interface of the Temporal Server service. We recommend using the default (8086) unless there is a conflict with other services running on the server.
  16. For Tile Server Port, enter the TCP port number of the Tile Server service. We recommend using the default (8084) unless there is a conflict with other services running on the server.
  17. If you use the image analysis and use external workers, deactivate Enable Sub Image Analysis on the central server to avoid excessive resource consumption, see Setup with Multiple Workers. It is activated by default, which is suitable and required for simple single-server setups.
  18. If you want to use your server as an archive in ZEN core, activate Setup Users and Groups.
  19. Click Apply.
  20. The installation starts. Once a component is installed, a green checkmark is displayed for the component.
  21. After successful installation of all components, the settings are applied and validated. The displayed status message informs you if the operation is in progress, if it succeeded, or if it failed.
  22. Go to the Run tab, see Checking the Functionality with the Run Tab.