Installing SecureConnect5 Client

InstallationThe SC5 client uses a simple InstallShield installer. Click “Next” to get started. You will need to agree to an End User License Agreement (to be added).

You should enter in the username and the organization. These values are collected by InstallShield, and are not sent back to HTI or verified against values in our database. These are records that may be useful in debugging or diagnosing a broken install.

Admin Tool Configuration

When the installation is complete, it will automatically open the Admin Tool. The Admin tool is a replacement for the old SC4 tray application. This application does not live in the system tray, and does not need to be running at all times.

The list in the top of the window shows all SC5 services running on the computer. Currently the installer only supports installing a single service.

The following controls can be used to work with this list:

Refresh: Refresh the list of services and statuses Auto-Refresh: Automatically refreshes the list of services and their statuses every few seconds Start: Start the selected service Stop: Stop the selected service Stop All: Stop all listed services

The “Installation” tab on the bottom section of the application shows a link to the installation directory, and shows a list of required files. The green “Installed” should appear next to all files. If the word “MISSING” appears anywhere, the installation is incomplete.

If a file is MISSING, DO NOT attempt to copy+paste the missing file from somewhere else. The entire package should be uninstalled, the installer should be verified, and it should be reinstalled from scratch. Mismatched file versions or corrupted installations may cause the agent to not work correctly.

If failures appear during later steps, make a note of the version numbers next to these files for debugging and diagnosing.

The “Configuration” tab shows a list of all configuration values from the config file. You can click the entries in the “Value” column to edit these values directly. Values which have been modified will appear in bold. To save your changes to the config file, click Save Changes.

You must update the AgentCode, the Password, the EncryptionKey and the BaseDirectory before you activate the agent. The first three values must match the values in the HTI database. The BaseDirectory must be a directory on the local machine with read/write permissions for the user that the service runs under.

The Web Service URL (bottom) must point to the public SC5 web service. The public URL for that is to be determined (and will be default).

The encryption key is stored in a special way and must be edited differently. Click the “Update Encryption Key” button to open a new window for the encryption key. Enter the encryption key twice, exactly as it appears in the ITF3 database. Entering the encryption key incorrectly will cause the client not to work. If the two values do not match, you will not be able to save. When the values are entered correctly, the “Save” button will be enabled.

This step may take several seconds to process. We encrypt the key so that the raw text does not appear in the config file.

Once all the configuration values have been entered, go to the “Diagnostics” tab. This tab contains several tests which can help to diagnose problems with the agent. Click the “Run All” button in the lower-right corner to run all tests. This may take several seconds to complete.

Green means the test passes and no action is required Red means the test failed and corrective action is required Black or Yellow mean that the test was not run, could not run, or is not fully implemented yet.

The first test, “Web Service Test Login” attempts communication with the web service. If the Agent Code, Password, EncryptionKey or WebServiceURL are not correct (from the Configuration tab), this test will fail. This test may also fail if there are network problems, or if a proxy needs to be configured to reach the web service. Double-check these values and try again.

The second test, “Base Directory Exists And Is Writeable” tests that the BaseDirectory parameter points to a suitable directory. This test may fail if the directory does not exist or if it does not have suitable permissions. Make sure the directory has Full Control access from the SYSTEM user (by default, or whichever user the SC5 service uses).

The third test, “Firewall is open” is not currently implemented, but will test firewall and proxy settings.

Additional tests may be added in the future, in response to installer feedback.

When all diagnostics tests pass, click the Start button at the top of the form to start the service. Please wait approximately 1 minute for the agent to start, check in with the web service and download configuration information. The service status should say Running.

After the agent has checked in with the webservice, go to the “Connectors” tab. Click the “Refresh Connectors” button. This will request the current configuration from the agent. You should see a list of all processes and all configuration values listed. Double-check all values to ensure the configuration is correct. You cannot change values here, only view them.

File Drop: Verify the drop directory exists and has write permissions

File Pickup: Verify the pickup directory exists and has read/delete permissions

Socket Server and Socket Client: Ensure that the IP address and port are open, not blocked by firewalls, and have permissions

Auto-Print: Verify the printer name (See the Printers tab for more information).

The “Logs” tab shows the local application log files. Logs are organized by date and severity. Click on a log to see the text of the file. These are color coded.

Black or Green are general or verbose logs and contain general information Yellow are warning logs. Warnings mean that files may be delayed (such as the target EMR not

listening on a socket, or target drop directory not able to accept files). Warnings may also be other issues which are not errors but may require attention.

Red are errors. These are important and should be communicated back to HTI support. Errors may prevent the agent from working.

If you are using AutoPrint functionality, click the “Printers” tab.

Click the “Refresh” button under the “Installed Printers” section to get a list of all printer names currently installed on the system. If you are using an AutoPrint connector, the configured printer name must match one of the entries in this dialog. If the printer you are looking for is not visible, it may not be correctly installed on the machine.

If the service is running, all diagnostics tests are passing, all connector configuration is correct and there are no Error logs being generated, the agent has been installed and started successfully.

Debugging Errors

How do I open the Admin tool?SC4 kept the admin tool always running in the system tray. SC5 does not do this.

The Admin tool should open automatically during the installation, and should be closed when configuration has been complete.

Shortcuts to the admin tool should be added to the desktop and the start menu. You can use these to open the Admin tool.

If the shortcuts are missing, you can navigate to the installation directory. The install tool is called “Halfpenny.SecureConnect5.Admin.exe”

The service does not appear in the list of servicesThe service has not been installed correctly. Most likely, you should uninstall the program and attempt to reinstall.

Ensure the installer is being run with administrative privileges. You require elevated privileges to install services.

I do not know the AgentCode, Password or EncryptionKeyThese values should be entered into the SC database, through the portal website. If you do not have these values, contact HTI support to get them added.

What BaseDirectory should I use?SC4 used the installation directory to store files. This caused problems on Windows 8 and systems with high security standards because the program install directory usually does not have read/write permissions for most user accounts.

SC5 allows the base directory to be configurable. Pick a directory that is easy to find. A directory like “C:\ITFSecureConnect” would be acceptable. Avoid anything in the user profile directory (Desktop, “My Documents”, etc) because those may be inaccessible from a different account. Do not use the “C:\Temp” directory or any directory which may be deleted frequently or modified/monitored by another program.

The Web Service diagnostic test failsEnsure that the agent has been created and configured in the HTI database, and that the agent is active. The Agent should be in New “N” Active “A” or Update “U” state. A state of Disabled “D” or Inactive “I” or something else may cause the agent to not work.

Double-check the values of the AgentCode, Password and EncryptionKey.

Double-check the URL of the SC5 web service. Ensure that the web service is visible (attempt to open that URL in a browser).

The encryption is tied to the current UTC time. Ensure that the clock on the client computer is set to the correct time and has the correct timezone settings (encrypted information is time-sensitive, so a bad clock time will make information unreadable). Different timezones are acceptable, so long as the settings are correct for the computer.

The Base Directory diagnostic test failsCheck that the specified directory exists on disk and has suitable permissions.

For the default install, the SYSTEM user should have Full Control permissions.

EMR Connectors or AutoPrint are not workingOn the Connectors tab, double-check the process settings.

Check folder and socket permissions, firewall settings, network settings and anything else that could be standing in the way.

For AutoPrint, ensure that the configured printer name appears in the list of printers on the Printers tab.

The Agent is generating Error or Warning logsGet the text of the error logs and send them to HTI support for help diagnosing the problem.