Usage Suspense Management
When the rating engine processes usage records, some records may fail and enter a suspended state. Suspended usage records passed mapping and mediation successfully but encountered an error during rating. You must resolve the underlying issue before reprocessing. Aria Allegro does not allow modifying suspended records to preserve the audit trail from the source.
Authorized users can discard suspended usage records when there is an agreement to ignore them or when a corrected delta file will be provided.
View Usage Suspense Data
- Click the Usage switch in the navigation pane.
- Click Usage Activity to expand the sub-menu.
- Click Usage Suspense.
The Suspense Reprocess tab displays by default, showing files with at least one suspended usage record, one line per file.
View Usage Suspense Details
- Navigate to Usage Suspense as described above.
- Apply filters to locate the file.
- Expand a file row using one of these methods:
- Click the Maximize icon on the left of the row to expand it inline. The row shows one line per suspense error code, including status, record count, error code, and error message. Click the record count link to view individual records suspended for that error code.
- Click the File Name link to open a detail drawer with the same information.
Filter Usage Suspense Data
- File Name—enter a partial or full file name. Case-insensitive partial match.
- Start Date—returns records on or after this date (inclusive, >= 00:00:00).
- End Date—returns records before this date (exclusive, < 00:00:00).
- Source Platform—select a source platform from the dropdown. Exact match.
- Service Type—select a service type from the dropdown. Exact match.
- Error Code—enter an error code. Case-insensitive partial match.
Results sort by Source Platform or File Name, ascending or descending. By default, results show the most recently loaded files first.
Reprocess Suspended Usage Records
Resolve the underlying suspense reason before reprocessing. Reprocessing without resolving the cause consumes system resources without clearing the suspense. See Usage Suspense Error Codes and Resolutions for details.
Aria Allegro supports reprocessing at three levels:
- Reprocess All—click Reprocess All in the header bar to reprocess all suspended usage records across all files. Use this when the resolution applies to all files, such as after resolving a temporary system error.
- Reprocess File—click Reprocess at the individual file level. Use this when all errors for a specific file are resolved.
- Reprocess Error Code—click Reprocess at the error code level within a file. Use this when the issue for a specific error code within a file is resolved.
Discard Suspended Usage Records
Only authorized users should discard suspended usage records. Discard only when there is an agreement to ignore those records or when a corrected delta file will be provided to replace them.
Aria Allegro supports discarding at three levels:
- Discard File—click Discard at the file level to remove all suspended usage records for the file. The table refreshes automatically to remove the file row.
- Discard Error Code—click Discard at the error code level within a file to remove all suspended records for that error code. The table refreshes automatically.
- Discard Individual Record—use the View Transactions link to open the individual records drawer, locate the record, and click Discard on that row. The table refreshes automatically.
Usage Suspense Error Codes and Resolutions
The following table lists common usage suspense error codes and their recommended resolutions.
| Error Code | Cause | Resolution |
|---|---|---|
| START_OR_END_DATE_MISSING_IN_USAGE_CONTAINER | The file mapping does not include a date attribute, or the date field is not marked mandatory, resulting in some records lacking a date. | If all records in the file are affected, correct the file mapping. You may need to copy and create a new mapping if the raw table already contains data. Discard the suspense records and reload the file. If only some records are affected, obtain a corrected delta file from the source, discard the suspended records, and load the delta file. |
| MISSING_MANDATORY_ACCNT_ID_OR_PROV_ID | The file mapping does not include a field to link the usage record to an account, or the field is not marked mandatory. | Correct the file mapping. If the raw table already contains data, copy and create a new mapping. Discard the suspense records and reload the file. |
| APPLICABLE_PRICE_ALLOWANCE_ACCUM_NOT_FOUND_IN_PO | The rating engine found no price unit or price offer with currency, accumulator, or allowance impact for this usage record. | Review the plan instance data in core Aria and the subscription view, focusing on price units and price offers. Resolve any missing elements, then reprocess the suspended record. |
| NO_SERVICE_FOR_THE_PROVISIONING_ID | The service ID in the usage record is not linked to any service type in any subscription for the usage record's date/time range. Possible causes include a missing plan instance or a plan instance that has not synchronized from core Aria to Aria Allegro. | Verify the plan instance is set up in core Aria with an effective date on or before the usage record's start/end date. Confirm that the subscription view in Aria Allegro shows the plan instance for the account. If the plan instance is missing from Aria Allegro, check the Reprocess Sync Errors section and resolve any synchronization errors before reprocessing the suspended usage record. |
| NO_ACTIVE_SERVICE_FOR_THE_PROVISIONING_ID | The service ID is found but the service is not in an active state for the usage record's date/time range. This may be caused by the timing of service activation, suspension, inactivation, or cancellation. | If the action can be undone in your CRM or Aria Allegro, reprocess the suspended usage and then redo the action. Alternatively, discard the usage record and provide a corrected delta file with usage dates that fall within the active service period. |
| PRICE_OFFER_NOT_CONFIGURED_COMPLETELY_FOR_USAGE_TYPE | The pricing model for the usage type in the price plan is incomplete in Aria Allegro. | Complete the pricing model setup for the usage type in Allegro. Create a price-plan audit with an effective date matching the usage record's start/end date if necessary, then reprocess the suspended usage record. |
| NO_MATCHING_PRICE_UNIT_FOR_THE_SERVICE | The rating engine found the service but no price unit associated with the usage type. | Check whether the usage type is missing from the plan in core Aria. Add the usage type and its pricing in Allegro if needed. Verify the plan instance association with the account is correct and that the effective dates predate the usage records. Resolve the issue and reprocess. |
| TIER_PRICING_NOT_FOUND | The price offer uses tiered custom rates, but the price plan is not configured for tiered usage rating. | Update the price offer with the appropriate tiered pricing configuration and reprocess the suspended record. |
| TIER_EVALUATION_FAILED | Tier evaluation failed for the price offer during rating. | Review the custom tier rates in the price unit to verify they match the tier pricing base setup in the Allegro price offer. Adjust the plan instance data or price offer setup as needed, then reprocess the suspended usage records. |
| USAGE_TYPE_MISSING_IN_USAGE_CONTAINER | The usage type is missing from the usage record. Usage type must be present directly in the raw usage file or derived through a mediation enrichment rule. | If the file lacks the usage type data, obtain a corrected file or delta file. If a mediation enrichment rule should derive the usage type, review and correct the rule setup. Resolve the issue and reprocess. |
| INVALID_USAGE_TYPE_OR_USAGE_TYPE_NO | The usage type received is invalid or the plan instance setup is missing the usage type. | If the file contains incorrect data, obtain a corrected file or delta file. If a mediation rule should derive the usage type, review and correct the rule setup. Resolve the issue and reprocess. |
| TRANSACTION_PRICING_NOT_FOUND | The price offer uses transaction attribute-based pricing but no matching pricing was found for the time/zone model and usage record combination. | Fix the price plan setup and reprocess the suspended record. |
| COMPLEX_PRICING_NOT_FOUND | The price offer uses composite pricing but no matching pricing is available. | Fix the price plan setup and reprocess the suspended record. |
| NO_MATCHING_PRICING_FOR_USAGE_RECORD | The price offer setup may be incomplete or the account plan instance data does not cover pricing for this record. | Fix the price plan setup or plan instance association and reprocess the suspended record. |
| MULTIPLE_PRICE_UNITS_RATING_NOT_ALLOWED | Multiple price units were found during rating. The system property Multi Price Unit Rating Behavior is set to Suspend. | Determine whether a multi-price unit setup is required. Set the system property accordingly, verify the plan configuration and plan instance associations, then reprocess. |
| BILLING_NOT_RUN_FOR_PREVIOUS_CYCLE | The billing job for the previous cycle did not run for this account. Aria Allegro tracks the billing cycle to confirm that allowances are available before processing usage records for a new cycle. | Check the job schedule configuration to confirm the billing job is included. If the job failed, resolve the issue, rerun the failed jobs, and reprocess the suspended record. |
| INVALID_USAGE_RECORD_INDICATOR | File mapping is configured for a structured file (header, detail, sub-records, and trailer) but the usage file does not conform to this structure. | If the file mapping is incorrect, adjust the mapping for the source platform (or copy and rename if usage data already exists for that source). If the usage file is incorrect, obtain and reload a corrected file. |
| FUTURE_DATED_USAGE_RECORD | The usage record has a future date. This typically occurs only in test or demo environments with virtual time enabled. | Set the Aria Allegro virtual time in System Properties to a future date that covers the usage record's date and reprocess. |
| MISSING_MANDATORY_CLIENT_ID | A new client was added to an existing deployment but the setup is incomplete. | Work with the deployment team to complete the client setup, then reprocess. |
| PLSQL_EXCEPTION | A system-level error occurred during processing. Possible causes include a temporary error during maintenance, a database error, or a software error. | For temporary errors, wait and reprocess. For persistent errors, contact your support team to review service logs and identify the root cause before reprocessing. |
Suspense Summary
The Suspense Summary tab provides a high-level overview of suspended usage records grouped by account, service identifier, file name, service type, error code, and error message. Use this view to identify patterns in suspense data and share a summary with your team.
View Suspense Summary
- Click the Usage switch in the navigation pane.
- Click Usage Activity to expand the sub-menu.
- Click Usage Suspense.
- Click the Suspense Summary tab.
Filter Suspense Summary
- File Name—case-insensitive partial match.
- Start Date—returns records on or after this date (inclusive).
- End Date—returns records before this date (exclusive).
- Source Platform—select from the dropdown. Exact match.
- Service Type—select from the dropdown. Exact match.
- Usage Record Type—select from the dropdown. Exact match.
Sort Suspense Summary
- Account ID—sort by account ID. This field may be blank if the record has no associated account.
- Service Identifier—sort by provisioning ID or client-defined plan instance ID.
- File Name—sort by file name.
- Service Type—sort by service type.
- Error Code—sort by suspense code.
- Error Message—sort by suspense error message.
Export Suspense Summary
- Navigate to the Suspense Summary tab as described above.
- Apply filters to narrow the data.
- Scroll right in the search results and click the 3 vertical dots in the table header on the right.
- Optionally, click Select Columns to choose and reorder columns.
- Click Export and select PDF or Excel. Aria Allegro downloads the file automatically.
- Locate the file in your Downloads folder.
Suspense Detail
The Suspense Detail tab provides a record-level view of suspended usage data. Each record includes the full Aria Allegro usage container attributes. Use this view to investigate individual suspended records and export detail data for review.
View Suspense Detail
- Click the Usage switch in the navigation pane.
- Click Usage Activity to expand the sub-menu.
- Click Usage Suspense.
- Click the Suspense Detail tab.
Filter Suspense Detail
- File Name—case-insensitive partial match.
- Start Date—returns records on or after this date (inclusive).
- End Date—returns records before this date (exclusive).
- Error Code—exact match.
- Source Platform—select from the dropdown. Exact match.
- Service Type—select from the dropdown. Exact match.
- Usage Type—exact match.
- Service Identifier—filter by provisioning ID or client-defined plan instance ID. Exact match.
- Suspended Failed Record Report—select a Boolean value from the dropdown. Exact match.
Sort Suspense Detail
- File Name—sort by file name.
- Start Date—sort by the usage record's start date.
- End Date—sort by the usage record's end date.
- Service Identifier—sort by service identifier.
- Service Type—sort by service type.
- Usage Type—sort by usage type.
- Error Code—sort by suspense code.
- Error Message—sort by suspense error message.
Export Suspense Detail
- Navigate to the Suspense Detail tab as described above.
- Apply filters to narrow the data.
- Scroll right in the search results and click the 3 vertical dots in the table header on the right.
- Optionally, click Select Columns to choose and reorder columns.
- Click Export and select PDF or Excel. Aria Allegro downloads the file automatically.
- Locate the file in your Downloads folder.
Service ID Lookup
The Service ID Lookup tab helps you diagnose usage suspense by verifying whether the parameters of a usage record can locate the correct account. Service ID (also called provisioning ID, fulfillment ID, or client plan instance ID) is a key input to the account lookup step in usage processing.
Use this tab when a usage record is suspended and you need to verify whether the service ID and date range in the record match an active service unit, subscription, and account in Aria Allegro.
Access Service ID Lookup
- Click the Usage switch in the navigation pane.
- Click Usage Activity to expand the sub-menu.
- Click Usage Suspense.
- Click the Service ID Lookup tab.
Service ID Lookup Filters
- Service ID—mandatory. Enter the provisioning ID from the usage record.
- Service Type—optionally select a service type from the dropdown to narrow the search to a specific service type.
- Start Date—enter the start date from the usage record.
- End Date—enter the end date from the usage record, if available.
Service ID Lookup Output
The lookup returns the following key attributes:
- Account ID—ID of the matched account.
- Subscription ID—ID of the matched subscription.
- Service Unit ID—ID of the matched service unit.
- Service Type—service type linked to the service unit.
- Audit Effective Date—audit effective date of the service unit.
- Audit Effective Status—service unit status as of the audit effective date.
- Provisioning ID Effective Date—date when the provisioning ID became effective for the service unit.
- Provisioning ID End Date—date when the provisioning ID no longer applies to the service unit.
- Balance Unit ID—ID of the balance unit linked to the service unit.
The following results indicate why a usage record may be suspended:
- No row found—the provisioning ID is not linked to any account. The service was not found.
- Row found with inactive status—the service exists but is not active (for example, it is inactive or closed).
- Row found with a future effective date—the service unit is not yet active for the usage record's date range.
Price Unit Analysis
The Price Unit Analysis tab helps you diagnose usage suspense related to pricing. After verifying account lookup using Service ID Lookup, use this tab to confirm whether the rating engine can find the correct price offer and price unit for a given usage type and account. This tab is most useful when a usage record is suspended because of a price offer or price unit issue.
Access Price Unit Analysis
- Click the Usage switch in the navigation pane.
- Click Usage Activity to expand the sub-menu.
- Click Usage Suspense.
- Click the Price Unit Analysis tab.
Price Unit Analysis Filters
- Account Number—enter the account number for the analysis.
- Service Unit ID List—mandatory. Enter one or more service unit IDs from the Service ID Lookup output, separated by commas.
- Price Unit Status—select a status from the dropdown to filter by price unit status.
- CD Usage Type—enter a client-defined usage type value.
- Start Date—enter the start date from the usage record.
- End Date—enter the end date from the usage record, if available.
- From Cache—select this checkbox to return results from the Aria Allegro cache rather than the database.
Enter the input parameters and click Search.
Price Unit Analysis Output
The analysis returns the following key attributes:
- ID—price unit ID matching the criteria.
- Audit Effective Date—the price unit's audit effective date.
- Audit Start Date / Audit End Date—start and end dates of the price unit audit.
- CD Usage Type—the client-defined usage type from the price unit.
- Plan Instance ID—ID of the plan instance linked to the price unit.
- Pricing Model—pricing model linked to the price offer.
- Priority—priority of the returned price offer.
- Commitment Term / Commitment Term Unit—commitment term linked to the price offer.
- Billing Profile ID—billing profile linked to the price unit.
- Price Offer JSON—full JSON representation of the price offer.
- No of Units—quantity purchased for the plan.
- Skip Commitment Tracking—indicates whether the price unit excludes commitment tracking for the account.
The following results indicate why a usage record may be suspended:
- No row found—the plan for the usage type is likely not associated with the account.
- Row found with inactive status—the price unit exists but is not active.
- Row found with a future start date or past end date—the price unit is not active for the usage record's date range.