AlarmBiller & Stages Integration Instructions
Welcome to the AlarmBiller Stages Integration. This integration ensures greater continuity between linked databases with two-way sync functionality, reduces data entry as much as possible on both ends of the integration, and includes a smooth user experience that creates ease of use when transferring, linking, and syncing accounts.
Integration Setup
The AlarmBiller Stages integration is enabled for all dealers. Before setting up the integration, the dealer will need the endpoint URL to use for the Stages integration setup in AlarmBiller, the username and password for the connection, as well as contact Stages to have a task setup with the appropriate task type and task parameters. This task setup information will be used to define the credentials for the Stages Site Group.
AlarmBiller Setup
To make use of the integration, in AlarmBiller navigate to Setup > Utilities > Third Party Services.
There are two tabs within Third Party Services; External Services and Third Party Services.
To set up the Stages Integration, click the first tab labeled 'External Services'.
Click the Stages link to define the Connection.
The Connections tab is where the link to Stages is configured. It is possible to connect to multiple Stages endpoints, though this scenario will be rare. Additionally, if there are any existing Stages integrations (via the old integration) these will be automatically migrated.
The Auto Sync checkbox will enable or disable auto-syncing for the integration. The Auto Sync is checked by default. If the Auto Sync is enabled, then if there is a linked record in AlarmBiller to one in an external Stages system, any updates in AlarmBiller will automatically be pushed to Stages.
If Auto Sync is not checked, then to sync the changes in AlarmBiller with a linked record in Stages either Account Sync or Sync record processes will need to be performed to sync the appropriate data.
To add a new connection to Stages or other central station integrations, click the Add button. This launches the Create Connection for Stages page where the information for your Stages database is entered.
The 'Name' field will automatically populate with the name of the integration currently in use, which in this case will be 'Stages'. Users can rename this connection, which may be the case if the name of the monitoring company for the dealer is more apparent for their regular use such as “Rapid”. The name of each connection must be unique for ease of identifying the connection throughout the integration process.
The 'Endpoint' field is the URL that points to the Stages API; it is prepopulated with the test endpoint, but this will need to be changed to the endpoint for the dealer's Stages database.
The Authentication portion (Username and Password) can be either Dealer or User-based. Dealer-based authentication means that there is a single user account for the Stages company and every user in AlarmBiller is granted access to the functions of the integration. User-based authentication means that each user has their own credentials. Select the one that is most appropriate and add the username and password to the respective fields that would be used to log in to Stages.
Note: If electing to use User-based authentication, each user must edit the existing connection and enter their own credentials into the username and password field, then save.
If the Authentication = User, then a single connection is defined with unique connection username and password. The user will access the connection and enter their own credentials. Once the user credentials are defined, the user will only have access to their own username and password.
Before the user can use the integration, the user must define the username and password associated with their Stages user.
Creating the User Connection
Edit the Connection
Enter the username and password.
The next time the user logs in, only the credentials for that user will be displayed.
User ‘abdealer201’ has defined their credentials and logs in:
User ‘userone’ has defined their credential and logs in:
The second tab, Mappings, shows which AlarmBiller records map to which Stages records. Clicking the links will show the current linked records of the type selected.
The following are examples of sites and devices that are integrated for this test AB Dealer:
Example of the Stages Site detail:
Example of the Stages Device detail:
On both the Connection page and the Connections grid, there is a Test button:
Clicking this will test the credentials to ensure that they are correct and that the integration will function.
Stages Setup
During the implementation phase of the integration, the credential setup will be performed by the Central Station user via a task in Stages.
In Stages dealer login, navigate to Setup > Site Group Setup. Select the Site Group used for AlarmBiller. From the Detail tab on the right side of the page, click the Credentials tab.
The Site Group must have credentials defined with the Credential Type = AlarmBiller with the username and password defined. The credential types are defined via Task Setup during the implementation phase of the integration.
Integration Process
AlarmBiller Integration Customer Wizard
The AlarmBiller customer wizard provides the option of pushing the Site/System into Stages from AlarmBiller or pulling an existing Site/Device from Stages into AlarmBiller.
When creating a new customer within AlarmBiller, on the Customer Site tab there is a new checkbox: ‘Integrate’. Clicking this will enable the integration. Selecting the Stages connection adds a new set of fields to the customer site and customer system tabs in AlarmBiller.
There are two options for adding a site to a new customer:
- Existing: Select an existing Site from Stages and link to the new customer site.
- New: Insert a new Site to Stages based on the one being created in AlarmBiller.
Add Existing Site and Devices from Stages to a New Customer in AlarmBiller
A site in Stages that is not linked to a customer site in AlarmBiller can be added as a new site to an existing or new customer in AlarmBiller. The site can also be linked to an existing customer’s site in AlarmBiller that is not already linked to a site in Stages.
Example: Site and devices created in Stages that do not exist in AlarmBiller:
Note: The billing id of the site is blank. Therefore, there is no link between this site in Stages and a customer site in AlarmBiller.
Create a new customer in AlarmBiller.
Click Next
On the Customer Site tab, check the Integrate option, select the Connection, and select ‘Existing’ for the Stages Information. This will add the fields Site and Description in the Stages section of the page.
Use the dropdown in the Site field to select the existing Stages site that is to be associated with this new customer. The data from the site in Stages is used to populate the Customer Site information.
Enter any additional information and click Next.
If using an Existing Site in Stages, you may select an existing device that is associated with the site in Stages or create a new Device in AlarmBiller that will then be pushed to the Stages site selected.
Select the Device from Stages or Create a new Device (System).
Enter the required data.
Click Next and enter Customer Recurring if applicable.
Click Submit.
Site and System (Device) are linked to a new customer in AlarmBiller.
The Site ‘billing id’ in Stages contains the customer site id from AlarmBiller.
NOTE: Do not delete or change any billing id values as this will break the link between Stages and AlarmBiller.
New Customer’s Site and System in AlarmBiller pushed to Stages
Add New Customer in AlarmBiller
Enter the customer’s information used by AlarmBiller.
Click Next
On the Customer Site tab, check Integrate, select the connection defined for the Stages integration
Select New for Stages Information.
Enter the site information.
Scroll to access the Stages fields.
The gray boxes are synched between the corresponding fields in Stages. After filling in the remaining required fields (marked with an asterisk), a System (Device) can be added.
Stages Site Field Definitions:
REGION: A region is a way for the Central Station to group together locations to deal with Storm conditions.
TIME ZONE: The Time Zone of the account. The available selections are administered by the central station.
SITE TYPE: The type of account. The available selections are administered by the central station.
DISPATCH TYPE: A Central Station defined as a way to group sites together for dispatch-related rules such as Action Plans and notifications.
PERMIT: Police Agency Permit for the account.
SUBDIVISION: This is a description field to display information that has no impact on Dispatching but can be displayed on the Dispatch window.
PETS: This is a description field to display information that has no impact on Dispatching but can be displayed on the Dispatch window.
KEYS: This is to indicate if the Central Station holds keys to the account. (UL Requirement)
UL CODE: If the account is a UL Certificated Account, the type of UL Certificate. The available selections are administered by the central station.
AUTHORITY: Default Authority level for the Site Contacts. The available selections are administered by the central station.
An arbitrary number of Stages contacts can be added. Please note these are not linked to your contacts in AlarmBiller. Contacts can be added, edited, or deleted from within the wizard. The Contacts for AlarmBiller are defined from the Billing Contacts tab of the Site.
Click “Next” at the top of the page to access the Customer System tab.
To create a new System (known as a ‘Device’ in Stages), check the “Create System?” box. When pushing a new Site to Stages, a new Device can be created. There would not be an existing Device available for a site that does not yet in Stages.
IMPORTANT NOTES:
The System Number field is grayed out and not accessible, it will be updated with the value entered for the Transmitter Code in the Stages section of the page.
Zones (also called Configurations in Stages) can be created, edited, and added to the system. These Zones are not linked to the Zones in AlarmBiller. The Zones for AlarmBiller are defined from the Billing Zones tab of the Site.
Click 'Update' to save the zone
Stages System (Device) Field Definitions:
TRANSMITTER CODE: This is the Account Identifier. (CSID#, XMIT#, Account#...etc)
ALT DEVICE ID: This is an alternative TRANSMITTER CODE for the account. (Phone#, Backup account…etc.)
OOS CATEGORY: Out of Service Category. This will set the account to not active. The available selections are administered by the central station.
DEVICE TYPE: This is typically used for default zoning and may correspond to the manufacturer or panel name/model. The available selections are administered by the central station.
TT Type, TT Days, TT Hours, TT Minute, Fail Event: The Timer Test configuration. The available selections for Time Test Type are administered by the central station. The Days, Hours, and Minutes are the expected interval of Timer Tests. The Fail Event an override for the default Event that will be created if the expected timer test signal is not received.
IVR#: This is a numeric number that the account can be accessed from using the IVR system.
PRIMARY XMIT: If the system is a Secondary/Backup, the Primary system is entered here.
COMM TYPE: The Communication Type of the panel. This is for informational purposes only. The available selections are administered by the central station.
LINE SECURITY: This is a UL Required field. (examples: Encrypted, Standard, or None (blank))
LID TYPE: A two-way communication system may have a Listen In Device Type for how the Listen In functions.
URL Text/Target: A device can display a URL on the dispatch window.
SIGNAL FORMAT: The signal format that the panel sends. This is for display purposes only.
ENTRY/EXIT PERIOD: The time allowed to enter in the Device User Code in the panel. This is for informational purposes only. Format mm:ss
LOCATION: A description of where the panel is located in the premise.
INFO: General information about the system.
FIRST SIGNAL DATE/TIME: The date and time of the first signal received.
SILENT?: If the panel alarm is silent. This is for informational purposes only.
CONFIG ONLY?: This is an option to ONLY use zones that are configured on the system, and not to use any default zoning.
If Customer Recurring is to be added, click Next to access the Customer Recurring page.
If Customer Recurring is not to be added at this time, click ‘Submit’ to save the customer, site, and system to AlarmBiller and push the site and device (system) to Stages.
The customer’s Site and System (if added) are saved to AlarmBiller.
The Site and Device are available in Stages.
Site:
Sites in Stages will have the Billing ID field populated with the AlarmBiller Customer Site ID. This code is used to identify the customer site when sending updates to AlarmBiller.
NOTE: Do not delete or change any billing id values as this will break the link between Stages and AlarmBiller.
Device (System in AlarmBiller)
Devices in Stages will have the Billing ID field populated with the AlarmBiller Customer System ID. This code is used to identify the customer system when sending updates to AlarmBiller.
NOTE: Do not delete or change any billing id values as this will break the link between Stages and AlarmBiller.
Changes are logged in Stages:
Contact is updated in Stages:
The Zone (Configuration) is also pushed to Stages:
Linking
If there is an existing Site in AlarmBiller and an existing Site in Stages, linking is the preferred method. From the Site page in AlarmBiller, click the Utilities tab, and from there select the External tab. At least one System (Device) is required in Stages when creating a site. Therefore; during the linking process at least one device must be selected when linking a site in AlarmBiller.
Site in Stages:
The billing id is blank. This indicates that this site is not currently linked to a site in AlarmBiller.
Add Devices to the site in Stages
Open the customer record.
Select the Sites/System tab of the customer.
Select the Site to be linked with the site in Stages
From the Utilities tab of the customer site, select the External tab:
Click ‘Add Link’ to launch the page for adding a link to this site.
Select the connection to Stages:
There is a tab for the Site and one tab for each System associated with that site. Selecting the Site from the dropdown will limit the Devices that can be selected on the System tabs to be only children of that Site in Stages.
Select the Site defined in Stages from the dropdown.
From the System tab, select the device from Stages.
Click Save.
A new ‘Stages’ tab is added:
In Stages the billing id of the site and device are updated:
NOTE: Do not delete or change any billing id values as this will break the link between Stages and AlarmBiller.
Unlinking a System:
To unlink a system:
Select the customer.
Click the Site/Sys tab:
Click the link for the system # to be unlinked.
Click the Utilities Tab of the selected system:
Click the External Tab:
Click the Delete icon:
A warning is received: “Are you sure you want to do this? It may have unintended consequences.”
If the link to the system is to be removed, click OK.
From the Stages connection tab for the Site, the system is now showing a link icon to create a new link if needed.
In Stages, the Device remains.
Pushing
Alternatively, if there is a Site defined in AlarmBiller, but the Site is not defined in Stages, the AlarmBiller site can be pushed to Stages. In addition to pushing the data to Stages, the Push Button on the External Tab can be used to also push the data to other integrations. If the Site is already linked, upon clicking the Push button only connections in which the record has not been previously linked will appear in the dropdown.
Open the Customer Record
From the Sites/Sys tab, select the site to be pushed to Stages.
Click the Utilities tab, and select the External tab:
Click the Push button.
Select the Stages Connection.
Enter the required and desired option information:
Click Save.
After the site is successfully pushed, the AlarmBiller Site page is displayed. The Site page contains a Stages tab. From the Stages tab there are additional tabs for Stages-related Devices, Notes, Contacts, and History.
Site is pushed to Stages:
The billing id is the customer site id from AlarmBiller.
NOTE: Do not delete or change any billing id values as this will break the link between Stages and AlarmBiller.
The External Tab
The External Tab from either the customer site or system pages includes three options.
Account Sync
The Account Sync button will only show up if there is an External reference in the grid.
The Account Sync will sync the entire hierarchy of the current record. A sync for a system will also sync the associated Site. However, a sync of a Site will not sync any associated systems, contacts, or zones.
The Use AlarmBiller Data button will resolve the differences between the AlarmBiller and Stages record using the AlarmBiller data. The Use Stages Data will resolve the differences between the AlarmBiller and Stages record using the Stage data. Account Sync is the same operation for Systems associated with the selected Site.
Select the Stages Connection:
Add Link
The Add Link option allows for an existing Site in AlarmBiller to be linked to an existing Site in Stages. To link a System in AlarmBiller with a Device in Stages, a corresponding Site must exist in Stages. The Add Link from the Contacts or Zone pages will not push to the Stages integration.
Push
The Push option allows for a Site defined in AlarmBiller that is not currently linked to a Site in Stages to be pushed to Stages. To push a System in AlarmBiller to a device in Stages, a corresponding Site must exist in Stages. The Push button from the Contacts or Zone pages will not push to the Stages integration.
Each grid row has the following features:
View the external reference (the hyperlink in the External Key column)
The external Site information shows the Stages devices, notes, contacts, and history information.
The external System (Device) will show the Stages configurations and history information.
Sync
The Sync button on the External Reference grid will only sync the selected record (not its children). However, this method gives more granular control over what gets synced.
Take AlarmBiller – sync the values from the AlarmBiller column to Stages.
Reset - undo all the Takes options.
Take Stages – sync the values from the Stages column to AlarmBiller.
In the grid:
Merge field - reflects what values will sync upon clicking Save.
The icons in each row do the same thing as the Take AlarmBiller <, Take Stages > and Reset buttons, but only on the given row.
Cancel – cancels the selection.
Save – launches the Sync for the selected options.
Currently, there is no way to put a manual entry in the Merge. The data must either exist in AlarmBiller or Stages. To change what is in a particular field, the change must be made in the applicable page: Site, System, or both. If using AutoSync and a change is made in AlarmBiller, the change will get pushed to Stages automatically.
Site Sync:
Select the sync option per field:
Verify the data in the merge column is the data to sync.
Click Save:
(OH and Ohio are synonymous in both Stages and AlarmBiller, therefore the value did not update.)
System Sync
Click the Take Stages icon on the record:
The Merge field is updated to allow verification prior to the sync.
Click Save to sync the record
The Account Number field in AlarmBiller is updated with the Transmitter Code in Stages:
Edit Link
Edit Link for a Site allows the user to change the link to a different Site in Stages that is not currently linked to AlarmBiller. The Edit Link for a System allows the user to change the link to a different Device in Stages for a Device that is not currently linked to AlarmBiller.
Delete
Deleting will remove this reference between Stages and AlarmBiller. The record (Site or System) in AlarmBiller and the referenced record in Stages will not be altered. Any changes to the records in either Stages or AlarmBiller after the linked reference has been deleted will not be pushed. To re-link these items, the Add Link function can be used.
The Stages Tab
Each linked item has a new tab that is named after the External Service defined in the Third Party Services setup. (In this example, the External Service is called “Stages”.) The information displayed shows how this record is linked to external records (Stages).
Clicking the Site Number link will open the tab’s content in a new page. The Address link will open the address in Google Maps. The Sync button will take you to the individual Sync page (as described above).
There are four tabs. Devices tab, which shows all the Stages Devices associated with this Site. Notes tab, which shows you the associated notes. Contacts tab, which shows all the contacts (including the ones you pushed, if any). Finally, the History tab, which shows the test history for the Devices associated with this Site.
This data is being pulled directly from Stages, and therefore is going to represent the latest information available from Stages.
In the Devices tab, a collection of Devices from Stages will be listed. Clicking the link will take you to a page for that device. There are different buttons in the Devices grid. The Edit icon lets you edit the Device in Stages, whether it’s linked to a System in AlarmBiller or not. However, if it is linked, it will synchronize those changes to the linked record in AlarmBiller. If the device is linked, the book icon can be used to access the linked System in AlarmBiller. If linked, there is also a Stages tab for this Device. If the device is not linked, the link button can be used to select a System in AlarmBiller to link to this Device.
From the Contacts tab, the Contact information is used to view or edit the Contact. This contact is only stored in Stages and not linked to AlarmBiller, therefore will not be reflected anywhere in the application outside of this grid. The Create button also pushes a new Contact directly to Stages.
The Stages tab on the System page shows data Stages has for that Device. If the Device Status is Normal, then the Activate Test Mode button is activated.
The Configurations tab shows the Configurations (Zones) that Stages has for this Device. New Configurations can be sent in Stages directly by clicking the Create button.
The History tab shows a subset of the History tab from the Site grid, filtered to only show the test history affecting this device.
Clicking the Activate Test Mode button will bring up a panel. Currently, only the All Points on test is supported. When putting a System or a Site on test via the integration, the Stages Site Time Zone is used.
Fill in the required fields (marked with an asterisk), and this will put that device on test.
Note: The Dates and Times for the test are in the Site’s time zone, which might differ from the current time zone.
Click Save.
A confirmation regarding the test status is received:
If accessing the customer record while a system test is running, the user is notified.
When a test is running, the ‘Deactivate Test Mode’ button is activated. Clicking the Deactivate Test Mode button will display the list of active tests from which any currently active test for that Device can be disabled.
Clicking the X button in the grid will deactivate that test.
If an Alarm is active on the system, the Device Status indicates ‘Alarm’.
Pushing Site from Stages to AlarmBiller for New Customer
In Stages, add a new Site and Device or Select a Site that is not linked with AlarmBiller.
Click the AB (AlarmBiller Send) icon in the Site View section:
From the ‘AlarmBiller New Customer’ tab, select if the customer is a business customer.
If business customer, check the ‘business customer?’ check box and confirm that the last name is the name to be used for the new customer:
If not a business customer, do not select the ‘business customer?’ check box, add a first name and confirm that the last name is the last name to be used for the new customer.
Confirm the remaining address information.
Click the AlarmBiller Save icon.
A message will be received indicating if the customer was successfully added to AlarmBiller.
Refresh the Site Data
Click the Site tab. Note: The billing id is updated with the site id from AlarmBiller.
NOTE: Do not delete or change any billing id values as this will break the link between Stages and AlarmBiller.
Click the Device tab. Note: The billing id is updated with the system id from AlarmBiller.
Each device will have a unique billing id.
Note: The AB (AlarmBiller Send) icon is no longer available since the site is already linked with AlarmBiller.
From AlarmBiller > Customer > Search and select the new customer.
Check and update any information for the customer needed by AlarmBiller such as Salesperson, Terms, Delivery Method, etc by clicking the Edit button on the customer view. Save any changes.
To confirm the information updated by the push from Stages:
Click the Sites/Sys tab of the customer.
Confirm that the site and any associated devices are listed.
Click the hyperlink for the Site.
Click the Stages Tab (the name of the tab will be the name of the Stages connection defined).
The Site and Transmitter Code from Stages are displayed. The Contacts tab contains the contacts defined for the Site in Stages.
The contact can be edited. The Create button can be used to add Stages related contacts.
The information on the History tab will be updated with tests performed on the site.
Click the Utilities Tab and then the External Tab.
The External Tab will show the Stages link information for the Site.
Click the Systems Tab.
From the list of Systems, click the hyperlink to the System Number.
Click Edit to make any changes to the system information used by AlarmBiller.
Save the changes.
Click the Stages Tab (the name of the tab will be the name of the Stages connection defined).
The Configuration created in Stages will be displayed.
From the Stages Tab of the System, the Activate Test Mode button can be used to put the system (device) on test.
Click the Utilities Tab and then the External Tab.
The External Tab will show the Stages link information for the System (Device).
Push Site and Devices from Stages to Existing Customer in AlarmBiller
In AlarmBiller, identify the customer that is not currently linked to AlarmBiller.
In Stages, add a new Site and Device or Select a Site that is not linked with AlarmBiller
Click the AB (AlarmBiller Send) icon in the Site View section
From the ‘AlarmBiller Existing Customer’ tab, search for the AlarmBiller customer to be linked with the Stages site.
Click the Select icon to the left of the customer to be linked.
A message will be received indicating if the site and related devices are submitted to AlarmBiller.
Refresh the Site Data.
Click the Site tab. Note: The billing id is updated with the site id from AlarmBiller.
Click the Device tab. Note: The billing id is updated with the system id from AlarmBiller.
NOTE: Do not delete or change any billing id values as this will break the link between Stages and AlarmBiller.
Each device will have a unique billing id.
NOTE: Do not delete or change any billing id values as this will break the link between Stages and AlarmBiller.
Note: The AB (AlarmBiller Send) icon is no longer available since the site is already linked with AlarmBiller.
From AlarmBiller > Customer > Search and select the customer.
To confirm the information updated by the push from Stages:
Click the Sites/Sys tab of the customer.
Confirm that the site newly pushed site from Stages is listed.
Note: There are now multiple sites: the original site(s) created in AlarmBiller and the new site pushed from Stages.
Click the hyperlink for the Site that was pushed from Stages.
Click the Edit button to make any Site information used by AlarmBiller and Save.
Click the Stages Tab (the name of the tab will be the name of the Stages connection defined).
The Site and Transmitter Code from Stages are displayed on the Devices Tab.
The Contacts tab contains the contacts defined for the Site in Stages.
The information on the History tab will be updated with tests performed on the site.
Click the Utilities Tab and then the External Tab.
The External Tab will show the Stages link information for the Site.
Click the Systems Tab.
From the list of Systems, click the hyperlink to the System Number.
Click the Edit button to make any changes to the system used by AlarmBiller, such as Panel Type, Panel Location, Warranty information, etc. Save the changes.
Click the Stages Tab (the name of the tab will be the name of the Stages connection defined).
If any Configurations were created in Stages, they will be displayed.
From the Stages Tab of the System, the Activate Test Mode button can be used to put the system (device) on test.
Click the Utilities Tab and then the External Tab.
The External Tab will show the Stages link information for the System (Device).
Sync updates from Stages to AlarmBiller
The following Site Data are automatically updated in AlarmBiller when updated in stages:
- Site Address
- Site Info
- Site Phone
- Device Xmit#
