Install UC

Before initiating the installation of the UC, the following prerequisites need to be completed:

Prerequisite

Instructions

URL of the ObserveID Authentication Provider

The URL must be requested from the ObserveID team before the installation starts.

OAuth scope for JWT authentication

For the OAuth scope it is possible to use the default one, prepopulated in the installer.

Client ID of your ObserveID instance

The Client ID of your ObserveID instance registered for the ObserveID Authentication Provider must be requested from the ObserveID team before the installation starts.

Client Secret of your ObserveID instance

The Client Secret of your ObserveID instance registered for the ObserveID Authentication Provider must be requested from the ObserveID team before the installation starts.

URL of the ObserveID backend

The URL should be requested from the ObserveID team before the installation starts.

Connection String value

It is optional. And if needed, Application Insights of Azure Monitor can be used for monitoring performance. In this case, it is possible to use your Azure subscription, or ask the ObserveID team to provide both values for you.

Instrumentation Key value

ObserveID Universal Connector is installed as a service on a Windows machine. The installation is performed with an installation file that runs an installation wizard to help you go through all steps of the configuration flow and ensure the service is installed according to your requirements. Below is a list of the wizard steps with details to follow:

  1. Double-click the file: ObserveID Universal Connector.exe, to run the installation wizard.
    icon

  2. Click Next in the Welcome dialog.

  3. Enter the following parameters, and then click Next to move to the next installation step:

    • the URL of the authentication provider received from the ObserveID team;
    • for the scope, it is possible to use the default one: universalconnectorapi, to enable the Universal Connector to work with JWT;
    • the Client ID of your ObserveID instance received from the ObserveID team;
    • the Client Secret of your ObserveID instance received from the ObserveID team.

  4. Use one of the two options of what account to provide the UC with: the default account, or a preferred account. LocalSystem is the default local account that will be established for the UC, unless you provide the credentials of the account you prefer.

    1. To use LocalSystem, click Next to skip the step and to move forward.
    2. To set up a preferred account, check Install the ObserveID Universal Connector service for this specific account, then enter the user name and the password as the credentials of the preferred account, and click Next to go to the next step.

    User name guidelines:

    • for a domain user, use the format: <Domain_Name>|<User_name>
    • for a local user account, use a dot (.) as the alias for the domain name, e.g: .|Administrator

  5. Enter the URL of the ObserveID backend received from the ObserveID team, and then click Next to move to the next step of the wizard.

  6. If needed, monitoring performance can be enabled for the UC. This is an optional step that can be skipped by clicking Next and moving forward.

    To enable monitoring, enter the Ingestion Endpoint and the Instrumentation Key. Both values are provided by Azure’s Application Insights, and allows you to connect the UC with Azure’s agent that gathers and sends its telemetry to Azure for analysis and presentation.

    For this option, an Azure account is needed. If your organization already has an Azure subscription, ask your administrator to add the UC to Application Insights, and provide you with the values. If you don’t have an Azure account, ask the ObserveID team to provide both values for you. Below is the list of values needed:

    • the Connection String value, which is entered into the Ingestion Endpoint field,
    • the Instrumentation Key value, which is entered into the Instrumentation Key field.

  7. If needed, specify a preferred installation folder, or use the following default folder: C:\Program Files\ObserveID\Universal Connector\ and click Next to move forward.

  8. Click Install to start the installation of the UC.

  9. With the Status bar, it is possible to observe how the installation goes.

  10. Once the installation is finished, the Completing the Universal Connector Setup Wizard dialog shows up. Click Finish to finish the installation.

    Once installed, the ObserveID Universal Connector is registered as a Windows service and can be managed through the system services interface (for example, started, stopped, or restarted).

  11. Open Windows Services (services.msc).

  12. Verify Service Installation and Status.

    1. Locate ObserveID Universal Connector in the list of services.
    2. Confirm that the service status is Running.
    3. If the service is not running, start the service manually.
    4. If required, restart the service to ensure proper initialization after installation.

  13. Configure Startup Type.

    1. In Windows Services, right-click ObserveID Universal Connector and select Properties.
    2. Open the General tab.
    3. Set Startup type to Automatic.
    4. Click Apply, then OK to save the configuration.

  14. Configure Service Recovery Options.

    1. In the ObserveID Universal Connector Properties window, open the Recovery tab.
    2. Set First failure to Restart the Service.
    3. Set Second failure to Restart the Service.
    4. Click Apply, then OK to save the configuration.