Interface Usage Data Processing
src/Apps/W1/Subscription Billing/App/Usage Based Billing/Interfaces/UsageDataProcessing.Interface.al87 lines, Copyright (c) Microsoft Corporation. MIT
namespace Microsoft.SubscriptionBilling;interface "Usage Data Processing"{ /// <summary> /// Import usage data into the connector-specific staging table (e.g. via Data Exchange Definition or API). /// </summary> /// <param name="UsageDataImport">Usage Data Import for which the import is executed</param> procedure ImportUsageData(var UsageDataImport: Record "Usage Data Import") /// <summary> /// Process imported records in the connector-specific staging table: /// 1. Create Usage Data Supp. Customers if they do not exist. /// 2. Create Usage Data Supp. Subscriptions if they do not exist. /// 3. Validate Subscription Lines and check their dates. /// 4. Assign the Subscription to the staging table record if possible. /// </summary> /// <param name="UsageDataImport">Usage Data Import for which the processing is executed</param> procedure ProcessUsageData(var UsageDataImport: Record "Usage Data Import") /// <summary> /// Validate that imported staging data exists before Usage Data Billing creation. /// Set an error on the Usage Data Import if no staging data is found. /// </summary> /// <param name="UsageDataImport">Usage Data Import to validate</param> procedure ValidateImportedData(var UsageDataImport: Record "Usage Data Import"); /// <summary> /// Create Usage Data Billing records from the connector-specific staging table. /// Handle retry logic for previously failed staging records. /// </summary> /// <param name="UsageDataImport">Usage Data Import for which billing records are created</param> procedure CreateBillingData(var UsageDataImport: Record "Usage Data Import"); /// <summary> /// Check the connector-specific staging table for errors after billing creation /// and set the Usage Data Import status accordingly. /// </summary> /// <param name="UsageDataImport">Usage Data Import to update with error status</param> procedure UpdateImportStatus(var UsageDataImport: Record "Usage Data Import"); /// <summary> /// Delete all connector-specific staging table records for a given Usage Data Import. /// Called when the Usage Data Import is deleted or reset. /// </summary> /// <param name="UsageDataImport">Usage Data Import whose staging data should be deleted</param> procedure DeleteImportedData(var UsageDataImport: Record "Usage Data Import"); /// <summary> /// Update the Subscription Header No. in the connector-specific staging table /// when a Supplier Subscription is connected to a Subscription. /// </summary> /// <param name="SupplierReference">Supplier Reference identifying the subscription in the staging table</param> /// <param name="SubscriptionHeaderNo">Subscription Header No. to assign to matching staging records</param> procedure UpdateSubscriptionHeaderNo(SupplierReference: Text[80]; SubscriptionHeaderNo: Code[20]); /// <summary> /// Open the connector-specific supplier settings page. /// Called when the user wants to view or edit settings for a particular Usage Data Supplier. /// </summary> /// <param name="UsageDataSupplier">Usage Data Supplier whose settings page to open</param> procedure OpenSupplierSettings(var UsageDataSupplier: Record "Usage Data Supplier"); /// <summary> /// Delete connector-specific data associated with a Usage Data Supplier. /// Called when the Usage Data Supplier is deleted. /// </summary> /// <param name="UsageDataSupplier">Usage Data Supplier whose related data should be deleted</param> procedure DeleteSupplierData(var UsageDataSupplier: Record "Usage Data Supplier"); /// <summary> /// Get the count of imported lines in the connector-specific staging table. /// </summary> /// <param name="UsageDataImport">Usage Data Import to count lines for</param> /// <param name="OnlyErrors">If true, count only lines with errors</param> /// <returns>The number of imported lines</returns> procedure GetImportedLineCount(var UsageDataImport: Record "Usage Data Import"; OnlyErrors: Boolean): Integer; /// <summary> /// Open the connector-specific staging table page for the given Usage Data Import, /// optionally filtered to show only lines with errors. /// </summary> /// <param name="UsageDataImport">Usage Data Import whose staging lines to show</param> /// <param name="ShowOnlyErrors">If true, filter to show only lines with errors</param> procedure ShowImportedLines(var UsageDataImport: Record "Usage Data Import"; ShowOnlyErrors: Boolean);}