Catalog Sync
The Data feed LOMs from core Aria relevant to Aria Allegro include:
- Usage Type LOM—create/update messages for usage types to set up in Aria Allegro
- Services LOM—create/update activation, recurring, and usage services defined as Billable services in Aria Allegro. Each service must associate with a Service Type in Aria Allegro.
- Plan, Plan Rate Schedule, Plan services, and Rates. Each unique combination of plan, plan rate schedule, and plan services creates a shell price-offer. This requires Allegro pricing model setup for Standard rates. Advanced usage Pricing flags at the plan invoicing level in core Aria control usage pricing configuration in Aria Allegro. Flags like “Add Allowance” and “Add Accumulators” optionally augment Activation and recurring services with Allegro Allowances and/or Accumulators. Key points:
- Allegro pricing models are not part of the Aria Catalog; customized rates are unavailable. A roadmap item tracks a Consolidated Aria Product Catalog for future release.
- To use customized rates (e.g., for B2B contracts), set up Aria standard tier rates and assign the Allegro standard Progressive tier pricing model for the price offer. Then, create accounts and associate plans with customized rates in Aria Allegro.
- Enable this by setting the system property “Usage Custom Rates from Billing” to true under Usage → Configurations → System Properties → Usage Processing (category) in Aria Allegro.
- This also enables using customized rates with Activation and Recurring services. This supports scenarios like “Minimum Commitment or Granting Allowances, where the customized rate charged to each customer maps 1:1 to the Allowance or Accumulator value in Aria Allegro. For example, a $9500 minimum commitment charge requires Aria Allegro to set the allowance/accumulator for the activation/recurring service to $9500.
- This feature is available with a hotfix in R67 deployments and will be included in R68 deployments to Stage Future, Stage Current, and Production.
- Until the consolidated Aria product catalog roadmap item is completed, using Aria Allegro with Customized Rates and core Aria models is mutually exclusive.
- Please note that Aria Allegro expects at least one usage service for a Master Plan setup. This could be a dummy service with 0 rates.
View Catalog Sync Activity
To view Catalog Sync Activity, follow these steps:
- Click the Usage switch (Usage/Account toggle) in the navigation pane.
- Click the Billing Sync Reprocess option to expand its sub-menu in the navigation pane. For pre-R68 deployments, it appears under the Usage Activity option.
- Click the Catalog option in the navigation pane.
- The system displays two tabs in the activity pane: Reprocess Summary and Activity.
- Click the Activity tab to view all Catalog sync activities in a search view.
This is shown in the following screenshot:
View Catalog Sync Activity Detail
To view details of a specific catalog sync activity, follow these steps:
- Refer to “View Catalog Sync Activity” section.
- Click on the ID Link to open a drawer for the details.
- The drawer shows
- Header attributes: to keep an audit trail of key attributes for the message
- Evant Payload: This is shown as an extendible text box, if you want to see the entire JSON payload that was sent from Core Aria for the corresponding activity. Please note that the payload format will be different for different data Feed LOMs. This might help with the review, if and when required. You can copy the entire JSON into any JSON Formatter tool for better readability.
This is shown in the screenshot below:
Activity Log Status Values
The status values for Catalog activity logs are:
- COMPLETE—The record was processed successfully by Aria Allegro.
- ERROR—The record failed processing in Aria Allegro. ERROR code and message accompany errored activity logs.
- IGNORED—Aria Allegro ignored the activity log. These appear only if Data Feed configuration enables messages for data Aria Allegro excludes. Adjust core Aria configuration to hide these.
- INCOMPLETE—This status is available but should not appear in Aria Allegro activity logs.
- PENDING—Aria Allegro has not processed the data feed activity yet. This transient state rarely appears.
Filters for Catalog Sync Activity
The default UI search returns data with the latest activities on top. As data grows over time, use the following filters to narrow your review:
- Aria Sync Id—Enter the exact Aria sync id to search.
- Action—Enter the exact action associated with the core Aria payload.
- Error Code—Enter the full error code to find specific errored activity logs.
- Event Id—Enter the exact event id assigned by core Aria.
- Object Type—Enter the exact number associated with the Object Type from core Aria.
- Action Name—Enter a case-insensitive partial action name from core Aria.
- Object Name—Enter a case-insensitive partial object name from core Aria.
- Status—Select the exact status from the drop-down list.
Sort Attributes for Catalog Sync Activity
The default UI search lists data with the latest activities first. Use the sort attributes as required.
- Id—Sort ascending or descending by activity log ID.
- Status—Sort ascending or descending by activity log status.
- Action Name—Sort ascending or descending by activity log action name.
- Object Name—Sort ascending or descending by activity log object name.
Reprocess Catalog Sync Errors
Aria Allegro allows reprocessing of Catalog Sync messages that error during sync. If reprocessing succeeds, the entry is removed from the Reprocess Summary view.
Common Errors and Resolution
The following table provides a list of common Catalog sync errors, with reasons and resolutions:
| Error Code | Reason | Resolution |
|---|---|---|
| BILLABLE_SERVICE_NOT_FOUND | A plan, plan rate schedule, and related message is received with a service not synchronized with Aria Allegro | Saving the service again in core Aria usually synchronizes it successfully, as the KAFKA setup receives other messages. Associate the service type with the billable service, then reprocess the failed sync record. |
| SERVICE_NUM_NOT_FOUND | A plan, plan rate schedule, and related message is received with a service number from core Aria, but is not found in Aria Allegro | Saving the service again in core Aria usually synchronizes it successfully, as the KAFKA setup receives other messages. Associate the service type with the billable service, then reprocess the failed sync record. |
| PRICE_OFFER_IS_NOT_FOUND | This can occur in modify plan scenarios when the original plan configuration is not synchronized. | If the original plan configuration contains errors, resolve them before reprocessing the data feed record. |
| GATEWAY_OBJECT_TYPE_IS_NOT_FOUND | The Data feed object type is not found in the data feed. | Gateway object type configuration is missing for the specified object type in the data feed. Add the configuration first in gateway_sync_object |
| ADVANCED_USAGE_PRICING_FLAG_NOT_SET | Advanced Usage pricing setup is incomplete | If you use Aria tiered customized rates and only TIERED pricing in Aria Allegro, set "Usage Custom Rates From Billing" to True under Configurations → System Properties → Usage Processing. When this property is enabled, do not check the "Advanced usage pricing flag" in core Aria. If you use Aria Allegro pricing models (custom pricing not supported), set the same property to False (default) and enable the Advanced Usage Pricing flag for the plan. Resolve and reprocess. |
| PLAN_RATE_SCHEDULE_NOT_FOUND | Plan rate schedule LOM is not found in Aria Allegro | Plan rate schedule object does not exist for the given schedule no. Sync the Plan LOM first and then reprocess the errored feed. |
| PROCESS_NOT_DEFINED_FOR_GATEWAY_OBJECT_TYPE | A data feed is enabled for an object type in core Aria and Allegro does not support the corresponding feed. | If the data feed setup contains errors, review and adjust the data feed enablement configuration in core Aria. If the data feed is necessary, it is likely a roadmap item not yet released. Coordinate with your customer support representative to prioritize this feature for release. |
| SYNC_EVENT_IS_NOT_FOUND | There is no object sync found in database for the given event-id in error. | Resolve the error and reprocess |
| SYNC_EVENT_NOT_VALID_FOR_ERROR_PROCESS | Object sync status is either COMPLETED or IGNORED. Processing it as error data feed is invalid. | Disable the data feed for the event in the core Aria Data feed enablement configuration and ignore the record. If the data feed is required, it likely remains a roadmap item. Coordinate with your customer support representative to prioritize its release. |
View Reprocess Summary
The reprocess summary offers three levels of data drill-down:
- Summary level—summarized for each unique combination of object name and action.
- Error Summary level—click to view the summary for each error code and message under the same object name and action. Activity logs may fail with different error codes, for the same object and action.
- Activity level—click to view individual failed activity logs for the same object name, action, error code, and error message.
To view Catalog Sync Reprocess Summary, follow these steps:
- Click the Usage switch (Usage/Account toggle) in the navigation pane.
- Click the Billing Sync Reprocess option to expand its submenu in the navigation pane. For pre-R68 deployments, it appears under the Usage Activity option.
- Click the Catalog option in the navigation pane.
- The system displays two tabs in the activity pane: Reprocess Summary and Activity.
- Click the Reprocess summary tab to view all Catalog sync activities in a search view.
- This displays a summarized view of catalog sync activities, with one row per grouping by object name, error code, error message, and action.
- To drill down, click the maximize icon left of the row to show the sub-table inline. This summary includes:
- Object Name—Name of the object sent by core Aria.
- Action Name—Name of the action sent by core Aria.
- Error Code—Error code generated by Aria Allegro if the data feed fails. Hover or expand the text box to see the full code.
- Error Message—Message associated with the error code. Hover or expand the text box to see the full message.
- Count—Number of records that errored for the object and action.
- To drill down further for each error line summary, click the Object Name link to view individual data feed messages in a drawer. Each row shows:
- Object Type—Type of the object for the errored activity.
- Action—Aria action code for the data feed.
- Event Id—Aria event ID associated with the data feed message.
- Event Time—Date and time the event was sent from core Aria.
- Event Payload—JSON payload sent by core Aria. Use hover or extend the text box to view the full payload.
- Error Number—Number associated with the activity log
- SCN—SCN number linked to the activity from core Aria.
- Status—Activity log status, showing ERROR
This is shown in the following screenshots:
View the Reprocess summary:
View the activities for the an object name with errored activities:
View the individual activity logs:
Reprocess Catalog Sync Errors
Aria Allegro supports multiple reprocessing levels for Catalog sync errors, depending on prior error resolutions. Upon successful reprocessing, the UI refreshes to hide activity logs processed at that level. Supported levels include:
- Reprocess-All: Click the Reprocess button in the header to reprocess all summary data.
- Reprocess at Summary level: Select the object and action name to reprocess, then click Reprocess. Repeat for other summaries as needed.
- Reprocess at Error Summary level: Expand the summary row using the maximize icon to view error details. Click the Reprocess button for the specific error code. Repeat for other errors under the same object as needed.
- Reprocess at Activity level: Click the object name to open a drawer with activity records. Locate the specific activity and click the Reprocess button. Repeat for other activities as needed.