Incident Data Transfer Service
Overview
The Incident Data Transfer Service sends SBN incident information out to an external system over a web (REST) connection. On a fixed timer it checks SBN for incidents that are ready to be sent, packages each one, and posts it to the configured external service. When the external system replies, the service records the acknowledgement back in SBN and marks the incident as processed so it is not sent again.
The service supports two integration styles, selected by the Request Type property: a full incident transfer (Salesforce), which includes the incident details, comments, free-format text, zone, and call-list information; and a lighter event notification (Katana), which sends a smaller set of incident identifiers. Run one instance configured for the integration the site uses.
If an incident cannot be delivered, the service retries a configurable number of times before reporting the problem. Should a fatal error occur, the service records the reason, sends a notification email, and stops. The service requires a working SBN data-server connection; if that connection cannot be established at start-up, the service logs the reason and stops.
Service Manager
On the current line (v96 and later) the services are installed and managed as described in Installing & Uninstalling. Service Manager applies to v95 and earlier.
Service Properties
Only properties specific to this service are listed here. Common service properties (SBN Server connection, Logging, SMTP) are found here.
Timer (In Seconds)
How often the service checks SBN for incidents to send. The service waits this many seconds between cycles, then processes any incidents that are waiting to be transferred.
Request Type
Selects which external integration the service uses. Set this to match the system the site is sending incidents to; it determines both how each incident is packaged and which endpoint it is sent to.
REST Service URL
The web address of the external service that incidents are posted to. This is provided by the receiving system and points the service at the correct endpoint.
REST Request Timeout (In Seconds)
How long the service waits for the external service to respond before treating the attempt as failed. If the timeout is reached, the attempt is retried according to the Max Retries setting.
Max Retries
The number of times the service will retry sending an incident when the external service does not respond, before reporting the failure. A short pause is taken between retries.
SBN Error Account (CID)
An SBN account (customer ID) used to raise an operator-visible alert when delivery problems persist. Leave blank to skip this notification.
Heartbeat (In Seconds)
How often the Error Account is touched to show the service is still active. This works together with the SBN Error Account so that, if the service stops keeping the account updated, an operator is eventually notified.