BI xPress Server Getting Started

Setup Instructions

Installation

Workbench Server is the main application that BI xPress Server is hosted within. 

Note:  Features only become available if you have purchased a license for the product you are trying to use.

1. After ensuring you meet the Hardware and Software Requirements, open the installer.

2. Uncheck the box Send feature usage statistics to Pragmatic Works if you don't want to send feature usage statistics. Read the License terms and conditions and then select I agree to the License terms and conditions. Select Next to continue the installation. BI xPress Server Installer License terms and conditions

Note:  The Use previous installation settings option helps you upgrade from older versions by attempting to gather as much of the previous installation's settings as possible. For example, the application pool identities may need reconfiguring.

3. Review the itemized list of components that Workbench Server will install, and the total space required on the Select Components page. Select Next to continue the installation.BI xPress Server Installer Component selection

4. Configure the website where Workbench Server will be accessed. The following configuration options are available:DOC xPress Server Workbench Server Website Configuration

Configuration OptionDescription
Workbench Server URLThe URL that you enter in a browser to access Workbench Server.

Note:  If you want to associate Workbench Server with a different port number than the industry standard port 80 (or 443 for https), include the port number using the following syntax: http[s]://<ServerName>[:<Port>]/
Run application pool asThe user account that the website uses for accessing the database, server files, and resources.

Note:  The account should already have access to the database(s) and server(s) that you want to access and document. The account should have database access that includes the ability to create, update, and delete tables, stored procedures, and other database objects.

Select from the following:
  • Application Pool Identity - An IIS controlled user account designed to have minimal permissions to only the server where Workbench Server is hosted.
  • Network Service - A built-in Windows user account that has limited network permissions. Generally, the Network Service account only has access to resources on the same computer hosting Workbench Server.
  • User specified below (Recommended) -  A local or domain user account created by the user or a system administrator that must have permissions to local and remote databases and local and remote resource files or folders. Using a specific local or domain user account makes it easier for system administrators to maintain and grant permissions to local and remote databases.

Select Next to continue the installation.

Important:  The user account that Workbench Server Website's Application Pool is authorized to use, dictates the option that's used for BI xPress Server Website and DOC xPress Server Website's Application Pools. If the websites are authorized to run as a specific user, unique users can still be selected for each Application Pool.

If Workbench Server needs access to services, databases, or assets on any other computer than the machine where Workbench Server is installed, then a specific domain user must be used by the Application Pool Identities and the DOC xPress Data Handler Service.

5. Setup the connection information for the database that's used to store the user and administration information. Select Next to continue the installation. BI xPress Server Installer User and Adminsitration Database

Note:  If you want the User and Administration Database located on a different system than the Workbench Server website and the setting Windows Authentication, then the Workbench Server Application Pool configured in Step 4 must be run using a domain user account.

6. If you selected User specified below for the Workbench Server Application Pool, then you can enter a different User name and password. If you did not select User specified below, select Next to continue the installation.BI xPress Server Installer BI xPress Server Website Configuration

7. Setup the connection information for the database that's used by BI xPress Server within the Monitoring Console. Select Next to continue the installation. BI xPress Server Installer BI xPress Database

Note:  The BI xPress Application Pool configured in Step 6, and the Workbench Server Application Pool configured in Step 4 must be running a domain user account if you want the BI xPress Database located on a different system than the Workbench Server website.

8. If User specified below was selected for the Workbench Server Application Pool, then you can enter a different User name and password. If User specified below was not selected, select Next to continue the installation.BI xPress Server Installer DOC xPress Website Configuration

9. Review the settings for how the DOC xPress Server meta data is distributed. Select Next to continue the installation.BI xPress Server Installer DOC xPress Settings

Note:  The DOC xPress Application Pool configured in Step 8 must be run using a domain user account if you want the DOC xPress Database located on a different system than the Workbench Server website.

10. Single Database: If you want to store all of the meta data in a single DOC xPress Server database, select Use a single database for DOC xPress Server storage.  Enter the connection information for the database used to store the DOC xPress Server meta data information. Select Next to Continue the installation. 

BI xPress Server Installer Use a Single Database
BI xPress Server Installer Single DOC xPress Database

Multiple Databases: If you want to store your meta data in up to four separate databases, select Use up to four separate databases for DOC xPress Server. Enter the connection information for the databases that used to store the DOC xPress Server meta data information. Select Next to continue the installation.

ConfigurationDescription
Command Query StoreThe DOC xPress metabase that DOC xPress Desktop Application users connect to in order to manage and create snapshots and data dictionary categories.
Dictionary Query StoreAn optimized database used to store Data Dictionary content for use within DOC xPress Server.
Generator Query StoreAn optimized database used to store metadate regarding DOC xPress Server generated documentation.
Browser Query StoreAn optimized database used to store the structure of objects for use within DOC xPress Server.
BI xPress Server Installer Use up to four databases
BI xPress Server Installer Multiple DOC xPress Databases

Note:  For management or scalability reasons, all database information can point to the same database, shared databases between any number of DOC xPress Server database(s), or even separate databases for each database required by DOC xPress.

11. Configure the DOC xPress Data Handler Service and the service login settings. Select Next to continue the installation.DOC xPress Server DOC xPress Data Handler Service

Important:  The DOC xPress Data Handler Service runs in the background and performs all the DOC xPress document generation and processing. This service runs after installation and when the computer starts up by default. 

If the DOC xPress Data Handler Service is set to run as a specific user, that user must be contained within the Log on as a service local security policy.

If documentation is not being generated, ensure the service is running and that the user account running the service has access to create, update, and delete tables, stored procedures, and other database objects within the DOC xPress Server database(s) that were created in Step 10.

12.   Configure the server paths to the server directories. The following configuration options are available:

Directory ConfigurationDescription
 DOC xPress Templates DirectoryThis directory that contains server templates that are used to lend form and reason to the output in DOC xPress Server.
DOC xPress Output DirectoryThis is the directory that contains all of the documentation that is generated by DOC xPress Server.
CHM Compiler Application PathThis is the path to the CHM Compiler that is installed on the server.

 Select Next to continue the installation.

BI xPress Server Installer DOC xPress Settings

Important:  DOC xPress Server only supports local folder locations for the DOC xPress Output Directory. Without the HTML Help Compiler application (hhc.exe), generating CHM documentation will fail.

13. Enter the connection information for the database that's used to store the LegiTest Server test suite history and assemblies. Select Install to begin the installation.

Important:  SentryOne Workbench Server versions 2019.4.1 and above remove Legitest server as a default installation.

BI xPress Server Installer LegiTest Server Database

Note:  Selecting Install downloads and installs the necessary software prerequisites. After installing the software prerequisites, Workbench Server begins installing the necessary software. After installation has completed, it may take several minutes while the server self configures before the website becomes operational. 

Allowing IIS Access

After the Workbench Server installation has completed, the administrator must allow users and groups within IIS to access the homepage of Workbench Server. Allow access by completing the following steps:

Note:  Control over users is handled within Workbench Server's administrative area. 

  1. Open IIS, right-click on the Workbench Server site, then select Edit Permissions.BI xPress Server Internet Information Services Edit Permissions
  2. Navigate to the security tab, then select Edit to open the Permissions for Workbench Server Host windowBI xPress Server Workbench Server Host Properties
  3. Select Add to open the Select Users or groups window.BI xPress Server Permissions for Workbench Server Host
  4. Add any individual users and groups that need access to Workbench Server's homepage. Select OK for all of the remaining dialogs to save your changes.BI xPress Server Select Users or Groups

Hardware Requirements

Determine your hardware requirements based on your environment's deployment model. BI xPress Server needs access to several databases to function. This creates the following two deployment scenarios:

Single Machine

In the single machine deployment model, the same machine has both Workbench Server and the databases installed. Workbench Server is the web application that contains BI xPress Server and its associated assemblies while the databases are hosted within a SQL Server Instance.

The following memory and processor requirements apply to all editions of BI xPress Server:

ComponentMinimum RequirementsRecommended Requirements
Memory4 GBAt least 8 GB and should be increased as the BI xPress database size increases to ensure optimal performance
Processor Speed1.4 GHz2.0 GHz or faster
Processor TypeNot Applicable
  • AMD Opteron
  • AMD Athlon 64
  • Intel Xeon with Intel EM64T support
  • Intel Pentium IV with EM64T support

Important:  Hardware requirements can vary based on workloads and other processes.

Multiple Machines

In the multiple machine deployment model, Workbench Server and the databases are installed on separate machines. Workbench Server is the web application that contains BI xPress Server and its associated assemblies while the databases are hosted within a SQL Server Instance. It's important to differentiate between the Server machine and the Database machine:

  • Server machine - the machine where Workbench Server is installed. 
  • Database machine - the machine containing a SQL Server instance where the DOC xPress database is deployed.

The following memory and processor requirements apply to all editions of BI xPress Server:

Server Hardware Requirements:

ComponentMinimum RequirementsRecommended Requirements
Memory4 GB6 GB
Processor Speed1.4 GHz2.0 GHz or faster
Processor TypeNot Applicable
  • AMD Opteron
  • AMD Athlon 64
  • Intel Xeon with Intel EM64T support
  • Intel Pentium IV with EM64T support

Database Hardware Requirements:

ComponentMinimum RequirementsRecommended Requirements
Memory4 GBAt least 6 GB and should be increased as the BI xPress database size increases to ensure optimal performance
Processor Speed1.4 GHz2.0 GHz or faster
Processor TypeNot Applicable
  • AMD Opteron
  • AMD Athlon 64
  • Intel Xeon with Intel EM64T support
  • Intel Pentium IV with EM64T support

Important:  Hardware requirements can vary based on workloads and other processes.

Software Requirements

Before installing BI xPress Server, make sure you meet the following system requirements:

  • Internet Information Services (IIS) 7 or later with:
    • Dynamic Compression installed
    • Windows Authentication installed and enabled
  • .NET 4.5.1 or later installed
  • PowerShell 3.0 or higher installed
  • SQL Server Integration Services 2012, 2014, 2016, 2017
    • Business Intelligence Development Studio (BIDS) 2008 R2 or SQL Server Data Tools (SSDT) 2010, 2012, 2014, 2015
  • Access to a SQL Server 2008 or later instance

Note:  BI xPress Server needs access to a SQL Server 2008 or later instance to install the following databases:

  • Workbench Server User and Administration database
  • BI xPress Database

The following operating systems are supported by BI xPress Server:

64-Bit (x64) Operating Systems:32-Bit (x86) Operating Systems:
  • Windows Server 2008
  • Windows Server 2008
  • Windows Server 2012
  • Windows 7
  • Windows Server 2016
  • Windows 8
  • Windows 7
  • Windows 10
  • Windows 8

  • Windows 10

The following optional prerequisites are required to access some resources using BI xPress Server:

  • Security
    • Windows User account(s) that can be used to access databases, servers, and documentable objects within the user's organization
    • SQL Server User account(s) to use for accessing BI xPress Server databases
  • Auditing Framework
    • Each version of SQL Server Integration Services that the user wishes to apply the auditing framework to.
    • Any Third-Party Products (Connection Managers, Tasks, Components, etc.) that are used within the SSIS Package(s)

The following browsers are supported by BI xPress Server:

  • Mozilla Firefox 29 or later
  • Internet Explorer 8 or later
  • Google Chrome 35 or later

Note:  JavaScript must be enabled within the Web Browser for proper viewing of BI xPress Server.

Software Requirements for other Workbench Server products:

The following optional prerequisites are required to access some resources using DOC xPress Server:

  • Security
    • Windows User account(s) that can be used to access databases, servers, and documentable objects within the user's organization
    • SQL Server User account(s) to use for accessing DOC xPress Server databases
  • Documentation
    • CHM
      • HTML Help Workshop and Documentation

The following optional prerequisites are required to access some resources using DOC xPress Visual Studio Extension: 

  • Visual Studio 2012 (Professional, Premium, or Ultimate Edition)
  • Visual Studio 2013 (Professional, Premium, or Ultimate Edition)
  • Visual Studio 2015 (Professional, Premium, or Ultimate Edition)

The following optional prerequisites are required to access some resources using DOC xPress Remote Agent:

64-bit Operating Systems:32-bit Operating Systems:




Providers:

SQL:

64-bit Operating Systems:32-bit Operating Systems:

SSAS:

64-bit Operating Systems:32-bit Operating Systems:SSAS Azure Analysis Services:
  • Microsoft Azure Analysis Services Client Libraries


SSIS:

  • Each version of SQL Server Integration Services (2005 or above) that the user wants to snapshot.
  • SQL Server Data Tools or Business Intelligence Development Studio.

SSRS:

  • Each version of SQL Server Reporting Services (2005 or above) that the user wants to snapshot.
  • SQL Server Data Tools or Business Intelligence Development Studio.
  • Support provided for the following report locations:
    • File System: SQL Server 2005 and above
    • Native Web Services: SQL Server 2008 R2 and above
    • SharePoint Web Service: SQL Server 2008 R2 and above

Unsupported: Hive, Informatica, and Oracle are no longer supported by DOC xPress Server.

The following optional prerequisites are required to access some resources using LegiTest Server:

  • Scheduling Test Assemblies
    • MSTest Suites: Microsoft Visual Studio 2013 or Agents for Microsoft Visual Studio 2013
    • NUnit Test Suites: NUnit Test Console
    • Any software requirements (SSIS, SSAS, etc.) used by LegiTest needed to execute a deployed test suite

Required Permissions

Important:  Many of the Application Service accounts need db_owner. These accounts issue updates to the database that may alter the schema of the database.

The following is a comprehensive list of each account and their required permissions:

Application Pool Identities:

Workbench Server Application Pool:

  • User and Administration database:
    • db_owner
  • LegiTest Server database:
    • db_owner
  • LegiTest Command Line Execution and Task Scheduler:
    • Local Security Policy:
      • Log on as batch job
    • Any permissions (databases, report servers, file system, etc.) required to successfully run a LegiTest Test Suite deployed to the server

BI xPress Application Pool:

  • BI xPress database:
    • db_owner
  • SSIS Monitoring Console:
    • For importing package layouts from SSIS Catalogs:
      • db_datareader
  • SSRS Monitoring Console:
    • SSRS ReportServer database(s):
      • db_datareader

DOC xPress Server Application Pool:

  • DOC xPress database(s):
    • db_owner

DOC xPress Data Handler Service:

  • DOC xPress database(s):
    • db_owner
  • Local Security Policy:
    • Log on as a service

DOC xPress Remote Agent Required Permissions

  • Local Security Policy:
    • Log on as a service
  • Technology-specific permissions:
    • SQL Server
      • Definition permissions for any object you want to document
    • SQL Server Analysis Services Multidimensional:
      • Read definition permission on each database object you want to document
    • SQL Server Analysis Services Tabular:
      • Administrator permission on each database object you want to document
    • SQL Server Integration Services
      • SSIS Catalog:
        • Read and Modify permission for each project within the SSISDB the user wants to analyze
    • SQL Server 2008 R2 (or higher) Reporting Services
      • Folder Security Settings:
        • Minimum Predefined User Roles required:
          • My Reports
          • Content Manager
        • Minimum Tasks required for a custom User Role:
          • View Reports
          • View Folders
          • View Data Sources
          • View Models
          • Consume Reports
      • Web Service Security Settings:
        • Minimum Predefined System Role required:
          • System User
        • Minimum Tasks required for a custom System Role:
          • Execute Report Definitions
    • Tableau Permissions
      • User must be a part of the Server Administrator role

Unsupported: Hive, Informatica, and Oracle are no longer supported by DOC xPress Server.

Upgrading SentryOne Workbench Server

Upgrade your version of SentryOne Workbench Server by completing the following steps:

  1. Open the Control panel and uninstall your current version of SentryOne Workbench Server.
  2. Log into support.sentryone.com and navigate to the resources tab to download the latest release.
  3. Install the latest release using the Installation instructions

Managing Your Server

Manage your Workbench Server and BI xPress Server with System Settings. Open System Settings by selecting the gear icon at the top right of the navigation bar. 

Workbench Server System Settings

The system settings are divided into different pages:

Roles

Within Workbench Server's administration page, the Roles page allows you to create, edit, or delete roles that dictate the actions users can take and the securables they can view within Workbench Server. Workbench Server Roles tab

Viewing Role Members

View the users within a selected role by selecting the role category you want to manage.

Workbench Server Role members

Note:  Selecting a role such as Administrators displays a list of all users that are assigned to that role, their display name, date joined, and last login time.  Within the selected role page, you can edit the role assignment for any selected users.

Adding Users to Roles

Add users to a specific role by completing the following steps: 

  1. Open the desired role category.
  2. Select  Add users to (role) to extend the pane and display the user search bar.
  3. Enter a username, then select the search button or scroll through the user list, and select a user.  Workbench Server Add User to a role
  4. Select the checkbox next to the desired user, then select Add users to add the user to the selected role.

Removing Users from Roles

Remove users from a specific role by selecting the checkbox next to each user that you want to remove, then selecting Remove users from (role).Workbench Server Remove user from role

Creating a New Role

Create a new role by completing the following steps:

  1. Open the Roles page, then select Create new role to add a new row within the Roles table.  
  2. Enter a name for the role, then select whether to make this the default role to assign new users. 
  3. Select Update to add the role to the list of roles. 
Workbench Server create new role
Add Role name and select Update

Workbench Server Roles tab new role added
New Role added

Editing or Deleting a Role

Edit a role by completing the following steps:

  1. Select edit for the role you want to edit to open the naming box.
  2. Make the desired changes to the name, then select whether you want to specify the role as the default role. 
  3. Select update to save your changes. 

Delete a role by completing the following steps: 

  1. Select delete for the role you want to delete to open the warning prompt. 
  2. Select delete to confirm the deletion.Workbench Server Delete a role

Note:  Select Cancel to stop the deletion of the role.

Users

The User page displays a list of all current users that have accessed Workbench Server. Administrators can use the User page to manually add domain users to Workbench Server or delete users from Workbench Server.Workbench Server Users tab

Note:  Workbench Server automatically adds users once they open the server URL by default.

To delete a user, select delete next to the desired user. Select OK to confirm the deletion.Workbench Server Delete user prompt

Note:  Select cancel to stop the deletion of the user.

Administrators can manually add users to the server using the Add Domain Users button.Workbench Server Add Domain users

From here, administrators can filter and select any domain user they want to include.

Actions

The actions page provides a list of predefined actions for each of Workbench Server's Features that detail what each role can perform. The main actions page lists the actions, the feature it pertains to, and a description of that action. Workbench Server Actions tab

Select an Action Name to open that action's page. On the Action page you can add or remove roles assigned to the action. Workbench Server Action page

Note:  By adding a role to an action, you are granting the role permission to perform the action. Removing a role from an action prevents the role from performing the action.

Adding Roles to Actions

Add roles to a specific action by completing the following steps: 

  1. Select the desired action, then select Add roles to to extend the pane. 
  2. Use the Search bar to search for roles to add to the action. If you do not type anything into the search bar, you can search a list of all roles that have been created on Workbench Server. 
  3. Select the check box next to the desired role, then select Add roles...  next to the search bar.Workbench Server Add role to action

Success: A message displays confirming the role was added and the role appears in the list of roles associated with that action.Workbench Server role added to Action

Deleting Roles from Actions

Select the checkbox for the desired role and then select Remove roles from to remove a role from an action. Workbench Server Remove roles from action

Note:  Selecting Remove roles from displays a confirmation message and the role will no longer be in the list.

Securables

Within Workbench Server's administration page, the securables page gives more granular control over what each role can see within each DOC xPress solution. The Securables page displays as a tree list with all solutions and their solution items present within your server's DOC xPress Metabase. You can choose to change access to each individual solution item, or the entire solution itself.

Important:  Explicit allowed and deny permissions placed within solution items are only applied to DOC xPress Data Dictionary and Snapshot Comparison Features.

Workbench Server Securables tabBy default all roles are allowed on each solution and its solution items. Select All roles allowed to the right of the desired solution or solution item to display all the roles that currently have been granted or explicitly denied access to that particular solution or solution item.Workbench Server Securables Add role

Adding Roles to Solutions or Solution Items

To add specific roles, select add to open the add roles window, where you can select the roles you want to add to the specified solution or solution item.Workbench Server Securables Add roles to Full Environment

Once a role is added it appears in the allowed roles box. The added role now has an allowed/denied switch to easily grant or deny permissions for that role on the particular solution or solution item.

Removing Roles from Solutions or Solution Items

Remove a specific role from a solution or solution item by completing the following steps:

  1. Expand the drop-down menu located on the right of the specific solution or solution item.
  2. From within the list of allowed roles, select the check box next to the role you want to remove and then select remove.Workbench Server Securables Remove role

Workbench Features

Workbench Server Features tab

The features page displays all of the  installed Workbench Server products. Administrators can do the following:

  • Allocate users
  • See the version (whether it's a trial) 
  • Disable or enable beta features

Select a feature to view all of the users that are currently licensed for that particular feature. 

Note:  Workbench Server hands out licenses to users who log in until all user licenses have been consumed by default.

Note:  Features that are in beta are disabled by default. Enable beta features for general use within Workbench Server by selecting Enable next to the desired feature.

Adding Users to a Feature

Administrators can add users to a specific feature by completing the following steps:

  1. Select Add users to next to the desired feature to extend the pane and display the search bar.  
  2. Search for a user with the search bar, or leave the search bar blank to search a list of all users with access to Workbench Server. 
  3. Select the check box next to the desired user name, then select Add users next to the search bar to add the user.Workbench Server adding users to a feature

Important:  When new features are installed to your Workbench Server server, users  are automatically added to the new Feature from the Default Role. If no role is currently set as the Default Role, users from the Administration Role are added automatically instead.

Removing Users from a Feature

Remove users from a specific feature by selecting the check box next to each user that you want to remove and then selecting Remove users from.Workbench Server Removing users from a feature

Feature Settings

The feature settings page allows you to manage the automatic generation and retention count for each solution. Expand and collapse specific features to view settings related to that feature. 

BI xPress Server

Workbench Server Feature Settings for BI xPress Server

Auditing Framework

The following settings are available:

Setting Description
(Connection Manager) Database NameThe name of the database containing the BI xPress architecture.
(Connection Manager) NameThe name used for the auditing framework connection manager.
(Connection Manager) Offline ModeAutomatically sets the newly created connection manager to Work Offline. This allows you to browse and continue developing your packages when the BI xPress database isn't accessible.
(Connection Manager)Server InstanceThe name of the server where the BI xPress database is located.
(Connection Manager)Windows AuthenticationControls whether the auditing framework uses Windows or SQL Server Authentication.
(Custom Logging)Date Variable 1 - 3If custom logging is enabled, you can log up to three custom date variables.
(Custom Logging) EnabledAllows the auditing framework to explicitly log variables.
(Custom Logging) Numeric Variable 1 - 3If custom logging is enabled, you can log up to three custom numeric variables.
(Custom Logging) OnErrorIf custom logging is enabled, all custom variables are logged when an error occurs.
(Custom Logging) OnPostExecuteIf custom logging is enabled, all custom variables are logged at the end of the selected logging scopes.
(Custom Logging) OnPreExecuteIf custom logging is enabled, all custom variables are logged at the start of the selected logging scopes.
(Custom Logging) OnWarningIf custom logging is enabled, all custom variables are logged when a warning occurs.
(Custom Logging) Package LevelIf custom logging is enabled, you can log the custom variables at the package level for the specified events.
(Custom Logging) String Variable 1 - 3If custom logging is enabled, you can log up to three custom string variables.
(Custom Logging)Task LevelIf custom logging is enabled, you can log the custom variables at the task level for the specified events.
Configuration Folder PathThe default directory where your  SSIS configuration files are located.
Continue Execution on Auditing Database Connection FailureChanges the behavior of the Auditing Framework to allow SSIS packages containing the Auditing Framework to continue executing if the Auditing Framework fails.
Do Not Report Auditing FailureChanges the behavior of the Auditing Framework to hide all errors that occur due to the Auditing Framework.
Enable Data Flow MonitoringControls whether the Auditing Framework monitor data flows in real-time.
Enable Variable Change TrackingMaintains a historical record of all value changes to variables during execution.
Include Variable for Disabling Auditing FrameworkIncludes a variable or parameter within the package that manually controls whether the auditing framework is enabled.
Include Variable for Disabling Data Flow MonitoringIncludes a variable or parameter within the package that manually controls whether the auditing framework monitors data flows within the package.
Include Variable for Disabling Logging for All WarningsIncludes a variable or parameter within the package that manually controls whether the auditing framework logs warnings.
Include Variable for Disabling Variable, Parameter and Connection LoggingIncludes a variable or parameter within the package that manually controls whether the auditing framework will log variables, parameters, and connection managers.
Include Variable for Enabling Variable and Connection FiltersIncludes a variable or parameter within the package that manually masks sensitive values contained within variables and connection managers when you view the package from the Monitoring Console.
Log All VariablesLogs the values of variables when package execution is started, and when the package execution completes.
Log Connection Details for Source and Destination ComponentsIf Log Row Counts is enabled, Connection Detail Logging logs connection details for each source and destination component.
Log ConnectionsLogs every connection manager's connection string during run-time.
Log Destination Row CountsIf Log Row Counts is enabled, Log Destination Row Count tracks the number of rows that are going into destination components.
Log Initial Parameter ValuesIf enable variable change is enabled, this option logs the initial values of all non-sensitive parameters within SSIS packages 2012 and up.
Log Object VariablesIf enable variable change is enabled, Object Variable Logging logs object variables.
Log Row CountsControls whether the Auditing Framework captures row counts flowing inside data flows.
Log Source Row CountsIf Log Row Counts is enabled, Log Source Row Count tracks the number of rows that are coming from source components.
Log SQL StatementsIf Log Row Counts is enabled, Log SQL Statement logs the SQL Statements used to extract data.
Log VariablesIf enable variable change is enabled, Log Variables tracks all variables, or only tracks the variables used in For Each Loops.
Log WarningsControls whether to log warnings that are encountered during package execution in the BI xPress database.
Maximum Iterations to Log for Loop ContainersControls the number of loops in a For or For Each Loop that the auditing framework logs. Setting this value to 0 means all iterations will be logged.
Remove Project ItemsWhen removing the auditing framework, this property controls whether project level items will be removed or retained.
Use C# Script LanguageControls whether the scripts created are C# or Visual Basic
Use ConfigurationsSpecifies whether the auditing framework includes configurations.
Use File ConfigurationSpecifies whether to use a configuration file or parameters.

 Report Monitoring Console Settings

SettingDescription
Active Users CountControls the number of users to return for the Most Active Users dashboard.
Longest Running Reports CountControls the number of reports to return for the Longest Running Reports dashboard.
PasswordThe SQL Authentication password that's used to connect to the ReportServer database.

Note:  Leave this section blank to connect with Windows Authentication using the BI xPress AppPool Identity.
Refresh IntervalControls how often the monitoring console reloads your reports.
Report Averages CountControls the number of reports to return for the Most Frequent Reports dashboard.
Server InstanceThe name of the server where the ReportServer database is located.
SSRS Database NameThe name of the ReportServer database. The following is an example of SSRS database naming defaults:

Native Syntax Mode

ReportServer or ReportServer_{<NamedInstance>}

SharePoint Syntax

ReportingService_{<GUID>}

TimeoutThe timeout length for the Reporting Monitoring Console.
UsernameThe SQL Authentication username used to connect to the ReportServer database. Leave this blank to connect with Windows Authentication using the BI xPress AppPool Identity.

SSIS Monitoring Console Settings

SettingDescription
Database NameThe name of the database containing the BI xPress architecture.
Maximum Variable LengthSet the variable value to return before concatenation occurs. This property can increase performance by reducing the amount of data returned from the BI xPress database.

Note:  This does not affect the length of a variable value stored within the database, only how much is retrieved from the database.
Package Execution CountControls the number of executions that are returned.
PasswordThe SQL Authentication password that's used to connect to the ReportServer database.

Note:  Leave this section blank to connect with Windows Authentication using the BI xPress AppPool Identity.
Polling Interval (in seconds)Controls how often the monitoring console will reload package executions.
Server InstanceThe name of the server where the BI xPress database is located.
TimeoutThe timeout length for the Monitoring Console.
UsernameThe SQL Authentication username used to connect to the ReportServer database. Leave this blank to connect with Windows Authentication using the BI xPress AppPool Identity.

License

The license page displays all licenses associated with Workbench Server. View the license name, issue date, expiration date, maintenance expiration date, number of users, and if it's a trial. Users can also add a license, view details of a license, or update a license from this page.Workbench Server License tab

Important:  Users who have been assigned a role that is a part of the Administration action have access to the Web Administration portion of Workbench Server, where License information is found.

Automatically Activating a License

If you already have an activation key and the server where Workbench Server is installed on has Internet access, then you should be able to automatically activate Workbench Server. Complete the following steps to automatically update your license:

  1. Open the License page, then select Add a new License to begin the process of automatically activating your installation of Workbench Server.Workbench Server Add new license button
  2. Enter your Activation key in the text box and then select activate online to automatically activate your license of Workbench Server Feature.Workbench Server License tab activate online

Manually Activating a License

If you require the assistance of the SentryOne's Support Staff to receive your license, or the machine where you installed Workbench Server does not have Internet access, you may need to manually activate your license of Workbench Server Feature. Complete the following steps to manually activate your license:

  1. Open the License page, then select Add a new License to begin the process of automatically activating your installation of Workbench Server.Workbench Server Add new license button
  2. Select activate manually. Copy the Environment Identifier, Environment Key, along with your Activation Key, and e-mail the information to SentryOne Support.
  3. Once a SentryOne Support Representative has provided you with your license block, paste the license block into the license block text box and then select apply license to manually activate your license for the currently selected Workbench Server feature.Workbench Server License tab activate manually

License Detail

Selecting a license's details button provides you with more information about the license currently activated on the server. Update (automatically), manually update, or deactivate your license on the license details page.Workbench Server License detail page

Deactivating a License

If you plan to migrate Workbench Server from one machine to another and have already activated your license on the old machine, you need to deactivate your license on the old machine. Deactivate your license by completing the following steps:

  1. Open the License page, then select details next to the corresponding feature that you want to deactivate.
  2. Select deactivate at the bottom of the page to begin the deactivation process.Workbench Server deactivate license button
  3. Within the confirmation text box, type YES and then select the remove license to confirm deactivation and remove the license from the machine.

BI xPress Server FAQ

Custom User Accessible URL

By default, Workbench Server's setup instructions require the machine name or the fully-qualified machine name to be used as the user accessible URL that will be used to access Workbench Server through the web browser. 

Note:  Additional configuration is required after installation if you want to use a custom user accessible URL.

Warning:  The following configuration steps are designed for basic custom user accessible URLs within an intranet and should only be attempted by domain and web administrators. SentryOne is not responsible for any issues that may occur due to modifications to your organization's DNS.

Configure a custom user accessible URL by completing the following steps:

1. Follow the Setup Instructions for Workbench Server. Ensure the user accessible URL and host name are set to the default value as set within the installer. Everything else within the setup instruction can be customized for your environment.Workbench Server Website Configuration

2. Once Workbench Server has been installed, launch Internet Information Services (IIS) Manager on the host server. 

3. Open the Connections panel, expand the Sites node, then select the Workbench Server site.Workbench Server Internet Information Services select Sites

Note:  Depending on the settings the user configured during installation, the site's name may be different then what is shown below.

4. In the Actions panel, select the Bindings... action to open the Site Bindings dialog box. Select Add... to open the Add Site Binding dialog box. Type the host header that you want to use to connect within the Workbench Server, then select OK to continue.Workbench Server Add Site Binding

5. Once all the site bindings have been configured, select Restart within the Manage Website portion of the Actions panel to restart the Workbench Server site.

6. Connect to the intranet DNS Server once Internet Information Services (IIS) Manager has been configured. 

7. Launch Server Manager on the DNS Server. Use the left pane console tree to expand the DNS Server name in the Server Manager snap-in. Double-click on Forward Lookup Zones.Workbench Server New Alias (CNAME)

8. Select the DNS zone with the host server that Workbench Server is installed on from the displayed zones list. Right-click the DNS zone and select New Alias (CNAME)... to open the New Resource Record dialog box.

9. Use the alias name configured previously and use the fully qualified machine name that Workbench Server was installed on as the target host, then select OK.Workbench Server New Resource Record

Success: Workbench Server should now be configured to use a custom user accessible URL.Workbench Server Custom URL

Flushing the DNS Resolver Cache

In some rare cases, you may be unable to connect. In this instance, you need to flush your DNS Resolver Cache. To flush the DNS Resolver Cache, complete the following steps:

  1. Launch Command Prompt .
  2. Enter ipconfig /flushdns within the Command Prompt window and press Enter.Workbench Server Flush DNS Resolver Cache commmand prompt            

Managing User Account Information

To access the Manage Account page, select the profile icon in the top right of the navigation bar, then select your user name to open your account page. The top lists your Role memberships and all roles assigned to you. On the bottom of the page you can update your profile. You may change your display name as well as your biography. After making any changes, select save to save your changes.BI xPress Server Manage Account page

AlwaysOn Availability Group Considerations

Server Installation

Before beginning the installation process of Workbench Server, the users that will be set to run each of the application pools must have permission to connect to the availability group through the availability group listener.

Once the user(s) that will be running the application pools has been granted permission to connect to the availability group through the availability group listener, installation of Workbench Server can begin.

Installation of Workbench Server follows the default setup instructions with several noticeable differences:

  1. Ensure that the Workbench Server application pool is set to run as the user that was originally configured to have permission to connect to the availability group through the availability group listener.
  2. Ensure that the User and Administration database is configured so that its server setting is set to point to the availability group listener.
  3. Ensure that the BI xPress Server application pool is set to run as the user that was originally configured to have permission to connect to the availability group through the availability group listener.
  4. Ensure that the BI xPress database is configured so that its server setting is set to point to the availability group listener.
  5. Ensure that the BI xPress Server application pool is set to run as the user that was originally configured to have permission to connect to the availability group through the availability group listener.
  6. Ensure that the BI xPress database(s) are configured so that their server settings are set to point to the availability group listener.
  7. Ensure that the BI xPress Data Handler Service is set to run as the user that was originally configured to have permission to connect to the availability group through the availability group listener.
  8. Ensure that the LegiTest database is configured so that its server setting is set to point to the availability group listener.

Once Workbench Server installation has been completed, creation of the BI xPress, BI xPress, LegiTest, and Workbench Server databases occurs automatically on the primary availability replica and you can continue  adding the databases to the availability group as availability databases.

Adding the databases to the Availability Group

After creating your metabase, you can add it as an availability database to the availability group. 

Note:  The following process is the same way you would add any other database to an availability group:

  1.  Within the database properties, set the databases' recovery model to Full.
  2. Create a network share that each availability replica has permissions to access.
  3. Create a full back up of each database on the network share created in Step two.
  4. Expand AlwaysOn High Availability within management studio's object explorer. Right-click on the availability group that you want to add the database(s) to and then select Add Database...BI xPress AlwaysOn Add Database
  5. Walk through the steps within the Add Database to Availability Group wizard, ensuring the database(s) selected meet all of the prerequisites. On the Select Data Synchronization page, select Full and specify the network share created in Step two as the location accessible by all replicas.BI xPress Add Database to Availability Group

Note:  Once the BI xPress database has been added to the availability group as an availability database, connect to the metabase through the availability group listener.

Multi-domain Considerations

Warning:  SentryOne does not provide support, nor do we suggest these scenarios.

Almost all of the modifications require altering operating system, Internet Information Services, and domain settings. Proceed with caution and always make a backup before modifying anything.

The methods described below are for advanced IT administrators who are comfortable with and have been allowed to alter any required settings and/or security protocols. These helpful hints are only for illustrative purposes and each environment will have its own unique requirements and hurdles.

Workbench Server is a robust software suite that can span multiple assets within an organization, even those that lie on different Microsoft Windows Domains.  Below are some helpful hints and recommendations for implementing a multi-domain installation.

Workbench Server / SQL Database in Different Domains

Hosting Workbench Server on a computer that's in a different Microsoft Windows domain than the databases needed to store information can be accomplished by using Windows Authentication or SQL Authentication.  Accessing machines across domains carries additional security risks that need to be taken into consideration before implementing this scenario.

Complete the following steps to use Windows Authentication to access cross-domain databases:

1. Ensure that there's a domain trust between the two domains.  

Additional Information: See this  Microsoft MSDN for more information about the scenario listed above.

2. Open and secure any necessary ports for communication between Workbench Server and any SQL Server instance.  Port 1433 is the most common port assigned to SQL Server. 3. While installing Workbench Server:

  • The domain user used in the next two steps must belong to the domain that has trust.  The relationship defined within the Domain Controllers Domain Trusts area will dictate which domain the user must be defined within.
  • Ensure that the user installing Workbench Server has access to the other domain's database servers so that the installation SQL scripts can execute and create databases, tables, etc.
  • Specify a user for the various application pools which has access to the other domain's database servers.  This domain user will be used to run the website and will need to create, update, and delete database objects in the same manner as a single-domain installation.

Note:  If the domain user installing Workbench doesn't have the appropriate rights on the other domain, installation may fail.

Complete the following steps to use SQL Authentication to access cross-domain databases:

  1. Open and secure any necessary ports for communication between Workbench Server and any SQL Server instance.  Port 1433 is the most common port assigned to SQL Server.
  2. While installing Workbench Server, specify the SQL Server instance and database as usual although a static IP address will most likely be used instead of a friendly name.
  3. Be sure to include the user name and password as usual.

User / Workbench Server in Different Domains

Hosting Workbench Server on a computer that's in a different domain than the users that will be accessing it presents some challenges in making sure that both domains have a trust relationship. 

Additional Information: See this Microsoft MSDN article for information about Domain Trust and how to implement it. 

Once a trust has been established between domains, the domain users that should be allowed access must be granted permission to access Workbench Server.  This can be done in the Internet Information Services Manager.