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



 

Home > Aria Crescendo Documentation > Data Streaming > Data Streaming Web Service 4.0

Data Streaming Web Service 4.0

This article applies to:Aria Crescendo

Overview

Aria's Data Streaming is a web service that, when activated, can allow Aria clients to consume data events in near-real-time to synchronize with one or more downstream information systems. With the Data Streaming component enabled, Aria clients acquire an authentication token, then configure a client—in their preferred programming language—to consume Server-Sent Events (SSE) from the Aria platform.

The Data Streaming service operates using at-least-once-semantics, guaranteeing that every message is delivered. It's logical model design allows data to easily be parsed to synchronize with other information systems.

Aria Data Streaming is an add-on service. Please contact your Aria Customer Success Manager for more information.

More Info Regarding SSE:

Change Streams and Load Streams

Aria Data Streaming provides two separate SSE streaming services: The "Change Stream" and the "Load Stream." Both share all of the details covered in other Data Streaming topics. An SSE client consumes the data from both streams. The received SSE events from both streams share the same structure, and they are described by the same Logical Model and formatted into JSON using the same rules.

Load Stream

The Load Stream will be the first stream your SSE client consumes when you initiate Aria's Data Streaming Web Service. Events in the Load Stream all have the event type "load" and represent a snapshot of a specified subset of Aria client data, such as all account data, all financial data or all usage data. 

To receive these data, you must submit a request to Aria Customer Support to launch an "extraction job" to generate a Load Stream with the desired data. 

Change Stream

Events in the Change Stream describe changes to Aria data in near-real-time. Each of these SSE events is identified as one of three actions: "create," "update" or "delete." These actions map to an Aria data entity identified by the header (first) data line in the event. Update events include updated fields related to the data entity and may omit fields that have not changed. 

Best Practices

Aria retains streamed data for 48 hours.

  • Aria recommends that you stream this data continuously. If that is not possible, data should be consumed as near-real-time as possible.
  • User (Client) has responsibility and should persist the consumed data in their system(s), as it is retrieved.

Subtopics 

Data Streaming Overview
Data Stream Client & Server-Sent Events (SSE)
Consuming Aria Data Streams
Data Streaming Authentication
Data Streaming Logical Object Model
Data Streaming JSON Representation
Example Data Streaming Code
Data Streaming Frequently Asked Questions

Last modified

Tags

This page has no custom tags.

Classifications

This page has no classifications.