Search the Aria Knowledgebase for
User Documentation, APIs, SDKs, and more!

 

Home > User Documentation > Notifications > Event Notifications > Event Notification Prerequisites

Event Notification Prerequisites

Overview

Event notification is the means by which Aria interacts with your service delivery system(s), informing you of any creation/modification of accounts based on the events to which you have subscribed. Once you complete the prerequisites, you must enable and then subscribe to event notifications. The following prerequisites must first be taken:

Accept the Aria IP Address Range

Ensure that your firewall will accept the Aria IP address range. Please contact Aria Systems Customer Support to obtain the Aria IP address range.

Configure your Provisioning Settings

Select your chosen provisioning settings that will determine how and when event notifications will be sent to your system(s). Detailed instructions for configuring your provisioning settings are provided in the Aria6 Administration Guide.

Use XSD or DTD Files

If you have event notifications sent to you as XML documents, you may choose to work with XML document definition files that describe the structure of the data in the event notifications that Aria will send to your system(s). One XML document definition is available of each event group. These files are available in the XSD and DTD formats. You can validate the data in the XML documents against the applicable XSD or DTD file. You can use the XML document definition files in either of these two ways:

  • Point your system(s) to the URL at which your chosen XML document definition file is located, or
  • Download your chosen XML document definition file.

The XSD and DTD files are located within Event Driven Provisioning.

Set up VIE (Virtual Inventory Engine) for Virtual Inventory

If you sell virtual inventory, you must have event notifications sent to VIE (Virtual Inventory Engine, also known as the Aria Resource Controller). That way, when a customer places an order for a resource type, Aria will automatically increase the number of units of the resource type that the customer has based on the API method that you call.

Note: In order for Aria to be able to track the amount of a resource type that each customer has, VIE must be set up in your Aria implementation. That way, Aria will be able to increase and decrease the number of units of a resource type that a customer has based on the API methods that you call.

Enable XML Statements

If you want Aria to generate statements for your customers as XML documents, you must enable XML statements in Aria6, to do so: Click Configuration > click Notifications > click Notification Settings > click XML Statement Distillation Option (you may have to go to the next page of notification settings to see this option) > select your desired Value to specify how you want Aria to generate XML statements:

  • Aria XML Statements WITHOUT Usage Detail
  • Aria XML Statements WITH Usage Detail

Note: If you select Aria XML Statements WITH Usage Detail, that may result in very large XML documents.

Aria will generate XML statements for customers with only the following notification methods:

Notification Method ID

Description

1

HTML Email

2

Text Email

3

Text Email w/link to HTML

6

Printable & Text Email

7

Printable & HTML Email w/Surcharge

9

PDF (Printing required, no Email)

10

PDF (delivered by Email)

11

PDF (Printing req & Email)w/surcharge

12

PDF (Printing req, no Email)w/surcharge

13

XML Master File

14

PDF Master File

You can use the update_acct_notify_method, create_acct_complete, or update_acct_complete API call to set a customer’s notification method. In order to work with XML statements generated by Aria, you must also do the following:

  • Use version 3.1 of the Account Notifications event group in order to subscribe to the Account Message Type "XML Statement" Requires Sending (event ID 442) event. (Please contact Aria Systems Customer Support to get access to version 3.1 of the Account Notifications event group.)
  • Subscribe to the Account Message Type "XML Statement" Requires Sending (event ID 442) event in the Account Notifications event group. This event notification informs you that an XML statement for a customer has been generated and provides an xml_statement_no.
  • After you receive event notifications about generated XML statements, you can retrieve those statements using an API call named get_aria_xml_statement. Each of these event notifications will contain an xml_statement_no that you can pass into the get_aria_xml_statement API call. After retrieving the statements, you may choose to format them based on your business needs for presentation to your customers or transfer them to your financial systems.
You must to post a comment.
Last modified
17:08, 25 May 2016

Tags

Classifications

This page has no classifications.