Report IP | General

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: ArmorIP is a proprietary IP reporting protocol by ICT. Reports are sent to an installed ArmorIP 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 ContactID codes for automation.

      ArmorIP 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; and for 256 bit it must be 32 characters.

  • Poll Time (seconds): The time (in seconds) between polling messages sent from the controller to the receiving server. The polling message format depends on the Reporting Protocol set 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 tab.

  • Time Before Switching to Backup (seconds): If a Backup service is configured above, this field defines the length of time (in seconds) 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 both 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 Adaptor: 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.

  • 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 (in seconds) 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.

    • Communication Failure Report Code/Group/Number: The Contact ID 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, in minutes.