Wiki Admin

Installing DSS Agent on Windows using Installer - DSS 6 | Data Source Solutions Documentation

Export as HTML Export as PDF Export as DOCX
Edit

Documentation: Installing DSS Agent on Windows using Installer - DSS 6 | Data Source Solutions Documentation

Installing DSS Agent on Windows using Installer

This section describes the requirements and step-by-step instruction on how to install DSS Agent on Windows using installer and the initial system configuration.

For installing DSS Agent on Windows using zip file, see Installing DSS Agent on Windows using Zip File.

For installing DSS Hub on Windows using installer or zip file, see Installing DSS Hub on Windows using Installer or Installing DSS Hub on Windows using Zip File respectively.

The installation file for Windows is available for download in .exe and .zip format. The compressed file (.zip) distribution is normally used as an alternative for the Windows executable based (.exe) distribution. Also, the installation steps are different on both formats.

Requirements

Following are the prerequisites for installing DSS Agent on Windows:

  • Sufficient disk space
    Ensure sufficient disk space is available on the machine where this installation will be performed. For more information, see Agent Disk Requirements.

  • Compatibility
    Check whether the DSS Agent version is compatible with the operating system and DBMS. Refer to the relevant Supported Platforms section or read the COMPATIBILITY section in the release notes (available under the Downloads tab in the Data Source Solutions dashboard).

  • Installation file
    DSS Agent installation file for Windows (e.g. datasourcesolutions-6.1.0_21-hub_and_agent-windows-x64-64bit_ga_patch-setup.exe). This file can be downloaded from the Downloads tab in the Data Source Solutions dashboard. For more information, see Downloading DSS.

  • Access to source and target locations
    For the DSS Agent to access a source or target database directly, the database connectivity (e.g. ODBC drivers) must be installed on the agent machine. For more information, see Source and Target Requirements.

  • Windows user account privileges:

    • Elevated user account privilege is required for running the DSS Agent executable/installer. Normally this means the user must supply an administrator password interactively.

    • The user account (e.g. datasourcesolutions) which will operate the DSS Agent must have Log on as a service policy enabled.

User account policies can be managed using the Windows Local Security Policy console (accessible from Control Panel ▶ Administrative Tools). The shortcut command to access this console is secpol.msc. For more information about enabling this policy, refer to the Microsoft documentation.

Install Steps

Perform the following steps in the user account that will be used for operating the DSS Agent:

  1. Run the DSS Agent installation file (e.g. datasourcesolutions-6.1.0_21-hub_and_agent-windows-x64-64bit_ga_patch-setup.exe).

  2. Click Next in the installation wizard dialog.
    Welcome

  3. Read the License Agreement, select I accept the agreement and click Next.
    License_Agreement

  4. Specify the installation directory for DSS_HOME, DSS_CONFIG, and DSS_TMP and click Next.
    Destination_Directories

  5. Click Next to create program folder for DSS Agent.
    Program_Folder

  6. Select DSS Agent and click Next.
    Installation Role

  7. Enter a value for DSS Agent Listener Port and click Next.
    Agent_Listener_Port

  8. Select the user account for running DSS Agent services.

    • If Specified user is selected, enter values for User, Password, Confirm Password and click Next.
      Services_User_Account_Specific
    • If Local System account is selected, click Next.
      Services_User_Account_Local

  9. Select Add DSS_HOME, DSS_CONFIG and DSS_TMP, if required, and click Next.

This is to set the environment variables DSS_HOME, DSS_CONFIG, and DSS_TMP in your operating system.

![Additional_Configuration](/static/docs/docs/dss6/install-and-upgrade/install/agent/installing-agent-on-windows-using-installer/_assets/SC-Dss-Install-Windows_AdditionalConfiguration_Agent.webp)

  1. Click Next to initiate the installation.
    Ready_To_Install

  2. After the installation is complete, click Finish to start the DSS Agent.

When DSS Agent is installed using the installer, the DSS Agent Listener process is automatically added to Windows Startup. No additional configuration is needed for the service to start after a system reboot.

![Installation_Completed](../../../_assets/SC-Dss-Install-Windows_CompletedAgent.webp)

  1. Configure the DSS Agent, which requires setting its network security and authentication properties. This can be done from a web browser (UI) while creating a location (provided the agent is in 'setup mode') or from the command-line (CLI).

By default, after starting the DSS Agent for the first time, it will be available in 'setup mode' for the next 60 minutes. In 'setup mode', you can configure the DSS Agent remotely from the hub machine using browser or CLI. When the 'setup mode' expires after 60 minutes, the agent can not be configured remotely. If you want to re-initiate the DSS Agent 'setup mode' later, use the command dssagentconfig directly on the agent machine. For example, to enable 'setup mode' for the next 1 hour, execute:

```plaintext
dssagentconfig Setup_Mode_Timed_Until=now+1h
```

Testing Connection to a DSS Agent

To test the connection to the DSS Agent, execute the command dssagenttest on the machine from which you are connecting to the agent. You can also check whether dssagentlistener is running by executing the command dssagenttest directly on the DSS Agent machine.

Examples for testing the connection to a DSS Agent
Example 1: Check connection to a DSS Agent

You can check the connection to the DSS Agent installed/running on a remote machine with username and password authentication enabled. Execute the following command on the hub machine or on the machine from which you are connecting to the DSS Agent:

dssagenttest -L myuser/mypassword mynode 4343

Sample output in Linux with successful authentication and also indicating that the DSS Agent Listener is running:

dssagenttest: Data Source Solutions 6.1.0/21 (windows-x64-64bit)
dssagenttest: Agent version 6.1.0/21.
dssagenttest: Authentication with username and password enabled.
dssagenttest: Authentication successful.
dssagenttest: Finished. (elapsed=0.34s)
Example 2: Check whether dssagentlistener is running

After installing and starting the DSS Agent Listener service, you can verify whether the dssagentlistener is running on the agent machine. Execute the following command on the agent machine:

dssagenttest mynode 4343

Sample output in Windows with successful authentication indicating that the DSS Agent Listener is running:

dssagenttest: Data Source Solutions 6.1.0/21 (windows-x64-64bit)
dssagenttest: Agent version 6.1.0/21.
dssagenttest: Authentication with username and password enabled.
dssagenttest: Authentication successful.
dssagenttest: Finished. (elapsed=0.18s)

See Also