Integration Agent for Dummies

Not Yet Reviewed

Does anyone have a simple explanation of how this is set up? i.e. what entries I need to update/amend in the IAconfig.xml file - and do I need to create a file for the integrationservice.
Up until now we have used the javaclient - so this is all new to me.
We have a management system on server ABC and AlarmPoint on server CDE and all we send are commands from one to the other to send out a simple msg to a named recipient.
(There is no interaction by recipients other than to acknowledge)
So the options and choices in the admin/install instructions is a bit baffling.



Date Votes

Please sign in to leave a comment.

  • The bare minimum configuration to get your IA working (assuming that you have a bsmith user with notifiable devices in xMatters) would be:
    * create a web services user in xMatters and grant the "register integration agent" privilege to this user (default name for this user is "ia_user")
    * on the IA server, create a .wspasswd file to contain the web services user's password in encrypted form (directions are in the Integration Agent guide -
    * in <IAHome>\conf\iaconfig.xml, make the following changes:
    ** configure the web service user name
    ** configure the name of the file containing the web service user's encrypted password
    ** configure the company name
    ** configure the URL of at least one primary xMatters server
    ** if you don't have a secondary server, delete the example secondary server URL
    ** configure the IP address for the "service-gateway" with the Integration Agent's address
    ** in the "service-configs" section, comment out all the paths except for the one you will be using. For testing purposes, the "generic" one is ideal
    ** save the file
    * for testing purposes, enable the Generic integration service in the xMatters UI by editing the Generic event domain and adding a "generic" integration service
    * start the IA by opening a command window, navigating to <IAHome>\bin, and typing start_console.bat
    ** no errors should be reported in the console. You should see a message "Successfully completed Integration Agent bootstrap process. Integration Agent is running."
    * open another command prompt, navigate to <IAHome>\bin, and verify connection to the xMatters instance, using the command "iadmin get-status".
    ** the xMatters server should show "Connectivity status: PRIMARY_ACCEPTED"
    ** the Generic integration should show "Status: ACTIVE"
    * use the command "apclient.bin --map-data generic 123 bsmith test-message" to send a test notification to bsmith

  • Reviewing what I just wrote, I see that the IA startup command has been corrupted. It should be "start underscore console.bat"

  • Great question! Jeremy has it spot on, but I can see this as a great article for my GIG series. If you are at all into building integrations, something to check out. Link here

  • Oh, and note that this forum uses Markdown. So using backtics ` can help with formatting code and command strings.

  • OK - thanks - I can follow that alright.
    But we already have an event domain of 'XYZ' which is set to be the default in AlarmPoint - so how we use that instead of 'generic'? Do we have to create .xml and .js files for it somehow?

  • Once again, these are just the basics, to give you a functioning starting point that you can build upon. These instructions should give you an "XYZ" integration that you can customize.
    * make a copy of the folder <IAHome>\integrationservices\generic and rename the copy to "xyz"
    * within the folder, rename generic.xml to xyz.xml and rename generic.js to xyz.js
    * in xyz.xml, replace the three instances of "generic" with "xyz" and save the file
    * in xyz.js, replace the three instances of "generic" with "xyz" and save the file
    * in <IAHome>\conf\iaconfig.xml, replace "<path>generic/generic.xml</path>" with "<path>xyz/xyz.xml</path>" and save the file
    * restart the integration agent (press ctrl-c in the command window where the IA is running, then issue the command start`_console.bat)
    * test by using the command "apclient.bin --map-data xyz 123 bsmith test-message" to send a test notification to bsmith


Didn't find what you were looking for?

New post