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

 

Home > Aria Crescendo Documentation > Event Notifications > Event Notification Prerequisites

Event Notification Prerequisites

This article applies to:Aria Crescendo

Overview

This article describes the prerequisites for subscribing to event notifications. Once you complete the following prerequisites, you can enable and then subscribe to event notifications.

Accept the Aria IP Address Range

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

Configure your Provisioning Settings

Select your chosen provisioning settings that determine how and when event notifications are sent to your system(s). Detailed instructions for configuring your provisioning settings are provided in Provisioning Settings.

Set Up XSD Schema 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 sends to your system(s). One XML document definition is available for each event group. These files are available in XSD format. You can validate the data in the XML documents against the applicable XSD 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 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 automatically increases 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 can increase and decrease the number of units of a resource type that a customer has based on the API methods that are called.

Enable XML Statements

If you want Aria to generate statements for your customers as XML documents, you must enable XML statements in Aria. To do so, Click Configuration > Notifications > Notification Settings > 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:

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

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

Aria generates 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_m, create_acct_complete_m, or update_acct_complete_m 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:

  • 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 the API  get_aria_xml_statement. Each of these event notifications contains an xml_statement_no that you can pass to 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

Tags

Classifications

This page has no classifications.