Activity Loader

Last updated
Save as PDF
Share
1. Share
2. Tweet
3. Share

Overview

Aria’s Activity Loader (UAL) allows you to load batches of data into Aria by means of various API calls. For instance, if you have data stored in a separate system and you want this data transferred into Aria, UAL allows you to set up an automated process that loads this information into the Aria platform. The type of data you may wish to load into Aria includes, but is not limited to:

Usage records
Account records
Order information

Note: UAL is not PCI compliant. Therefore, you should not load credit card information into Aria using UAL.

Data Loading Frequency

By default, the data that you configure for transfer into Aria is loaded during a nightly batch job. The batch job consists of a data retrieval from a predefined FTP server, which Aria then attempts to load and parse as defined by the specific APIs calls in use.
In addition, you can run UAL batch jobs on-demand, as well as configure up to six additional batch jobs in a given day.

Note: Aria restricts SFTP with UAL to port 22. There is no override available. You should ensure your SFTP server is configured to use port 22.

Steps to Set Up UAL

The following core steps are necessary to complete your UAL configuration:

Set up a UAL configuration file. Refer to the UAL Configuration File Construction article for more information.
Set up UAL data files for loading into Aria. Refer to the UAL Data File Requirements article for more information.
Set up a UAL configuration in Aria. Refer to the Create a New Activity Loader article for more information.

For a summary of the process by which UAL data flows from your system(s) into Aria, refer to the UAL Flow Diagram.

Create a New Activity Loader
You configure a Universal Activity Loader (UAL) file for each API method you want to use to load data into Aria. You set the server location, file details, and response options, and then Aria loads the data through a nightly batch job or an on-demand run.
Perform an On-Demand UAL Batch Job
You run a UAL batch job on-demand by clicking Start Manual Session, instead of waiting for the nightly job. You then check the results in the UAL logs.
Schedule Multiple UAL Batch Jobs
You can schedule up to six UAL batch jobs to run at set times each day. You set a starting time for each job on the Activity Loader screen, spacing each one at least two hours apart.
UAL and API Calls
UAL loads batches of data into Aria through specific API calls, such as record_usage_m and create_acct_complete_m. UAL does not support API calls that return information back to you.
UAL Configuration File Construction
You build the UAL configuration file as an XML file. The file defines the columns and column order for the data file you load into Aria.
UAL Data File Requirements
Each data file you load into Aria through UAL must meet several requirements. These include a unique file name, a plain-text format, consistent comma or pipe delimiters, no column headers, and a location on an accessible FTP server.
UAL Flow Diagram
This article shows a diagram of the UAL process. The diagram traces how data moves from your system into Aria through a Universal Activity Loader batch job.
View Activity Loader (UAL) Logs
You view the results of each UAL data load attempt in the Activity Loader audit logs. You check the Pull Error Code field for a failure, then click the Errors tab for details.