SentryOne Document Generating Documentation

Download:  Visit the SentryOne Document product page to learn more about purchasing or to start a free trial.

After you have successfully installed the SentryOne Document remote agent and configured a solution (see the Getting Started article for instructions), you can use SentryOne Document to generate documentation. Generate documentation for your Solution by completing the following steps:

1. Log into SentryOne Document, then select Solutions to open the Solutions dashboard.

SentryOne Document Web Portal select Solutions

2. Select the Start Snapshot button for the desired solution, then select Snapshot on the Snapshot Configuration window to start your snapshot.

SentryOne Document Web Portal Solutions Dashboard Start a Snapshot
SentryOne Document Web Portal Solutions Dashboard Confirm Snapshot Request

Note:  Your Snapshot Request is processed by the remote agent assigned to the solution. The snapshot may take several minutes. View your snapshot progress on the Task History page for the selected solution.SentryOne Document Web Portal Task History for Solution

Note:  You can cancel a snapshot for a solution that's pending, or in progress on the solution's Task History page. Select Cancel to open the Confirm Workflow Cancellation window, then select Confirm to cancel the snapshot.  

SentryOne Document Task History for Solution select Cancel
Cancel Snapshot

SentryOne Document Confirm Workflow Cancellation window select Confirm
Confirm Workflow Cancellation

Important:  The Remote Agent pool assigned to your Solution needs at least one Remote Agent to take a snapshot. If your Remote Agent pool doesn't have an assigned Remote Agent, you are prompted to assign one.

SentryOne Document Snapshot Configuration No Remote Agent assigned
Remote Agent not assigned

SentryOne Document Change Pool Assignment window
Change Pool Assignment

Once your documentation has generated, you can select SentryOne Document View Documentation buttonfrom the Solutions Dashboard to open the Documentation page and drill down into your solution's metadata. SentryOne Document Web Portal Documentation page for Solution

Note:  You can also select the Documentation tab, then select a Solution from the drop-down list to display documentation.SentryOne Document Documentation page Solution drop-down list

For more information about the Documentation page in SentryOne Document, see the SentryOne Document Solutions Dashboard article.