Setup Instructions

Parent Previous Next


Server Setup Instructions


Table of Contents

  Hardware Requirements

  Software Requirements

  Required Permissions


Workbench Server is the main application that LegiTest Server is hosted within. However, the features will 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.   If you do not wish to send feature usage statistics, uncheck the box "Send feature usage statistics to Pragmatic Works".

3.   Make sure to read the License terms and conditions before checking "I agree to the License terms and conditions". When you are done reviewing the settings for the current page, click "Next".

Important Note:

The "Use previous installation settings" option helps users upgrading from older versions. This option attempts to gather as much of the previous installation's settings as possible. For example, the application pool identities may need reconfiguring.


Please review each configuration page before continuing.



4.   On the "Select Components" page, you should see an itemized list of the components Workbench Server will be installing as well as the total space required. When you are done reviewing the settings for the current page, click "Next".



5.   On the "Workbench Server Website Configuration" page, you can configure the website that Workbench Server will be accessed from. When you are done reviewing the settings for the current page, click "Next".

1.   Workbench Server URL: This is the URL that users will enter into their web browser to access Workbench Server. If the user wishes to have Workbench Server associated with a different port number than the industry standard port 80 (or 443 for https), please include the port number using the following syntax:



http[s]://<ServerName>[:<Port>]/


 

2.   Run application pool as: This is the user account that the website will use for accessing the database, server files, and resources. This user account should already have access to the database(s) and server(s) that will be accessed and documented. This user should have database access that should include the ability to create, update, and delete tables, stored procedures, and other database objects.


1.   Application Pool Identity: An IIS controlled user account designed to have minimal permissions to only the server that Workbench Server is being hosted on.

2.   Network Service: A built-in Windows user account that has limited network permissions. Generally, the Network Service account will only have access to resources on the same computer hosting Workbench Server.

3.   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 as well as local and remote resources such as files and/or folders. The advantage to using a specific local or domain user account is that it is easier to maintain and grant permissions to local and remote databases by system administrators.


Important Note:

The user account that Workbench Server Website's Application Pool is authorized to use, whether it is the Application Pool Identity, Network Service, or Specific User, will dictate the option that will also be 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 Workbench Server is being installed on, then a specific domain user must be used by the Application Pool Identities as well as the DOC xPress Data Handler Service.


6.   On the "User and Administration Database" page, setup the connection information for the database that will be used to store the user and administration information. When you are done reviewing the settings for the current page, click "Next".


Important Note:

If users are planning on having the User and Administration Database located on a different system than the Workbench Server website and the setting Windows Authentication is intended to be used, the Workbench Server Application Pool configured in Step 5 must be run using a domain user account.



7.   On the "BI xPress Server Website Configuration" page, if "User specified below" was selected for the Workbench Server Application Pool on the "Workbench Server Website Configuration" page, then a different User name and password can be input in here. Otherwise, click "Next".


8.   On the "BI xPress Database" page, setup the connection information for the database that will be used by BI xPress Server for use within the Monitoring Console. When you are done reviewing the settings for the current page, click "Next".


Important Note:

If you are planning on having the BI xPress Database located on a different system than the Workbench Server website and you wish to use Windows Authentication, the both the BI xPress Application Pool configured in Step 7 and the Workbench Server Application Pool configured in Step 5 must be running using a domain user account.



9.   On the "DOC xPress Server Website Configuration" page, if "User specified below" was selected for the Workbench Server Application Pool on the "Workbench Server Website Configuration" page, then a different User name and password can be input in here. Otherwise, click "Next".



10.     On the "DOC xPress Server Databases" page, this page details the settings on how you wish for the DOC xPress Server meta data to be distributed. When you are done reviewing the settings for the current page, click "Next".

Important Note:

If users are planning on having the DOC xPress Database located on a different system than the Workbench Server website and the setting Windows Authentication is intended to be used, the DOC xPress Application Pool configured in Step 9 must be run using a domain user account.


Single Database: If you wish to store all of the meta data in a single DOC xPress Server database, go to Step 10.1.

Multiple Databases: If you wish for your meta data to be stored in up to four separate databases, go to Step 10.2.



1.   On the "Single DOC xPress Database" page, setup the connection information for the database that will be used to store the DOC xPress Server meta data information. When you are done configuring the settings for the current page, click "Next".



2.   On the "Multiple DOC xPress Database", setup the connection information for the databases that will be used to store the DOC xPress Server meta data information. When you are done configuring the settings for the current page, click "Next".


1.   Command Query Store: The DOC xPress metabase that DOC xPress Desktop Application users connect to in order to manage and create snapshots and data dictionary categories.

2.   Dictionary Query Store: An optimized database used to store Data Dictionary content for use within DOC xPress Server.

3.   Generator Query Store: An optimized database used to store metadate regarding DOC xPress Server generated documentation.

4.   Browser Query Store: An optimized database used to store the structure of objects for use within DOC xPress Server.


Important 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.   On the "DOC xPress Data Handler Service" page, you can configure the DOC xPress Data Handler Service and how you wish for the Service to log on as. When you are done reviewing the settings for the current page, click "Next".



Important Note:

The DOC xPress Data Handler Service is a service that runs in the background and performs all of the DOC xPress documentation generation and processing. By default, this service should be running when the computer starts up and also after installation.


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.


Additionally, if documentation is not being generated, please ensure that this 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.   On the "DOC xPress Settings" page, configure server paths to server directories. When you are done reviewing the settings for the current page, click "Next".


1.   DOC xPress Templates Directory: This directory that contains server templates that will be used to lend form and reason to the output in DOC xPress Server.

2.   DOC xPress Output Directory: This is the directory that will contain all of the documentation that is generated by DOC xPress Server.

3.   CHM Compiler Application Path: This is the path to the CHM Compiler that is installed on the server.



Important Note:

Currently, 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.   On the "LegiTest Server Database" page, setup the connection information for the database that will be used to store the LegiTest Server test suite history and assemblies. When you are done configuring the settings for the current page, click "Install".


Important Note:

Once the user clicks the "Install" button, Workbench Server will first begin downloading and installing the necessary software prerequisites. After installing the software prerequisites, Workbench Server will begin installing the necessary software. Once installation has completed, it may take several minutes while the server self configures before the website becomes operational. Please be patient during this configuration process.



14.   Now that installation has completed, the administrator needs to allow users and/or groups within IIS to access the homepage of Workbench Server.  Fine grained control of users is handled within Workbench Server's administrative area.


Important Note:

Once the user clicks the "Install" button, Workbench Server will first begin downloading and installing the necessary software prerequisites. After installing the software prerequisites, Workbench Server will begin installing the necessary software. Once installation has completed, it may take several minutes while the server self configures before the website becomes operational. Please be patient during this configuration process.


1.   Open IIS, right-click on the Workbench Server site, click Edit Permissions...



2.   Navigate to the security tab. Click Edit...



3.   Click Add...



4.   Add any individual users and groups that need access to Workbench Server's homepage.  When finished, click OK for all the remaining dialogs to close them.