certify business process procedure installation guide · creating a certify bpp database 6 certify...

Worksoft, Inc. · 15851 Dallas Parkway, Suite 855 · Addison, TX 75001www.worksoft.com · 866-836-1773

Certify Business Process Procedure™

Installation Guide

PN BPPIG 92 011018

Certify Business Process Procedure Installation Guide

Version 9.2

© Copyright 2018 by Worksoft, Inc. All rights reserved.

Worksoft is a business name of Worksoft, Inc. Information in this document is subject to change and revision without notice. No part of this manual may be reproduced by any means, electronic or mechanical, for any purpose other than the purchaser’s personal use, without prior written permission from Worksoft.

Worksoft provides this documentation “as is” without warranty of any kind, either express or implied. Worksoft may revise information in this document without notice and does not represent a commitment on the part of Worksoft, Inc.

Worksoft, Inc. may have patents or pending patent applications covering subject matter in this document. The furnishing of this document does not give you any license to these patents except as expressly provided in any written license agreement from Worksoft, Inc.

Patent

Worksoft Certify®

U.S. Patent No. 7,600,220

Trademarks

Worksoft Certify® is a registered trademark of Worksoft, Inc.

All other trademarks and trade names mentioned in this guide are the property of their respective owners.

Certify Business Process Procedure Installation Guide 3

Table of Contents

Chapter 1 Preparing to Install Certify BPP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4

Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5

System Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5

Creating a Certify BPP Database . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5

Chapter 2 Configuring Your Application Web Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7

Configuring Your Application Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8

Adding Roles and Features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8Configuring the Web Server Role (IIS) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14

Configuring Application Pools . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16

Enabling IIS Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17

Chapter 3 Installing Certify BPP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18

Installing Certify BPP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19

Accessing Certify BPP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28

Upgrading Certify BPP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28

Chapter 4 Uninstalling Certify BPP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29

Uninstalling Certify Business Process Procedure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30

Appendix A Using Certify BPP Templates for Worksoft Certify Reports . . . . . . . . . . . 31

Chapter 1 Preparing to Install Certify BPP

In This Chapter

Overview .............................................................................................................................. 5

Creating a Certify BPP Database ............................................................................................. 5


Overview

Overview

Certify Business Process Procedure™ (BPP) product is a web-based reporting tool that automatically generates comprehensive reports with any Worksoft Certify® integration tests. This guide contains information on how to install and configure Certify BPP from start to finish.

System Requirements

Before you begin to install the product, verify that your web server, client machines, and database server meet the requirements listed in the Worksoft Help Portal.

Creating a Certify BPP Database

You need to create your database for Certify BPP before you install the product.

To create your Certify BPP database:

1 Locate the Apply.exe utility within your Certify BPP distribution package:

...\Worksoft Certify Process Reporting\BPP_Database\

2 Double-click Apply.exe.

The Apply utility opens.


http://docs.worksoft.com/

Creating a Certify BPP Database

3 In the Apply tool’s text fields, type in the following database connection information:

• Database server name

• Database name

4 In the SA User and SA Password fields, type the system administrator user name and password to access the database server.

5 Click Start.

The Apply utility begins to create your new database.

Be sure to note your database connection strings that you created for the new Certify BPP database and for all Certify databases that you intend to use for reports. You will need this information for the installation process.

6 Certify Business Process Procedure Installation Guide

Chapter 2 Configuring Your Application Web Server

In This Chapter

Configuring Your Application Server ........................................................................................ 8

Configuring Application Pools................................................................................................ 16

Enabling IIS Services ........................................................................................................... 17


Configuring Your Application Server

Configuring Your Application Server

In order to transform your application server into a web server, Microsoft® Internet Information Services (IIS) must be installed in order to host Worksoft Web services and Worksoft web applications. After you have installed IIS, you will need to configure the Server Manager.

This chapter will guide you to configuring the minimum requirements for Worksoft products. You may need assistance from your IT administrator.

Adding Roles and Features

The Server Manager allows you to add specific roles and features to your web server that are required for Worksoft products.

To add roles and features to your web server:

1 From the Start menu, select Administrative Tools > Server Manager.

The Server Manager opens.

2 In the Navigation pane, select Dashboard.

3 In the Summary Tasks pane, select Add Roles and Features.

The Add Roles Wizard opens.

4 Click Next.



The Select Installation Type page appears.

5 Select the Role-based or feature-based installation option.

6 Click Next.



The Select Server Roles page appears.

7 From the Server Roles list, select the following roles:

• File Services

• Web Server (IIS)

8 Click Next.

After you have added the roles to the web server, you will add features to the web server.



A dialog box appears asking if you want to add features to the web server.

9 In the Add Features dialog box, select the Include Management Tools (if applicable) option.

10 Click Add Features.

The Select Features page appears.



11 Select the .NET Framework 3.5.1 Features (Installed) and all of its child nodes.

12 Select the WCF Services (Installed) and all of its child nodes.

13 Use the scroll bar and select the next features to add:

• Remote Server Administration Tools (Installed)

• Child node Role Administration Tools (Installed)

• Child node Web Server (IIS) Tools (Installed)

You may receive a message that states the following:

To install Active Directory Rights Management Services Tools, this server must be joined to a domain. Before you can continue, you must join this server to a domain. Cancel this wizard and join the server to a domain. Then, run this wizard again.

If you do receive this message, cancel the wizard and join the wizard to the domain.



14 Use the scroll bar and select the Windows Process Activation Service and all of its child nodes.

15 Click Next.

The Web Server Role (IIS) page appears.


Configuring the Web Server Role (IIS)


After you have added your roles and features, you will now need to configure the Web Server role (IIS) in the Server Manager.

1 Click Next on the Web Server Role (IIS) screen.

The Select Role Services page appears.

2 In the Role Services list, select the following services. You will need to use the scroll bar to select all of the services.

Node Child Nodes

Common HTTP Features Default Document

Directory Browsing

HTTP Errors

Static Content

Health and Diagnostics HTTP Logging

Request Monitor



3 Click Next.

The Confirm Installation Selections page appears.

4 Click Install to install the role services.

Application Development ASP.NET 3.5

ASP.NET 4.5

.NET Extensibility 3.5

.NET Extensibility 4.5

ASP

CGI

ISAPI Extensions

ISAPI Filters

Security Request Filtering

Performance Static Content Compression

Management Tools IIS Management Console

Management Service

IIS 6 Management Compatibility and all of its child nodes

Node Child Nodes


Configuring Application Pools

Configuring Application Pools

Application pools are required in IIS to manage how web applications are hosted. Worksoft products require that you create two different application pools. This section will help you configure application pools that you can use for Worksoft web applications.

Note: If you are upgrading from Certify BPP v9.1, you will need to create a new application pool on your application server. Go to Advanced Settings and set Enable 32-bit Applications to False. Reusing the old application pool is not recommended.

To configure your first application pool:

1 In the Server Manager, select Roles > Web Server (IIS) > Internet Information Services (IIS) in the left Navigation pane.

A secondary Navigation pane named Connections appears.

2 In the Connections Navigation pane, expand the nodes under your web server name and select Application Pools.

3 In the far right Action pane, click Add Application Pool.


Enabling IIS Services

The Add Application Pool dialog box appears.

4 In the Name field, type BPP.

5 In the .NET Framework Version drop-down list, select .NET Framework v4.0.30319.

6 In the Managed Pipeline Mode drop-down list, select Integrated.

7 Select the Start Application Pool Immediately option.

8 Click OK.

The application pool that you created appears in the Application Pools pane.

Enabling IIS Services

You will now need to verify that several IIS services are enabled.

To verify IIS services are enabled:

1 If the Server Manager is not open, select Administrative Tools > Server Manager from the Start menu

The Server Manager opens.

2 In the Navigation pane, select IIS.

3 In the right Services pane, verify that the following services are enabled and running:

• Application Host Helper Service

• IIS Admin Service

• Windows Process Activation Service

• World Wide Web Publishing Service

4 If any of these window services are not running, you will need to start these services.

To start a service, select the service from the list and click Start in the right menu. You are also able to start your services by going to Administrative Tools > Services on your machine.


Chapter 3 Installing Certify BPP

In This Chapter

Installing Certify BPP ........................................................................................................... 19

Accessing Certify BPP........................................................................................................... 28

Upgrading Certify BPP.......................................................................................................... 28


Installing Certify BPP


Before you install Certify BPP, the IIS must be installed and configured on the server.

To install Certify BPP:1 In the Certify Business Process Procedure package, double-click on the Certify Business Process

Procedure.exe file.

The Certify Business Process Procedure Installer opens.

2 Click Next.

When the system analysis has completed, the Custom Setup page appears.



This page allows you to change how the feature is installed.

These directories can be installed on separate machines or on the same machine. If these directories are installed on separate machines, then the Worksoft Certify BPP Web Applications directory and the Certify BPP Web Services must be available on a public website.

The directories used for file archives must be shared and located on the same drive for both machines. For example, if you have the ActiveLink file archives located on D:\Archives, then the remote machine must have the D drive mapped to the shared drive on the Web Services machine as D:\Archives.

3 Click on a program icon in the list to change how the feature is installed by selecting one of the following of options:

• Will be installed on local hard drive

• Entire feature will be installed on local hard drive

• Entire feature will be unavailable

Directory Description

Worksoft Certify BPP Web Applications

Contains two web applications:

• Certify BPP Web Application

• ActiveLink

The ActiveLink application allows the user to view archive items and filter them according to the data source, project, and process.

Worksoft Certify BPP Data Services Contains the following:

• Administrative tool

• Certify BPP Web Services

• Certify BPP Windows Services



4 Click Next.

The Destination Folder page appears.

5 If you want to accept the default directory for your installation files, click Next.

If you do not want to accept the default directory for the installation files, click the Change button to select a different installation directory for the Certify BPP client, and then click Next.

The first web component registration page appears.



There are three web components that you will be registering within IIS. To simplify the installation process, register all of these components underneath the Default Web Site and use three independent virtual folders.

If you are sharing your web server with other non-Worksoft products, then you may need to take advantage of the Certify BPP’s flexibility of creating a new website or multiple websites that are hosted on different ports.

6 In the IIS Website field, select the Default Web Site value or select an existing site in the drop-down list. The website must be a public website.

7 In the Virtual Folder text field, type in a new folder name or accept the default name. The name must not contain any spaces.

If you are creating a new website and not sharing that website with another Certify BPP web component, leave the Virtual Folder field blank so that the folder will be registered under the website itself. After you create a website, you may need to adjust the port settings manually within IIS.

8 Click Next.

The second web component page appears.




11 Click Next.



The third web component page appears.




14 Click Next.

The Certify BPP Web Service URL page appears.



15 In the BPP Web Service URL field, type in the full URL for the BPP core web application. This URL will not be used by users. It is used internally within the Certify BPP software components.

This URL corresponds to the BPP Web Services page that you have already specified in this installer in Step 6. If you used Default Web Site as your value, then the default URL value should be used in this step.

If you created a new website, you may need to specify a port in your IIS. Before continuing this installation process, complete the manual adjustments in the IIS.

If you have created a new website, then the URL must coincide with the host header tag or DNS IP address of the IIS website.

If you are using the default website with a virtual directory, then type in the machine name and specified virtual directory.

16 Click Next.

The Certify BPP Database Configuration dialog box appears.

17 In the Database Server Name text field, type in a server name.

18 Select which Security option Database Authentication.

19 In the Database User Name and Database Password fields, type the user name and password.

Note: Certify BPP does not support Windows authentication.



20 Click the Test/Continue button to test your connection.

If the test fails, you will need to troubleshoot the database connection.

21 From the Database Name drop-down list, select the Certify BPP database that you created before installation.

22 Click Select.

The Certify BPP Core WCF Service Configuration page appears.

This page is where you will specify the connection information for the Certify BPP database. The data source connection strings that you specify on this page will display in Certify BPP as the available data sources to run reports. Certify BPP is able to generate reports from more than one database.

23 In the Certify Data Source Connection Strings field, type in one or more database connection strings for the Certify database(s) you want Certify BPP to report against. You need to list at least one database string, and each name needs to be unique.

24 Click Next.



The Email Settings page appears.

25 In the Email Address field, type in the email address that will be sending the report.

26 Click Next.

The SMTP Settings page appears.

Certify BPP sends out email notifications when a new report is created. You will need to specify the SMTP server that will send out the email notifications.



27 In the respective fields, type in the following:

• SMTP Server

• SMTP Server Port

• SMTP Login

• SMTP Password

If the settings are not valid, Certify BPP will still be functional; however, the size of your log file will be affected since Certify BPP will log errors for all of the failed email notifications.

28 Click Next.

The Completing the Certify BPP Installation page appears.

29 Click Next to begin the Certify BPP configuration.

The Certify BPP installer verifies the following:

• IIS settings

• ASP.NET v4.0 for all of the web applications

• URLs that have DNS entries that can be reconciled by users

• Unique websites that are either running on unique ports or host headers


Accessing Certify BPP

The installation process completes, and the Completing Certify BPP Installer page appears.

30 Click Finish to complete the installation.

Accessing Certify BPP

The URL address for Certify BPP is configured during installation:

http://<server>/<virtual folder name>/If you have any questions about your specific URL address, please ask your IT administrator.

Upgrading Certify BPP

To upgrade your Certify BPP version, you will need to uninstall your previous version before you install the new version. For more information about uninstalling the product, see Chapter 4 “Uninstalling Certify BPP”.

Also, you will need to create a new application pool on your application server. For more information, see “Configuring Application Pools” on page 16.


Chapter 4 Uninstalling Certify BPP

In This Chapter

Uninstalling Certify Business Process Procedure ..................................................................... 30


Uninstalling Certify Business Process Procedure

Uninstalling Certify Business Process Procedure

As you uninstall Certify BPP, the database is not removed and remains unchanged. If you want to refresh or create a new database, you will need to run the database script for the type of database you are using.

To uninstall Certify BPP:

1 Open the Certify BPP Uninstall utility by selecting Start > Control Panel > Programs > Uninstall a Program.

The Uninstall or Change a Program utility appears.

2 Scroll down the programs list and right-click on Worksoft Certify and select Uninstall.

The Worksoft Uninstall utility appears.

3 Click Next.

The next screen appears.

4 Click Next to continue with uninstalling Certify BPP.

5 The final screen appears.

6 Click Finish to complete the uninstall process.


Appendix A Using Certify BPP Templates for Worksoft Certify Reports

After you have created report templates in Certify BPP, you are able to use them as templates for reports that display Worksoft Certify results.

Before you are able to utilize the templates, you first must update the Certify BPP Configuration file in order to connect to Certify.

To configure Certify BPP to connect to Certify:

1 In Notepad, open the Worksoft.BusinessProcessReporting.BppServices.exe.config file located in the following directory:

C:\Program Files\Worksoft Certify Business Process Procedure\Worksoft Certify BPP Data Services\Bpp Core WCF Service

2 Search for the following lines in the <appSettings> section of the configuration file:

3 Update the values in this section:

Where:

TemplateManagerTargetFolder = Folder in which the Certify BPP reports are saved

TemplateManagerEmailFrom = Email address from the sender

TemplateManagerEmailSubject = Email subject line for a successful report

TemplateManagerEmailTemplate = Template for the email that has a successful report

TemplateManagerErrorSubject = Email subject line for report error

TemplateManagerErrorTemplate = Template for an email with a report error

TemplateManagerItemUrl = Location of the Certify BPP templates


The TemplateManagerTargetFolder value must have the correct path listed, and it should be based on your Certify BPP installation folder. Verify that the path does not show double backslashes.

Example:

<add key="TemplateManagerTargetFolder" value="C:\Program Files (x86)\Worksoft\Worksoft Certify Business Process Procedure\BPPReports\" /><add key="TemplateManagerEmailFrom" value="[email protected]" /><add key="TemplateManagerEmailSubject" value="Your report is ready" /><add key="TemplateManagerEmailTemplate" value="TemplateItemEmailTemplate.htm" /><add key="TemplateManagerErrorSubject" value="An error has occurred while processing your report" /><add key="TemplateManagerErrorTemplate" value="TemplateErrorEmailTemplate.htm" /><add key="TemplateManagerItemUrl" value="http://Goofy/BPPWebService/TemplateDownload.ashx?documentId=" />

4 After you have completed your updates, save the updated configuration file.

You should now be able to connect to Worksoft Certify. From the Certify menu, select Tools > Change Certify BPP Configuration option to connect to Certify BPP. For more information, see the Worksoft Certify Online Help.

Note: If you use Windows authentication in Worksoft Certify, the integration will not work. Certify BPP only supports SQL Server authentication.


certify business process procedure installation guide · creating a certify bpp database 6 certify...

Documents