SentryOne Document Generating Documentation

Download:  Visit the SentryOne Document product page to learn more about purchasing or to start a free trial. You can explore the product right now in our demo environment.

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.

Document Solutions dashboard displaying multiple solutions.

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

Solutions Dashboard selecting the S1DocCloud solution and highlighting the Start Snapshot button.
Snapshot Configuration window presenting options to schedule a snapshot and a button to start a snapshot immediately.

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.Document Task History displaying the progress of the started snapshot including descriptions, completion times, and statuses.

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.  

Task History for a started Snapshot, displaying completed segments and highlighting the Cancel button to stop the snapshot.
Cancel Snapshot

Confirm Workflow Cancellation window prompting you to select Confirm to stop the snapshot.
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.

Snapshot Configuration notifying you no remote agents are assigned and linking you to configure remote agents.
Remote Agent not assigned

Remote Agent Pool window prompting you to choose an agent pool from the drop-down menu to change pool assignment.
Change Pool Assignment

Once your documentation has generated, you can select Document View Documentation button selectable from the Solutions Dashboard.from the Solutions Dashboard to open the Documentation page and drill down into your solution's metadata. Documentation page displaying a Data Flow task table with property and values, a summary of the task, and a task diagram.

Note:  You can also select the Documentation tab, then select a Solution from the drop-down list to display documentation.Documentation page highlighting the documentation tab and the solution drop-down menu.

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