Documenti di Didattica
Documenti di Professioni
Documenti di Cultura
Table of Contents
About This Guide .......................................................................3
Installing the Appropriate Driver .............................................................4 Installing OHM Files and Configuring Data Sources .............................................5 Apache Tomcat Versions ..............................................................5 Install OHM Files on Apache Tomcat ....................................................5 Configure Data Sources for Apache Tomcat ...............................................7 Update Data Sources (SQL Server from OHM 7.0) for Apache Tomcat .........................8 Oracle WebLogic Versions .............................................................9 Install OHM Files on Oracle WebLogic ...................................................9 Configure Data Sources for Oracle WebLogic ............................................11 Update Data Sources (SQL Server from OHM 7.0) for WebLogic .............................13 IBM WebSphere Versions ............................................................14 Install OHM Files on IBM WebSphere ...................................................14 Configure Data Sources for IBM WebSphere .............................................18 Update Data Sources (SQL Server from OHM 7.0) for WebSphere ...........................21 Register OHM/Web......................................................................21 Change Password ......................................................................23 Define Setup Properties ..................................................................24 Define Global Properties .............................................................24 Define LDAP Properties ..............................................................29 Define Special Properties .............................................................30 Define Account Properties ............................................................32 Move Static Resources to Web Server ......................................................36 Communicate OHM/Web URL Address to Users ..............................................37 Creating Databases .....................................................................37 Connect to Data Source ..............................................................37 Create the Database ................................................................38 Updating Databases .....................................................................39 Connect to Data Source ..............................................................40 Update OHM Database and Tables .....................................................40 Update/Upload Reports ..............................................................41
Additional Information
Page 3
If you typically run SQL scripts directly in OHM, click the following link: Run the SQL script used to create all of the database audit triggers.
2. After you have updated or created your databases, re-enable auditing for the appropriate tables. This guide describes the process system administrators and PureSafety internal support will follow to install OHM/Web 7.2. NOTE: Prerequisites: Before installing OHM/Web 7.2, make sure you have done the following: You must install Java Runtime Environment (JRE) 1.6 or higher on the server where you will install OHM. We have changed minimum requirements in OHM 7.1. Install the appropriate drivers. If you have custom reports, they must be modified. Contact PureSafety customer support for assistance in determining if they should continue to use the compatibility settings until they can update their reports.
The installation process consists of the following phases: 1. Install the OHM application files on your application server and configure data sources. 2. Register the OHM/Web application and define account properties. 3. Create or Install databases. New Install: create your database. Upgrading: Update your organization's databases.
4. Load reports. Here are some general recommendations to keep in mind as you plan your install or upgrade: After you set up your database accounts, you have to restart OHM for your changes to take effect. Users should not be logged in to the system while you are upgrading your databases.
Install the driver you download in the appropriate location based on the application server you use.
Page 4
You can use anything you want as the JNDI Data Source Name (note that it must begin with jdbc/), but be sure to write it down because you will need it later, in the Connecting to the Data Source from OHM section. 3. Restart the application server after installing the application.
NOTE: Customers upgrading from an earlier version of OHM/Web: You must undeploy the old WAR file before you can deploy the new one, which you are instructed to do in step 2 below.
Page 5
1.
Start the Apache Tomcat Application Manager: http://example.org:8080/manager/html, where example.org is your server address. The Management Console screen appears.
2. 3.
On the Management Console, locate the old WAR file and click Undeploy in the Commands column on that row. Go to Deploy section> WAR file to deploy sub-section. In the Select WAR file to upload field, enter the full path and file name of the ohm.war file. Note: If you use the file directly from the CD you have received, the path and file name are a reference such as D:\ohmweb\ohm.war (the drive letter reference may vary based upon the PC disk drive configuration).
4.
Click Deploy.
Page 6
Once you have uploaded the WAR file, you must register and configure the OHM/Web application. For detailed instructions, refer to the Registering OHM topic in this guide.
Unlike the other application servers in this guide, Apache Tomcat does not have a graphical user interface for creating JNDI resources. You need to manually edit the Tomcat configuration files to create a data source. For a list of Apache Tomcat supported versions see OHM Technical Requirements. OHM 7.2 Client-Hosted Technical Requirements. 1. 2. 3. 4. Before starting to configure your data source, stop your Tomcat server. Go to your Tomcat application directory (for example, C:\Program Files\Apache Software Foundation\Tomcat 6.0). Go to the conf directory. Open the Context.xml file with a plain-text editor, such as Notepad, WordPad, Notepad++, TextEdit, or VIM (depending on your operating system). The root node in this file is the Context node. All resources in this file should be placed between the beginning Context tag (<Context>) and the ending Context tag (</Context>). Option If you are creating an Oracle data source, place the following XML tag between the Context tags: Description <Resource name="jdbc/ohmoracle" auth="Container" type="javax.sql.DataSource" removeAbandoned="true" removeAbandonedTimeout="30" logAbandoned="true" maxActive="100" maxIdle="30" maxWait="10000" validationQuery="SELECT 1 FROM DUAL" username="[username]" password="[password]" driverClassName="oracle.jdbc.driver.OracleDrive r" url="jdbc:oracle:thin:@[server]:1521:[SID]" />
Page 7
Option If you are creating a Microsoft SQL Server data source using MS SQL 2005 or 2008, place the following XML tag between the Context tags:
Description <Resource name="jdbc/ohmsql" auth="Container" type="javax.sql.DataSource" removeAbandoned="true" removeAbandonedTimeout="30" logAbandoned="true" maxActive="100" validationQuery="SELECT GETDATE()" testOnReturn="true" maxIdle="30" maxWait="10000" username="[username]" password="[password]" driverClassName="net.sourceforge.jtds.jdbc.Driv er" url="jdbc:jtds:sqlserver://[server]:1433/[datab ase]" />
5.
The name attribute in these tags represents the JNDI Data Source Name (jdbc/ohmoracle or jdbc/ohmsql). You can change this name to a different one as long as the new name begins with jdbc/ and is not the same name as the name of another data source. Replace [username], [password], [server] and [SID] or [database] with the database user, login password, server name and Oracle SID or SQL database, respectively. Note: If your SQL Server database machine has multiple instances of SQL Server installed on it, you should use the following URL instead: jdbc:jtds:sqlserver://[server]/[database];instance=[instancename]. Replace [instancename] with the name of the appropriate SQL Server instance. Restart your Tomcat server. If you have configured the Context.xml file properly, you should now have a working data source to use in OHM. If Tomcat fails to start or exhibits odd behavior, you may have malformed XML in the Context.xml file. We recommend familiarizing yourself with XML files and syntax before attempting to edit this file.
6.
Tomcat, Apache, and their logos are trademarks of the Apache Software Foundation for open source software.
Update Data Sources (SQL Server from OHM 7.0) for Apache Tomcat
This step applies only to SQL Server customers who are upgrading from OHM 7.0 to 7.2. If you are currently using version... Pre-7.0 7.0 and use an Oracle database 7.1 Do this... Refer to Configure Data Sources. You do not have to update your data sources You do not have to update or configure your data sources.
Page 8
Unlike the other application servers in this guide, Apache Tomcat does not have a graphical user interface for creating JNDI resources. You need to manually edit the Tomcat configuration files to create a data source. For a list of Apache Tomcat supported versions see OHM 7.2 Client-Hosted Technical Requirements. 1. 2. 3. 4. Before updating your data source, stop your Tomcat server. Go to your Tomcat application directory (for example, C:\Program Files\Apache Software Foundation\Tomcat). Go to the conf directory. Open the context.xml file with a plain-text editor, such as Notepad, WordPad, Notepad++, TextEdit, or VIM (depending on your operating system). The root node in this file is the Context node. All resources in this file should be placed between the beginning Context tag (<Context>) and the ending Context tag (</Context>). Edit the value in the driverClassName attribute. You must change it from "om.microsoft.sqlserver.jdbc.SQLServerDriver" to "net.sourceforge.jtds.jdbc.Driver". Edit the value in the url attribute. You must change it to "jdbc:jtds:sqlserver://[server]:1433/[database".
If your SQL Server database machine has multiple instances of SQL Server installed on it, you should use the following URL instead: jdbc:jtds:sqlserver://[server]/[database];instance=[instancename]. Replace [instancename] with the name of the appropriate SQL Server instance.
5. 6.
7.
Restart your Tomcat server. If you have configured the Context.xml file properly, you should now have a working data source to use in OHM. If Tomcat fails to start or exhibits odd behavior, you may have malformed XML in the Context.xml file. We recommend familiarizing yourself with XML files and syntax before attempting to edit this file.
Tomcat, Apache, and their logos are trademarks of the Apache Software Foundation for open source software.
Page 9
1.
Start the Oracle WebLogic Console Application: http://example.org:8080/console/, where example.org is your server address.
2.
Page 10
3.
4. 5.
Enter the path where the ohm.war file is located, select the ohm.war radio button, and click Next. Complete the additional information you are prompted to enter and click Next. Click Finish when done.
Once the WAR file has been uploaded, you must register and configure the OHM/Web application. For detailed instructions, refer to the Registering OHM" topic in this guide. After you have registered and configured the OHM/Web application, you may start the application using the following URL: http://servername:7001/ohm/OHMIndex.
Page 11
5.
Enter the data source name (for example, ohmoracle) in the Name field and the JNDI Data Source Name (for example, jdbc/ohmoracle) in the JNDI Name field.
6.
Select Oracle or MS SQL Server in the Database Type field. If you use Oracle, you must use a JDBC driver supplied by Oracle (for example, ojdbc6.jar 11.1.0.7.0 +). in the Database Driver field. You can download it from here: http://www.oracle.com/technetwork/database/features/jdbc/index-091264.html.. If you selected SQL Server, choose Other in the Database Driver field.
7. 8. 9. 10.
Click Next. On the next page, clear the Supports Global Transactions option and click Next. On the next page, enter the database name (or SID for Oracle) in the Database Name field. Enter the host name, database user name, and password in the other fields. The pre-populated port number should be correct unless your DBA has specified a non-standard port number. If you use SQL Server, you need to find out and enter the port number, which is usually 1433 or empty if there are multiple SQL Server instances installed. Click Next.
Page 12
11.
On the last page: If you use Oracle, verify that the Driver Class Name and URL are correct and click Test Configuration. If you use SQL Server, enter the following data: In the Driver Class Name field, enter "net.sourceforge.jtds.jdbc.Driver". In the URL field, enter
jdbc:jtds:sqlserver://[server]/[database];instance=[instancename]
if there is only one SQL Server instance. Replace [server] with the hostname or IP address of your SQL Server,[database] with the database to open, and [instancename] with the name of the SQL Server instance to connect to. In the Properties field, add the line below indicating the SQL Server database login name (applicable only for SQL Server database).
user=<SQL Server database login name>
If the test fails, check your settings for accuracy. When the test succeeds, click Finish. On the next page, click on the data source you just created. Then, click on the Targets tab. Select the check box beside the WebLogic server on which OHM/Web is deployed. Click Save. Your data source is now ready to be used by OHM/Web 7.2.
Oracle and WebLogic Server are registered trademarks of Oracle Corporation and its affiliates.
Update Data Sources (SQL Server from OHM 7.0) for WebLogic
This step applies only to SQL Server customers who are upgrading from OHM 7.0 to 7.2. If you are currently using version... Pre-7.0 7.0 and use an Oracle database Do this... Refer to Configure Data Sources. You do not have to update your data sources
Page 13
You must remove and recreate your data source, using the new driver class name ("net.sourceforge.jtds.jdbc.Driver") and JDBC URL ("jdbc:jtds:sqlserver://[server]:1433/[database"). For additional help, review your application server documentation; if you need further assistance, contact your application server customer support. NOTE: If your SQL Server database machine has multiple instances of SQL Server installed on it, you should use the following URL instead: jdbc:jtds:sqlserver://[server]/[database];instance=[instancename]. Replace [instancename] with the name of the appropriate SQL Server instance.
Page 14
2.
Go to Applications> Application Types> WebSphere Enterprise Applications. The Enterprise Applications page appears.
3.
If you are a current OHM customer, redeploying OHM, complete the following steps: (a) In the applications table, select the check box next to the OHM application you are redeploying, and click the Stop button in the toolbar. The application is stopped. (b) Once the application status changes to Stopped, select the same check box again, and click the Uninstall button. (c) Click OK to confirm your action. (d) In the Messages section, click the Save directly to the master configuration link.
Click Install. Browse and select the ohm.war file and click Next. Note that it might wake a while for the .war file to upload. On the Preparing for the application installation page, select Detailed and click Next. Next, select the Detailed installation option. On Application Security Warnings page, click Continue. On Step 1 of the new application installation process, you have the option to change the application name to whatever desired (you can use just "OHM"). Then, click Next. On Step 2, select the check box next to the OHM-Web Application and click Next. On Step 3, click Next. You do not have to do anything on this page. On Step 4, click Next. You do not have to do anything on this page. On Step 5, click Next. You do not have to do anything on this page. On Step 6, click Next. You do not have to do anything on this page. On Step 7, select the check box next to the OHM-Web Application, select the appropriate virtual host (often, this is default_host), and click Next. On Step 8, enter the appropriate context root (usually this is /ohm) and click Next.
Page 15
17.
On Step 9, which is the Summary page, click Finish. Note that it will take several minutes for OHM to deploy, and the next page will load incrementally (one line at a time).
Page 16
18.
When you see the "Application OHM installed successfully" message, click the Manage Applications link. NOTE: Do not click Save yet!
19.
Page 17
20.
Click the OHM-Web Application link In the Class loader order field, select the Classes loaded with local class loader first (parent last) option. Click Apply. Click OK. Click OK again. In the Messages section, click the Save directly to the master configuration link. This may take a few moments. Select the check box next to the application you just deployed ("OHM") and click Start.
Page 18
2.
In the menu on the left, go to Resources> JDBC> JDBC Providers. (a) If you are using Oracle and an Oracle provider does not already exist, or if you are using SQL Server and a jTDS provider does not already exist, click the New button to add a provider. Otherwise, skip to Step 3 below. (b) If you use Oracle, select Oracle in the Database Type field. If you use SQL Server, select User-defined in the Database Type field. (c) If you use Oracle, select Oracle JDBC Driver in the Provider Type field. (d) If you use SQL Server, enter net.sourceforge.jtds.jdbcx.JtdsDataSource in the Implementation Class Name field. (e) If you use Oracle, select Connection pool data source in the Implementation Type field. (f) Provide a name and description, and click Next. (g) Enter nothing in the Class Path or Directory Location fields, and click Next. (h) On the summary page, click Finish. (i) On the JDBC Providers screen, click on the provider you just created. (j) Enter the full path to the driver file (including the JAR file name and extension) in the Class Path field and click Apply. Click OK. (k) Click Save directly to the master configuration. This might take a few minutes. In the menu on the left, go to Resources> JDBC> Data Sources. Click New to create a data source. In Step 1, enter a data source name (for example, ohmoracle) and a JNDI name (for example, jdbc/ohmoracle). Click Next. In Step 2, click Select an existing JDBC provider, select the Oracle or jTDS (SQL Server) provider, and click Next. In Step 3: If you use SQL Server (and thus jTDS), leave the default options selected on the page and click Next. If you use Oracle, enter jdbc:oracle:thin:@[server]:[port]:[SID] in the URL field, select the appropriate 9i, 10g, or 11g data store helper in the Data Store Helper Class Name field (according to the Oracle version you are running), and click Next. In Step 4, you dont have to populate any fields. Click Next. In Step 5, review the summary page. When done, click Finish. The Changes have been made to your local configuration message appears at the top of the page. Click the Save link. Scroll down the page, and click the data source you just created (for example, ohmoracle). On the next page, select Additional properties> Custom properties on the right side of the screen.
3. 4. 5. 6. 7. 8.
Page 19
13.
Create Custom Properties if you use SQL Server (and thus jTDS). (a) Create a new property called 'URL.' 1. Click New. 2. Enter the name URL (all uppercase). 3. Enter the value
jdbc:jtds:<server_type>://<server>[:<port>][/<database>][;<property>=<value>[;...]]
where <server_type> is one of either 'sqlserver' or 'sybase' (their meaning is quite obvious), <port> is the port the database server is listening to (default is 1433 for SQL Server and 7100 for Sybase) and <database> is the database name -- JDBC term: catalog -- (if not specified, the user's default database is used). The set of properties supported by jTDS is: instance: Named instance to connect to. SQL Server can run multiple so-called "named instances" (i.e. different server instances, running on different TCP ports) on the same machine. When using Microsoft tools, selecting one of these instances is made by using "<host_name>\<instance_name>" instead of the usual "<host_name>". With jTDS you will have to split the two and use the instance name as a property. 4. Click OK. (b) Create a new property called 'serverName.' 1. Click New. 2. Enter the name serverName (uppercase N). 3. Enter the value of your SQL Server hostname or IP address. 4. Click OK. (c) Create a new property called 'databaseName.' 1. Click New. 2. Enter the name databaseName (uppercase N). 3. Enter the value of the name of the database you wish to open. 4. Click OK. (d) Create a new property if there are multiple instance of SQL Server on the same machine. 1. Click New. 2. Enter the name instance (all lowercase). 3. Enter the value of the name of the SQL Server instance you wish to connect to. 4. Click OK. (e) Create a new property 'user.' 1. Click New. 2. Enter the name user (all lowercase). 3. Enter the value of the database user (login) username. 4. Click OK. (f) Create a new property 'password.' 1. Click New. 2. Enter the name password (all lowercase).
Page 20
3. Enter the value of the database user (login) password. 4. Click OK. 14. 15. 16. Click Save. A message displays at the top of the page "Changes have been made to your local configuration." Click on Resources> JDBC> Data Sources, scroll down the page, and click on the data source you just created (for example, ohmsql). On the next page, click Test Connection. If the connection fails, check all your settings for accuracy. If it succeeds, you are ready to use the data source with OHM.
Update Data Sources (SQL Server from OHM 7.0) for WebSphere
This step applies only to SQL Server customers who are upgrading from OHM 7.0 to 7.2. If you are currently using version... Pre-7.0 7.0 and use an Oracle database 7.1 Do this... Refer to Configure Data Sources. You do not have to update your data sources You do not have to update or configure your data sources.
You must remove and recreate your data source, using the new driver class name ("net.sourceforge.jtds.jdbc.Driver") and JDBC URL ("jdbc:jtds:sqlserver://[server]:1433/[database"). For additional help, review your application server documentation; if you need further assistance, contact your application server customer support. NOTE: If your SQL Server database machine has multiple instances of SQL Server installed on it, you should use the following URL instead: jdbc:jtds:sqlserver://[server]/[database];instance=[instancename]. Replace [instancename] with the name of the appropriate SQL Server instance.
Register OHM/Web
The following steps outline registering OHM/Web 7.2. 1. In a browser, go to the following URL: http://server:port/appurl/do/config, where: Server is the name of the server where the OHM/Web application is installed. Port is the port name, if one is required by the application server configuration. Appurl is the application URL on the server for the OHM application. An example would be http://www.myserver.com/ohm/do/config. Depending on the Java application server you are using and how it is configured, a port number may or may not be required. For example: Apache Tomcat: http://www.myserver.com:8080/ohm/Setup Oracle WebLogic: http://www.myserver.com:8888/ohm/Setup IBM WebSphere: http://www.myserver.com:9080/ohm/Setup
Page 21
2.
On the Software License Agreement page, enter the password for the OHM/Application Setup screen. The password is case sensitive. The default password is PASSWORD. Read the agreement, click the radio button to accept the agreement, and click Continue.
Page 22
3.
In the side navigation bar, click Register. Enter all the necessary information. Fields with a red asterisk are required. Be sure to enter the real serial number, which appears on the label of the CD with the OHM/Web program files. NOTE: This step will attempt to contact PureSafety via the Internet for authentication. Therefore, the application server must have an Internet connection. If the application server does not have an Internet connection, contact PureSafety at 800-332-8089 to obtain a registration key.
4.
Change Password
We recommend that you change the password to the account configuration screen to ensure only appropriate users have access to the account. You can do this at any time before or after you register. 1. 2. 3. In the side navigation bar, click Change Password. Enter the old and the new passwords, as required. The new password must be at least 6 characters long. Click Change Password. After changing the password, the system returns to the Setup screen.
Page 23
Page 24
Page 25
Description Application server OHM/Web is installed on. OHM automatically selects the application server it detects, so you should change this value only if you are absolutely certain it is not correct. If your application server is not available in the drop-down menu, OHM will not run properly on your server. Path for the file where any error or log messages are written. Select the level of detail you want to see in the troubleshooting log. If OHM generates errors or warnings, support can use this information to correct issues. Trace Information (Not Recommended). This option logs trace messages, debug messages, informational messages, warnings, standard errors, and fatal errors. Typically, the system generates 50-100 trace messages for each loaded page. We do not recommend you use this option because it provides a large amount of information. Debug Information (Not Recommended). This option logs debug messages, informational messages, warnings, standard errors, and fatal errors. Typically, the system generates 10-30 debug messages for each loaded page. We do not recommend you use this option unless customer support specifically asks you to enable it. Informational Messages (Enable detailed logger). If you select this option, the system works the same way as it did previously if you had selected the Enable detailed logger (debug) check box. This option logs informational messages, warnings, standard errors, and fatal errors. Typically, the system generates 3-8 informational messages for each loaded page. This option is useful because it provides information about what happens when a page is loaded that helps administrators troubleshoot issues. Warnings (Default, Recommended). When you upgrade to OHM 7.2, the system uses this value by default. This option logs warnings, standard errors, and fatal errors. We recommend this option because it provides the level of detail system administrators need to evaluate the OHM application. Errors. This option logs only standard and fatal errors. We do not recommend using this option because it leaves out warnings, which we recommend you review. Fatal Errors (Not Recommended). This option logs only fatal errors. We do not recommend using this option because it leaves out messages that we recommend you review, such as warnings and standard errors.
Serial number used when you registered the OHM/Web application. E-mail address where any failed logons are sent. The system sends an e-mail message to this address when someone attempts to log in to the application with an invalid password, user name, or account code. To disable this feature, leave this field blank. E-mail address where any database errors are sent. The system sends an e-mail message to this address whenever a database error occurs that the OHM/Web application does not handle (for example, insufficient tablespace errors, database offline errors). To disable this feature, leave this field blank. E-mail address where any application errors are sent. To disable this feature, leave this field blank.
Page 26
Property Email Errors From Email SMTP Server Logon Account Field
Description E-mail address used as the Sender when error messages are e-mailed to the appropriate administrator. To disable this feature, leave this field blank. SMTP mail host used by the application to send e-mails, such as e-mails sent as reports and notifications. Select Show Account Listing to display a drop-down list of accounts in the Account field on the logon screen. Select Free Text Field to allow users to enter an account name in the Account field on the logon screen.
Leave as DEFAULT and the default database account is used. Application name section in the URL used to run the program. It should be set by inspecting the URL used to start the Setup program. In the example above, the URL to run the setup program is http://localhost/ohm/Setup, so we would enter ohm in this field.
Temporary Directory
Path where OHM/Web writes temporary work files. The application server process must have full rights to this path. The directory must exist before OHM/Web is started. Path where OHM/Web stores files containing archived employees. If you leave this field blank, this data is stored in the database. Path where OHM/Web stores scanned and uploaded documents and images. If you leave this field blank, documents are stored in the database. Path where the OHM/Web spell check dictionary and other application resources, such as ssceam.tlx and ohmweb.ddf, are located. These files are normally located in the lex subdirectory when the OHM.WAR file is unzipped. For application servers where the OHM.WAR file is not exploded, these files must be manually extracted from the OHM.WAR file. This directory is required and must exist before OHM/Web is started.
Directory on the server where OHM/Web stores report output files, such as PDF and RTF files. If you leave this field blank, this data is stored in the database. URL used to access generated reports. The default URL is @PROTOCOL://@SERVER:@PORT/@APPURL/GetReport. OHM/Web dynamically replaces the placeholders @PROTOCOL, @SERVER, @PORT, and @APPURL with the appropriate values when the user logs in. URL where OHM/Web image files are stored. The default URL is @PROTOCOL://@SERVER:@PORT/@APPURL/share/images/. OHM/Web dynamically replaces the placeholders @PROTOCOL, @SERVER, @PORT, and @APPURL with the appropriate values when the user logs in. Change this setting only if you place image files in a different location than the shared directory. See the Moving Static Resources to a Web Server Directory section at the end of this document.
URL where OHM/Web stores OHMApplet.class and any Active X controls it uses. The default URL is @PROTOCOL://@SERVER:@PORT/@APPURL/share/applets/.
Page 27
Property
Description OHM/Web dynamically replaces the placeholders @PROTOCOL, @SERVER, @PORT, and @APPURL with the appropriate values when the user logs in.
URL where OHM/Web stores Javascript files and stylesheets. The default URL is @PROTOCOL://@SERVER:@PORT/@APPURL/share/scripts/. OHM/Web dynamically replaces the placeholders @PROTOCOL, @SERVER, @PORT, and @APPURL with the appropriate values when the user logs in.
URL where JSP files are located. The default URL is @PROTOCOL://@SERVER:@PORT/@APPURL/jsp/. OHM/Web dynamically replaces the placeholders @PROTOCOL, @SERVER, @PORT, and @APPURL with the appropriate values at the time the user logs in. URL where OHM/Web servlets are executed from. The default URL is @PROTOCOL://@SERVER:@PORT/@APPURL/. OHM/Web dynamically replaces the placeholders @PROTOCOL, @SERVER, @PORT, and @APPURL with the appropriate values at the time the user logs in.
Select this check box to enable a profiling mechanism in OHM/Web. Clear check box to disable it. The statistical profiler tells the administrator what sections of OHM/Web are using the most server processing time.
Select this check box to enable OHM/Web to use browser cookies for session management. Typically, this setting is enabled. However, if local security guidelines specify that cookies should not be stored, you can disable it. Clear the check box to disable it.
Select this check box to enable OHM/Web to convert HTTP requests to UTF-8. Typically, this setting is enabled. Clear the check box to disable this behavior.
Select this check box to enable the validation of request IP addresses against session IDs as an extra level of security. If users connect with an IP address that won't change during the life of a session, this setting can be set to Yes. Clear the check box to disable this behavior. If users connect through a pool of IP addresses and not with a single IP address through the life of a single session, this setting should be disabled.
Select the check box to ensure the Logon page remembers the last account that the user logged in to. Clear the check box to ensure the Logon page initially displays the default account.
Select the check box to ensure the Logon page doesnt display any account to log in to. You must define a default account, and users can log in only to that default account. Clear the check box to disable this functionality and ensure that the Database Tools (which show tablespace settings, etc.) in the Setup module are hidden. This
Page 28
Property
Description setting is often disabled in environments where database settings should not be available to application users.
Select the check box to enable the audit features of OHM/Web. For more information about the audit log refer to the Audit Log Configuration Web document. Clear the check box to disable the audit features of OHM/Web.
Clear the check box to ensure that the table used to define background jobs is hidden. Background jobs can be used to execute commands on the server. Hiding the table prevents users from accessing this functionality. Select the check box to enable OHM/Web to load a Java Applet for every page that requires one. Clear the check box to have OHM/Web load only the applet for main pages. If the majority of users use Internet Explorer, set this field to No.
Property Enable LDAP support check box Initial Context Factory field
Description Select this check box if using Lightweight Directory Access Protocol (LDAP) to authenticate user logons. Enter the class used to create the LDAP context, for example, sun.com.jndi.ldap.LdapCtxFactory. Check with the system administrator if you are
Page 29
Property
Description not sure what value to use this field. Click the Check button to verify that this is a valid entry.
Format for the user name that is passed to the LDAP server, for example: @USER@domain.com cn=@USER,cn=Users,dc=domain,dc=com If there are multiple organizational units in which the name may be found and the LDAP service can recognize it, @USER@domain.com is the preferred setting If the LDAP service does not recognize the @USER@domain.com format, the name may need to have each component defined. If this is the case, enter a format similar to the following in this field: cn=@USER,cn=Users,dc=domain,dc=com To use multiple user name formats, separate each with AND, as in the following example: @USER@domain.com AND @USER@server1.domain.com AND @USER@server2.domain.com
Type of authentication that should be used. The recommended option is Simple. NOTE: Using Simple with LDAPS and SSL are not supported. Server URL that will be contacted for authentication, for example: ldap://www.myldapserver.com:389 Check with your system administrator if you have questions about the specific URL and port settings.
Enter the password for users who have security to search the directory for other valid users. Click the Check button to verify that it is a valid password. String used as the base of the LDAP search for the user in the directory (for example, cn=Users, dc=mydomain, dc=com). String used as an attribute in user searches in the directory. For example, for Active Directory: (&(sAMAccountName=@USER))
Description If Secure Socket Layer (SSL) is supported by the application server, enter the name of the SSL protocol handler. For example: For Sun's JSSE, the name is com.sun.net.ssl.internal.www.protocol. For IBM's protocol handler, the name is com.sun.ibm.ssl.internal.www.protocol.
If you dont use SSL, leave this field blank. SSL Provider If SSL is supported by the application server, enter the name of the SSL Provider. For example, for IBM's JSSE, the name is com.ibm.jsse.JSSEProvider. If you dont use SSL, leave this field blank. Get Username From Use this setting if you send the user name in a request header, cookie, or request parameter from another authentication application. For example, if using SiteMinder, set this field to HEADER:sm_user. Prefix the parameter with HEADER:, COOKIE:, or PARAMETER: to specify whether the parameter is being sent in as a header, cookie, or parameter. The URL that the authentication program launches must be http://server/ohm/OHMIndex?DO=LOGON. It may optionally contain &DATABASE= to specify a certain database. Get Roles From Use this setting if the roles to which a user is assigned are sent in a request header, cookie, or request parameter from another authentication application. For example, if a comma-delimited list of roles will be sent in a header, use the setting: HEADER:roles. Prefix the parameter with HEADER:, COOKIE:, or PARAMETER: to specify whether the parameter is being sent in a header or parameter. The URL that the authentication program launches must be: http://server/ohm/OHMIndex?DO=LOGON. The URL may optionally include &DATABASE= to specify a particular database. Incident Reporting Account This setting applies only if you use the Safety module. Account used when a user anonymously logs in to record incidents or hazard issues. To disallow anonymous entries, leave this field blank. Clinic Search Account This setting applies only if you use the Encounter Log module. Account used when a user anonymously searches clinic records. To disallow anonymous searches, leave this field blank. Auto Job Server Name Server in a clustered environment used to process OHM scheduled background jobs. If an automated job is scheduled to import a specific file and more than one server exists in the cluster, only one server should import the file. By defining a server name in this field and by defining the server name in the automated job record, you ensure that only the selected server processes that job. This parameter may also be set by adding the line AUTOJOBSERVER= to the properties file.
Page 31
Property
Description Refer to the Load Balancing Web document for additional information about deploying OHM/Web in a clustered environment.
Domains to which OHM is allowed to send emails. Leave this field blank if OHM is allowed to send e-mail to any domain.
4. Once you have entered the correct data for the default account, click Save Changes.
Page 32
Description This field allows you to change the account code. This code must be entered or selected whenever a user logs on (depending on the Logon Account Field setting on the Global Properties page). It is easier to recall if it is set to something meaningful, ABC for ABC Steel Corporation, for example. Description of the account. Type of database to connect to.
Page 33
Description Applies only if you use Oracle. Enter the Oracle version you use. This setting is the name of the JDBC DataSource. You can click the Browse button and locate your data source. If you browse to the file, you can be sure you have selected a valid data source. If you did not use the Browse button to locate the data source, you must click the Check button after entering the data source name to verify that it works as expected.
Owner or schema for the database. This is a required field for an Oracle database. It is optional for Sybase and SQL Server databases if the database owner is 'dbo'. Number of result rows that are fetched from database queries at one time. E-mail address where any failed logons are sent. The system sends an e-mail message to this address when someone attempts to log in to the application with an invalid password, user name, or account code. This property overrides the corresponding global property. If you leave this field blank, the global value is used. If the global value is blank, this feature is disabled. E-mail address where any database errors are sent. The system sends an e-mail message to this address whenever a database error occurs that the OHM/Web application does not handle (for example, insufficient tablespace errors or database offline errors). This property overrides the corresponding global property. If you leave this field blank, the global value is used. If the global value is blank, this feature is disabled. E-mail address used as the Sender when error messages are e-mailed to the appropriate administrator. This property overrides the corresponding global property. If you leave this field blank, the global value is used. If the global value is blank, this feature is disabled. Number of minutes of inactivity before a session is inactivated. Note: This setting can conflict with the application server's session timeout setting (refer to the application server documentation). To avoid the conflict, verify that the two parameters are separated by several minutes.
Session Timeout
Temporary Directory
Path where OHM/Web writes temporary work files. The application server process must have full rights to this path. The directory must exist before OHM/Web is started. You must click the Check button after entering the path to verify that it works as expected.
Archive Directory
Path where OHM/Web stores files containing archived employee records. The directory must exist before OHM/Web is started. You must click the Check button after entering the path to verify that it works as expected. You can also store employee records in the database by placing DB in this field. However, storing this information in the database can affect system performance. We recommend you store it in a secure directory instead.
Documents Directory
Path where OHM/Web stores scanned and uploaded documents and images. The directory must exist before OHM/Web is started. You must click the Check button after entering the path to verify that it works as expected.
Page 34
Property
Description You can also store documents and images in the database by placing DB in this field. However, storing these files in the database can affect system performance. We recommend you store them in a secure directory instead.
Resource Directory
Path where the OHM/Web spell check dictionary and other application resources, such as ssceam.tlx and ohmweb.ddf, are located. The directory must exist before OHM/Web is started. You must click the Check button after entering the path to verify that it works as expected. If blank, the Global value is used. If the Global value is blank, this feature is disabled.
Directory on the server where OHM/Web stores report output files, such as PDF and RTF files. The URL for Reports setting must point to this directory. The directory must exist before OHM/Web is started. You must click the Check button after entering the path to verify that it works as expected. For example: If the web server has a share called http://server/ohmreport that points to a directory c:\temp\ohmreport, then this parameter must be c:\temp\ohmreport and the next parameter, URL for Reports, must be http://server/ohmreport/.
URL used to access generated reports. There are two methods for OHM/Web to retrieve reports: The first method is to set this to point directly to the report output path (e.g. http://server/ohm/share/reportoutput/). OHM/Web retrieves reports as file resources in that directory. The advantage to this method is that it uses fewer server resources and may be somewhat faster. The disadvantage to this method is that anyone who knows the name of the generated report file can type the URL containing the report name into a browser and open the report. The second method is to set this value to '@PROTOCOL://@SERVER:@PORT/@APPURL/GetReport'. With this setting, OHM/Web retrieves the report with a java servlet. This method uses more server resources, but is much more secure. OHM/Web checks the user's privileges before returning the generated report.
URL where OHM/Web image files are stored. The default URL is @PROTOCOL://@SERVER:@PORT/@APPURL/share/images/. OHM/Web dynamically replaces the placeholders @PROTOCOL, @SERVER, @PORT, and @APPURL with the appropriate values when the user logs in. Change this setting only if you place image files in a different location than the shared directory. See the Moving Static Resources to a Web Server Directory section at the end of this document.
URL where OHM/Web stores OHMApplet.class and any Active X controls it uses. The default URL is @PROTOCOL://@SERVER:@PORT/@APPURL/share/applets/. OHM/Web dynamically replaces the placeholders @PROTOCOL, @SERVER, @PORT, and @APPURL with the appropriate values when the user logs in.
Page 35
Description URL where OHM/Web stores Javascript files and stylesheets. The default URL is @PROTOCOL://@SERVER:@PORT/@APPURL/share/scripts/. OHM/Web dynamically replaces the placeholders @PROTOCOL, @SERVER, @PORT, and @APPURL with the appropriate values when the user logs in.
URL where JSP files are located. The default URL is @PROTOCOL://@SERVER:@PORT/@APPURL/jsp/. OHM/Web dynamically replaces the placeholders @PROTOCOL, @SERVER, @PORT, and @APPURL with the appropriate values at the time the user logs in. URL where OHM/Web servlets are executed from. The default URL is @PROTOCOL://@SERVER:@PORT/@APPURL/. OHM/Web dynamically replaces the placeholders @PROTOCOL, @SERVER, @PORT, and @APPURL with the appropriate values at the time the user logs in.
This setting applies only if you use the Safety module. User ID that anonymous users can log in with to record incidents or hazard issues.
This setting applies only if you use the Encounter Log module. User ID users can log in with to anonymously search clinic records.
Enable unicode support Enable PDF data Enable RTF printing Enable spell checker
Select the check box to support Unicode (UTF-8) characters in the database. Select the check box to allow users to print reports in PDF (Portable Document Format) format. Select the check box to allow users to print reports in RTF (Rich Text Format) format. Select the check box to allow users to use the spell check feature in OHM/Web. This check box works only if you have entered the correct path in the Resource Directory setting on the Global Properties page.
Page 36
3.
Change the URLs in the Setup screen to point to the new directory. For example, after creating a virtual Web directory called ohmshare on a server called ohmstuff.abcsteel.com, change the URLs on the OHM/Web setup screens to point to the new shared folder. In this case, change: URL for Images to @PROTOCOL://ohmstuff.abcsteel.com/ohmshare/images URL for Applets to @PROTOCOL://ohmstuff.abcsteel.com/ohmshare/applets/ URL for Scripts to @PROTOCOL://ohmstuff.abcsteel.com/ohmshare/scripts/ NOTE: The shared directory can be on any server. It does not necessarily have to be on the same server as the OHM/Web application. The JSP path and Servlet path always reference the J2EE Web application server.
4.
Creating Databases
This section applies only to new customers who are installing OHM 7.2 for the first time. Now that you have created your data source and defined your account properties, you are ready for the following steps: 1. Configure OHM/Web to connect to a data source. 2. Set up the account configuration pages so that they generate and/or run a script to create your database and the tables for it.
2.
Page 37
3.
Enter the necessary information on this page. Be sure to enter the JNDI Data Source Name for the data source you created (for example, jdbc/ohmoracle or jdbc/ohmsql) in the Data Source Name field. You can also browse to the data source file, select it, and select the Use This Data Source check box. Once you have entered it, click the Check button beside the Data Source Name field. If you get the error message below, the system couldnt find the data source in your application servers JNDI tree.
4.
To correct this issue, return to the data source configuration for your application server and verify that everything is set up correctly.
Once your connection works as expected, click Save Changes on the New Account tab and proceed to the next step.
2. 3.
Page 38
4.
Once you have filled in the script information, you can run the script in OHM or in a SQL application, as outlined below. NOTE: Be sure to talk to your database administrator (DBA) to see if you should process the script in OHM or not and find out if she wants to review it before you can process it. Your first (and the recommended) option is to download the SQL installation script and run it using another tool. OHM does not run the script for you. Depending on your network and security settings, this option might work better for your organization. In this case, you complete this process in two steps: 1. Clear the Run the SQL script after generating it check box and submit the form. OHM generates the first half of the script for you. Load the script into your preferred SQL administration tool or application and execute it from there (or ask your DBA to run it). . 2. After you run that script, log back in to OHM and run the upgrade process again. At this point, OHM migrates employee data to the employee database tables and then generates the second half of the script. 3. Load the second half of the script into your preferred SQL administration tool or application and execute it from there (or ask your DBA to run it). NOTE: IMPORTANT When running the SQL script manually and on ORACLE, run the script as the Oracle db user with the appropriate permissions rather than system or admin user. Your second option is to run the SQL script in OHM. In this case, select the Run the SQL script after generating it check box, and submit the form. OHM creates the installation SQL script, connects to the database as the system administrator, executes the script, and updates the employee database tables in the process. Depending on the speed of your application server and database server and the network connection between them, this process can take anywhere from 5 to 20 minutes.
5.
Once you have run the script, return to the list of accounts in the OHM/Web Property File Editor, select the account you just created, and click Load Reports to load canned reports.
Updating Databases
This section applies only to upgrading customers, who are migrating from an earlier version of OHM/Web to OHM/Web 7.2. 1. 2. Configure OHM 7.2 to connect to a data source. Set up the account configuration pages so that they generate and/or run a script to create your database and the tables for it.
NOTE: This note applies only if you have enabled the audit log in OHM. 1. Before you update your databases, you must disable auditing for all the tables that you currently audit. To do this: (a) Go to the OHM home page> Settings> System Settings> Audit Log section> Setup screen. (b) Select a table you currently audit. (c) Click the following link on the right side: Unmark every column in the OHM/Web database for audit. (d) Next, click one of the following links depending on whether you typically download SQL scripts or run them directly in OHM: If you typically download SQL scripts and run them outside of OHMusing your preferred SQL administration tool or application and execute it from there click the following link: Retrieve the SQL script used to create all of the database audit triggers. NOTE: IMPORTANT When running the SQL script manually and on ORACLE, run the script as the Oracle db user with the appropriate permissions rather than system or admin user. If you typically run SQL scripts directly in OHM, click the following link: Run the SQL script used to create all of the database audit triggers.
Page 39
2. After you have updated or created your databases, re-enable auditing for the appropriate tables.
2. 3.
4.
To correct this issue, return to the data source configuration for your application server and verify that everything is set up correctly.
Once your connection works as expected, click Save Changes on the New Account tab and proceed to the next step.
2.
Page 40
3.
4.
Once you have filled in the script information, you can run the script in OHM or in a SQL application, as outlined below. NOTE: Be sure to talk to your database administrator (DBA) to see if you should process the script in OHM or not and find out if she wants to review it before you can process it. Your first (and the recommended) option is to download the SQL installation script and run it using another tool. OHM does not run the script for you. Depending on your network and security settings, this option might work better for your organization. In this case, you complete this process in two steps: 1. Clear the Run the SQL script after generating it check box and submit the form. OHM generates the first half of the script for you. Load the script into your preferred SQL administration tool or application and execute it from there (or ask your DBA to run it). 2. After you run that script, log back in to OHM and run the upgrade process again. At this point, OHM migrates employee data to the employee database tables and then generates the second half of the script. 3. Load the second half of the script into your preferred SQL administration tool or application and execute it from there (or ask your DBA to run it). NOTE: IMPORTANT When running the SQL script manually and on ORACLE, run the script as the Oracle db user with the appropriate permissions rather than system or admin user. Your second option is to run the SQL script in OHM. In this case, select the Run the SQL script after generating it check box, and submit the form. OHM creates the installation SQL script, connects to the database as the system administrator, executes the script, and updates the employee database tables in the process. Depending on the speed of your application server and database server and the network connection between them, this process can take anywhere from 5 to 20 minutes.
5.
Once you have run the script, return to the list of accounts in the OHM/Web Property File Editor, select the account you just created, and click Load Reports to load canned reports.
Update/Upload Reports
The last step in the installation process is to update/upload reports into your OHM 7.2 database. 1. Go to the OHM/Web Property File Editor: http://server/appurl/do/config, where: Server is the name of the server where the OHM/Web application is installed. Appurl is the application URL on the server for the OHM application. On the List Accounts screen, select the appropriate account, and click Load Reports.
2.
Page 41
3.
4.
Page 42
Additional Information
OHM 7.2 Client-Hosted Technical Requirements
Contact UL PureSafety Customer Support at 800.332.8089 if you have any questions. NOTE: PureSafety neither recommends nor supports versions no longer supported by the third party vendors. Application Hardware Processor: Consult application server deployment expert to meet your organization's needs RAM: Must allocate at least 768 MB maximum Heap space, 512 MB PermGen space and 200 MB Eden space to the Java Virtual Machine. Consult application server deployment expert to meet your organization's needs. Hard Disk Space: Consult application server deployment expert to meet your organization's needs. Application Software Application Server Apache Tomcat 5.5.26-5.5.33 6.0.20-6.0.32 Oracle WebLogic 10.3.0.0 IBM WebSphere 7.0.0.11 Web Server Apache 2.0, 2.1, 2.2 IIS 6, 7, 7.5 Oracle WebLogic 10.3.0.0 IBM WebSphere 7.0.0.11 Operating System Any operating system supported by vendor
Any operating system supported by vendor Any operating system supported by vendor
NOTE: All application servers required JRE 6 Workstation Hardware Minimum Processor RAM Network Connection Sound/Speakers Video/Display Hard Disk Space 1.8 GHz Intel 512 MB 512 Kbps 16-bit 1024x768 monitor resolution, 32-bit color As needed Recommended 1.8 GHz Pentium 1 GB 10 Mbps 16-bit 1024x768 monitor resolution, 32-bit color As needed Database Server Software Software Database: Oracle 10g, 11g, Microsoft SQL Server 2005/2008 Operating System: Contact database vendor support Workstation Software Browser: Internet Explorer 7 & 8 with Java Runtime Environment 6 Operating System: Windows XP, Windows 7 Adobe: Reader 7, 8, 9, 10, Acrobat Writer 9 Flash: Flash Player 9, 10.0, 10.1, & 10.3
Database Server Hardware Processor: Contact database vendor support RAM: Contact database vendor support Hard Disk Space: Contact database vendor support
Page 43
Other Signing Tool (Optional) Topaz SigPlus Electronic Signature Pad (USB or Serial Model)
Page 44