Home > Aria Crescendo Documentation > Data Streaming > Data Streaming Web Service > Subscribing to Objects In the Data Streams

Subscribing to Objects In the Data Streams

Overview

This feature allows users of Aria's Data Streaming Web Service to subscribe to the objects they want to see in their Data Streams. This optimizes the efficiency of the stream, because only the objects subscribed to appear in the streams.

Currently available objects you can subscribe to are listed below. See the Notes section for important functionality details.

Financial Objects

  • Credit Memo
  • Recurring Credit
  • Transaction
  • Invoice
  • Service Credit
  • Order
  • Statement

Account Objects

  • Account
  • Contact
  • Payment Method
  • Billing Group
  • Contract
  • Comment
  • Dunning Group

Plan Instance Objects

  • Plan Instance
  • Plan Unit Instance
  • Usage

Plan Catalog Objects

  • Plan
  • Usage Unit Type
  • Service
  • Usage Type

How to Subscribe to Data Streaming Objects

Getting here: Configuration Notifications Stream Object Subscription 

Customer Support must enable this Stream Object Subscription screen in your Aria instance before you can use it to specify stream objects. By default, all users are granted read-only access to this screen. Your Aria Administrator can assign higher level access to this screen via the Security > Roles module,> [Select a Role] > Notifications section by checking additional privileges for Stream Object Subscription.

data_object_subscription_1.png

  1. On the Stream Object Subscription screen, check the checkbox next to each object you want Aria to include in your Data Stream.If you want to select all objects in a particular category, click the checkbox next to Select All.

    Note: Certain objects, when checked, cause other objects to be selected. See the Notes section below.
     
  2. Click the Save button to save your subscription selections. Objects will immediately be included in your current data stream.

Best Practices

  • Two high-volume objects that can increase latency are Comment and Usage record. If these are not relevant to your data streaming needs, you should unsubscribe from these.

Notes

  • When you subscribe to the Account object, you are automatically subscribed to the Account Coupon Assignment and Account Discount Rule Assignment objects.
  • When you subscribe to Plan Instance, you are automatically subscribed to Plan Instance Coupon Assignment, Plan Instance Discount Rule Assignment, and Queued Plan Instance objects.
  • When you subscribe to the Transaction object, you are automatically subscribed to the Transaction Application object.
  • When you subscribe to the Invoice object, you are automatically subscribed to the Pending Invoice and Invoice Reversal objects.
  • When you subscribe to the Plan object, you are automatically subscribed to Plan Rate Schedules and Plan relationships objects.
Last modified

Tags

This page has no custom tags.

Classifications

This page has no classifications.