PHRED Installation Guide

Transcription

1 PHRED Installation Guide ColdFusion Version 10, SQL Server Database January 27, 2014 PHRED Installation Guide Page 1

2 Table of Contents Application Environment... 3 Application Tailoring... 4 Web Server Requirements... 6 ColdFusion Requirements... 6 ColdFusion Application Server Requirements... 6 User Requirements... 8 Installation Checklist... 9 PHRED Installation Installation Troubleshooting Notes pop-up windows do not display Charts do not display PDF Reports do not display Chinese characters This instruction set assumes that all items will be installed on the C drive. If you install items on a different drive, then changes the C references to whichever drive you install them on. PHRED Installation Guide Page 2

3 Application Environment ColdFusion applications can be deployed via web servers such as IIS, PWS, etc. to any compatible browser and platform. ColdFusion Server provides all of the necessary functionality for delivering Web applications. Each server includes a number of different services that handle page processing, security, state management, connection management, and a variety of other functions. Because the application server provides this technology, developers focus on the problem of creating applications and easily take advantage of all the functionality already provided by the server. HTTP Request 1 Internet or Intranet 2 Web Server CF Page Cold Fusion Application Server 3 Databases Directories File System Web Browser 5 Web page 4 Web page COM/CORBA Web Servers Client Network Server 1. When a user clicks a Submit button on a form or a hypertext link on a page, the user s Web browser sends an HTTP request to the Web server via the Internet or an intranet. 2. The Web server passes the data submitted by the client and the appropriate page to ColdFusion Server through a server API. 3. ColdFusion reads the data from the client and processes the CFML in the page. Based on the CFML, the server interacts with database servers, the file system, SMTP servers, and potentially other applications and extensions through the ColdFusion API or through COM/DCOM. 4. ColdFusion dynamically generates an HTML Web page that is returned to the Web server. 5. The Web server returns the HTML page to the user s browser. PHRED Installation Guide Page 3

4 Application Tailoring In the PHRED Administrator, the following things may be modified: Change a User s password (in case of forgotten passwords) Access ColdFusion Administration Run charts and reports via System Stats Delete Problems One at a time using the selection tree Control how the Tracking Data section is displayed via Tracking Data Maintenance Modify individual user s Login information via Login Maintain Support Tables: Action Subtype drop down list Action Type drop down list ActStatus Action Status drop down list apscfserver assign the server name and verity path apspdfreportpath assign the paths to execute and store PDF reports apssystem Options - self-registration, security, etc. Locations drop down list Close Without Resolution drop down list Coaching on all screens Commodity drop down list Company Name drop down list Help on all pages LoginGeneral logins of all who can access the tool Login Statements information displayed on the Login screen Max Limits set the maximum number of fields allowed for specific screens Project Name drop down list Screen Statements text on each 8D screen Real Coach or Experts list of people to contact for help Root Cause Groups drop down list Sample Problems set a problem as Sample to be viewed only Screen Statements text and hints on each of the screens Supporting Data Types Checklist Time Zones drop down list Warning Statements for automatic s These functions are limited to those with Administrator privileges. See PHRED Administrator instructions for more information. PHRED Installation Guide Page 4

5 PHRED Installation Guide Page 5

6 Web Server Requirements While there are several web servers that could be used to deliver the ColdFusion application to the Intranet, it is recommended that MS Internet Information Server (IIS) be used as the Intranet server. It is important that the web server is installed prior to installing ColdFusion. ColdFusion Requirements A licensed copy of ColdFusion version 8 must be installed on the web server in order to run this application. This must be purchased separately. A free 30-day evaluation version is available from Normally we recommend using the ColdFusion Standard edition. However, depending on your requirements, you may need to use the more advanced edition called Enterprise. See the product comparison chart on the Adobe website. Ensure that your web server has been installed prior to installing ColdFusion. ColdFusion Application Server Requirements ColdFusion Product Editions Processor Operating Systems Memory Windows ColdFusion 10 Standard Edition or Enterprise Edition, based upon user requirements Processor sufficient to support the Operating System in use Microsoft Windows Server 2003 Web Edition, Standard Edition, Enterprise Edition (SP1 and R2) Windows Server 2008 R2 Data Server SP1 Microsoft Windows 2000 Advanced Server, Datacenter Server, Server (SP3 or higher) Microsoft Windows 2000 Professional (SP3 or higher) Microsoft Windows XP Professional or Home Edition Windows Vista Hard Disk Free Space 500 MB Drives 512 MB RAM (2 Gig recommended) DVD ROM drive PHRED Installation Guide Page 6

7 Database ColdFusion uses 32-bit ODBC drivers to communicate with a wide variety of relational database systems. It has been tested for compatibility with the Microsoft ODBC Desktop Drivers, which are bundled with the product: -Microsoft SQL Server -Microsoft Access -Oracle If the driver you want to use is not listed, it is likely that it will work correctly with ColdFusion. In order to be used with ColdFusion, an ODBC driver must: -Be a 32-bit driver -Conform to Level 1 of the ODBC API -Support the core SQL grammar -Support date and/or time data types Database connections are established using the ColdFusion Administrator. The ColdFusion Administrator is a complete management console for application, application server, and server cluster administration. PHRED Installation Guide Page 7

8 User Requirements The only software required on the user s PC is a web browser to access the web pages. MS Internet Explorer version 6.0 or higher is the ONLY recommended browser at this time. MS Internet Explorer Setup: 1. Go to Internet Options. (On IE version 6.0 or higher Internet Options is located under the Tools pull down). 2. On the General tab, click on the Settings button. (IE 7 on the General tab under Browsing History, click the Settings button.) 3. Under the Check for newer versions of stored pages: heading, select Every visit to the page. (IE 7 Under the Check for newer versions of stored pages: heading, select Every time I visit the webpage.) 4. Click the OK button on the bottom of the Setting pop-up window. 5. Select the Security tab. 6. Select the Trusted Site icon on this pop-up window. 7. Click Site button and then add the server that PHRED is on as a trusted site. Click Apply, then OK. 8. Click the OK button on the bottom of the Internet Options pop-up window. PHRED Installation Guide Page 8

9 Installation Checklist ITEM # SECTION PAGE # TASK COMPLETED 1 User Requirements MS Internet Explorer Setup: 2 PHRED Installation 3 PHRED Installation 4 PHRED Installation 5 PHRED Installation 6 PHRED Installation 7 PHRED Installation 8 PHRED Installation 9 PHRED Installation 10 PHRED Installation 11 PHRED Installation 12 PHRED Installation 13 PHRED Installation 14 PHRED Installation 7 Change the settings in MS Internet Explorer -- Check for newer versions of stored pages: select Every visit to the page 10 Create a directory called PHRED under the wwwroot directory 10 Copy all of the files from the CD or zip file to this directory. 10 Restore the PHREDSQL.bak database into your SQL Server 10 Using the IIS administrator, create a new Virtual Directory under the Default Web Server that points to the top PHRED directory structure and set the IIS title to PHRED. 10 Make sure new directory and all subordinate directories/files have web execute permission 10 Copy all of the files from the Customtags directory to the Cfusion/customtags directory. 10 Make sure the ColdFusion services are running and set to Automatic Start. 10 Make sure the World Wide Web Publishing Service is set to Automatic Start, and has a started status. (IIS users only) 11 Set ColdFusion Server Variables 11 Set ColdFusion Session Variables 12 Create a SQL Server Datasource in the Cold Fusion Administrator 13 Enable Chinese characters by checking String Format to enable Unicode characters. 14 Set Mail Server for forgotten passwords PHRED Installation Guide Page 9

10 ITEM # SECTION PAGE # TASK COMPLETED 15 PHRED Installation 16 PHRED Installation 17 PHRED Installation 18 PHRED Installation 14 Set the Servers Swap File. (optional) 15 Set the Maximum number of POST request parameters 16 Set the Scheduled Task. 17 Set up the APSCFServer table in the application to reflect the name of your server. PHRED Installation Guide Page 10

11 PHRED Installation 1. Create a directory called PHRED either under the wwwroot directory (typically this will be c:\inetpub\wwwroot\phred); or on the data drive (for example; D:\websites\PHRED). 2. Copy all of the files from the CD or zip file to this directory. 3. Using the Restore option in SQL Server, restore the PHREDSQL_XXX (where XXX is the companyname).bak database into your SQL Server system. 4. Using the IIS administrator, create a new Virtual Directory under the Default Web Server that points to the top PHRED directory structure and set the IIS title to PHRED. (Note: Create this virtual directory, even if there is already an existing folder with the directory name. Do not delete the preexisting window folder) 5. Make sure new directory and all subordinate directories/files have web execute permission. 6. Copy all of the files from the Customtags directory, PHRED\Customtags, to the Cfusion\Customtags directory. This enables Search and other functions to run properly. 7. Make sure the ColdFusion Services are set to automatic start and are running. 8. Make sure the World Wide Web Publishing Service is set to Automatic Start, and has a started status. PHRED Installation Guide Page 11

12 9. Login to the ColdFusion Administrator. Under Server Settings, select Memory Variables. Ensure the Enable J2EE Session Variables, Enable Session Variables and Enable Application Variables are selected. 10. Change session settings to client preferences. This should be longer than the default 20 minutes. We recommend a couple of hours at least. If the user times out before saving, the changes will be lost. PHRED Installation Guide Page 12

13 11. Also in the ColdFusion Administrator under Data Sources, select SQL Server as the driver and set the Data Source Name to PHREDSQL_XXX (where XXX is company name). Then click Add. 12. Enter the Database as PHREDSQL_XXX (where XXX is the company name). Enter the name of your SQL Server Server. Set the Username to phred. PHREDSQL_XXX ships with a pre-established Username of phred and a placeholder password of phred. Change the Password both in SQL Server and here to meet the security requirements of your company. PHRED Installation Guide Page 13

14 Also to enable Chinese characters, check String Format, to enable the Unicode characters. Change the Port number, if needed, to meet your security requirements. 13. Click Submit to return to the previous page. Status should be verified, which checks the connection. This insures you have not made a typo in the path name and that ColdFusion can get there from here. 14. Only if the database cannot be verified, click on the PHREDSQL_XXX data source then update the name of the database or server that it is located on. Another possibility is that the SQL Server Group properties are not set correctly. Under SQL Server Services, select the SQL Server Agent. Under Logon select This account and enter the credentials for the PHRED database.this works differently depending on local system settings. PHRED Installation Guide Page 14

15 15. Under Server Settings in the left column, click on Mail. Point to your Mail Server for forgotten passwords to be ed back to the address used when registering. 16. Servers Swap File: Verity requires some additional space to build/index the Collections. It is best if the server s swap file is set to 2-1/2 to 3 times the memory size. This means that if you have 1000 Mbytes of memory, then your swap file should be set to 2500 Mbytes to 3000 Mbytes. If this is larger than allowed, then set it to the largest amount possible. 17. Under server settings, select settings. Increase the value of the Maximum number of POST request parameters to from the default value of 10, under the subheading of Request size limits. PHRED Installation Guide Page 15

16 18. Scheduled Task In order to make Verity Collections work, you must setup a Scheduled Task that updates the collections twice a day for the best performance. In the Debugging and Logging section, click Scheduled Tasks then click Schedule New Task. Fill in the information as shown below. The Frequency and exact time to run the task is up to you. Point the URL towards the IndexVerityCollections.cfm file using the full http address. In the Publish section towards the bottom of the page, in the File field point to the ScheduledTask.htm file that is located in the ScheduledTask subdirectory. This requires a physical mapping to where the file is located on the server. Use backslashes to separate the sections. This file will hold the output of the indexing the procedure when it runs. Check the Save output to a file checkbox. Once all of the values have been filled in and verified, click Submit to activate the Scheduled Task. You will get a successful completion message if everything is setup correctly. Note: You can see the results of this Scheduled Task on the PHRED Admin page in either of two locations: Verity Collection Index Log or Verity Collection Scheduled Task Review. PHRED Installation Guide Page 16

17 19. Login to PHRED and select Administration. Select System Setup option. On the system setup administrator screen change the server name, and path in the ServerName field to the name of the server where the application code resides. Change the name and path of the Verity Collections in the VerityPath field to match where these physically reside on the server. Change the Attachments name and path in the AttachPath field to match where these physically reside on the server. Change the report path in the PDF Reports Path field to match where these physically reside on the server. Then click Next. PHRED Installation Guide Page 17

18 20. Create the Verity Collections Also within Administration, click Verity Collection Action and Create Indexes. It will automatically set up the collections which enable keyword searching. PHRED Installation Guide Page 18

19 Installation Troubleshooting Following are several suggestions for addressing common PHRED installation problems. Additional support is available for ColdFusion via the world web wide from Adobe, the developers of ColdFusion, at In their support section, support forums, Knowledge base and Installation support are available at no charge. The keyword search facility is normally quite helpful. Notes pop-up windows do not display If you have installed any type of Pop-up Blocker, the Notes pop-up windows will be blocked. Most Pop-up Blockers can be customized to view pop-up windows at certain sites. You may either customize your Pop up-blocker, or uninstall it to alleviate this problem. Charts do not display With a new installation of CFMX sometimes it does not work right from the install with flash forms or graph and chart production. Through research into these problems I've found there are a number of problems with a number of fixes. Problem: /CFIDE mapping does not exist in coldfusion directory Solution: Add a mapping to the CFIDE directory in your /wwwroot folder in the CF admin Problem: CFIDE and JRunScripts directories not mapped in IIS Solution: If you don't have the CFIDE and JRunScripts (/cf_root/runtime\lib\wsconfig\1) directory mapped as virtual directories for your website in IIS ColdFusion will not have access to the components it needs to generate the flash/graphs. Problem: CFIDE and JRunScripts directory exists as a virtual directory but it still doesn't work Solution: Go to the properties of each directory in IIS and go to the 'Virtual Directory tab'. Make sure that the 'Application Name' and 'Starting Point' are both 'Default Application' (unless you have a reason otherwise) and that the 'Execute Permissions' are set to 'Scripts and Executables Not Scripts ONLY! PHRED Installation Guide Page 19

20 Problem: The CFIDE and JRunScripts are set up correctly as described and it still doesn't work. Solution: Go the the properties of the website in IIS and click on the 'Home Directory' tab. Check that the 'Execute Permissions' are 'Scripts only' or 'Scripts and Executables' depending on your needs. Click the configure tab and look down the mappings for.cfm.swf and click edit. Be sure the check box 'Check that file exists' is unchecked. PDF Reports do not display Chinese characters 1. The Coldfusion update needs to be installed true type collections need to be deleted. SimSun.ttc and MingLui.ttc These can be done in any order. Apply the Coldfusion update Select the English Windows Updater. It is 130 MB. below. Updating a ColdFusion 8 server configuration on Windows This section explains how to install ColdFusion 8 Update 1 on a server configuration on a Windows platform. Read the ColdFusion 8 server configuration installation notes before you install the update. To install ColdFusion 8 Update 1 on Windows: 1. Close any applications that are currently running on your computer. 2. If you are running the server configuration, stop the following Services: ColdFusion 8 Application Server ColdFusion 8 Search Server All ODBC services 3. Run CF801_Win_Updater.exe. The Install Wizard starts. 4. Follow the instructions in the wizard. Select the Server Configuration option on the Configure Installer page. Respond as appropriate to all other options; for example, specify the location of the ColdFusion 8 installation that you are updating and the location of the CFIDE directory. Let the installer run to completion. Note: If you use IIS as your web server and do not shut it down in step 3, ColdFusion attempts to shut down each site individually and restart it after installing Update 1. If you have large numbers of sites, this might take a long time. 5. After the Pre-Installation Summary page of the wizard, the updater copies updated files to your computer and upgrades any configured web server connectors. 6. After the installation is complete, ensure that any services that you stopped in step 2 are running; restart them if they are not running. PHRED Installation Guide Page 20

21 Remove the 2 TTC fonts. These fonts were not easy to remove, due to access issues. Below is what we did. With the two Chinese true type collections (SimSun.ttc and MingLiu.ttc) and now the Chinese characters show up in the PDF file. So here is what we did to get rid of these fonts: 1. Backup the Registry. Go to the Command Prompt and enter "regedit /e backupfilename". Backupfilename: "c:/backups/regbkup reg", or whatever name you normally use. 2. Find and delete all occurrences of these two files by searching on SimSun.tcc and MingLiu.ttc. They will both appear in the same section of the registry so it should be easy to find both of them. 3. Reboot the server. 4. You can try to directly delete them in the fonts directory: c:/windows/fonts, but this didn't work for me. If it does, then you're home free. Just reboot the server and you should be good to go. If you are denied access then you'll have to go the more complicated route to remove the 2 ttc s Either boot the server in SAFE mode and delete the 2 TTC s or Go into DOS via the Command Prompt again and set your directory to the fonts directory: c:/windows/fonts<r> Before you will be able to delete them (because of access issues) you'll have to rename them: c:/windows/fonts> rename SimSun.ttc SimSun.badc<r> c:/windows/fonts> rename MingLiu.ttc MingLiu.badc<r> Now you can delete them: c:/windows/fonts>del *.badc<r> 5. Reboot the Server. Go into the CF Admin to the Font Manager section and look at the bottom section that is entitled System Fonts. These two fonts should no longer appear. Run the report and check to see that the fonts now appear in the PDF file. Note: I originally just deleted the SimSun.ttc (Simplified Chinese font) but this wasn't enough. I had to delete the Traditional fonts as well - MingLiu.ttc. PHRED Installation Guide Page 21