Services mediate interactions between Protege X and external systems such as reporting stations, automation controllers and intercoms. They allow Protege X controllers to communicate directly with other systems via ethernet, USB ethernet or the onboard modem dialer.
Once a service is programmed you can start or stop the service by clicking the button beside the service record. If you edit and save the service it will automatically stop and start again to implement the changes.
Services may require the use of onboard hardware devices or expansion devices. Not all controller models support all connection channels, so consult the documentation for your controller model before programming services.
Name
-
Name: The name of the record in English.
English is the default system language for all records and is assumed to be the primary language.
-
Name (Second Language): The name of the record as it appears within the Protege X user interface when the operator's Portal Settings display language is set to a language other than English.
When the operator's display language is set to any language other than English, all 'Second Language' values become the primary value, and the English versions are displayed as the 'Second Language' value.
Service Type
Type
-
Service Type: The service type determines which kind of operation or communication this service will perform.
-
Contact ID: Sends alarms, tests and events using the Contact ID reporting format to a monitoring station capable of receiving the Contact ID format.
Contact ID reporting is only available for controller models with onboard modem dialers.
- Report IP: Allows the Protege X system controller to send alarm and activation information over an IP connected network. The Report IP service supports multiple formats and allows the connection to third-party reporting, if required.
- Automation and Control: Provides a generic interface for integration with third-party automation products, such as Savant, Control 4, Crestron, AMX, C-Gate and Command Fusion
- C-Bus: Provides integration with building control and automation products using the Clipsal C-Bus protocol.
-
Service Mode: Determines how the service will start.
- The 0 - Manual Mode setting ensures that the service will only start by manual command from an operator.
- The 1 - Start With Controller OS setting configures the service to start automatically when the controller boots up.
Commands
- This field is used to send programming commands to the device. It should only be used when specifically advised by ICT documentation or technical support.
Contact ID
This reporting service sends alarms, tests and other events to a monitoring station over a phone line using the controller's onboard modem dialer. Reports are sent in the standard Ademco Contact ID format.
Phone line reporting is only available for controller models with onboard modem dialers.
Configuration
-
Client Code: This code represents the controller or site in reports to the central monitoring station. This is typically a hexadecimal number with 4 digits but the format may depend on the receiver compatibility. This will be issued by the monitoring station.
Client codes can also be set for individual areas in Programming | Areas | Configuration.
-
PABX Number: If the controller is connected to an internal phone network it will first dial this number to gain an external phone line.
If the PABX number is disabled by an Operating Schedule (Programming | Phone Numbers | General) the external number will be dialed immediately.
-
Phone Number 1: The primary phone number for the monitoring station. The controller will dial this number first to report events.
-
Phone Number 2: This phone number is used when the controller cannot make a connection with either Phone Number 1 or the Phone Backup.
-
Phone Backup: This phone number is used when the controller cannot make a connection with Phone Number 1.
The sequence of dialing attempts depends on whether Use Alternate Dialing Method is enabled in the Options section.
Options
-
Use Alternate Dialing Method: This option determines the order in which the service will try the phone numbers programmed in the Configuration section if Phone Number 1 fails.
The options are:
- Sequential (this option disabled): When Phone Number 1 fails the service continues to try this phone number until it reaches the maximum Dial Attempts (Settings section). If all attempts fail the service repeats this process with the Phone Backup, then with Phone Number 2.
- Alternate (this option enabled): When Phone Number 1 fails the services tries the Phone Backup once, then tries Phone Number 1 again, then repeats in an alternating fashion. When both numbers have reached the maximum Dial Attempts the service tries Phone Number 2 until it also reaches the maximum number of attempts.
When all numbers have reached the maximum dial attempts the Reporting Failure trouble input is opened.
-
Pause After PABX: When this option is enabled the dialer will insert a pause of 2.5 seconds after dialing the PABX number.
-
Report Open: When this option is enabled the service will report disarming (opening) for all areas using this service.
-
Report Close: When this option is enabled the service will report arming (closing) for all areas using this service.
-
Report Alarms: When this option is enabled the service will report input alarms.
-
Report Tampers: When this option is enabled the service will report input tampers and trouble input alarms.
-
Report Restore: When this option is enabled the service will report input restores.
-
Report Bypass: When this option is enabled the service will report input bypasses.
-
Service Operates As Backup: When operating as a backup the service will not begin reporting unless it is initiated by another service that has failed to report. This service will report any messages from the primary service which failed to send, and then return operation to the primary. The backup service starts and stops at the same time as the primary service.
Only Report IP services have the option to set a Backup Service (Configuration section).
-
Log Modem Events To Event Buffer: When this option is enabled, detailed events describing the call progression will be saved to the event log for every report.
This can be used for troubleshooting issues but should be turned off during normal operation as large numbers of events will be generated.
Settings
-
Dial Attempts: Determines how many times the controller will attempt to dial each number before moving on to the next backup number. This limit applies even when the report was successful.
For UL/cUL installations (with Enable UL Operation Mode enabled in Controller Records | Controllers | Options) the controller will not allow values above 8.
-
Port Attempts: Determines how many times the service will attempt to gain access to the onboard modem before reporting a communications failure. This may occur when another service is using the same port for communications.
-
Report Count: Determines how many reports the service can send in each call to the monitoring station. Between 8 and 16 is recommended. If the limit is reached the controller will dial out again to send any remaining messages.
-
Handshake Time: The length of time that the controller will wait to receive a handshake message response from the remote receiving unit. This can be adjusted if a longer than normal call completion time is required.
-
Dial Time: The length of time that the controller will wait following a failed reporting attempt before redialing or dialing a backup number.
-
Off Hook Output/Output Group: This output or output group is activated when the service begins using the modem and is deactivated when the communication is completed. It can be used with remote exchange systems that require ground start communication connections.
-
Report OK Output/Output Group: This output or output group is activated when the service successfully completes a report. It is not deactivated automatically, and should be programmed with an Activation time (Controller Records | Outputs | General) to ensure that it is turned off between reports.
Background Monitoring
-
Enable Background Monitoring: When background monitoring is enabled the service will regularly send polling messages to confirm that the phone lines are operational. This ensures that issues in any of the phone lines (whether primary or backup) are detected.
- Background Poll Time When OK: Determines how often the controller will check the status of the service when there are no known issues.
- Background Poll Time When Known Failure: Determines how often the controller will check the status of the service when there is a known issue.
- Test Report CID Code/Group/Zone: The Contact ID event code, group number and zone number that the controller will send for the test report.
- Phone 1 Failed CID Code/Group/Zone: The Contact ID event code, group number and zone number that the controller will use to report failed communication with Phone Number 1.
- Phone 2 Failed CID Code/Group/Zone: The Contact ID event code, group number and zone number that the controller will use to report failed communication with Phone Number 2.
- Backup Phone Failed CID Code/Group/Zone: The Contact ID event code, group number and zone number that the controller will use to report failed communication with the Backup Phone.
Report IP
This reporting service sends alarms, tests and other events to a monitoring station over an IP connection. The Report IP service supports a number of formats over UDP and TCP connections, either encrypted or unencrypted, allowing it to send more informative reports more cheaply and securely than traditional phone line reporting.
As well as the onboard ethernet connection, some controller models include a USB-ethernet interface which enables you to connect a Protege DIN Rail Cellular Modem to send reporting messages over a 4G cellular network. For more information and configuration instructions, see the Protege DIN Rail Cellular Modem Configuration Guide.
Configuration
-
Client Code: This code represents the controller or site in reports to the central monitoring station. An account code for Report IP can be up to 8 digits. Any leading zeros will be truncated so that the minimum number of digits possible is sent (e.g. 004311 is shortened to 4311). If the client code is longer than the reporting format allows it will be truncated.
-
Reporting Protocol: The Report IP Service supports a number of reporting formats. This includes versions of traditional formats that can be sent over an IP connection, providing maximum flexibility.
-
Armor IP: Armor IP is a proprietary IP reporting protocol by ICT. Reports are sent to an installed Armor IP server which provides a standard Ademco 685 output and allows routing and redirection of messages to other receivers. This format provides full textual transmission that includes the names of the records (user, area, input) that generated the report and additional information such as field time and controller name. It also includes standard Contact ID codes for automation.
Armor IP reporting is available in both UDP and TCP modes, and either encrypted or unencrypted.
For more information, see the ArmorIP Version 3 Internet Monitoring Application User Manual.
- SIA Over IP (DC09): Communicates in the SIA Level 2 format using the SIA DC09 specification for digital communication.
- CID Over IP: Communicates in the Contact ID format using the SIA DC09 specification for digital communication.
- CSV IP: CSV IP is an IP reporting protocol used by Alarm New Zealand. This is a generic ASCII protocol which takes the form: username, password, client code, message. This service sends report messages in Contact ID format.
- Patriot LS30: Patriot LS30 is a proprietary IP reporting protocol by Patriot Systems. This service sends report messages in a variant of the Contact ID format.
-
-
CSV IP Username/Password: The username and password required for the CSV IP protocol.
-
Encryption Level: Sets the encryption type used to encrypt messages from the service. The encryption settings here must match those in the receiving device so that the messages can be decrypted.
-
Encryption Key: If the Encryption Level is set, this field defines the associated encryption key. The key is any sequence of letters and numbers shared with the receiving device.
- For 128 bit encryption the key must be 16 characters long.
- For 192 bit it must be 24 characters.
- For 256 bit it must be 32 characters.
-
Poll Time: The time between polling messages sent from the controller to the receiving server. The polling message format depends on the Reporting Protocol defined above.
Ensure that the same poll time is set at both the controller and the receiver.
-
Backup Service: The backup service will be used when the Report IP service suffers a communication loss. It is useful to select a service that connects over the phone line to ensure that reports can be sent over an alternative connection when there is a cable failure or internet outage.
The service selected here must have Service Operates As Backup enabled in the Options section.
-
Time Before Switching To Backup: If a Backup Service is configured above, this field defines the length of time that the IP connection must be lost before the service will activate the backup.
Primary/Secondary Channel Settings
The secondary channel provides a backup path for communication with the monitoring station should the primary channel fail. If the primary channel cannot be used the service will try the secondary channel before starting the backup service.
The two channels should at minimum have different IP addresses and/or port numbers. For higher reliability use two different mediums for internet access, such as wired and wireless connections.
-
IP Address / Host Name: The address of the receiver that messages are sent to.
-
IP Port Number: The port used for communication with the receiver. This will depend on the configuration of the receiver software or hardware.
-
Network Adapter: The network adapter on the controller that the Report IP service uses for communication. This should be set to Cable to use the onboard ethernet interface, or USB Ethernet to use a cellular modem.
The 3G modem option is not used.
-
Number of Port Open Attempts: The number of times the service should attempt to open the communications port before logging a communication failure and switching to the other channel or a backup service. To bypass this setting use the Switch Secondary IP Immediately option (Options tab).
-
Ack Wait Time: The length of time that the service will wait for an acknowledgement (ACK) packet from the receiver before resending the report.
- Report Fail Output/Output Group: This output or output group is activated when the service experiences a communication failure. It is deactivated when communication is restored.
-
Enable Offline Polling: Offline polling occurs when the service is not normally in use, i.e. operating as a backup. If the backup service loses connection the Reporting Failure trouble input will open and a report will be sent to the monitoring station. This ensures that any issues are detected before the backup service is required.
Primary/Secondary Communication Failure Report
- Communication Failure Report Code/Group/Number: The Report IP event code, group number and zone number sent when the offline polling fails.
- Offline Poll Count: The number of offline polls that must fail before the connection failure is reported.
- Offline Test Report Time: The time between offline polls.
Options
-
Switch Secondary IP Immediately: With this option enabled, when the primary channel fails to connect the service will immediately attempt the secondary channel instead of making multiple attempts to connect over the primary (i.e. the Port Open Attempts setting is ignored).
-
Report Open: When this option is enabled the service will report disarming (opening) for all areas using this service.
-
Report Close: When this option is enabled the service will report arming (closing) for all areas using this service.
-
Report Alarms: When this option is enabled the service will report input alarms.
-
Report Tampers: When this option is enabled the service will report input tampers and trouble input alarms.
-
Report Restore: When this option is enabled the service will report input restores.
-
Report Bypass: When this option is enabled the service will report input bypasses.
-
Log Acknowledge Response: When this option is enabled, an event will be logged whenever an acknowledgment (ACK) packet is received from the monitoring receiver.
This option may be useful for initial configuration and troubleshooting but should be disabled during normal operation to save event storage.
-
Log Polling Message: When this option is enabled, an event will be logged whenever a polling message is sent to the monitoring receiver.
This option may be useful for initial configuration and troubleshooting but should be disabled during normal operation to save event storage.
-
Log Message Retries: When this option is enabled, an event will be logged whenever the service resends a failed message.
-
Log Reporting Failure: When this option is enabled, an event will be logged whenever communications have failed completely and the service is waiting to make another attempt.
-
Service Operates As Backup: When operating as a backup the service will not begin reporting unless it is initiated by another service that has failed to report. This service will report any messages from the primary service which failed to send, and then return operation to the primary. The backup service starts and stops at the same time as the primary service.
Only Report IP services have the option to set a Backup Service (Configuration section).
Automation and Control
This integration service provides a generic interface for communication with third-party automation systems (e.g. Control 4, Crestron, AMX, C-Gate, Command Fusion) and other programs. This allows the Protege X system to be monitored and controlled externally through custom made applications.
External applications can log in to the Protege X controller using a valid user PIN code. Messages are sent and received via the ICT Automation and Control Protocol. For more information, contact ICT.
Configuration
- IP Port: The TCP/IP port that the service will use to communicate.
-
Encryption Level: Sets the encryption type used to encrypt messages from the service. The encryption settings here must match those in the receiving device so that the messages can be decrypted.
-
Encryption Key: If the Encryption Level is set, this field defines the associated encryption key. The key is any sequence of letters and numbers shared with the receiving device.
- For 128 bit encryption the key must be 16 characters long.
- For 192 bit it must be 24 characters.
- For 256 bit it must be 32 characters.
-
Checksum Type: Sets the type of checksum that will be appended to the end of each control packet.
- 8 bit Sum is a simple addition of all previous bytes in the packet.
- CRC-16 is a standard CRC (Cyclic Redundancy Check) based on the CRC-16-CCITT polynomial.
Options
-
Numbers are Big Endian: The default method of sending multi byte numbers is Little Endian (least significant byte first). With this option selected, multi byte numbers will be sent as Big Endian (most significant byte first).
-
Allow Status Requests When Not Logged In: When this option is enabled the external program connected to the service can request and receive status updates (e.g. area status) without logging in. The program cannot send control commands (e.g. disarming the area) without logging in with a valid user PIN.
-
User Logon Lock Out Timer If Incorrect PIN Is Supplied: When this option is enabled, if an incorrect PIN is supplied three times in a row the service will block further attempts for 60 seconds.
-
ACK Commands: With this option enabled the service will send an acknowledgment (ACK) packet to the external program after it successfully receives a control command.
-
Expect ACK For Status Monitoring: With this option enabled the service will expect an acknowledgment (ACK) packet to be returned after it sends a status update. If no ACK is returned within 3 seconds the status update will be resent.
-
Resend Status Monitoring If No Ack After 5 Attempts: If Expect ACK For Status Monitoring is enabled above, this option controls the cut off criteria for unacknowledged status updates.
- When this option is enabled the service will resend each status message until it receives an ACK from the external program.
- When this option is disabled the service will stop sending a status update if it has not been acknowledged after 5 attempts.
-
Expect Ack For Events: With this option enabled the service will expect an acknowledgment (ACK) packet to be returned after it sends an event. If no ack is returned within 3 seconds the event will be resent.
-
Resend Events If No Ack After 5 Attempts: If Expect Ack For Events is enabled above, this option controls the cut off criteria for unacknowledged events.
- When this option is enabled the service will continue sending each event until it receives an ACK from the external program.
- When this option is disabled the service will stop sending an event if it has not been acknowledged after 5 attempts.
C-Bus
This integration service communicates with a C-Bus Network Interface (CNI) for automation control.
Configuration
- CNI IP Address: The IP address of the C-Bus network interface that the controller is communicating with.
-
CNI Port: The IP port used to communicate with the C-Bus network interface.
This should be the same port used for communications between the CNI and the C-Bus Toolkit software.
- Communication Failure Output/Output Group: This output or output group is activated when there is a communication failure with the CNI.
General
-
Enable Text Output: Enable this option to convert communications from the controller to a human readable format. This allows for debugging if a monitoring device is used in place of the CNI
Note: The integration will not function with this option enabled.
-
Add CR to Text Output: When Enable Text Output is in use, enabling this option adds a carriage return character to the end of each message.
- Add LF to Text Output: When Enable Text Output is in use, enabling this option adds a line feed character to the end of each message.
-
Log C-Bus PCI Failure Message: With this option enabled, error events will be logged when the CNI fails to initialize.
This option may be useful for initial configuration and troubleshooting but should be disabled during normal operation to save event storage.
-
Log C-Bus Ack Message: With this option is enabled, events will be logged for each acknowledgement (ACK) packet received from the CNI.
This option may be useful for initial configuration and troubleshooting but should be disabled during normal operation to save event storage.
-
Log C-Bus Data Activity: With this option enabled, events will be logged for all packets sent to and received from the CNI.
This option may be useful for initial configuration and troubleshooting but should be disabled during normal operation to save event storage.
Setting up Reporting Services
The following instructions detail the steps required for setting up services which send reports to offsite monitoring stations, either over a phone line or via the IP network. The supported types of reporting service are:
- Contact ID
- Report IP
When a reporting service is added to an area it can send reports relating to area arming/disarming and events for inputs and trouble inputs programmed in that area. The following steps briefly describe how to create a reporting service and begin reporting on an area.
- Navigate to the Controller Records | Services page. You will be prompted to select the Location and Controller which will use this reporting service.
- Add a new service with a Service Type of ContactID or Report IP.
- Configure the communication settings required to send reports to the monitoring station, such as the Client Code and any phone numbers or IP channels.
- Select which event types this service will report (open, close, alarm, tamper, restore and/or bypass) in the Options section.
- For Report IP services add and configure a Backup Service if required. This allows the controller to report over an alternate IP connection or phone line if the connection fails.
- Save the service.
- Navigate to the Programming | Areas page and select an area that will be monitored by this service.
- In the Configuration section, scroll down to the Services section and click Add.
- Select the new reporting service then click Select.
- Save the area. Repeat for any additional areas.
- Return to the Controller Records | Services page. Click the dropdown arrow beside the new service and click Start Service.
Now the service can report the selected event types for those specific areas to the monitoring station.
Manual Service Commands
Clicking the button beside a service record (only visible when hovering) opens a menu with manual commands for that service.
Control
- Start Service: Starts the service.
- Stop Service: Stops the service.