SmartService Options Tab

The options tab contains all of the necessary settings for logging into the SmartService system.

 

SmartService URL

Enter the URL of the SmartService server in the following format:

http(s)://<<SmartService IP address>>:<<SmartService port address>>/SmartService

The default SmartService port address is 8801.  Verify the actual port setting in IIS on your system. 

User Name
Enter the user name to login to the EntraPass system.  It is recommended that you name the user so it is clear that Events2HVAC is sending the commands in audit trails.

Note:  The user name used must be a valid EntraPass operator username which has the necessary permissions to lock/unlock doors.

Password

Enter the password to login to the EntraPass system.

Session Timeout

This is the timeout in seconds that controls when the login session key will expire.  If the checkbox Keep Session Alive is checked, this time is used to automatically login to keep the session active.  When Keep Session Alive is not checked, this value is used to predict when a new login needs to happen prior to sending a command.

Note:  This value should be equal to or less than the session idle timeout defined in the Kantech operator – web parameters.

Ignore SSL Errors

Check this option to ignore any SSL validation errors when connecting to a HTTPS connection.

Warning:  Ignoring SSL errors is not recommended since it essentially allows any certificate, regardless of trust or status, to be accepted and permits a man-in-the-middle attack.  The best practice is to generate or purchase a trusted certificate from a trusted authority.

Login Always

Check this option to force Events2HVAC to login prior to any command sent to the Kantech service.

Test Login Button

This button will attempt to login and communicate with the SmartService system.  After a successful login, it will also read in the operator permissions.  If there are any permissions that are needed, an additional warning will be shown.  Note:  If there are communication issues, there will be a timeout delay before any error message is shown.

Test Connection Button

This button will attempt to communicate with the SmartService system.  This does not require a login, so it is just used to see if the SmartService is available.  Note:  If there are communication issues, there will be a timeout delay before any error message is shown.

Commands

 

  Field Name

  Description

  Range

Retries

Number of attempts to retry any failed commands

Default = 1

Retry Delay

Number of milliseconds to delay before each retry.

Default = 3000 ms

Timeout

Number of milliseconds after a request is made before it fails

Default = 15000 ms

 

Log API Requests

Check this option to generate DEBUG log entries for each request from Events2HVAC to the SmartService system.  This is primarily used temporarily for troubleshooting.  The logger must be logging DEBUG events for this data to show up in the log files.

Log API Responses

Check this option to generate DEBUG log entries for each response from the SmartService system.  This is primarily used temporarily for troubleshooting.  The logger must be logging DEBUG events for this data to show up in the log files.

Note:  Make sure you turn this feature off after troubleshooting so that the response files don’t fill up your hard drive.