SentryOne Document Remote Agents

Product Availability: SentryOne Document is currently in a Pilot release status. Visit the pilot sign-up page to learn more and take it for a test drive!

Overview

Remote Agent Overview

What is a remote agent?

A remote agent is a service that runs in the background on a machine within your environment, and is responsible for generating the snapshots and documentation for the solutions configured within SentryOne Document. It feeds the snapshot and documentation back to SentryOne Document Cloud. This agent service needs to be installed on a machine that has access and permissions to the environments configured to be documented. See the System Requirements article for more details.

Where should a remote agent be installed?

The remote agent may be installed on any on-premises machine that meets the system requirements, including access to all the resources (i.e. a SQL Server) it must connect to in order to create documentation. Keep in mind that since it runs as a Windows service in the background, it can only perform the work while the machine is running. A machine that is shut down overnight will not be able to generate documentation or take snapshots during that time.

How many remote agents are needed?

In general, you should start with a single remote agent. During this pilot release it is unlikely that you will need more than one. Situations where you may need more than one remote agent include:

  • You require numerous or large snapshots and they are taking longer than acceptable to complete with a single agent
  • Your network environment is locked down in such a way that not one machine has access to all the resources you are trying to document. In this case, you might need to install a remote agent on Machine1 to access SQLServer1, and a remote agent on Machine2 to access SQLServer2.
Managing Remote Agents

Manage Remote Agents

Manage the remote agents assigned to SentryOne Document. In SentryOne Document, select Manage > Remote Agents to open the Remote Agents management page. 

SentryOne Document Web Portal Remote Agents > Manage Remote Agents
SentryOne Document Web Portal Manage Remote Agents page

Manage Remote Agents page details

MetadataDescription
Machine NameThe name of the machine where the Remote agent is installed.
Date RegisteredThe day and time that the Remote agent was registered with SentryOne Document.
DescriptionA user entered description about the Remote agent.
Remote Agent PoolThe Remote agent pool to which the remote agent is assigned.
Last Signal receivedThe last time a successful connection was made to the remote agent.

Manage Remote Agents page buttons

ButtonDescriptionImage
SentryOne Document Web Portal Edit description buttonSelect the Edit description button to edit the description column for the selected remote agent. Enter your desired description, and then select to save your changes. SentryOne Document Web Portal Manage Remote Agents Edit description
SentryOne Document Web Portal Change pool assignment buttonSelect the Change pool assignment button to open the Change pool assignment window. Select the desired remote agent pool from the drop-down list, and then select Change Pool Assignment to save your changes.SentryOne Document Web Portal Change Pool Assignment window
SentryOne Document Web Portal Check Connectivity buttonSelect the Check connectivity button for a remote agent to open the Check remote agent connectivity window. Select Start connectivity check to verify the connection.SentryOne Document Web Portal Check Remote Agent Connectivity window
SentryOne Document Web Portal Task History buttonSelect the Task History button for a remote agent to open the Task History page for the remote agent. SentryOne Document Web Portal Remote Agent Task History
SentryOne Document Web Portal Manage License buttonSelect the Manage License button to open the Manage License window. SentryOne Document Web Portal Manage Licenses window
SentryOne Document Web Portal Delete buttonSelect the Delete button to open the Delete Remote agent window. Select Delete Remote agent to delete the selected remote agent from the Remote Agents page.SentryOne Document Web Portal Delete Remote Agent window

Deleting a Remote Agent

You can delete any unused remote agents in your SentryOne Document environment by completing the following:

1. Open Windows Services, then select the remote agent you want to delete. Right click the remote agent, then select Stop to stop the service from running.SentryOne Document Open Services and Stop Remote Agent

Note:  Stopping the SentryOne Document Remote Agent Service makes the uninstall process easier and does not require you to restart your machine.

2. Select the Windows button, then navigate to the SentryOne folder. Right click the SentryOne Document Solution Configuration Tool, and select Uninstall to open the Control Panel.SentryOne Document Solution Config Tool select Uninstall

3. Right click the SentryOne Document Remote Agent that you want to uninstall, then select Uninstall to uninstall the service. Select Yes to confirm your selection.

SentryOne Document Remote Agent Uninstall from Control panel
SentryOne Document select Yes to Uninstall Remote Agent

Viewing a Remote Agent Log

If your remote agent encounters any issues or failures, you can select the Task History button for the desired remote agent. On the Task History page for the remote agent, you can view or download log output that details the issue. 

Note:  For a more detailed log, you can view the log output for your on premises installation at the following path:

  • C:\Program Files (x86)\SentryOne\SentryOne Document Remote Agent\SentryOne.Document.RemoteAgent.exe.config

Logging is set to record any error by default. If you want your log to record more detailed data, you can change this configuration to debug.

Managing Remote Agent Pools

Manage Remote Agent Pools

SentryOne Document Web Portal Manage Remote Agent Pools

Note:  SentryOne Document automatically creates a default system-generated remote agent pool that you can't change. When you register a remote agent, your remote agent goes into that pool by default.

Use the SentryOne Document Remote Agent pool page to create custom pools, and move agents around between them. If you have multiple remote agents, and want to control what work they can pick up, you can group them into pools. When a snapshot is requested for a solution item, it allocates that work to any of the available agents within the pool that is associated with that solution item.

Creating a new pool

Create a new remote agent pool in the Manage Remote Agents pools page by completing the following steps:

  1. Select New Pool to open the New Remote Agent Pool window.SentryOne Document Web Portal Manage Remote Agent Pools New Pool
  2. Enter a Pool name, and then select Save to create your remote agent pool.SentryOne Document Web Portal Create New Pool window

Success: Your remote agent pool is ready to use! SentryOne Document Web Portal Manage Remote Agent Pools New pool available

Manage remote agent pool page details

MetadataDescription
Pool nameThe name of the remote agent pool.
Agents AssignedThe number of remote agents assigned to the pool.

Manage remote agent pool buttons

ButtonDescriptionImage
SentryOne Document Web Portal Manage Remote Agent Pools New Pool buttonSelect the New Pool button to open the Create new pool window.SentryOne Document Web Portal Create New Pool window
SentryOne Document Web Portal Manage Remote Agent Pools Edit name buttonSelect the Edit Remote agent pool name button open the Edit Remote Agent Pool window. Enter the desired changes, and then select Update to save your changes.SentryOne Document Web Portal Manage Remote Agent Pools Edit pool name
SentryOne Document Web Portal Manage Remote Agent Pools Delete pool buttonSelect the Delete button to open the Delete Remote Agent pool window. Select Confirm Delete to delete the selected remote agent pool.SentryOne Document Web Portal Delete Remote Agent Pool Window

Deleting a Remote Agent Pool

Important:  Before deleting a selected remote agent pool, you must reassign all the existing remote agents, solutions, and solution items within the pool to another pool.

Delete a selected remote agent pool from SentryOne Document by completing the following:

1. Reassign any remote agents, solutions, or solution items that are assigned to the pool you want to delete. In this example, we reassign a remote agent to a different pool. 

SentryOne Document Web Portal Change pool assignment
SentryOne Document Web Portal select Remote Agent poolSentryOne Document Web Portal Change Pool Assignment

2. Open the Remote Agent Pools page (Manage > Remote Agent Pools). SentryOne Document Web Portal Manage > Remote Agent Pools

3. Select the Delete button for the remote agent pool you want to delete, then select Confirm Delete to complete the process.

SentryOne Document Web Portal Delete Remote Agent Pool button
SentryOne Document Web Portal Delete Remote Agent Pool Confirm Delete

Success: The remote agent pool has been deleted from your SentryOne Document environment.SentryOne Document Web Portal Remote Agent Pool deleted