Installing the SentryOne Document Remote Agent and Configuration Tool

Installing

Additional Information:

  • See the System Requirements article for important information, including required permissions.
  • See the Remote Agent article for details about what it is and where you should install it.
  1. Download: Download the SentryOne Document Remote Agent Configuration Tool from https://document.sentryone.com/ by selecting the Download Config Tool & Remote Agent button. This will download SentryOne.Document.RemoteAgent.msi.Document landing page highlighting the Download Config Tool & Remote Agent button.
  2. Execute the SentryOne.Document.RemoteAgent.msi file to launch the SentryOne Document Remote Agent Setup wizard. Select Next to continue.Setup Wizard Welcome prompt displaying a welcome message and prompting the user to select Next to continue with the install.
  3. Select the box next to I accept the terms in the License Agreement to accept the End-User License Agreement, then select Next to continue.Document End User License agreement prompting you to read the EULA and accept the terms.
  4. Select Next to accept the default installation direction, or use Change to set a custom installation directory before proceeding.Destination folder page displaying the default destination folder and providing the option to change the destination.
  5. Select Install on the Ready to install SentryOne Document Remote Agent screen when you want to start the installation process.Installation page confirming that the installation is ready and prompting you to select Install.

    Note:  Between this step and the next there may be a User Account Control popup message asking you if you want to allow the application to make changes. If the screen seems stuck and the install does not progress, the popup may be behind it.

  6. The Installing SentryOne Document Remote Agent screen will display the status of the installation process.Document installation wizard displaying installation progress with a progress bar.
  7. Select Finish to complete the installation. Launch SentryOne Document Remote Agent Configuration Tool is checked by default and will open the application automatically.Completed Remote Agent Setup message, prompting you to select Finish and the Launch Configuration tool option checked.

Additional Information: See the Troubleshooting SentryOne Document article if you are having trouble installing the remote agent.

Configuring

Configure the settings for your SentryOne remote agent in the SentryOne Document Remote Agent Configuration Tool. Complete the following steps to finish your configuration:

  1. Enter the instance name for your remote agent, and the service URL. Select Next to continue. Remote Agent Configuration Tool with My Docs RA as the service name and the default host URL.

    Note: 

    • The Service Instance Name is a friendly name for the agent. It appears in the application with this name, and the service name will be SentryOne Document Remote Agent <Service Instance Name> on the machine where it is installed.
    • The Target Host URL (service URL) is set to https://document.sentryone.com by default and this is the URL you should use for SentryOne Document cloud. For SentryOne Document Software, you should use the on-premises host URL where you are self-hosting SentryOne Document.
    • The green check marks shown in the image above indicate a valid connection.
  2. Enter the remote agent account username and password. Select Next to continue.RA Config Tool with an entered username and password that is verified by a green check mark.

    Note:  The service account must be within the Log on as a service local security policy. Other permissions to resources may be required in order to create snapshots.

  3. Enter the number of Maximum Concurrent Tasks that the remote agent can complete (the default value is 4) and accept the default Local Cache Path or use the ellipsis to select a custom path. Select Next to continue.Config Tool Concurrency limit and cache path providing the option to set Max Concurrent tasks and the local cache path.

    Note:  Using the ?Help button will display additional information about the fields.Config tool Concurrency limit and cache path displaying details about Maximum Concurrent Tasks and a greyed out screen.

  4. You're now ready to install the remote agent with the configuration values you just set. Select Next to start the process.Ready to install page displaying the systems configuration values all in one screen.
  5. When the installation is complete, you'll have options to 1) Start service, 2) Configure solutions, or 3) Exit.Installation Complete screen displaying the Start Service, Configure Solutions, and Exit buttons.
    OptionDescription
    Start ServiceSelect Start Service to activate the remote agent on your machine.
    Configure SolutionsSelect Configure Solutions to open the SentryOne Document configuration tool. Use the SentryOne Document configuration tool to configure solutions for your environment. Add Solutions and Solution items with the configuration tool in the same way as the SentryOne Document Client. For full instructions on adding solutions and solution items, see Adding Solutions and Adding Solution items
    ExitCloses the SentryOne Document Remote Agent Configuration tool.

Launching

  1. When the SentryOne Document Remote Agent and Configuration Tool first launches, there is a browser pop up screen that asks you to log in to your SentryOne account. If you are using the cloud version of SentryOne Document, this step is required. If you are using the self-hosted version, you can close this screen.SentryOne Login page prompting you to log in with your username and password.
  2. The Welcome to SentryOne Document! screen appears. If you didn't log in, you may see a Credentials are required for this server error message for the default server. Accept the default Server if it is correct (the cloud version is https://document.sentryone.com), or enter the URL of your on-premises host.Server validation page displaying the Server URL and a Validate button. A yellow note says credentials are required.
  3. Select Validate to test the connection to the specified Server. Once the validate is successful, select Connect.Validation page with the server URL validated with a green success message.
  4. Select the Start button on the Welcome! screen to add your first solution. Document Wizard Welcome prompt helping you to start your first solution.

    Additional Information: See the SentryOne Document Configuring Solutions article to continue adding your first solution.