ISSUE TRACK FOR WINDOWS INSTALLATION GUIDE VERSION 4.0.0.XX
Contents CONTENTS Chapter 1 Introduction 1-1 Welcome to Issue Track for Windows 1-1 About this Guide 1-1 Product Name 1-1 Documentation Roadmap 1-1 Chapter 2 Security Features 2-2 Web Interface 2-2 Integration with AutoAudit for Windows 2-2 Configuration 2-2 Security- and Permission-Based User Rights 2-2 SQL Server Database Administration 2-3 Create Issue Track Roles in SQL Server Enterprise Manager 2-3 Issue Track Roles: Select & Update Authorization Security Table 2-3 Security User Roles and Functions 2-4 Chapter 3 Pre-installation Notes 3-5 What the Installation Program Does 3-5 Chapter 4 Upgrade Installation 4-6 Upgrading an Existing Issue Track Version 4-6 Before Performing an Upgrade Installation 4-6 Uninstalling Issue Track 4-6 Changing Permission Settings for an Upgrade 4-6 Chapter 5 Initial Installation Procedure 5-7 Chapter 6 After Installation 6-16 Changing SQL Server Connection String 6-16 Web.Config File 6-16 Using integrated Security 6-16 Using Single Sign On (SSO) environment Security 6-17 Web.config File 6-17 Using Windows Integrated Security 6-17 Using Issue Track Forms-Based Security 6-18 Changing the Settings for File Attachments 6-18 Web.Config File 6-18 User ID & Password, and E-Mail Settings 6-18 In AutoAudit for Windows 6-18 Starting Issue Track 6-19 ii
Contents Chapter 7 Troubleshooting 7-20 E-mail link to an Action Plan Failure 7-20 Send Error Reports 7-21 Service Desk Contacts 22 iii
Introduction CHAPTER 1 INTRODUCTION WELCOME TO ISSUE TRACK FOR WINDOWS You have invested in an easy to use Web-based application that is used as a companion tool with AutoAudit for Windows. ABOUT THIS GUIDE This guide presents two installation scenarios 1) Upgrade Installation (upgrading an existing Issue Track for Windows version) 2) First-Time Installation Product Name The name Issue Track for Windows has been abbreviated to Issue Track. The name AutoAudit for Windows has been abbreviated to AutoAudit. Documentation Roadmap Reference Issue Track for Windows Reference Manual Reference AutoAudit for Windows Setup Guide Reference AutoAudit for Windows Reference Manual Reference AutoAudit for Windows and Issue Track for Windows Technical Specifications 1-1
Security Features CHAPTER 2 SECURITY FEATURES Web Interface As a Web-based application, Issue Track is easily accessible by anyone with a common Web browser. Users can edit data using Internet Explorer. Issue Track can be used over your corporate Intranet, or over the Internet. Integration with AutoAudit for Windows Issue Track is used with AutoAudit, allowing Auditors and Coordinators to communicate using a Web browser. Configuration Issue Track is configured to work with an existing AutoAudit database. The data is seamlessly pushed back and forth between the two applications resulting in immediate display in either application with minimal user intervention. Security- and Permission-Based User Rights Issue Track lets you track open issues on a secure Web site, where Coordinators can monitor and update progress. Auditors can exchange data through the AutoAudit interface. Access to Issue Track is granted via User ID and password, which are defined in the Coordinator Setup section of WorkForce Scheduling in AutoAudit. Reference AutoAudit for Windows Setup Guide 2-2
Security Features SQL SERVER DATABASE ADMINISTRATION Normally the SQL Server Login that connects to the SQL Server for Issue Track is part of the Client Role, which has permissions to all tables. Create Issue Track Roles in SQL Server Enterprise Manager An Issue Track Role could be created in the SQL Server with the permissions listed in the table below. Then the SQL Server Login that connects for Issue Track to SQL Server could belong to this Issue Track Role, which has only the minimum permissions needed for Issue Track. Issue Track Roles: Select & Update Authorization Security Table Employees LanguageAA ActPlans Activities Issues Security Attachment2 Attachment2FolderContent Attachment2Folders Attachment2History Attachment2Version Coord AppSystem MSTCheck TMCollect Overview Select Select Select, Update Select Select Select Select, Update, Insert, Delete Select, Update, Insert, Delete Select, Update, Insert, Delete Select, Update, Insert, Delete Select, Update, Insert, Delete Select, Update Select Select Select Select 2-3
Security Features SECURITY USER ROLES AND FUNCTIONS Issue Tracking and Follow-up Issue Track for Windows automates the communication flow between auditors, reviewers, and coordinators, making it easier to post, track, and monitor issues that turn up during audits. Issue Track provides a common meeting place, where all parties involved in audit issues can contribute to the process at the appropriate junctures. You can generate issues from AutoAudit and automatically copy them to Issue Track at any time during an audit. AUTOAUDIT FOR WINDOWS Auditors Accessible to all Action Plans in AutoAudit; however, does not have access to Issue Track. Views reports on issue aging, risk and resolution rates, issue status and issues by category, and exchange data. If an auditor is set as Inactive, they can still log into AutoAudit, but their name will no longer be available in the drop-down selection lists. The only way to lock an auditor out of AutoAudit is to change their password. ISSUE TRACK FOR WINDOWS Coordinators Coordinators are also known as auditees. Only see Action Plans related to their area of responsibility. Responsible for documenting their progress. Have edit rights to all Action Plans that the Coordinator is assigned, and in which the Action Plan is checked to display in WMR or Issue Track. Have read-only rights to all Action Plans that have categories matching the Coordinator s categories, and in which the Action Plan is checked to display in WMR or Issue Track. Reviewers Oversee the activity of all Coordinators. Can see action plans related to their area of responsibility, including which Coordinators are responsible for resolution. Have read-only rights to all Action Plans that the Reviewer is assigned, and in which the Action Plan is checked for display in WMR or Issue Track. Have read-only rights to all Action Plans that have categories matching the Reviewer's categories, and in which the Action Plan is checked to display in WMR or Issue Track. 2-4
Pre-installation Notes CHAPTER 3 PRE-INSTALLATION NOTES The installation must run under a privileged user account. Typically this is an administrator account. Issue Track cannot be installed to the system directory. This release requires AutoAudit for Windows 3.0, 3.1, 3.2, or 4.0. A Server Variable entry is available for Secure Access Manager (SAM) users. Refer to the Integrated Security Solutions section for Web.Config File changes in this guide for more information. This entry will bypass the login page with secure access. For non-english installations, a dialog box prompts to select the Web site that you want to deploy to the virtual directory. In addition, the application uses Security ID for the administrators group. If using Internet Explorer 5.5 or lower, the grid control will not display correctly in Issue Track. The Issue Track installation requires that you have AutoAudit installed with an AutoAudit SQL Server database created. WHAT THE INSTALLATION PROGRAM DOES The installation program performs the following tasks during a first-time installation: Installs the Microsoft.NET Framework and service packs. Installs Microsoft Data Access Components (MDAC) 2.7 and service packs. Sets Issue Track file and folder permissions. Note The installation will register asp.net with the Issue Track program only. 3-5
Upgrade Installation CHAPTER 4 UPGRADE INSTALLATION UPGRADING AN EXISTING ISSUE TRACK VERSION New versions of the program, incorporating enhancements and new features, are regularly introduced as part of our continuing service. We strongly recommend that you upgrade all new versions immediately to make sure that your program is operating with the most current functions and features. BEFORE PERFORMING AN UPGRADE INSTALLATION Uninstalling Issue Track An upgrade installation requires that you first remove the previous version of Issue Track before you install the new version. Follow these steps to upgrade an existing Issue Track version. 1) Use Windows Control Panel Add/Remove Programs, select Issue Track Change or Remove Programs. 2) Navigate to the original Issue Track installation directory and remove any files and subfolders left behind; for example, any temp files. 3) Use the Initial Installation Procedure in this manual to install the new version of Issue Track. CHANGING PERMISSION SETTINGS FOR AN UPGRADE Review the Select and Update Authorization Security Table on page 2-3 for changing permission settings. Reference AutoAudit for Windows Setup Guide 4-6
Initial Installation Procedure CHAPTER 5 INITIAL INSTALLATION PROCEDURE Perform this procedure to install Issue Track on your hard disk for the first time. Issue Track cannot be installed to the system directory. The Issue Track installation requires that you have AutoAudit installed with an AutoAudit SQL Server database. The installation program creates new virtual directories and copies the required product files to your hard disk. Double-click the IssueTrack.exe file ( ). Welcome The Welcome screen begins the Issue Track installation. Click Next to continue. Click Cancel to stop the installation. Destination Folder The Destination Folder screen displays the location for your Issue Track installation. Click the Change button to select another destination folder for the installation. Click Back to return to the previous screen. Click Next to install Issue Track to the default Destination Folder location: C:\Intepub\wwwroot\IssueTrack\ Click Cancel to stop the installation. 5-7
Initial Installation Procedure Change Current Destination Folder Browse and select another destination folder for the installation. Click OK. Click Cancel to stop the installation. Ready to Install the Program Verify your selections. Click Back to return to the previous screen. Click Install to begin the installation. Click Cancel to stop the installation. Installing Issue Track The Installing Issue Track status screen displays momentarily. 5-8
Initial Installation Procedure Welcome When the program is finished copying new files, you will see the Welcome screen. Click Next to continue. Company Name Enter your organization s name and click Next. AutoAudit Database Connectivity Choose a connection string to the AutoAudit database. Click the browse ( ) button to display the Data Link Properties dialog box. Click Back to return to the previous screen. Click Next to continue. Click Cancel to stop the installation. Data Link Properties The Data Link Properties dialog box lets you select an existing AutoAudit database. This is the standard Windows system interface for configuring connection strings to data sources. The Provider tab should already display the correct OLE DB Provider. If not already displayed, select the Connection tab. Use this tab to specify where your data is located and how to connect to it using this OLE DB provider. 5-9
Initial Installation Procedure Make sure that the Allow saving password box is checked to save the password for future connection. Click this button to test the connection with the specified data source. Select or enter a server name: Enter the server name for the server containing the AutoAudit database. Spaces are not allowed in database names. Enter information to log on to the server: Select Use a specific user name and password to authenticate your logon information to the data source. Note User name: Type the User ID to use for SQL authentication when you log on. Password: Type the password to use for SQL authentication when you log on. Allow saving password: Check this box to allow the password to be saved with the connection string. If you do not check this box, the message: "Connection Unsuccessful" displays when you later click Next on the "AutoAudit Database Connectivity" dialog box. 5-10
Initial Installation Procedure Select the database on the server Test Connection Click this button to test the connection with the specified data source. If a test connection is made, the Test successful message displays. If an incorrect user name is entered, a Microsoft Data Link Error displays: Test connection failed because of an error in initializing provider. Login failed for user xxxxxxx. If no connection is made, the Connection Unsuccessful message displays. If Connection Unsuccessful, review the settings. Spelling errors or case sensitivity in the Data Link Properties dialog box can block connections. Repeat steps to create a valid connection string. Make sure that the Allow Saving Password box is checked. Click OK. AutoAudit Database Connectivity The AutoAudit Database Connectivity screen displays again with the selected connection string. Click Back to return to the previous screen. Click Next to continue. Click Cancel to stop the installation. 5-11
Initial Installation Procedure SMTP Server Connectivity Issue Track uses SMTP (Simple Mail Transfer Protocol, an IETF standard for effective e-mail transfer) to send systemgenerated error reports via e-mail back to Paisley, a Thomson Reuters company, for troubleshooting purposes. Enter your SMTP server name. Click the Test button to verify the SMTP e-mail server connection. If the mail server that was specified is not found, the test fails and a message displays indicating the test failed. IIS Setup If you receive an Unsuccessful SMTP Connection, click OK. Verify that the proper mail server name was entered, and then check the mail server configuration. If the e-mail server is set to block e-mails, the Issue Track generated-report function will be disabled and you can continue. If the SMTP server connection is good, the Test Successful message displays, and the inbox for the specified e-mail address will contain a test message. Click Next. In Windows XP Professional and Windows 2000 Professional, only the Default option is available. In Windows 2000x Server environments, two IIS Setup options are available for your Web site connection. Choose either Default or Advanced. On certain systems the Advanced option is disabled because the operating system does not support it. 5-12
Initial Installation Procedure Default Windows XP Professional and 2000 Professional Click Next to continue. Advanced Windows 2000 Server Families If you chose Default, virtual directories are created for Issue Track under the IIS Default Web site. IIS provides Internet services such as the WWW service for hosting Internet and Intranet content. If you chose Advanced, the IIS Advanced Setup screen displays to let you create a new Issue Track Web site name for IIS. Website Name Root Directory Host Header: Static IP Address URL to site Enter the Web site name that will display in IIS Manager. The Root Directory text box displays the Issue Track files installation location. If you choose Host Header configuration, enter the host header name in the text box. If you choose the Static IP Address for the Issue Track Web site, enter the IP address in the text box. Both choices require a DNS entry. Enter the URL for the Issue Track Web site. This URL entry will depend on the configuration option specified (that is, either Host Header or Static IP). 5-13
Initial Installation Procedure Summary A summary of the settings you have chosen displays. Verify your selections and click Install to begin the installation. InstallShield Wizard Completed 5-14
Initial Installation Procedure The installation status screen displays momentarily, and then the InstallShield Wizard Completed screen displays. Click Finish. The installation procedure is completed. 5-15
After Installation CHAPTER 6 AFTER INSTALLATION CHANGING SQL SERVER CONNECTION STRING Integrated Security Solutions Web.Config File This connection string must be placed in the web.config file in the root directory of Issue Track. Place a connection string like the following one in the AutoAuditDataConnection key in the AppSettings section of the Web.Config file: "Data Source=CKOVBTLGX620;Initial Catalog=AutoAudit;User ID=ClientID;Password=ClientPWD;Connection Timeout=120;" After logging into Issue Track, the AutoAuditDataConnection value is cleared and the connection string becomes encrypted under EncryptedData. Using integrated Security When using this setting, CanChangeLogin should be set to 0. <Entry> <key xsi:type="xsd:string">clientservervariable</key> <value xsi:type="xsd:string">logon_user</value> </Entry> <Entry> <key xsi:type="xsd:string">canchangelogin</key> <value xsi:type="xsd:string">0</value> </Entry> If Integrated Security (ClientServerVariable set to LOGON_USER as above), it will override/nullify the AutoAudit for Windows password security settings for Coordinators. If Enable Password Security is checked in AutoAudit for Windows security setup form, CanChangeLogin should be set to 1 so Issue Track's Personal Settings page works as it should for users when they need to make a nonexpired password change. 6-16
After Installation USING SINGLE SIGN ON (SSO) ENVIRONMENT SECURITY Web.config File An SSO (provided by SAM, Tivoli or Siteminder, etc.) access control solution can pass the user name credentials to Issue Track via a custom HTTP header variable. The variable name used to pass the value must be entered in the web.config file's ClientServerVariable value so Issue Track knows the header variable (servervariable) carries the username. In this example the Http header variable name is HTTP_MY_USER. Issue Track will read the value contained in this variable and attempt to match it to a coordinator's UserID. If matched, the user is logged in automatically. If no match is found, access to Issue Track is denied. Http Header Variable Name = HTTP_MY_USER <Entry> <key xsi:type="xsd:string">clientservervariable</key> <value xsi:type="xsd:string">http_my_user</value> </Entry> <Entry> <key xsi:type="xsd:string">canchangelogin</key> <value xsi:type="xsd:string">0</value> </Entry> USING WINDOWS INTEGRATED SECURITY If a Windows user is logged into the domain that contains Issue Track's IIS server, the user can be automatically logged into Issue Track using Windows Integrated Security. There are two main steps to enable this. 1) Turn on Integrated Windows authentication in IIS for the Issue Track site (note that this will cause IIS to check Windows credentials when accessing files in the Issue Track directory). Also, deselect Anonymous Access. 2) Set the ClientServerVariable value to LOGON_USER. Make sure the Coordinators' Login IDs match their network IDs. <Entry> <key xsi:type="xsd:string">clientservervariable</key> <value xsi:type="xsd:string">logon_user</value> </Entry> <Entry> <key xsi:type="xsd:string">canchangelogin</key> <value xsi:type="xsd:string">0</value> </Entry> 6-17
After Installation USING ISSUE TRACK FORMS-BASED SECURITY This is Issue Track's overriding security method. Whether the ClientServerVariable is blank or not, this security is set ON. When the ClientServerVariable value is blank, requests for any Issue Track resource will require the coordinator to provide valid credentials as entered in AutoAudit's Coordinator Setup form. <Entry> <key xsi:type="xsd:string">clientservervariable</key> <value xsi:type="xsd:string"></value> </Entry> <Entry> <key xsi:type="xsd:string">canchangelogin</key> <value xsi:type="xsd:string">1</value> </Entry> CHANGING THE SETTINGS FOR FILE ATTACHMENTS Web.Config File The default attachment limit is 4 megabytes. This setting can be changed in the Web.Config file by adding the maxrequestlength attribute to the httpruntime element setting the executiontimeout attribute as shown below. <system.web> <httpruntime maxrequestlength="4096" executiontimeout="900" /> USER ID & PASSWORD, AND E-MAIL SETTINGS Setup options are available in AutoAudit for Windows You can choose to allow User ID & Password, and e-mail changes in Issue Track. In the Web Response System (WRS) you can choose the information that you would like to show or not show. For example, if you do not want coordinators to see information like Discussion & Background, and Cause & Effect information, do not check the boxes. If you want coordinators to only see the recommendations, you can check the box to allow this information to be shown. AutoAudit for Windows Setup Guide, Options System Setup Web/Email. In AutoAudit for Windows Do the following: Enable Issue Track in AutoAudit (refer to the Web/Email Enabling Issue Track section of the AutoAudit for Windows Setup Guide). Enable access to AutoAudit (refer to the Coordinator Setup section of the AutoAudit for Windows Setup Guide). 6-18
After Installation Make sure the Display in Issue Track check box is checked on the AutoAudit Action Plan form (refer to the AutoAudit for Windows Reference Manual). Now Coordinators and Reviewers can be assigned to Action Plans and e-mails can be sent to them. STARTING ISSUE TRACK In the newly-installed Issue Track application based on the Issue Track Web configuration you have chosen (for example, at http://machine name/issuetrack where machine name is the host computer name without an extension). Coordinators and Reviewers can log into Issue Track and open Action Plans. The Issue Track for Windows Log In screen displays. Type in your Username, if it is not displayed. Type in your Password. Select a Language from the drop-down list. After you have entered your username and password, click the Login button to access the Issue Track. Reference Issue Track for Windows Reference Manual, or online Help files. 6-19
Troubleshooting CHAPTER 7 TROUBLESHOOTING E-MAIL LINK TO AN ACTION PLAN FAILURE What is the URL in AutoAudit for Windows? Go into AutoAudit for Windows: Options System Setup Web/Email The URL on this screen is as follows: The default installation: http://<iisservername>/issuetrack/application/ Advanced installations: http://<yourcompanydefinedurl>/application/ If the e-mail link does not work, you can log into Issue Track manually. Open an Internet Explorer browser session (we do not support other browsers). Type in the Issue Track URL without /Application/ that appears in the email URL: Default URL for manual access: http://<iisservername>/issuetrack Advanced installations: http://<yourcompanydefinedurl> If you receive "Internal Error" messages while connected to Issue Track, Paisley needs copies of the error messages that are in the Application Event Viewer on the IIS Server hosting the Issue Track Web application. Do the following: 1. From the IIS Server desktop, right-click on My Computer icon. 2. Select Manage. 3. Select Event Viewer. 4. Select Application. 5. Select View Filter. 6. Select Error only If your IS person can't determine why the application is not working correctly, send the error log files to Paisley for review. Action Save Log File As Save the file to text (*.txt) format If the Web site does not open, send Paisley the ITInstall.log file from the C:\root directory of the IIS Server where Issue Track was installed. Note Have your IS department review the log to determine if they did an Advanced Installation to the Default Web site path. You can determine this by looking at the path where Issue Track was installed. 7-20
Troubleshooting If the path is C:\inetpub\wwwroot, that is the default Web site path. Continue to review the ITInstall.log file and determine if the application was installed as an Advanced installation or Default. Advanced installation values: IISSetup = "Advanced"; InstallationController.URL = "http://issuetrack"; (URL will NOT be http://<iis Server Name>/IssueTrack) A Default installation values: InstallationController.IISSetup = "Default"; InstallationController.WebsiteName= "Default Web Site"; InstallationController.InstallDirectory = "C:\Inetpub\wwwroot\IssueTrack\"; If you have the application installed to C:\inetpub\wwwroot on the IIS Server, you have a default installation. If you have the default path, and an advance installation, you will need to: Uninstall Issue Track (through Add/Remove Programs in the Control Panel), if you want to do an Advanced installation of Issue Track, make sure you 1. Install the application to a different path from C:\inetpub\wwwroot. 2. Add the custom Web site to your DNS. 3. Create a host header for the advanced Web site. SEND ERROR REPORTS A message displays when an internal Issue Track error occurs: Internal Error. If this error keeps occurring contact your system administrator. When you click the Send error report text link, Issue Track will try to connect to a Web service to send a formatted e-mail with the exception to Paisley. If it cannot connect, it will try to send a generic e-mail with the error report. 7-21
Service Desk Contacts SERVICE DESK CONTACTS Self-Service http://servicedesk.paisley.com Client self-service provides the ability to interact with the service desk through a web-based tool. This tool offers clients an easy method to create and manage support occurrences and interact with the support staff and is available to all clients with current maintenance agreements. Call/Fax Toll free: +1.888.812.2335 (U.S. and Canada) Phone: +1.320.286.4600 (all other countries) Fax: +1.320.286.4500 To learn more about our products email info@paisley.com or visit www.paisley.com. AutoAudit for Windows is a registered trademark of Thomson Reuters. 2009 Thomson Reuters. All rights reserved. Republication or redistribution of Thomson Reuters content, including by framing or similar means, is prohibited without the prior written consent of Thomson Reuters. 'Thomson Reuters' and the Thomson Reuters logo are registered trademarks and trademarks of Thomson Reuters and its affiliated companies.. IT-INSTALL-030309 22