Building Blocks

View Existing Service Types

1. Click on the Usage switch (Usage/Account toggle switch) in the navigation pane
2. Click on the Configurations menu option in the navigation panel. This will expand the sub-menu for Configurations in the Navigation Pane.
3. Click on the Building Blocks menu option in the navigation pane
4. Click on the Service Type tab in the Activity Pane.
5. This will fetch the existing set of service types configured for the client and show a line for each service type on the table.

Filter Attributes for the Service Type

1. Service Type: Filter based on the service type configured. It is a case-insensitive, partial match filter. For example, if we use the filter as "cloud", then it will match all the service types that have a case in-sensitive "cloud" as part of the name.

Sort Attributes for the Service Type

1. Service Type: Sort ascending or descending based on the service type.

This is shown in the following screenshot:

View Details of a Specific Service Type

1. Navigate using "To view existing service type"
2. Select and click the service type. This will open the drawer and allow you to modify the data

Add a New Service Type

1. Navigate using "To view existing service type"
2. Click the Add Service Type button towards the top-right corner of the activity pane. This will open a drawer to add details of the new service type. 
   • In the first field, either select a Service Type from the dropdown list available OR type a new service Type. All Caps is usually preferred
   • The UI will automatically copy the same in the next Name field for the service type as default. You can edit the name field, if required.
3. Click on the SAVE button at the bottom right corner of the drawer. This will push the changes to save the configuration using the backend API.
4. Click on the CANCEL button at the bottom right corner of the drawer to cancel all the data entry and go back to the main activity pane for the service types.

Modify Existing Resource Configuration

Since it is a very simple configuration, the only attribute you can modify is the name of the service type which is reference only.

1. Navigate using "To view existing service type"
2. Click the Id link button with the ID highlighted in the Aria Blue color to open the drawer to modify the service type. 
3. Modify the attributes (the ID field cannot be modified) inline as required.
4. Click on the SAVE button at the bottom right corner of the drawer. This will push the changes to save the configuration using the backend API.

Click on the CANCEL button at the bottom right corner of the drawer to cancel all the data entry and go back to the main activity pane for the currency resources.

Delete a Service Type for the Client

Aria Allegro manages the referential integrity if the service type is still in use in other configurations. Only when the service type is no longer referenced, it will allow the users to delete a service type.

1. Navigate using "To view existing service types"
2. Select the service type from the table. 
3. Press the Trash container icon in the same row on the right-hand side. 
4. Press the Save button to save the deletion of the service type. Please note that if the service type is used and referenced in other configurations, then it will throw an error.
5. To cancel the deletion prior to Saving it, press the Cancel button to revert.

View Existing Billable Services

1. Click on the Usage switch (Usage/Account toggle switch) in the navigation pane
2. Click on the Configurations menu option in the navigation panel. This will expand the sub-menu for Configurations in the Navigation Pane.
3. Click on the Building blocks menu option in the navigation pane
4. Click on the Billable Service tab in the Activity Pane.
5. This will fetch the existing set of service types configured for the client and show a line for each service type on the table.

Filter Attributes for the Billable Services

1. Name: The name of the billable service. It is a case-insensitive, partial match filter. For example, if we use the filter as "voice", then it will match all the billable services that have a case in-sensitive "voice" as part of the name.
2. Service Type: Select the service type from the dropdown list to filter all billable services of a given service type. This works as an Exact Match with the dropdown list.
3. Usage Type No: With Aria Catalog reference, you can use the usage type number to find the specific billable service. This filter is an exact match filter.

Sort Attributes for the Allowance Resource

1. Name: Ascending or descending sort based on the name of the billable service.
2. Service Type: Ascending or descending sort based on the service type associated with the billable service.
3. Usage Type No: Ascending or descending sort based on the usage type number associated with the billable service.

This is shown in the following screenshot:

View Details of a Specific Billable Service

1. Navigate using "To view existing service type"
2. Select and click the billable service ID link. This will open the drawer and allow you to modify the data

Add a New Service Type

1. You only add new services using Aria Admin UI and not through Aria Allegro. This is so that monetized transactions that flow back from Aria Allegro to Aria Billing Cloud will have the right reference to ensure invoicing and other functionality.

Modify Existing Resource Configuration

You only modify existing services using Aria Admin UI and not through Aria Allegro. This is so that monetized transactions that flow back from Aria Allegro to Aria Billing Cloud will have the right reference to ensure invoicing and other functionality. Users are only required to associate an Aria Service Type for a Billable Service.

1. Navigate using "To view existing service type"
2. Click the Id link button with the ID highlighted in the Aria Blue color to open the drawer to modify the service type. 
3. Find the Service Type field and associate the Aria Allegro service type by selecting one from the dropdown list. Please note that Allegro UI populates the dropdown list using the service type configuration.
4. Click on the SAVE button at the bottom right corner of the drawer. This will push the changes to save the configuration using the backend API.
5. Click on the CANCEL button at the bottom right corner of the drawer to cancel all the data entry and go back to the main activity pane for the currency resources.

View Existing Usage Types

1. Click on the Usage switch (Usage/Account toggle switch) in the navigation pane
2. Click on the Configurations menu option in the navigation panel. This will expand the sub-menu for Configurations in the Navigation Pane.
3. Click on the Building Blocks menu option in the navigation pane
4. Click on the Usage Type tab in the Activity Pane.
5. This will fetch the existing set of usage types configured for the client and show a line for each service type on the table.

Filter Attributes for the Usage Type

1. Name: The name of the usage type. It is a case-insensitive, partial match filter. For example, if we use the filter as "call", then it will match all the usage types that have a case in-sensitive "call" as part of the name.
2. Usage Type No: With Aria Catalog reference, you can use the usage type number to find the specific usage type. This filter is an exact match filter.

Sort Attributes for the Usage Type

1. Name: Ascending or descending sort based on the name of the usage type.
2. Usage Type No: Ascending or descending sort based on the usage type number associated with the usage type.

This is shown in the following screenshot:

View Details of a Specific Multi-rate Usage Type,

1. Navigate using "To view existing multi rate usage types"
2. Select and click the billable service ID link. This will open the drawer and allow you to view the data

Add a New Multi-rate Usage Type

1. You only add new usage types using Aria Admin UI and not through Aria Allegro. This is so that monetized transactions that flow back from Aria Allegro to Aria Billing Cloud will have the right reference to ensure invoicing and other functionality.

Modify an Existing Usage Type

1. You only modify existing usage types using Aria Admin UI and not through Aria Allegro. This is so that monetized transactions that flow back from Aria Allegro to Aria Billing Cloud will have the right reference to ensure invoicing and other functionality.

View Existing Multi-rate Usage Types

1. Click on the Usage switch (Usage/Account toggle switch) in the navigation pane
2. Click on the Configurations menu option in the navigation panel. This will expand the sub-menu for Configurations in the Navigation Pane.
3. Click on the Building Blocks menu option in the navigation pane
4. Click on the Multi Rate Usage Type tab in the Activity Pane.
5. This will fetch the existing set of multi rate usage types configured for the client and show a line for each service type on the table.

Filter Attributes for the Multi-rate Usage Type

1. Service Type: Select the service type from the dropdown list to filter all billable services of a given service type. This works as an Exact Match with the dropdown list.
2. Subscription Category: Select the multi-rate usage type setting based on the subscription category (Postpaid, Prepaid, Prepaid with AAA, etc) by selecting the value from the dropdown list. This is an Exact match filter
3. Usage Type No: With Aria Catalog reference, you can use the usage type number to find the specific billable service. This filter is an exact match filter.

Sort Attributes for the Allowance Resource

1. Service Type: Ascending or descending sort based on the service type associated with the billable service.
2. Subscription Category: Ascending or descending sort based on the subscription category for which the multi-rate usage configuration is set up.
3. Usage Type No: Ascending or descending sort based on the usage type number associated with the billable service.

This is shown in the following screenshot:

View Details of a Specific Multi-Rate Usage Type

1. Navigate using "To view existing multi rate usage-type"
2. Select and click the service type ID link. This will open the drawer and allow you to modify the data

Add a New Multi-rate Usage Type

1. Navigate using "To view existing multi rate usage-type"
2. Click the Add Multi Usage Type button towards the top-right corner of the activity pane. This will open a drawer to add details of the new multi rate usage type configuration. 
   • In the first field, select a Service Type from the dropdown list available. This attribute only provides an easy reference to differentiate from multiple such configurations. 
   • For the next field Subscription Category, select the value from the dropdown list. Some of the values are for future use. These are:
     1. POSTPAID—a postpaid subscription
     2. PREPAID—a prepaid subscription
     3. PREPAID_AS_POSTPAID—a prepaid subscription in essence but may require invoice generation for all or specific usage cases. This may not be required for all regions.
   • In the next field Usage Type, select the usage type field from the dropdown list. Please note that the Allegro UI populates the dropdown list using the usage-type configuration.
   • Allegro UI will automatically populate the ID associated with the selected Usage type in the next field.
   • The next field Invoice line using child entries is a check box field. For the configuration, if you want the invoice lines to show each child usage type, then select the checkbox. Otherwise, leave it unselected. If unselected, the invoice line is assumed to be presented as combined parent level usage type only.
   • The next field Usage Type dependencies is a check box field. For the configuration, if you are going to add a child usage type which is dependent on another child usage type, then you should select the check box. This is an Allegro UI trying to control data entry. 
     1. An example of the usage type dependencies is with our example in this section where the Surcharge usage-type can be a fixed percentage of the of the usage fee, then you are not required to set up a price plan for the surcharge and can instead provide an override within this configuration itself. This is an optimization allowed in the configuration.
   • Refer to the Quick Notes button which provides the following information
     1. Select the "Invoice line using child entries" to determine the level at which to aggregate monetized usage when usage aggregation for invoicing is enabled. If the checkbox is enabled, aggregation will use the child usage types, otherwise the parent usage type.
     2. Select the "Usage Type dependencies" if the monetization for subsequent entries is dependent on the previous entries. For example, with two usage types "Usage fee" and "Usage Surcharge", Usage Surcharge entry can be X% of previous Usage fee entry. Surcharge will only be calculated on the net value of the Usage fee. Otherwise, leave the checkbox disabled.
     3. The Expression field is used for dependencies to evaluate the Quantity. In our example, the entry for Usage Surcharge can build the expression using the Usage Fee value and that will be used as a quantity.
     4. If the Percent field is used for any dependencies, then a flat %age will be applied on the expression value as an override to the actual pricing configured for the usage-type. In our example, Usage surcharge may have a pricing model configuration set, but in the context of the multi-rate configuration if the percent value is provided, the monetization model configuration for usage surcharge will be ignored.
     5. Note that the UI allows sequencing of the usage type rows in a multi-rate configuration. With the use of expression and percent, use the sequence wisely and set the expression/percent field accordingly. Expression and Percent field will always be disabled for the first row.
   • To add multi pass usage types (child entries), press the Add Button to add a row for each child-entry required.
     1. The first two fields are mutually exclusive. 
        • If Invoice Line using child entries check box is not selected, then Allegro expects that you can type any value in the second field Usage Sub Type for the child entry (the first field is disabled) as it will all be sent back to Aria Billing cloud with the parent usage type reference.
        • If Invoice Line using child entries check box is selected, then Allegro expects that you select the value for the first field Usage Type from the dropdown list of usage types configured (the second field is disabled).
     2. If the checkbox for Usage Type dependencies is left unchecked (not selected), then the next set of fields are disabled. Otherwise,
        • In the next field Expression reference the expression builder with Multi Rate Usage Type.
        • In the next field Percent enters a percentage value. This is specified as a decimal value between 0 to 1. For example, 0.15 for 15%. The percentage is applied on the value derived by the expression.
     3. Continue to Add more child rows for each pass by pressing the Add Usage Type button and repeating the process.
3. Click on the SAVE button at the bottom right corner of the drawer. This will push the changes to save the configuration using the backend API.
4. Click on the CANCEL button at the bottom right corner of the drawer to cancel all the data entry and go back to the main activity pane for the service types.

Modify Existing Multi-rate Configuration

Since it is a very simple configuration, the only attribute you can modify is the name of the service type which is reference only.

1. Navigate using "To view existing multi rate usage-type"
2. Click the Id link button with the ID highlighted in the Aria Blue color to open the drawer to modify the service type. 
3. Modify the attributes (the ID field cannot be modified) inline as required and as detailed in the "To add a new multi-rate usage-type configuration".
4. Click on the SAVE button at the bottom right corner of the drawer. This will push the changes to save the configuration using the backend API.

Click on the CANCEL button at the bottom right corner of the drawer to cancel all the data entry and go back to the main activity pane for the currency resources.

Delete a Multi-rate Usage Type Configuration for the Client

Deleting a multi rate usage type configuration will stop processing multi passes for the existing configuration. Hence, use it wisely.

1. Navigate using "To view existing multi rate usage types"
2. Select the multi rate usage-type from the table. 
3. Press the Trash container icon in the same row on the right-hand side. 
4. Press the Save button to save the deletion of the multi rate usage-type configuration.
5. To cancel the deletion prior to Saving it, press the Cancel button to revert.

Sequence the Child Usage Type Entries in a Multi-rate Usage Type Configuration

For each multi rate usage type configuration, the user has the Sequencing icon available to sequence the child entries. Please note that in this configuration, with the possible use of expressions, may have inter-dependences which should be reviewed to ensure all the configuration is correct when you re-sequence the entries.

1. Navigate using "To view existing multi rate usage types"
2. Select the multi rate usage-type from the table and press the ID Link. This will open the drawer with the configuration and a sub-table for child entries.
3. Use the Sequencing icon on the left side of each row (3 rows of two dots), press and hold the left key on the mouse or pad and move the row up/down. Repeat this process until you are satisfied with the sequencing. Review the dependency entries for correctness before saving your changes.
4. Press the Save button to save the save the sequencing within a multi rate usage-type configuration.
5. To cancel the sequencing prior to Saving it, press the Cancel button to revert.

Expression Builder with Multi-rate Usage Type Child Entries

If you want a different and independent monetization model for each child usage type for each pass of rating the usage record, then make sure that you unselect the Usage Type Dependencies field. Otherwise, an expression field for each subsequent row will be required. 

This expression builder is slightly different from other expression builders with Accumulators or Rate Units because of the interdependencies between child entries. In our example if the sequence of the child entries (each pass of rating) is Access Fee  Usage Fee  Usage Surcharge, then

• Access fee does not require an expression. The pricing will come from the monetization model associated with the Access fee since it is the 1st entry.
• Usage Fee can be an independent monetization model OR can be an expression using the Access Fee (previous entry)
• Usage Surcharge can be an independent model OR can be an expression using one or both of Access Fee and Usage Fee (previous entries)
• And so on for additional rows.

Add an Expression

1. The first field in the expression builder is the expression pane. There are two options for the user to build the expression. These are:
   1. Type the expression in the expression pane OR
   2. Use the operators, operands and fields below the expression pane to build an expression.
2. Tools available for expression builders are:
   1. Operators—These are multiply ‘*’, divide ‘/’, add ‘+’, subtract ‘-‘, left bracket ‘(‘, right bracket ‘)’, minimum operator ‘min’, maximum operator ‘max’.
   2. Select Field—Select the field from the dropdown list. Please note that with the sequence of child entries allowed and interdependence between rows,
      1. For the first row, the dropdown list will be empty
      2. For the second row, the dropdown list will show one entry with reference to the first row in the configuration. For this row, you can build an expression around the first-row entry (Engine uses the gross amount field impact from the 1st row (1st pass rating).
      3. For the third row, the dropdown list will show two entries with reference to the entries in the first two rows in the configuration. For this row, you can build an expression around the first two row entries (Engine uses the gross amount field impact from the 1st two rows (1st pass rating)
      4. And so on.
3. To build the expression let us use the following example,
   1. Access fee is an independent monetization model, so no expression is required.
   2. Usage fee is 125% of the access fee. Expression will be ‘Access Fee’ and the percentage field will be 1.25
   3. Usage surcharge is 15% of the sum of activation fee and the usage fee. Expression will be ‘AccessFee + UsageFee’ and the percentage field will be 0.15
4. Typing the expression manually. It is advised that you use the expression builder to avoid typing errors.
   1. In the expression pane type expression as ‘AccesFee’ for the 2nd row of Usage Fee
   2. In the expression pane type expression as ‘AccessFee + UsageFee’ for the usage surcharge row.
5. Using the operators and operands from the toolbox
   1. For the Usage Fee (2nd row)
      1. Select the Access Fee from the Select Field dropdown list from the toolbox. You will see the expression shows as "AccessFee" in the expression pane.
      2. Click Save for the expression and it will take you back to the multi-rate usage-type configuration drawer.
   2. For the Usage Surcharge (3rd row)
      1. Select the Access Fee from the Select Field dropdown list from the toolbox. You will see the expression shows as "AccessFee" in the expression pane.
      2. Select the Add operator from the toolbox. This will show the expression as "AccessFee +"
      3. Select the UsageFee Fee from the Select Field dropdown list from the toolbox. You will see the expression shows as "AccessFee + UsageFee" in the expression pane.
      4. Click Save for the expression and it will take you back to the multi-rate usage-type configuration drawer.
6. Click on the SAVE button at the bottom right corner of the drawer. This will push the changes to save the expression to go back to the previous drawer.
7. Click on the CANCEL button at the bottom right corner of the drawer to cancel all the expressions and go back to the main activity pane for the accumulator resource.