WF-distiller Installation Guide

Transcription

1 WF-distiller Installation Guide Version 4.0 SP2 September 2016 prepared by WF-distiller Engineering

2 2016 Lexmark. All rights reserved. Lexmark is a trademark of Lexmark International Inc., registered in the U.S. and/or other countries. All other trademarks are the property of their respective owners. No part of this publication may be reproduced, stored, or transmitted in any form without the prior written permission of Lexmark. Page 2

3 Contents About WF-distiller... 4 System Requirements... 4 Operating Systems... 4 Software Requirements... 4 Microsoft SQL Server 2008 / Microsoft Internet Information Services (IIS)... 4 Microsoft. NET Framework version 3. 5 SP Microsoft Office... 5 WF-distiller Server installation... 6 Install WF-distiller with a SQL Server database... 6 Install WF-distiller with an Oracle database... 7 About upgrading WF-distiller... 9 Prepare for the upgrade... 9 Uninstall the existing version... 9 Upgrade the server installation... 9 Set up Windows Authentication WF-distiller client installation Install the WF-distiller administration clients Test the WF-distiller client installation WF-distiller WebDesk Install the virtual directory Configure WebDesk in IIS Test the WebDesk installation WebDesk config.xml Page 3

4 About WF-distiller WF-distiller is a workflow product suite by Brainware, Inc. serving as an integration tool between data capturing and processing software and the company s ERP system. WF-distiller is a client server application for delivering electronic data around a business in the form of business cases. System Requirements Operating Systems WF-distiller requires a complete and successful installation of the software on a server or workstation running one of the following operating systems. Microsoft Windows Server 2008 R2 Microsoft Windows Server 2012 Microsoft Windows 7 Software Requirements The installation of the WF-distiller Server with WebDesk requires the following third party products. One of the following database servers Microsoft SQL Server 2008 Microsoft SQL Server 2012 Oracle 11g Oracle 12c Microsoft Internet Information Services (IIS) Microsoft.NET Framework version 3.5 SP1 Microsoft Word and Excel Microsoft SQL Server 2008 / 2012 SQL Server Setup installs the following software components required by the product. Microsoft.NET Framework 3.5 SP1 SQL Server Native Client SQL Server Setup support files Microsoft Internet Information Services (IIS) WebDesk requires IIS. For more information, see Configure WebDesk in IIS. Page 4

5 Microsoft. NET Framework version 3. 5 SP1 The WebDesk server requires Microsoft.NET Framework 3.5 SP1. Microsoft Office The WebDesk document template options require Microsoft Word and Excel. The document template facility allows business case data to be automatically merged into Word and Excel templates. Page 5

6 WF-distiller Server installation Depending on your installation environment or on the kind of installation you wish to perform, refer to one of the following sections. Install WF-distiller with a SQL Server database Install WF-distiller with an Oracle database Upgrade WF-distiller Install WF-distiller with a SQL Server database To install WF-distiller with a SQL Server database, complete the following steps. 1. From the WF-distiller Server installation directory, run Setup.exe. 2. In the WF-distiller Server 4.0 Welcome page, click Next. 3. In the WF-distiller Server 4.0 Credentials page, type the User Name, the Company Name, and the Serial Number as provided by Brainware and then click Next. 4. In the Install WF-distiller Server page, accept or change the installation directory and then click Next. Note Ensure that the installation directory does not contain any spaces. 5. In the Select Installation Host page, complete the following substeps. 1. In the Host field, accept or change the name of the machine on which you are installing WF-distiller Server. 2. In the Port field, accept or change the default port number 3466 and then click Next. Note The port number can be set to any value of your choice. For ease of supportability by the support team, we recommend to use port number 3466 unless already installed applications use this port number or specific port blocking rules on your network require using another port. 6. Service entries must be registered with Windows in the services file in the default file location in the C:\Winnt\System32\Drivers\Etc directory. In the Modifying File page, specify how the setup modifies the standard windows services entry file and then click Next. Note If WF-distiller has been previously installed, select Do not make any changes. 7. In the Select Database Type page, select Microsoft SQL Server. 8. In the Database Creation page, to create a new database, select the Create new database check box or to keep an existing database, clear the check box. 9. In the SQL Server Login page, type the database name, the username and the password to be created and then click Next. Note Ensure that the password meets the Database Server password policy. You can also create the user manually after completing the installation, if required. 10. Accept or change the directory where MS SQL Server stores the data files. 11. Specify the database server name, the authentication type and if required, the login ID and the password and then click Next. Page 6

7 12. Verify the settings and then click Next. 13. Click Install. 14. In the InstallShield Wizard Complete page, choose to restart your computer now or later. Note We recommend to restart your computer at this point. 15. On the server where WF-distiller is installed, in the [installation directory]\server\files\ directory, open wflsrv.cnf and check if the WFL_DBNAME parameter contains the correct user name, password and connection string to connect to the database. 16. On the database server, ensure that the WF-distiller database and user ID are created successfully. 17. In Windows Services, check if the WF-distiller service is running. 18. From the [Installation path]\server\files directory, open the errlog.log file and check for success or error messages. Install WF-distiller with an Oracle database The installation requires an installed ODAC package. The setup installs the required version. During the setup process the installation directory and subdirectory file paths are added to the PATH environment variable, and are placed before any other Oracle directory file paths. Note It might be required to uninstall existing ODAC versions. To uninstall the existing version, follow the uninstallation instructions of the ODAC README file. To install WF-distiller with an Oracle database, complete the following steps. 1. Start the Oracle database and create an Oracle system user account to be used for WF-distiller. 2. Connect to the Oracle database using the recently created Oracle database user. 3. From the WF-distiller Server installation directory, run Setup.exe. 4. In the WF-distiller Server 4.0 Credentials page, type the User Name, the Company Name, and the Serial Number as provided by Brainware and then click Next. 5. In the Install WF-distiller Server page, accept or change the installation directory and then click Next. Note Ensure that the installation directory does not contain any spaces. 6. In the Select Installation Host page, complete the following substeps. 1. In the Host field, accept or change the name of the machine on which you are installing WF-distiller Server. 2. In the Port field, accept or change the default port number 3466 and then click Next. Note The port number can be set to any value of your choice. For ease of supportability by the support team, we recommend to use port number 3466 unless already installed applications use this port number or specific port blocking rules on your network require using another port. Page 7

8 7. Service entries must be registered with Windows in the services file in the default file location in the C:\Winnt\System32\Drivers\Etc directory. In the Modifying File page, specify how the setup modifies the standard windows services entry file and then click Next. Note If WF-distiller has been previously installed, select Do not make any changes. 8. In the Select Database Type page, select Oracle. 9. In the Database Creation page, to create a new database, select the Create new database check box. To keep an existing database, clear the check box. 10. Specify the database server connection in the following format: host:port/instance_name. Note The default port number for Oracle is Specify the username and the password created in step 1 and then click Next. 12. In the InstallShield Wizard Complete page, choose to restart your computer now or later. Note We recommend to restart the computer at this point. 13. On the server where WF-distiller is installed, in the [installation directory]\server\files\ directory, open wflsrv.cnf and complete the following substeps. 1. Check if the WFL_DBNAME parameter contains the correct user name, password and connection string to connect to the database. 2. Check if the WFL_DATABASETYPE parameter contains the value ORA. Example WFL_DATABASETYPE=ORA 14. On the database server, ensure that the WF-distiller database is created successfully. 15. In Windows Services, check if the WF-distiller service is running. 16. From the [Installation path]\server\files directory, open the errlog.log file and check for success or error messages. Page 8

9 About upgrading WF-distiller To upgrade to the new version, uninstalling the existing version is required. For Oracle only The installation requires an installed ODAC package. The setup installs the required version. During the setup process the installation directory and subdirectory file paths are added to the PATH environment variable, and are placed before any other Oracle directory file paths. Note It might be required to uninstall existing ODAC versions. To uninstall the existing version, follow the uninstallation instructions in the ODAC README file. Prepare for the upgrade To prepare for the upgrade, complete the following steps. 1. Copy the current installation directory to a backup location. 2. Create a backup of the WF-distiller database. 3. If applicable, hold ready service account login credentials for the WF-distiller and BWServices. 4. Verify that.net Framework 3.5 SP1 is installed. Uninstall the existing version To uninstall the existing version, complete the following steps. 1. In Windows Services, set the WF-distiller service and all BWServices from Automatic to Manual. 2. Stop all WF-distiller services and all BWServices. 3. In Windows Programs and Features, uninstall WF-distiller Configuration and Administration Tools using the Uninstall option. 4. Restart the computer. 5. In Windows Programs and Features, uninstall the existing WF-distiller Server using the Uninstall option. 6. Restart the computer. Upgrade the server installation To upgrade the server installation, complete the following step. Complete the steps in Install WF-distiller with a SQL Server database or Install WFdistiller with an Oracle database without creating a new database, if you want to reuse the existing one. Page 9

10 Set up Windows Authentication To set up Windows Authentication for WF-distiller, complete the following steps. 1. To configure Windows Authentication in the server config file, complete the following substeps. 1. From the [Installation path]\server\files directory, open the wflsrv.cnf file. 2. Search for the WFL_DBNAME parameter and modify the line as follows: WFL_DBNAME=Host[\InstanceName];/WFdistiller/$integrated/ 2. To configure the connection string in the ASP.NET 2 applications, complete the following substeps. 1. Open the WebDesk or BWService config.xml file. 2. Search for the <connectionstrings> section and add the required connection strings. Note The connection string used with Windows Authentication must include the entry Integrated Security=True. 3. Start the Workflow services and review the error logs. WF-distiller client installation To install and test the WF-distiller client, follow the steps in Install the WF-distiller administration clients and Test the WF-distiller client installation. Install the WF-distiller administration clients 1. From the Client Setup directory, run Setup.exe. 2. In the Welcome to the InstallShield Wizard for WF-distiller Configuration and Administration Tools page, click Next. 3. Accept or change the default installation directory, and then click Next. 4. In the Host field, accept or change the server name where the WF-distiller server process is installed. 5. In the Port field, accept or change the default port number 3466 and then click Next. Note The port number corresponds to the port number assigned in the server installation. 6. In the Click Install to begin the installation page, click Install. 7. In the InstallShield Wizard Complete page, choose to restart your computer now or later and then click Finish. Note A restart of the computer is suggested. Page 10

11 Test the WF-distiller client installation To test the WF-distiller client installation, complete the following steps. 1. To ensure that the Administration Client can access the WF-distillerservice, complete the following substeps. 1. From the Windows Start menu, launch WF-distiller > Administration > Configuration Administration. 2. In the WF-distiller login screen, in the UserName field, type WF- Admin 3. In the Password field, type WF-Admin and then click OK. 4. In WF-distiller Administration, check if any error messages display. 2. To ensure that Process Designer runs successfully, complete the following substeps. 1. From the Windows Start menu, launch WF-distiller > Administration > Process Designer. 2. In the WF-distiller login dialog, in the UserName field, type WF- Admin. 3. In the Password field, type WF-Admin and then click OK. 4. In Process Designer, in the left pane, open Server > Active Processes > Default Process > ACTIVE PD. 5. In the right pane, verify that the default Start and Stop process displays. Note The displayed process might differ for an existing workflow. Page 11

12 WF-distiller WebDesk Install the virtual directory Because administrators at client sites wish to retain control of the virtual directories that exist in their IIS environment, WF-distiller WebDesk uses a manual configuration process. Complete the following steps. 1. Copy the entire contents of the WebDesk directory from the Brainware installation directory to a physical directory on the web server. IIS expects physical directories to be stored under C:\Inetpub\wwwroot\ by default but the directory location can comply with the standards defined by the client. 2. Create a new virtual directory in IIS and configure it to point at the WebDesk physical directory created during installation. Configure WebDesk in IIS 1. In Internet Information Services (IIS) Manager, in the Connections pane, right-click Default Web Site and then click Add Application. 2. In the Add Application dialog box, in the Alias field, type WebDesk. 3. In the Physical Path field, browse to the WebDesk installation directory and then click OK. 4. In the Connections pane, select Default Webs Site. 5. In the Feature View pane, in the IIS section, double-click Authentication. 6. In the Authentication pane, verify that Anonymous Authentication is enabled. 7. In the Connections pane, select the WebDesk virtual directory. 8. In the Feature View pane, in the IIS section, double-click Default Document. 9. In the Default Document pane, add login.aspx. Test the WebDesk installation To test the WebDesk installation, complete the following steps. 1. In a browser window, type 2. In the Login dialog box, in the UserName field, type WF-Admin. 3. In the Password field, type WF-Admin and then click Log-In. 4. Verify that the WebDesk client displays. Page 12

13 WebDesk config.xml Configuration of the WebDesk application is controlled via the config.xml file. < Server> host Name of the server where WF-distiller Server is installed. port Port number specified during WF-distiller Server installation. Host Admin default From Name of SMTP server f or sending s address to which notification of W ebdesk runtime errors are sent. address used as From address for s sent from W ebdesk. < Logging> on Boolean flag to indicate whether logging is turned on or off. location Destination of logging information. If blank, messages are written to the event log. If not blank, specifies path name of log file. < Database> SQLServer Boolean flag to indicate the database type. True = SQL Server False = Oracle connect String Database connection string < Upload> temp Pathname of directory used for creation of temporary files required during WebDesk operation. Page 13