Configuring the Hyland Login Service (Windows Service) - Conductor - Foundation 23.2 - Foundation 23.2 - Ready - Hyland RPA - external

Hyland RPA Conductor

Platform
Hyland RPA
Product
Conductor
Release
Foundation 23.2
License

The Hyland Login Service is configured through the AM.LoginService.Host.exe.config file located in the Hyland Login Service directory (for example, C:\AnotherMonday\AM-Ensemble\LoginService). Open it with an editor of your choice and adjust the settings according to your needs.

To change the database connection, search for LoginServiceDB and modify the connection string.

Note: The Hyland Login Service must run in the security context of Local System. There are multiple ways of gaining privileges to remote systems local services:
  1. The recommended way of connecting the Hyland Login Service to the database is using managed service accounts (machine accounts) and granting them access to the SQL Server. For more information, see Configure Windows Service Accounts and Permissions on docs.microsoft.com. This approach will work using a windows domain only. In case you are in work-group, please use option 2.
  2. Use SQL Server authentication by providing the Hyland Login Service with a username and a password to authenticate against the database. For more information on the authentication mode and how to modify it, see Choose an Authentication Mode on docs.microsoft.com.

As of security and maintenance reasons Hyland strongly suggest using manged service accounts whenever possible. This allows easy central administration of database privileges while minimizing administration effort and and avoiding security risks.

Additional configuration values you will find in the appSettings section.

Key Value
LicenseKey Please provide your valid LicenseKey for activating the Hyland Login Service. The license key can be found in the Customer Portal .
ClientIdentificationExpression The definition of the environment variables used to identify the client (system) in the database. It is used to manage offline license activation requests and optionally for managing the productions (single-account mode).
ApplicationRefreshTime The amount of time the applications read from the database are cached before they are read from database again. Usually, there is no requirement to reduce this time.
ClientRefreshTime The amount of time the clients read from the database are cached before they are read from database again. Reducing the time might be reasonable in case you are updating your clients regularly (especially during a testing period).
InfoValueRefreshTime The amount of time the info values read from the database are cached before they are read from database again. Usually, there is no requirement to reduce this time.
CredentialsRefreshTime The amount of time the credentials read from the database are cached before they are read from database again. It might be reasonable to reduce the time in case you are updating the credentials regularly (for example, when passwords change more frequently)
EnvironmentVariablesRefreshTime Environment variables like %COMPUTERNAME% are cached as well. Usually, there is no requirement to reduce this time.
ActiveSessionSleepTime The Hyland Login Service is working only in case no user is logged in at console session. It stops working when a user is logged in, so the Hyland RPA Conductor can do its job. This value defines how often shall the Hyland Login Service check if the logged in session is still present.
CredentialproviderResponseTimeout The actual login is done by the CredentialProvider. This value defines how long the Hyland Login Service waits for the CredentialProvider to initiate a login before the task fails.
CredentialproviderLoginTimeout After the CredentialProvider initiated a login process: How long shall the LoginService wait for a confirmation, that the login finished successfully.
serilog:* Configures the log of the Hyland Login Service. Here you can modify values like the file path to the actual log file. For more information, see Configuration Basics on github.com.
RequiredDatabaseVersion Do not change this value unless asked for. It defines the minimum database scheme version the Hyland Login Service requires.
ApplicationTypeName The actual credentials to login into windows are managed using Hyland RPA Manager. This value defines the application type. Usually, there is no requirement to change this value.
WindowsApplicationName This value is also used for gaining the credentials to login into windows. Usually, there is no requirement to change this value.
LoginServiceProductName Defines the product name when setting up the license management in Hyland RPA Manager. Usually, there is no requirement to change this value.

Even more configuration settings can be found in the log4net section. There you can adjust additional logging settings used by some internal components. See https://logging.apache.org/log4net/release/manual/configuration.html for details on how to configure it.