TECHNICAL TRAINING LAB INSTRUCTIONS

Transcription

1 In Lab 2-1 you will review the Kofax TotalAgility 7 software prerequisites. Although complete instructions for installing the prerequisites, including the necessary user accounts follows the review, it will not be necessary to perform the prerequisite installations for this course as they have already been performed. After completing steps 1 through 33 in Lab 02-1, proceed to the installation of Kofax TotalAgility 7 in Lab 2-2 which also includes installation of Kofax Transformation Server and Kofax Transformation Designer. At the end of Lab 2-2 there will be a cursory check of both Kofax TotalAgility Designer and Kofax Transformation Designer to prove basic functionality for upcoming exercises. Lab 02-1 Installing Kofax TotalAgility 7 Prerequisites for Kofax TotalAgility 7 (For Information Only) 1. Confirm that the required software is installed. 2. Click on Start/Control Panel/Programs and Features. 3. Find Microsoft.NET Framework 4.5.1, Microsoft Silverlight 5.1, Microsoft SQL Server in the list of installed products. 4. Exit the Programs and Features dialog box. 5. Confirm that users were specified or created for use during install and as service accounts. 6. Click on Start/Control Panel/Administrative Tools/Computer Management. 7. Select Local Users and Groups. Note: Two Windows users (Administrator and KTAService or equivalent) are generally required to install Kofax TotalAgility 7 and its prerequisites. A third user may be optionally created if SQL Server Authentication is to be used. a. Administrator or a member of the Administrators group (to perform installation). In this example the Trainee windows account is a member of the Administrators group, and will perform the installation. Lab02 - Install Kofax TotalAgility 7.docx Last Revision: 08/12/2014 1

2 b. KTAService (or equivalent) Service account, a domain user (in this example a local account), and is the account used to run the TotalAgility Core Worker and Transformation Designer services (must been configured to have Log on as a Service) and have permissions on the filing system. This account also needs to be a local administrator of the server. Note: that for training purposes we will use the Trainee account to install the software. Note: that the installer of the software will become the owner of the TotalAgility databases. You would therefore need to grant the KTAService account access to the TotalAgility databases after an installation, if you are installing using a different account. The minimum privileges for the KTAService account on the TotalAgility databases would be Read/Write/Execute. You could create an executor role in each TotalAgility database specifically for this. You could then assign the read/write/executor role to the KTAService login (User Mapping). 8. Select the Users folder. Create a user for the Service Account: User name: KTAService Full name: DV-TRAIN-WLX64\KTAService Password: W0rkstation (capital W then a zero) De-select User must change password at next logon Select Password never expires 9. Open Local Security Policy by typing secpol.msc in a Command Prompt or selecting Start\Control Panel\Administrative Tools\Local Security Policy: Lab02 - Install Kofax TotalAgility 7.docx Last Revision: 08/12/2014 2

3 10. Expand Local Policies, select User Rights Assignment, and double click Log on as a Service in the right-hand panel. 11. Add the KTAService so that they have Log on as a service rights. Click Apply. Click OK. Lab02 - Install Kofax TotalAgility 7.docx Last Revision: 08/12/2014 3

4 Install with Wizard Database Creation (used in this course) You can either create the databases manually or let the installation wizard create the Kofax TotalAgility databases. In this part you will connect to SQL Server, and add the KTAService account as a Login to SQL Server. You will also set the appropriate permissions for the Installer and Service accounts. The installer account creates the databases during the wizard. Add the Service Account as a Local Administrator The service account requires access to the filing system of the server during the installation. 12. Click on Start/Control Panel/Administrative Tools/Computer Management. 13. Select Local Users and Groups. 14. Double click the Administrators group. 15. Click Add. 16. Enter KTAService and click Check Names. 17. Click OK. 18. Click OK. Add the Service Account as an SQL Login and Set Service Account SQL Permissions 19. Open Start/All Programs/Microsoft SQL Server 2008 R2 20. Select SQL Server Management Studio. 21. Click on Connect. 22. Expand the Security folder, and expand the Logins folder. 23. Right-click over the Logins folder and select New Login Locate the KTAService account using the Search button. Lab02 - Install Kofax TotalAgility 7.docx Last Revision: 08/12/2014 4

5 25. Select Windows Authentication. 26. Click Server Roles. 27. Select sysadmin role (this is only required during installation as the wizard checks for dbcreator privilege although it doesn t need it). The wizard needs to connect to databases as the service account during licensing set-up. Add the Installer Account as an SQL Login and Set Installer SQL Permissions 28. The Trainee account is the installer account. This account has already been added as a SQL login in the training environment. 29. Expand the Security folder in SQL Management Studio. 30. Double click on the Trainee account. 31. Select Server Roles and check the dbcreator server role. Note: (i) Enables the Wizard to create databases. (ii) Enables Wizard to initialize databases (as the creator is the default owner and therefore has the associated owner privileges). 32. Click on File/Exit to exit SQL Server Management Studio. 33. Skip to the section Installing Pre-requisites. Note: Instructions on how to install the databases manually are covered for your reference in the next section. We will not cover this practically in the training class. Install with Manual Database Creation (not covered) Manually Creating the Databases (not covered in this training course) 34. Right-click on Databases and click New Database. Create the following databases: TotalAgility TotalAgility_Documents Lab02 - Install Kofax TotalAgility 7.docx Last Revision: 08/12/2014 5

6 TotalAgility_Reporting TotalAgility _Reporting_Staging TotalAgility_Simulator TotalAgility_Archive Note: (i) You can choose to create additional databases for TotalAgility_Audit. This is recommended by Kofax in a production installation. (ii)the Trainee account is the database owner. Add the Service Account as a Local Administrator The service account requires access to the filing system of the server during the installation. 35. Click on Start/Control Panel/Administrative Tools/Computer Management. 36. Select Local Users and Groups. 37. Double click the Administrators group. 38. Click Add. 39. Enter KTAService and click Check Names. 40. Click OK and OK again. Add the Service Account as an SQL Login and Set Service Account SQL Permissions 41. Open Start/All Programs/Microsoft SQL Server 2008 R2 42. Select SQL Server Management Studio. 43. Click on Connect. 44. Expand the Security folder, and expand the Logins folder. 45. Right-click over the Logins folder and select New Login... Lab02 - Install Kofax TotalAgility 7.docx Last Revision: 08/12/2014 6

7 46. Locate the KTAService account using the Search button. 47. Select Windows Authentication. 48. Select Server Roles and check the dbcreator server role. Note: This is only required during installation as the wizard checks for this privilege even though it doesn t actually use it. 49. Click on User Mapping. 50. In practice the KTAService account will need the db_owner database role. The KTAService account will require access to the TotalAgility databases now that they are installed. The db_owner database role would be required as a minimum for the service account during installation (to create tables). In this scenario the KTA databases would need to be created prior to installation to allow the db_owner role to be assigned prior to installation. After installation the DBA can remove the dbcreator server role and db_owner database role and give the minimum privileges for the service account: read/write/execute. 51. To summarise, the service account requires dbcreator server role and db_owner database role during the installation wizard. If these roles cannot be granted, you can manually create the database and run the SQL installation database scripts to create the tables. The table scripts can be found in the installation media in a folder called DatabaseScripts. After installation the service account will require the minimum permissions: read/write/execute. Lab02 - Install Kofax TotalAgility 7.docx Last Revision: 08/12/2014 7

8 Add the Installer Account as an SQL Login and Set Installer Account SQL Permissions 52. The Trainee account is the installer account. This account has already been added as a SQL login in the training environment. 53. Expand the Security folder in SQL Management Studio. 54. Double click on the Trainee account. 55. Click on User Mapping. 56. Select each TotalAgility database and assign the db_owner database role (so the databases can be initialized e.g. with tables). 57. Click OK. 58. Click on File/Exit to exit SQL Server Management Studio. Lab02 - Install Kofax TotalAgility 7.docx Last Revision: 08/12/2014 8

9 Installing Prerequisites (Information Only Already Completed in classroom).net Install using the web installer here: Silverlight 5.1 Install Silverlight on any client machine accessing the TA Designer via a web browser: Silverlight needs to be on machines accessing the Kofax TotalAgility Designer, so if you are planning to access it from the server machine, install Silverlight there. Use the latest version of Silverlight available. Version 5.1 or greater. IIS The simplest way to install and configure IIS is to use Server Manager: 1. Open Server Manager (see Open Service Manager for details) 2. Click Roles in the navigation tree 3. If Web Server (IIS) is not listed, click Add Roles 4. Add the Web Server (IIS) Role a. Include ASP.NET b. Under Security, include Windows Authentication Important: It doesn t matter what installation order you choose (.NET 4.0 -> IIS or IIS ->.NET 4.0, however, you still need to register ASP.NET with IIS using the following command line. Run from: %WINDIR%\Microsoft.NET\Framework\v ): aspnet_regiis.exe ir Additional details can be found at: Lab02 - Install Kofax TotalAgility 7.docx Last Revision: 08/12/2014 9

10 To validate the last step, check that you have ASP.NET v4.0 application pools as shown below: Lab02 - Install Kofax TotalAgility 7.docx Last Revision: 08/12/

11 SQL Server Install SQL Server 2008 R2 (or SQL Server 2012) Enable Windows and SQL Server authentication mode 1. Open SQL Server Management Studio (usually Start -> Programs -> MS SQL Server 2008 R2 -> SQL Server Management Studio 2. Right-click server -> Properties 3. Select Security. Lab02 - Install Kofax TotalAgility 7.docx Last Revision: 08/12/

12 Enable Network Access This is required to access the database from different machines. 1. Open Start -> Programs -> MS SQL Server 2008 R2 -> Configuration Tools -> SQL Server Configuration Manager 1. Enable TCP/IP protocol as shown on screenshot below: Connection strings Various Kofax TotalAgility components require connection strings to access databases. Typical connection strings have the following format: Windows authentication Data Source=serverAddress;Initial Catalog=dataBase;Integrated Security=SSPI SQL authentication Data Source=serverAddress;Initial Catalog=dataBase;User Id=myUsername;Password=myPassword; Lab02 - Install Kofax TotalAgility 7.docx Last Revision: 08/12/

13 In this training example the Kofax TotalAgility installation media has been copied to your virtual environment to C:\Kofax TotalAgility 7.1. If you have a separate orchestration and transformation server you can install the Transformation Designer and Server on a different server. The transformation designer and server executable install files can be found in: C:\Kofax TotalAgility 7.1\TotalAgility\TransformationDesigner C:\Kofax TotalAgility 7.1\TotalAgility\TransformationServer Lab 2-2 Installing Kofax TotalAgility 7 To install Kofax TotalAgility, do the following: 1. Open C:\Kofax TotalAgility 7.1\TotalAgility\TotalAgilityInstall\ 2. Right click Setup.exe for Kofax TotalAgility 7.1 located in the TotalAgilityInstall folder and select Run As Administrator. 3. You will see a splash screen, click Next. Then you will see the Kofax Inc. Software License Agreement; accept the license agreement and then click Next. 4. Then you will select the type of installation from Web Server, Application Server, or combined Web/Application Server; select Web/Application Server: Lab02 - Install Kofax TotalAgility 7.docx Last Revision: 08/12/

14 5. Click Next. A list of the required software and the status of each item appears. 6. Click Next. 7. The Software Destination screen appears. Note: The default location of the folder where Kofax TotalAgility will be installed appears. You may choose a different location, if required. 8. Click Next. The Windows Account screen appears. Lab02 - Install Kofax TotalAgility 7.docx Last Revision: 08/12/

15 9. Configure the Service Account as follows: a. Enter KTAService as the user name and W0rkstation as the password of the Windows account used to run Kofax TotalAgility services. When specifying a user name and password other than your Windows account, you must ensure that the account has the rights to logon as a service in your local security policy. Note: In this course use the KTAService account with the password: W0rkstation (capital W and then a zero). Also note that the Trainee (Installer) account will be created as a user inside TotalAgility after installation (not the service account!). b. If necessary, to support SSL, select the checkbox. Do NOT select for SSL in this exercise. Note: The SSL option is only available if the https binding is configured in IIS. 10. Click Next. The Databases screen appears. Lab02 - Install Kofax TotalAgility 7.docx Last Revision: 08/12/

16 Click on any one of the ellipsis buttons to select e.g. a remote database server Note: Only select Overwrite databases if they exist? If the databases have been created prior to running setup. This option will initialize the databases with the tables, stored procs etc. It will not overwrite the original databases. 11. Enter TotalAgility_Archive for the Finished Jobs Database name. 12. Click on any one of the ellipsis buttons and select the database server. The database security settings screen appears. 13. Fill in the account information as shown. For this class, we will be using Windows Authentication. If you are using SQL Server Authentication, use the appropriate SQL Server account. Important: Click the checkbox for Apply these settings to all other Databases. Click OK. Lab02 - Install Kofax TotalAgility 7.docx Last Revision: 08/12/

17 14. Click Next. The DB Connection Results screen appears. 15. Click Next. The Install Options screen is displayed. Ensure Import System Maps is checked. Note: You can learn about Sticky Sessions, Clustering, Scaling, and Load Balancing by reading the Admin guide in the Documentation folder in the TotalAgility installation folder: - TotalAgility\TotalAgilityInstall\Documentation\KofaxTotalAgilityAdminGuide_EN.pdf. Lab02 - Install Kofax TotalAgility 7.docx Last Revision: 08/12/

18 16. Click Next. The Installation Review screen appears. 17. After reviewing the settings, click Next. Setup installs the required files, databases, and other integrated products. 18. The License Proxy Configuration screen will appear after the Kofax TotalAgility 7 components are installed. Note: We will not install a License proxy. This feature can be used when you cannot directly reach a license server. Lab02 - Install Kofax TotalAgility 7.docx Last Revision: 08/12/

19 19. Click Next. 20. The Licensing screen will appear after the Kofax TotalAgility 7 components are installed. To activate the license server, do the following: Note: For the purposes of this class leave the default settings localhost or hostname and port 3581, then when prompted enter the license information attached to your station or distributed by the instructor. a. In the License Server box, enter the location of the server where the License server is installed. By default, the license server points to localhost. Lab02 - Install Kofax TotalAgility 7.docx Last Revision: 08/12/

20 b. In the Port Number box, enter the port number on which the License Server listens. c. Click Next. d. Enter the Serial Number and Product Code received on purchase of the product (As noted previously, use the information provided in class). Please note the following: The MAC Address of your machine by default in the Machine ID box. The Serial Number and Product Code appear by default if the License Server is a shared license server. Lab02 - Install Kofax TotalAgility 7.docx Last Revision: 08/12/

21 e. To obtain the MAC address, from the start menu enter cmd. Run cmd.exe. On the command Line enter ipconfig/all and press enter. The physical address (MAC) address will be listed. f. Click the 'Automatic button: Automatic: Use this option when internet connectivity is available. The license is activated online. Manual: Use this option when there is no internet connectivity or if automatic activation is unsuccessful. Configure the following details: 1. From the Licensing screen copy (CTRL-C) the Machine ID. 2. Open a Browser and go to Kofax.com 3. Select Services\Tools 4. Select Kofax Product License Activation a. Enter Serial Number b. Enter address c. Click Next 5. Follow the onscreen instructions to complete the information required. At this time paste the Machine ID into the Machine ID field. 6. Click Submit. 7. Copy the returned License Activation Code and paste it into the Manual Activation Window in TotalAgility. Note: At this stage, you can also skip activating a license by clicking Skip. If you skip activating the license, a warning appears to inform that you need to activate the license. 21. Click Finish. The Kofax TotalAgility 7 Installation is now complete. Lab02 - Install Kofax TotalAgility 7.docx Last Revision: 08/12/

22 Note: An Application Pool called TotalAgilityAppPool is installed in IIS. The app pool should run under the identity of the service account. You can check this by opening up IIS and clicking on Application Pools. Lab02 - Install Kofax TotalAgility 7.docx Last Revision: 08/12/

23 Lab 2-3 TECHNICAL TRAINING LAB INSTRUCTIONS Installing the Kofax Transformation Server For this class, it is necessary to install the Kofax Transformation Server to execute the automatic capture activities at run time. In practice the Transformation server would typically be installed on a separate server. The Setup.exe for the Transformation Server can be found in the installation media: TotalAgility\TransformationServer\setup.exe. To install the Kofax Transformation Server, do the following: 1. On completion of the Kofax TotalAgility installation, a message appears asking if you want to install Transformation Server. 2. Click Yes to install the Kofax Transformation Server. Lab02 - Install Kofax TotalAgility 7.docx Last Revision: 08/12/

24 3. Click Install again. TECHNICAL TRAINING LAB INSTRUCTIONS 4. The Kofax Transformation Server 7.1 Setup screen appears: 5. Click Next. 6. The Destination Folder screen appears. Lab02 - Install Kofax TotalAgility 7.docx Last Revision: 08/12/

25 7. Click Next to install to the default folder or click Change to choose another. 8. On the Service Account Setup screen, enter the user name (KTAService) and password (W0rkstation) of the Windows account that will be used to run the Transformation server service. Note: When specifying a user name and password other than your Windows account, you must ensure that the account has the rights to logon as a service in your local security policy. 9. Click Next. The Obtaining TotalAgility configuration screen appears. Lab02 - Install Kofax TotalAgility 7.docx Last Revision: 08/12/

26 10. Enter the Kofax TotalAgility Server Service URL. (May be retrieved automatically) Click Next. The Connection options to TotalAgility Server screen is displayed. 12. Click Next. The Advanced execution options setup screen appears. Lab02 - Install Kofax TotalAgility 7.docx Last Revision: 08/12/

27 13. Click Next. 14. Click Next. The Ready to install Transformation Server screen appears. 15. Click Install. The Installation process is in progress. Lab02 - Install Kofax TotalAgility 7.docx Last Revision: 08/12/

28 16. Click Finish. The remaining part of the setup progresses. 17. The Kofax Transformation Server installation is now complete. 18. Click Close. In order to test the basic functionality of the system start the Kofax TotalAgility Designer by bringing up a browser ( and noting that the Designer appears to operate normally. Note: The Installer account becomes the default user in TotalAgility. Perform the same kind of cursory test for the Kofax Transformation Designer: In Microsoft Windows: Start/All Programs/Kofax Transformation Designer/Transformation Designer. 19. Logout of both design environments. Lab02 - Install Kofax TotalAgility 7.docx Last Revision: 08/12/

29 Lab 2-4 (not carried out in this training course) Only required if you have installed the TotalAgility Databases using the Wizard and your company security policy requires reduced privileges on the Databases and local machine for the Service Account. Set Appropriate Permissions after Installation 1. Revoke sysadmin Role from KTAService account. 2. On each KTA database: Grant Read Role to KTAService user Grant Write Role to KTAService user Grant Execute (script) to KTAService user (or alternatively, grant db_owner to each database) 3. Revoke the dbcreator role from the Installer account. 4. Remove the service account from the local Administrators group. Service Account Permission on File System If the service account is not a local administrator on the server you must grant Modify permissions on the TotalAgility folder. This folder contains other folders e.g. Agility.Server.Web, GenerateAssemblies, and CoreWorkerService folders. The service account requires these permissions to e.g. store the cached KTA forms on the file system, and generate assemblies at run time. You cannot configure this permission in advance as the folders are created during the installation and at run time if e.g. a business rule, branching rule, or.net script is executed. Important: You do not have to carry these steps in the training class as the Trainee account is a Local Administrator. 5. Right click over the folder C:\Program Files\Kofax\TotalAgility\ and select Properties. Lab02 - Install Kofax TotalAgility 7.docx Last Revision: 08/12/

30 6. Select the Security tab and click Edit. 7. Click Add Locate the service account you used during the installation and click OK. 9. Select the Modify Permission and click Apply. Lab02 - Install Kofax TotalAgility 7.docx Last Revision: 08/12/

31 Lab 2-5 TECHNICAL TRAINING LAB INSTRUCTIONS Backing up Kofax TotalAgility 7 Databases After you have installed Kofax TotalAgility, it would be advisable to back up each database before any content is added through the UI. In this example we will use SQL Server to back up the 3 TotalAgility databases that were created in this installation. 1. Select Start > All Programs > Microsoft SQL Server 2008 R2 > SQL Server Management Studio. 2. Click Connect. 3. Expand the Database folder. 4. Right click over the TotalAgility database and select Tasks > Back Up 5. Click OK. 6. Repeat steps 4 and 5 for the TotalAgility_Documents, TotalAgility_Simulator and TotalAgility_Archive databases. 7. Close SQL Server Management Studio. Lab02 - Install Kofax TotalAgility 7.docx Last Revision: 08/12/