SYSTOC to PureOHS Employer Portal Install and Upgrade Instructions

Transcription

1 SYSTOC to PureOHS Employer Portal Install and Upgrade Instructions

2 Table of Contents Overview...3 Add Triggers to SYSTOC Database Tables...4 Data Client Windows Service...5 Install the SYSTOC Data Client Windows Service...5 Upgrade the SYSTOC Data Client Windows Service...6 Organization Manager...9 Install the SYSTOC PureOHS Organization Manager...9 Upgrade the SYSTOC PureOHS Organization Manager...11

3 Overview The SYSTOC to PureOHS Employer Portal gives companies secure, online access to a limited set of their employees' data. Each company manages their own user accounts, which controls the type of information a user can view. For example, a company can allow a user to view injury or treatment information but not drug test results. SYSTOC customer documentation for the Employer Portal is available in the SYSTOC help system. Log in to SYSTOC, launch the help system, and search help for PureOHS Extensions. The diagram below describes the activity related to the PureOHS Employer Portal when implemented for a SYSTOC customer and 3 companies in the SYSTOC customer's database. SYSTOC to PureOHS Employer Portal Install and Upgrade Instructions (Rev ) Page 3

4 Add Triggers to SYSTOC Database Tables Database triggers are added by your IT Department staff knowledgeable about running database scripts against the SYSTOC database. Prerequisites: Transport Layer Security (TLS) 1.1 or 1.2 security protocol. SYSTOC Server Name and SYSTOC database name Administrative permissions to the SYSTOC database UL.SYSTOC.PureOhsDataClient zip downloaded from the SYSTOC deployment website: deployment.puresafety.com 1. Extract the files from the zipped folder. 2. Open the Scripts folder and run the DataClientScripts.sql against the SYSTOC database. Important: the ULONLY folder is for UL EHSS use only. It contains a script that is used in the event the PureOHS Employer Portal needs to be permanently removed for your site. SYSTOC to PureOHS Employer Portal Install and Upgrade Instructions (Rev ) Page 4

5 Data Client Windows Service Install the SYSTOC Data Client Windows Service The SYSTOC application uses this Windows service to manage the transfer of SYSTOC data to PureOHS. The Data Client Windows service is installed and configured by your IT Department staff (client-hosted customers). UL Application Management staff install the windows service for UL Hosted customers. Prerequisites: Microsoft.NET Framework 4.5. Transport Layer Security (TLS) 1.1 or 1.2 security protocol. UL.Systoc.PureOhsDataClient_ zip downloaded to a server that is always running and has access to the SYSTOC database and the SYSTOC charts folder. SYSTOC Server Name and SYSTOC database name. Note: the user account used to run the Windows service must have rights to the SYSTOC database. PureOHS Client ID and Client Secret obtained from your UL EHSS contact person. 1. Double-click the Installer.bat file. 2. Click Yes on the User Account Control window that appears. The installer window displays while the installation begins. 3. Follow the Setup Wizard prompts to complete the installation. The files are installed to C:\Program Files (x86)\ul EHSS\SystocDataClient. 4. Verify that the service was installed by opening the Windows Services on the local system and locating the UL.Systoc.PureOhsDataClient service. 5. View the properties of the service and note the following: The service is started automatically upon completion of the installation. Note: The service uses the local system account, by default. Any account can be used as long as it has access to the SYSTOC database, the SYSTOC charts folder, the C:\Program Files (x86)\ul EHSS\SystocDataClient\ folder, and sufficient permissions to run as a service. Update the service to run under the desired user account. 6. Navigate to C:\Program Files (x86)\ul EHSS\SystocDataClient. 7. Open the UL.Systoc.PureOHSDataClient.WindowsService.exe.config with Notepad or another plain text editor. SYSTOC to PureOHS Employer Portal Install and Upgrade Instructions (Rev ) Page 5

6 8. Make the following changes to the configuration file, highlighted in yellow in the image below: DataSource=YourServerName: replace YourServerName with your SYSTOC server name. Initial Catalog=YourDatabaseName: replace YourDatabaseName with your SYSTOC database name. PureOhsClient ID: the value must be the word webclients in quotes. Client Secret: the value must be in quotes. Chart Path: replace YourChartPath with your path to the charts folder, in quotes. For example: \\SERVER\SYSTOC\CHARTS Note: Do not use a mapped drive and do not include a slash at the end. Do not change the default Polling Frequency, Max Threads, and MaxRetryAttempts settings at this time. You may need to adjust these values over time depending on the volume of activity and capacity of the system. 9. Save the changes and close the text editor. 10. Return to the Windows Services list and start the service. 11. Install and configure the SYSTOC PureOHS Organization Manager. NOTE: If you use the Repair option on your local workstation (Control Panel > Programs > Programs and Features), you must update the service to run under the desired user account. See step 5. Upgrade the SYSTOC Data Client Windows Service The steps below provide instructions on upgrading SYSTOC Data Client Windows service versions above The Data Client Windows service is installed and configured by your IT Department staff (client-hosted customers). UL Application Management staff install the windows service for UL Hosted customers. A good practice is to make a copy of your current UL.Systoc.PureOHSDataClient.WindowsService.exe.config file and save it to your desktop or other location. SYSTOC to PureOHS Employer Portal Install and Upgrade Instructions (Rev ) Page 6

7 Prerequisites: Microsoft.NET Framework 4.5 Transport Layer Security (TLS) 1.1 or 1.2 security protocol. UL.Systoc.PureOhsDataClient_ zip downloaded to a server that is always running and has access to the SYSTOC database and the SYSTOC charts folder. SYSTOC Server Name and SYSTOC database name. Note: the user account used to run the Windows service must have rights to the SYSTOC database. PureOHS Client ID and Client Secret obtained from your UL EHSS contact person. 1. Extract the files from the zipped folder. 2. Run the DataClientScripts.sql against the SYSTOC database. See Add Triggers to SYSTOC Database Tables. 3. Double-click the Installer.bat file. 4. Click Yes on the User Account Control window that appears. The installer window displays while the installation begins. 5. Follow the Setup Wizard prompts to complete the upgrade. The files are installed to C:\Program Files (x86)\ul EHSS\SystocDataClient. 6. Verify that the service was installed by opening the Windows Services on the local system and locating the UL.Systoc.PureOhsDataClient service. 7. View the properties of the service and note the following: The service is started automatically upon completion of the installation. Note: The service uses the local system account, by default. Any account can be used as long as it has access to the SYSTOC database, the SYSTOC charts folder, the C:\Program Files (x86)\ul EHSS\SystocDataClient\ folder, and sufficient permissions to run as a service. Update the service to run under the desired user account. SYSTOC to PureOHS Employer Portal Install and Upgrade Instructions (Rev ) Page 7

8 8. Retain the default selection as shown in the image below and click OK. The service is restarted automatically upon completion of the upgrade. SYSTOC to PureOHS Employer Portal Install and Upgrade Instructions (Rev ) Page 8

9 Organization Manager Install the SYSTOC PureOHS Organization Manager The SYSTOC PureOHS Organization Manager is a desktop application used by SYSTOC administrators to configure companies in the SYSTOC database to export data to PureOHS. The person who performs this install must have administrative rights on the workstation and a SYSTOC user account with administrative rights. Prerequisites: Microsoft.NET 4.5 Framework UL.Systoc.PureOhsOrganizationManager_ zip downloaded from the deployment website at deployment.puresafety.com to an easily accessed location, such as the workstation where you plan to install it. PureOHS Organization IDs for the SYSTOC companies you are configuring. Your UL EHSS contact person provides this information. 1. Extract the files from the zipped folder. 2. Double-click the Installer.bat file. 3. Click Yes on the User Account Control window that appears. The installer window displays while the installation begins. 4. Click Next on the Setup Wizard to begin the installation. SYSTOC to PureOHS Employer Portal Install and Upgrade Instructions (Rev ) Page 9

10 5. Accept the default location of C:\Program Files (x86)\ul EHSS\PureOhsOrganizationManager or click Change to select a different installation location. Click Next. 6. Click Install to continue the setup process. 7. Select Finish to complete the installation. The installation screen closes when it is finished and a start icon is placed on the desktop. 8. Navigate to the installation location you selected, or to C:\Program Files (x86)\ul EHSS\PureOhsOrganizationManager if you used the default location. 9. Open the UL.Systoc.PureOhsOrganizationManager.exe.config with Notepad or another plain text editor. SYSTOC to PureOHS Employer Portal Install and Upgrade Instructions (Rev ) Page 10

11 10. Make the following changes to this configuration file, highlighted in yellow in the image below: Data Source={Server Name}: replace {Server Name} with your SYSTOC server name. Do not include the braces. Initial Catalog={Database Name}: replace {Database Name} with your SYSTOC database name. Do not include the braces. 11. Save the changes and close the text editor. 12. Double-click the UL Systoc PureOhsOrganizationManager desktop icon to launch the application. 13. Log in with a SYSTOC administrator's User ID and Password to verify that you can log in. The PureOHS Organization Manager tool is ready for the SYSTOC administrator to use. Upgrade the SYSTOC PureOHS Organization Manager The steps below provide instructions on upgrading SYSTOC PureOHS Organization Manager. The person who performs this install must have administrative rights on the workstation and a SYSTOC user account with administrative rights. A good practice is to make a copy of your current UL.Systoc.PureOHSOrganizationManager.exe.config file and save it to your desktop or other location. Prerequisites: Microsoft.NET 4.5 Framework Download the UL.Systoc.PureOhsOrganizationManager_ zip from the deployment website at deployment.puresafety.com to an easily accessed location, such as the workstation where you plan to install it. PureOHS Organization IDs for the SYSTOC companies you are configuring. Your UL EHSS contact person provides this information. 1. Extract the files from the zipped folder. SYSTOC to PureOHS Employer Portal Install and Upgrade Instructions (Rev ) Page 11

12 2. Double-click the Installer.bat file. 3. Click Yes on the User Account Control window that appears. The installer window displays while the installation begins. 4. Click Next on the Setup Wizard to begin the upgrade. 5. Select the same destination folder that you used for the original installation. Important: a message displays and the upgrade fails if the incorrect installation path is selected. 6. Accept the default location of C:\Program Files (x86)\ul EHSS\PureOhsOrganizationManager or click Change to select a different installation location. Click Next. SYSTOC to PureOHS Employer Portal Install and Upgrade Instructions (Rev ) Page 12

13 7. Click Install to continue the setup process. 8. Follow the Setup Wizard prompts to complete the upgrade. SYSTOC to PureOHS Employer Portal Install and Upgrade Instructions (Rev ) Page 13