About LegiTest Server

LegiTest Server gives you an easier glimpse at your tests and the results of the tests. You can drill into any given element to detect where a failure may have occurred. LegiTest Server also allows you to integrate test runs and alerts with the Notification Engine.

Release Notes

An archive of the release notes for LegiTest Server may be downloaded here as a PDF.

Installation

Workbench Server is the main application that LegiTest Server is hosted within. 

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

2. Uncheck the box Send feature usage statistics to SentryOne if you don't want to send feature usage statistics. Read the License terms and conditions, then select I agree to the License terms and conditions. Select Next to continue the installation. 

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.

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

Select Next to continue the installation.

5. Enter the connection information for the database that's used to store the user and administration information. Select Next to continue the installation. 

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.

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

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.

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

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. 

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.

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

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

 Select Next to continue the installation.

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. 

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:

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

Hardware Requirements

Determine your hardware requirements based on your environment's deployment model. LegiTest 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 LegiTest 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 LegiTest Server:

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 LegiTest Server and its associated assemblies while the databases are hosted within a SQL Server Instance. It is 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 LegiTest database is deployed.

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

Server Hardware Requirements:

Database Hardware Requirements:

Software Requirements

Before installing LegiTest 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
• Access to SQL Server 2008 or later instance

The following operating systems are supported by LegiTest 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, et cetera) used by LegiTest needed to execute a deployed test suite

The following browsers are supported by LegiTest Server:

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

Software Requirements for other Workbench Server products

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 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:

• Any edition of Microsoft Visual Studio 2012
• Any edition of Microsoft Visual Studio 2013
• Any edition of Microsoft Visual Studio 2015

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

Providers:

Hive:

Oracle:

SQL:

SSAS:

SSIS:

• Each version of SQL Server Integration Services (2005 or above) that the user wishes 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 wishes 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

Informatica PowerCenter:

If connecting to a SQL Repository: 

Required Permissions

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, et cetera) 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:
  • Hive
    • Read permissions for the HDFS files that you wish to document
  • Informatica
    • View definition permissions on the Informatica repository
    • Read permissions within the Informatica repository on any folder and object you wish to document
  • SQL Server
    • Definition permissions for any object you wish to document
  • SQL Server Analysis Services Multidimensional:
    • Read definition permission on each database object you wish to document
  • SQL Server Analysis Services Tabular:
    • Administrator permission on each database object you wish to document
  • SQL Server Integration Services
    • SSIS Catalog:
      • Read and Modify permission for each project within the SSISDB the user wishes 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
  • Oracle Permissions
    • Connect permissions on any schema that you wish to document
  • Tableau Permissions
    • User must be a part of the Server Administrator role

Managing Your Server

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

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.

Viewing Role Members

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

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 and then select the search button, or scroll through the user list and select a user.  
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 check box next to each user that you want to remove, and then selecting Remove users 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. 

Add Role name and select Update

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, and 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.

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.

To delete a user, select delete next to the desired user. Select Ok to confirm the deletion 

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

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. 

Select an Action Name to open that action's page. On the Action page you can add or remove roles assigned to 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.

Deleting Roles from Actions

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

Role Based Security

Below is a list of all configurable permissions that can be used in LegiTest Server:

Securables

Within Workbench Server's administration page, the securables page gives you a more granular level of control over what each role can see within a DOC xPress solution.

Workbench Features

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. 

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 and then select Add users next to the search bar to add the user.

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.

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.

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.
2. Enter your Activation key in the text box and then select activate online to automatically activate your license of Workbench Server Feature.

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.
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.

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.

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.
3. Within the confirmation text box, type YES and then select the remove license to confirm deactivation and remove the license from the machine.

LegiTest Server Features

The Dashboard is the first view that displays when you enter LegiTest Server. The Dashboard view allows you to navigate through all tests starting from the very top, the containing assembly, to the very end of any given test. The Dashboard view shows a glimpse of the amount of tests that failed or succeeded in their last run. You can also use the Dashboard to set where the notifications go for these items.

Use LegiTest Server to do the following:

1. Use the LegiTest Visual Studio Extension to create test suites.
2. Configure test suites to publish results and assemblies to a LegiTest Server.
3. From the server, configure and run published test suites. These scheduled test executions will publish their results back to the server.

Summary

With a quick glance at the name of the test object, you can see its status from the last run by looking at the symbol next to it. On the right side of the table, Pass/Fail data from the last run is also summarized so you can see how many items passed or failed.

Selecting the icon to the far right allows you to add a notification to the BixPress Server's Notification Engine.

When you select a test object you will be brought to run history page, unless the item you select is a Test. Selecting a Test opens the details page of the first failed assert if applicable, or the run details page if the Test is part of a Data Driven run. This allows you to quickly see all tests run while data driven.

Get more details on any test run by selecting on the run in the graph or the data table. The run detail page shows the entire test tree from the point selected. You can quickly see what items passed or failed from this page for that particular run. 

If an item has more detailed information to view, such as an assert, or an error for that particular step was thrown, a View Details link becomes accessible for that item. Viewing a completed assert takes you to a page showing what the assert was comparing, it's actual and expected result, and if it had passed or failed. This view also shows you any parameters that were used if it was a data driven run.

Viewing a failed item allows you to view the error thrown as to get further insight into what went wrong with the test step.

Viewing unexecuted assemblies:

The summary page has two views. The first (and default) is the Summary view. The second view is the Unexecuted Assemblies view. This view lists all assemblies that have been pushed to the server, but have yet to be executed. You can execute these tests from this view, and once complete, their results are pushed over the Summary view and removed from the Unexecuted Assemblies view.

Notifications

The Quality Dashboard can also be used as a shortcut for adding a notification to the Notification Engine that's triggered by a test object. Complete the following steps: 

1. Select the icon on the far right of the desired test to open the Add and remove notification menu.
2. Select add notifications to open a prompt for enrolling in notifications.
3. Enter the name of the notification, the event name that triggers the notification, and the severity of the notification. Select enroll to enroll the test object in notifications.

Tagging Test Objects

LegiTest Server allows you to add custom tags to any test object on the Dashboard. Tags are searchable and enable you to show all objects tagged with the desired filtering tag. 

Use the test management page for the desired test object to tag a test object. 

Filtering By Tag

To filter the summary page and show only items by a specified tag, do one of the following:

• Select any visible tag on the summary page.
• Use the search bar on the summary page. 

Filtering by tag displays all tags matching the specified search term and allows you to select any tag in the search results.

Once a tag is selected, you can see which tag is being displayed under the search bar. Select Remove Filter to remove the applied filter.

Viewing Grid Asserts

If an assert contains a grid comparison or validation, any errors are pushed to the server for you to view as a grid. Failed rows are highlighted in red, and rows that are not equal but within a set tolerance are highlighted in yellow.

You can export the table to Excel by selecting Export to Excel above the desired grid. Selecting Export to Excel saves the table as an .xls file that can be opened in Excel. 

You can select Switch View to view the expected and actual grids side by side instead of as one grid.

Grid Assert Hyperlinks

You can add hyperlinks to help manage test(s) that the grid/validation assertion belongs to. For grid comparisons, you can add a hyperlink per side (actual and expected hyperlink.) Validation grids have only have one hyperlink.

To access the Edit Hyperlinks page, drill down to the test, then select the wrench icon. 

Select Edit Hyperlinks to display the following configurable options:

Deleting Tests

Move Assemblies to the trash view of the summary page by selecting the blue trash icon. Select the test objects that you want to delete permanently from the trash view. 

After moving the assembly over to the trash, you are presented with the following two options: 

Empty Trash permanently deletes ALL test objects in the trash view, along with their runs.

Manage Tests

Select the wrench icon from the LegiTest Server Dashboard to open the Manage Tests page. 

On the Manage Tests page, you can do the following:

Navigation

The navigation menu to the left displays the latest status for that test object at a glance. Select any of these links to open the management page for that item. 

Tagging

Tagging a test object allows you to label your test objects with custom tags. These tags can be used on the Summary page for filtering, and on the Tag Permissions page for setting permissions for individual items. In the Tag section, select from exisiting tags on the server using the dropdown menu, or enter the name for a new tag. 

Server Testing

With LegiTest and LegiTest Server you can launch tests uploaded to the server from the LegiTest Quality Dashboard. Any uploaded test suite can also be scheduled to run on a schedule with LegiTest's command line.

Publishing Assemblies

Before running or scheduling tests from the server, you must push the test assemblies to the server.

To push test assemblies to the server, complete the following steps:

1. Right click the project you want to push to the server.
2. Select Publish to LegiTest Server to open the publish to server window.
3. Specify how and where to publish the assemblies and results. The following configuration options are available:

4. Once these settings are selected and you select ok, the required parameters for publishing updates and the assemblies push to the server. This gives you a flexible way of choosing the location of all assemblies and results, and managing a project with multiple suites.

Publishing Assemblies with the LegiTest CommandLine

Push assemblies using the included LegiTest CommandLine tool. To do so, the following switches must be used:

Example:

lh "localhost" -ma "C:/ToPublish/LegiTestProject.dll" -af "C:/ToPublish"

Running Test Assemblies

LegiTest server allows you to run a LegiTest Assembly from the LegiTest dashboard. When you log onto LegiTest and view your LegiTest dashboard, the top level items marked as Assemblies have two icons beside its name. The the green play button launches the selected test suite. The green calendar allows you to schedule the assembly to be run at a later time.

Running a test assembly displays a notification prompt about the test status. Once the test finishes, a success or failure message displays based on the outcome of the test. If the test run is successful, you can see the run information in the test runs, and drill down into the assembly. 

Command Line

If Workbench Server was not installed in the default location, or the installation is later moved, you need to update the configuration file for LegiTest Command Line. This configuration file is located by default at:

• C:\Program Files (x86)\Pragmatic Works\Workbench Server\LegiTest Command Line\PragmaticWorks.LegiTest.CommandLine.exe.config

The section that needs updating looks like the following example:

<appSettings>
       <add key="NUnitTestRunnerLocation" value="%programfiles(x86)%\NUnit 2.6.3\bin\nunit-console.exe" />
       <add key="MSTestRunnerLocation" value="%programfiles(x86)%\Microsoft Visual Studio 12.0\Common7\IDE\CommonExtensions\Microsoft\TestWindow\vstest.console.exe" />
       <add key="schtasks.exe" value="%windir%\System32\schtasks.exe" />
       <add key="LegiTestCommandLine" value="%programfiles(x86)%\Pragmatic Works\Workbench Server\LegiTest Command Line\PragmaticWorks.LegiTest.CommandLine.exe" />
</appSettings>

The value for each respective key needs to be changed if any of the following scenarios occur:

NUnitTestRunnerLocation

• A different version of NUnit is being used.
• the installation of NUnit is moved.

MSTestRunnerLocation

• A version other than Visual Studio 2013 is being used.
• The installation of Visual Studio 2013 is moved.

LegiTestCommandLine

• The default location for Workbench Server is not used.
• The installation of Workbench Server is moved.

Command Switches

LegiTest Server can perform many actions with the command line tool. The tool is found in the directory C:\Program Files (x86)\Pragmatic Works\Workbench Server\LegiTest Command Line. Double-click the file PragmaticWorks.LegiTest.CommandLine.exe.

Actions:

Runners:

Scheduling Test Assemblies

Select the green calendar button by the desired assembly name on the LegiTest dashboard to run your Test Assemblies on a schedule. Selecting the calendar button opens the scheduling page. After you've set your desired schedule you will be brought back to the LegiTest Dashboard. 

System Coverage

The System Coverage integration gives you visibility into the parts of your system that have been tested, and the status of those tests. 

Getting Started

To get started with the System Coverage feature of LegiTest, complete the following steps: 

1. Open a LegiTest suite in Visual Studio, and navigate to the Server Integration node. 

2. Enter the address of the server that contains the installation of Workbench Server to give access to the Doc xPress metabase, which is what the report will be built from.

3. After setting up your server, navigate to the System Coverage node and select a test. 

4. In the Doc xPress search section, we typed in GridStuff, because we want to specify that this specific test is responsible for representing the health of the GridStuff object. To do this, we highlight GridStuff, and select Add to add it to this test.

5. Once you have the items you want represented by this test, save the project. Make sure to select Push results on the server integration page. Once saved, run the test and then visit the server to create a report that includes this item.

6. Open the LegiTest Server dashboard to access the System Coverage on the server. Select System Coverage in the navigation bar to open the Reports dashboard.

7. For this example, select Create Report to open the create report page to begin creating a report.

8. Enter a report name. Use the search bar to search the Doc xPress metabase for items to add to the report. For this example, GridStuff was added, because we know that the GridStuff item was added to a test. This now becomes a report item in the report. When an item is added, the reporting for that item starts at the Path level for it, and then calculates downward. For this example we also add the \Databases path as a report item. Once you've added all of the desired report items, create the report. 

The report page opens after the report is created. The top report item is the total of all items added to the report. The second graph shown is for the GridStuff item we added. 

 The second report item, Databases, shows a percentage of failures, passes, and untested items.

Graphs are a quick way to view the status of your environment. Select Tree view to switch to a more detailed drillable view. Drill into a path to see where these failures and passes occurred.

During report creation, you can choose which view to default to. By selecting the Default to Tree View option above the Create Button, the report opens to the tree view.

Search Testable Objects

Use the Search Testable Objects page to find the latest status of a testable object and avoid creating a report to view just a single item. The search function works similarly to the search on the Create Report page because it also searches the Doc xPress metabase. The search function enables you to find out if the object was tested, and if so, if it passed or failed, or if its previous test was inconclusive.

Edit Testable Paths

The Edit Testable Paths page allows you to manage which paths are tested. By default, most well known paths are added. If you need more paths to be tested, such as custom paths, you can add them on this page. 

System Dashboard

Items from the LegiTest Server's system coverage can be added to the Workbench Server System Dashboard. 

To add a LegiTest System Coverage tile to the System Dashboard, select System Dashboard at the top navigation bar to open the System Dashboard page.

Select an action icon on the dashboard pane to perform one of the following actions:

You can rearrange the order of tiles by dragging and dropping them within the page.

System Dashboard Settings

System Dashboard Settings allows you to create, edit, and delete tiles to be used in the System Dashboard. To add a LegiTest System Coverage tile to the System Dashboard complete the following steps:

1. Select Select tile to add to your dashboard... checkbox and select Legitest System Coverage. 
2. Select + Add Tile to open the LegiTest System Coverage configuration page.

System Coverage

In the Add New Tile - LegiTest System Coverage page, you can configure the following:

Frequently Asked Questions

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. 

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

1. Follow the Setup Instructions for Workbench Server. Make sure 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.

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 and then select the Workbench Server site.

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, and then select OK to continue.

5. Once all of 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.

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.

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.            

Managing User Account Information

Select the profile icon in the top right of the navigation bar, then select your username to open the Manage Account page. View your Role memberships (a list of roles assigned to you) and make updates to your profile. Makes changes to your display name or biography (if desired) then select save to update your profile information. 

Multi-domain Considerations

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 Databases

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.

Using Windows Authentication to access cross-domain databases

1. Ensure that there's a domain trust between the two domains.  The following Microsoft TechNet article explains: https://technet.microsoft.com/en-us/library/cc961481.aspx
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. Complete the following 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.

Using 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.

Users / Workbench Server

AlwaysOn Availability Group Considerations

If you want to install Workbench Server database(s) to an AlwaysOn Availability Group as availability databases, you should consider the following:

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 have been granted permission to connect to the availability group through the availability group listener, installation of Workbench Server can begin. Installation of Workbench Server will follow 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 DOC 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 DOC xPress database(s) are configured so that their server settings are set to point to the availability group listener.
7. Ensure that the DOC 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, DOC xPress, LegiTest, and Workbench Server databases will occur automatically on the primary availability replica and then you can continue on to adding the databases to the availability group as availability databases.

Adding the databases to the Availability Group

Once the database(s) have been created, the database(s) can now be added as availability database(s) to the availability group. This is done in the exact same way a user would add any other database to an availability group:

1. Within the database properties, ensure that the databases' recovery model is set to Full.
2. Create a network share that each availability replica has permissions to access.
3. Create a full backup of each database on the network share created previously.
4. Once all of the databases have a full backup located on a network share, expand AlwaysOn High Availability within management studio's object explorer.
5. Right-click on the availability group that the user wishes to add the database(s) to and select Add Database...
6. Walk through the steps within the "Add Database to Availability Group" wizard, ensuring the database(s) selected meet all prerequisites. Select Full and specify the network share created previously as the location accessible by all replicas on the Select Data Synchronization page.

Once the BI xPress, DOC xPress, LegiTest and / or Workbench Server database(s) have been added to the availability group as availability databases, whenever you want to connect to the databases, you should connect through the availability group listener.

Cannot Find MS Test or NUnit Test Runner

When running tests from the server, you may encounter an error stating that the server can not find the MSTest or NUnit test runner. This can occur if you have the these items installed in non-default areas. To change where the LegiTest Server looks for these items, edit the config file found by default here: 

C:\Program Files (x86)\Pragmatic Works\Workbench Server\LegiTest Command Line\PragmaticWorks.LegiTest.CommandLine.exe.config

The following sections in bold need to be updated to match the user's install location for MS Test or NUnit:

<appSettings>
       <add key="NUnitTestRunnerLocation" value="%programfiles(x86)%\NUnit 2.6.3\bin\nunit-console.exe"/>
       <add key="MSTestRunnerLocation" value="%programfiles(x86)%\Microsoft Visual Studio 12.0\Common7\IDE\CommonExtensions\Microsoft\TestWindow\vstest.console.exe" />
       <add key="schtasks.exe" value="%windir%\System32\schtasks.exe" />
       <add key="LegiTestCommandLine" value="%programfiles(x86)%\Pragmatic Works\Workbench Server\LegiTest Command Line\PragmaticWorks.LegiTest.CommandLine.exe" />
</appSettings>

Addendum: LegiTest Visual Studio Extension

LegiTest System Coverage

System Coverage displays objects that have been tested within a system. System Coverage has two modes of operation: DOC xPress integrated, and standalone.

DOC xPress Integrated

In DOC xPress Integrated mode, information about the objects available for tests comes from DOC xPress Server. Because there is a solution snapshot present, the system can tell you the items that are available to test. LegiTest Client displays the DOC xPress Metadata Search tool, and you can select items from your DOC xPress Server to mark as tested. There are four available categories of test output:

Standalone

In standalone mode, there isn't any information about the objects available to test. In this mode, System Coverage is only able to show the first three categories of output (Passed, Failed, Inconclusive). The system collates data based on the identifiers you assign to individual items.

Setting up Coverage Information

When setting up system coverage there are two parts that must be configured:

• the binding of items to tests 
• the configuration of viewable reports on the server. 

In the client, selecting the System Coverage node in a test group displays the following:

On the right is the DOC xPress Metadata Search which allows you to find items to mark as covered. On the left is a tree that represents the content of the current group / suite. Entering a search term returns results from the server.

By selecting an item in the left hand tree and then double clicking the found item in the right hand pane, the item is bound to the test. Now when the test runs, that item is considered covered and has a Passed, Failed, or Inconclusive status depending on the test outcome.

LegiTest Viewing Reports

Select the Reports node under System Coverage to display system coverage reports from the Server in the LegiTest Client. Selecting the Reports node produces a list of the coverage reports available on the server.

Select a report, and then select View this report to display the graph view of the report. The graph view contains a summary graph, and a graph for each coverage report item that's configured.

Select View as tree to change the view to a detailed tree view that displays all the available objects, and their status.