Installing SentryOne Document Software

Introduction

SentryOne Document Software is an on-premises, browser-based option for documenting your data estate. This product is a replacement for the DOC xPress product and is the self-hosted version of SentryOne Document cloud.

Important:  If you are using the cloud version of SentryOne Document at https://document.sentryone.com/, this article is not applicable to you.

System Requirements

  • SentryOne Document System Requirements
  • IIS must be installed and enabled in your Windows OS 
    • Additional Information: See the Installing IIS article on Microsoft Docs for details on installing or enabling this features in Windows
  • Windows Authentication for IIS must be turned on
    • Additional Information: See the Windows Authentication article on Microsoft Docs for details on enabling this feature in Windows IIS
  • It uses port 44302
  • SQL Server 2012 or later (to host the SentryOne Document database)

Additional Permissions

By default, a network service user runs the IIS application pools. This user (or the user you change it to) must have read/write access to C:\Program Files (x86)\SentryOne\SentryOne Document (or your custom installation directory).

If you are using Windows authentication to access the SentryOne Document database, the user account must:

  1. Exist as a login account on the database server
  2. Have access to the SentryOne Document database
  3. Be added to the db_datareader, db_datawriter, and db_ddlamin roles on the SentryOne Document database

Note:  The SentryOne Document Software installer grants the required access to the network service for the IIS application pools.

Installation Instructions

Where to Install

SentryOne Document Software supports both single-server and multi-server setups. There are additional steps needed multi-server configurations.

Additional Information: See the blog post A New, On-Premises Approach to Documentation and Data Lineage: SentryOne Document Software for details about the steps needed for multiple-server setup.

There are two install files for SentryOne Document Software:

  1. SentryOneDocumentSetup.exe is the file used to install SentryOne Document Software on premises as shown in the steps below. It is the web client software.
  2. SentryOne.Document.RemoteAgent.msi is the file used to install the SentryOne Document Remote Agent and Configuration Tool. This file should be installed after the SentryOneDocumentSetup.exe installation is complete (as described below). This does not need to be installed on the same server as the web client software. It can be installed on a web server, database server, or other server entirely (as long as it has the needed access to both the web server hosting the SentryOne Document  web client and the database server hosting the SentryOne Document database).

.NET Core Framework and Windows Hosting Services

The first part of the installation process ensures that you have the Microsoft .NET Core Framework required for SentryOne Document Software. It installs Windows Server Hosting (if necessary). IIS must be installed before starting this process.

  1. Execute SentryOneDocumentSetup.exe on the machine where you want to install the web client to get started.
  2. Select Accept and Install to continue.SentryOne Document setup window prompting you to Accept and Install.
  3. You may need to install Windows Server Hosting (if so, you'll see a series of popups similar to the ones below). Select the box next to I agree to the license terms and conditions, then select Install, wait for the installation to complete, and then select Close.
    MS .NET Core 3.1.3 Windows Server Hosting EULA prompting you to accept terms and install.MS .NET Core 3.1.3 Windows Server Hosting Setup Progress displaying a green progress bar.MS .NET Core 3.1.3 Windows Server Hosting Setup Installation Successfully Completed message.
  4. The Setup Progress window will remain open while the installation continues.SentryOne Document Setup Progress displaying a green progress bar.

SentryOne Document Setup

  1. Select Next on the SentryOne Document Setup screen.Document Setup Wizard Welcome message prompting you to select Next to continue.
  2. Select the box next to I accept the terms in the License Agreement, then select Next.Document Setup EULA prompting you to agree to terms and select Next.
  3. Accept the default destination folder for installation, or use Change to specify a non-default location, then select Next.Document Destination Folder displaying the default installation destination and allowing you to change the destination.
  4. Enter a Server name where the SentryOne Document database will be hosted. Enter a Username and Password if you want to use SQL Server authentication. Leave those fields blank to use integrated security through Windows authentication. Select Test to validate the configuration. Once the test has completed successfully, select Next.
    Configuration page prompting you to enter the Server name, Username, and Password with the option to Test the connection.Connection test pop up displaying Connected Successfully.
    Test results popup

    Note:  If your Test fails, check for firewall rules that may be blocking the connection, and ensure that you have entered your credentials correctly.

    Note:  The SQL Server Name\Instance format may be used for Server.

  5. Enter a Hostname for the server that will host the SentryOne Document Software website (web client), then select Next.Website Hostname Config page prompting you to enter your Hostname in IIS used to access Document.

    Note:  You may need to enter the fully qualified domain name (FQDN) for your host. This value may be changed after installation through IIS, if needed.

  6. Select Install to begin the installation process with the configured settings. You may go Back to change any settings or select Cancel to exit the process without installing SentryOne Document.Document Setup Ready to Install prompting you to select Install to begin installation.
  7. The installation process will proceed.Document Installation progress displaying a green progress bar.
  8. The web client for SentryOne Document has been installed. Select Finish to open the SentryOne License Manager Setup process.Document Completed Setup Wizard prompting you to select Finish to complete the installation.

SentryOne License Manager Setup

  1. Select Next to start the setup wizard for the SentryOne License Manager.Document License Manager Welcome message prompting you to select Next to continue.
  2. Select the box next to I accept the terms in the License Agreement, then select Next to continue. Document End User License agreement prompting you to accept the terms and select Next to continue.
  3. Select Next to accept the default installation destination, or use Change to specify a non-default location.Destination folder page displaying the default destination folder and providing the option to change the destination.
  4. Select Install to install the SentryOne License Manager.Ready to install SentryOne License Manager prompting you to select Install to continue.
  5. Select Finish to complete the installation process. Selecting the box next to Launch License Manager will open the License Manager when the setup wizard exits.Completed License manager Setup Wizard prompting you to select Finish and Launch the License Manager.

Success: The web client for SentryOne Document is now installed.

Document Setup Successful message.

What's next?

License Manager

When the License Manager launches, you'll need to enter your Activation Key

  1. Select Install a license to get started.SentryOne License Manager displaying multiple Document License keys and expiration dates.
  2. On the Licensing screen, choose an activation method. This example selects Use an activation key (which requires an internet connection).Licensing choose activation method with Activation key and Activate manually without internet options.
  3. Paste your license into the Activation key field for your environment. A green check mark after the Activation key indicates a valid key. Select Activate to continue.Licensing Use activation key displaying an entered activation key with a green check and the environment identifier code.
  4. The Activation Complete screen should appear to show you a list of licensed applications. The SentryOne Document On-Premises product is the one applicable to this product installation.Licensing Activation Complete screen displaying the activated Document license and its Maintenance expiration date.

Success: SentryOne Document is now ready to be launched through your browser.

Opening SentryOne Document

Open SentryOne Document in your browser.

  1. Navigate to your server:port (In this example, it is http://lhp75-1118-4a5a:44302/)Browser window navigated to the Server port displaying a windows security login prompt requesting a username and password.
  2. Log in using your Windows credentials. Note:  You may need to use the format DOMAIN\User name (depending on your environment).

Success: The self-hosted SentryOne Document application is ready for you to begin.

Browser window displaying the Document Solutions dashboard for the Server Port with no data to display.

Note:  There's not much to see at this point. You'll need to configure a solution and generate some documentation to see the real magic of SentryOne Document.

Installing SentryOne Document Remote Agent and Configuration Tool

See the Installing Remote Agents and Remote Agents articles for more information and step-by-step instructions.

Updating IIS Binding Information

See the SentryOne Document Software IIS Bindings article if you need to update the IIS binding Type, IP address, Port, or Host name.

Using SentryOne Document

After you install the SentryOne Document Remote Agent and Configuration Tool, you can proceed to configure your first solution, then continue to the Using SentryOne Document section for guides to using all the features.

Upgrading

Important:  If you are currently on version 2020.10 or earlier, you must uninstall SentryOne Document through Add or remove programs before installing the latest version.

To upgrade SentryOne Document Software, run the latest SentryOneDocumentSetup.exe file and follow the installation instructions above. The defaults for the server and host names may have changed since your previous installation. Please verify those values are correct for your configuration when upgrading. 

No additional configuration (i.e. re-adding) is required for the remote agents when upgrading SentryOne Document Software. If an update is available for the remote agent software, that will need to be applied separately. To update a remote agent, see the SentryOne Document Remote Agents article.

Download: Get the latest SentryOneDocumentSetup.exe here.

Uninstalling

Uninstall SentryOne Document through Add or remove programs in Windows.

Note:  This does not remove the SentryOne Document Remote Agent software, which must be uninstalled separately. To delete a remote agent, see the SentryOne Document Remote Agents article.

Troubleshooting

See the SentryOne Document Troubleshooting article.