Working with Draft Usage Rating

The draft usage rating enables you to see the forecasted billable amount for the submitted usage inputs before you actually rate them.

This helps you to

• Edit the quantity, add more inputs, etc., before you perform the actual rating. 
• Use this amount as a source for your Revenue Forecast requirements.

 Once you are comfortable with the draft computed data, you can process them to get the rated amount. 

Processing Draft Usage Rating

You can process a single usage input from the Usage Input Detail page, or process multiple usage inputs from the list view, by running a batch job, or by calling an API.

Single Usage Input

1. Go to the Usage Input Detail page.
2. Click the (Draft) Process Usage Input button to display the (Draft) Calculate Rated Amount page, which shows the message, "Usage Input can be draft computed only if it has a status Loaded. The current status is Loaded."

3. Click Process.
   The Usage Input Detail page opens, showing the forecasted amount against the (Draft) Rated Amount field. 

   

   The Status of the draft processed Usage Input remains as Loaded.

   
   
   
   

The Usage Inputs related lists are updated with the new usage inputs and corresponding (Draft) Rated Amount.

The (Draft) Rated Quantity and (Draft) Fee Amount are updated on the Usage Schedule.

Once you are satisfied with the forecasted values in the above-mentioned fields you can process the usage input.

Click Process Usage Input. The forecasted amount is rated and updated in the Rated Amount field. The corresponding billing schedule reflects the rated amount as the fee amount to be billed.

Multiple Usage Inputs

You can submit multiple usage inputs that are in Rated or Loaded status for draft rating.

Restriction

• For multiple usage inputs, every time a set of usage inputs are processed they will be honored as fresh usage inputs and only the rated amount for those set of usage inputs will be forecasted and posted on the Usage Schedule. The old forecasted data on the Usage Schedule will be overwritten by the next forecast run. 

You must process ALL the usage inputs of the same asset line item at once. If partial usage inputs are processed then the output data will be incorrect.

Through the usage input list view

You can process multiple usage inputs at once from the UI list view. 

1. Create a list view of the usage inputs.

2. Click the "select all" checkbox above the usage inputs. For example, if an asset line item has 500 usage inputs, with 100 in Rated status, 150 Draft-Rated, and the remaining yet to be Draft-Rated, you must select all the usage inputs of this asset line item for draft rating.
   The system processes all the usage inputs that are in Loaded status and ignores the ones in Rated status.
   

   

   As the number of usage inputs increases with time, you must select all the usage inputs for draft rating them. 

3. Click (Draft) Process Usage Input(s) to raise the Process Usage Rating page showing the message "Usage inputs with status as Loaded will be draft computed" and the list of usage inputs to be processed.
4. Click Process Usage Input.
   The Usage inputs list view opens showing the rated amount updated in the (Draft) Rated Amount field.
5. The draft-rated usage inputs remain in the Loaded status, even after processing. The draft amount is updated in the (Draft) Rated Amount field. Check the (Draft) Rated Amount field to learn if the processing is successful. If required, you can edit the data of the draft computed usage inputs and re-submit them for processing. 
   
   

The (Draft) Rated Quantity and (Draft) Fee Amount fields are updated on the Usage Schedule. The Usage Inputs related lists are updated with the new usage inputs and corresponding (Draft) Rated Amount.

Once you are satisfied with the forecasted values in the above-mentioned fields you can process the usage input. Click Process Usage Input. The forecasted amount is rated and updated in the Rated Amount field. The corresponding billing schedule reflects the rated amount as the fee amount to be billed.

By executing a Batch Job

You can run a batch job to draft rate usage inputs that are in Loaded status.

You can schedule the call from the Schedule Apex button on the Apex Classes page or using the following cron expression.

Apttus_Billing.DraftUsageRatingJob job = new Apttus_Billing.DraftUsageRatingJob();
String cronExpression = ‘0 0 0 ? * * *’;
System.schedule(‘Draft Rating Job’, cronExpression, job);

You get the following results by passing different parameters.

Set<Id> usageIds = new Set<Id>();
Set<Id> aliIds = new Set<Id>{'a093m00001ocy2I', 'a093m00001octXV', 'a093m00001nvtW4'};
for(Apttus_Billing__UsageInput__c ui : [Select Id From Apttus_Billing__UsageInput__c Where Apttus_Billing__AssetLineItemId__c IN: aliIds]){
	usageIds.add(ui.Id);
}
Apttus_Billing.DraftUsageRatingJob job = new Apttus_Billing.DraftUsageRatingJob(usageIds, null);
Database.executeBatch(job);

Set<Id> aliIds = new Set<Id>{'a093m00001ocy2I', 'a093m00001octXV', 'a093m00001nvtW4'};
Apttus_Billing.DraftUsageRatingJob job = new Apttus_Billing.DraftUsageRatingJob(null, aliIds);
Database.executeBatch(job);

On completion of the batch job, the (Draft) Rated Quantity and (Draft) Fee Amount fields are updated on the usage schedule. The usage inputs related lists are updated with the new usage inputs and corresponding Rated Amounts.

Once you are satisfied with the forecasted values in the above-mentioned fields you can process the usage input. The old forecasted data will be overwritten by the next forecast run. 

By calling an API

You can draft rate usage inputs in bulk by calling the draftPendingUsageInput API. This API supports processing 1000 usage inputs in the synchronous mode. The API gives no response about the result of processed or errored-out usage inputs. If the usage inputs are processed in batch mode, an email containing processed usage input information is sent to the user. If the usage inputs are processed synchronously then the user can verify the result by looking into individual usage input records.

There are four different flavors of this API.

The (Draft) Rated Quantity and (Draft) Fee Amount are updated on the Usage Schedule. The Usage Inputs related lists are updated with the new usage inputs and corresponding (Draft) Rated Amount.

Once you are satisfied with the forecasted values in the above-mentioned fields you can process the usage input. You can call the API to Process Usage Input. The forecasted amount is rated and updated in the Rated Amount field. The corresponding billing schedule reflects the rated amount as the fee amount to be billed.

Effect of Asset Amendment on Forecasted Usage Input

The forecasted usage inputs are vulnerable to asset amendments. If you amend the asset line item, the billing schedules and usage schedules are superseded and new billing schedules are created with Pending Billing status. The values in the (Draft) Rated Amount and Rated Amount fields are reset to zero for the usage inputs.

Let us understand this effect with the help of an example.

Example:

Suppose you are a billing administrator of a company selling computer hardware 'Internet Plans’ and you have already invoiced the customer. The details are summarized in the following table:

Define tire prices as follows:

0-20 = 200

21-40 = 400

Define usage inputs for the dates

6/5/2023 - 20 quantity

7/8/2023 -10 quantity and draft rate them.

Initiate billing, you will get the following results:

Billing will generate the billing schedules as follows:

The Usage Inputs related lists are updated with the new usage inputs and corresponding (Draft) Rated Amount.

The (Draft) Rated Quantity and (Draft) Fee Amount are updated on the Usage Schedule.

Amend the asset line. You will get the following results:

• Existing billing schedules are superseded and new billing schedules are created with Pending Billing status.
• Draft rated Amount of all the existing usage inputs is set to zero.
• Existing Usage schedule Draft Fee Amount will remain as it is. New schedules that are created will not have any Draft Fee Amount.

Existing billing schedules are superseded and new billing schedules are created with Pending Billing status as shown:

Draft rated Amount of all the existing usage inputs is set to zero.

Existing Usage schedule Draft Fee Amount will remain as it is. New schedules that are created will not have any Draft Fee Amount as shown:

Hence, if you amend the asset line item, the associated usage inputs are reset to zero.