Resources

Delete a Currency Resource for the Client

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

1. Navigate using "To view existing currency resources"
2. Select the currency resource 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 currency resource. Please note that if the currency resource 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 Currency Resources

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 Resources menu option in the navigation pane
4. Click on the Currency tab in the Activity Pane.
5. This will fetch the existing set of currency resources configured for the client and show a line for each resource on the table.

This is shown in the following screenshot:

View Details of a Specific Currency Resource

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

Filter Attributes for the Currency resource

1. Name: The name of the currency resource is a filter. It is a case-insensitive, partial match filter. For example, if we use the filter as "dollar", then it will match all the dollar currency resources configured.

Sort Attributes for the Currency Resource

1. Name: Sort ascending or descending based on the name of the currency resource.
2. Currency Id: Sort ascending or descending based on the Currency id of the resource.

Add a New Currency Resource

1. Navigate using "To view existing currency resources"
2. Click the Add Currency button towards the top-right corner of the activity pane. This will open a drawer to add details of the new currency. The system configurations allow us to set default values for many UI attributes. If these attributes are Add the data as follows:
   • In the first field, select the Currency Id (mandatory attribute) from the dropdown list of currencies.
   • As you select the currency from the dropdown list, Allegro UI automatically populates the Symbol for the currency in the next field.
   • The next field Name (mandatory attribute) is also auto populated based on the Currency Id selection. Users can change the name, if required.
   • Choose the Rounding Method (mandatory attribute) in the next field using the dropdown list. The Rounding methods supported are:
     1. DOWN—Round Down where a value 0.8 would round down to 0.00
     2. HALF_DOWN—Round half down where 0.5 would round to 0.00.
     3. HALF_UP—Round half up where 0.5 would round to 1.0
     4. UP—Round UP where a value 0.2 would round up to 1.0
     5. NEAREST—Round to the nearest integer with 0.3 would round to 0 and 0.7 would round to 1.0. A 0.5 would round to 1.0
   • In the next field, add an integer value for Decimal Precision (mandatory attribute). For 2 decimal places, enter or use the increment/decrement counter to value 2.
   • 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.

Modify Existing Resource Configuration

The most common case to modify an existing resource configuration is to modify the rounding method and/or the rounding precision. 

1. Navigate using "To view existing currency resources"
2. Click the Id link button with the ID highlighted in the Aria Blue color to open the drawer to modify some attribute of an existing currency resource. 
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.
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 Currency Resources

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 Resources menu option in the navigation pane
4. Click on the Allowance tab in the Activity Pane.
5. This will fetch the existing set of allowance resources configured for the client and show a line for each resource on the table.

Filter Attributes for the Allowance Resource

1. Name: The name of the allowance resource. It is a case-insensitive, partial match filter. For example, if we use the filter as "free", then it will match all the allowance resources that have a case in-sensitive "free" as part of the name.

Sort Attributes for the Allowance Resource

1. Name: Sort ascending or descending based on the name of the allowance resource.
2. Allowance Id: Sort ascending or descending based on the Allowance id of the resource.

This is shown in the following screenshot:

View Details of a Specific Allowance Resource

1. Navigate using "To view existing currency resources"
2. Select and click the allowance resource. This will open the drawer and allow you to modify the data

Add a New Allowance Resource

1. Navigate using "To view existing allowance resources"
2. Click the Add Allowance button towards the top-right corner of the activity pane. This will open a drawer to add details of the new non-currency allowance resource. The system configurations allow us to set default values for many UI attributes Add the data as follows:
   1. In the first field, type the Allowance Id (mandatory attribute). Some advice it to keep it short. Align to the use of ‘Free’ or ‘Included’ and use a short id accordingly. For e.g., FreeMin or InclMin for Free or includes minutes, FreeCurr or InclCurrency for free or included currency.
   2. Type the Symbol (mandatory attribute) that you want associated with the allowance. An advice is to use FM, IM, FC, IC for the advised name field.
   3. The next field Name (mandatory attribute) is auto populated with a value same as the ID of the resource. Users can change the default value.
   4. In the next field, select the Allowance Type (mandatory attribute) from the dropdown list. The possible values are:
      1. AMOUNT—For e.g., A Free $ allowance will offset the amount.
      2. QUANTITY—For a e.g., a Free Minutes allowance will offset the quantity of the usage transaction.
      3. COUNT—For e.g., Free SMS allowance will offset each SMS record.
   5. Choose the Rounding Method (mandatory attribute) in the next field using the dropdown list. The Rounding methods supported are:
      1. DOWN—Round Down where a value 0.8 would round down to 0.00
      2. HALF_DOWN—Round half down where 0.5 would round to 0.00.
      3. HALF_UP—Round half up where 0.5 would round to 1.0
      4. UP—Round UP where a value 0.2 would round up to 1.0
      5. NEAREST—Round to the nearest integer with 0.3 would round to 0 and 0.7 would round to 1.0. A 0.5 would round to 1.0
   6. In the next field, add an integer value for Decimal Precision (mandatory attribute). For 2 decimal places, enter or use the increment/decrement counter to value 2.
   7. 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.
   8. 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.

Modify Existing Allowance Configuration

The most common case to modify an existing resource configuration is to modify the rounding method and/or the rounding precision. 

1. Navigate using "To view existing allowance resources"
2. Click the Id link button with the ID highlighted in the Aria Blue color to open the drawer to modify some attribute of an existing allowance resource. 
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.
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.

To delete an allowance resource for the client,

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

1. Navigate using "To view existing allowance resources"
2. Select the allowance resource 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 allowance resource. Please note that if the allowance resource 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 Accumulator Resources

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 Resources menu option in the navigation pane
4. Click on the Accumulator tab in the Activity Pane.
5. This will fetch the existing set of allowance resources configured for the client and show a line for each resource on the table.

Filter Attributes for the Accumulator Resource

1. Name: The name of the accumulator resource. It is a case-insensitive, partial match filter. For example, if we use the filter as "data", then it will match all the accumulator resources that have a case in-sensitive "data" as part of the name.

Sort Attributes for the Accumulator Resource

1. Name: Sort ascending or descending based on the name of the accumulator resource.
2. Allowance Id: Sort ascending or descending based on the accumulator id of the resource.

This is shown in the following screenshot:

View Details of a Specific Accumulator Resource

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

Add a New Accumulator Resource

1. Navigate using "To view existing accumulator resources"
2. Click the Add Accumulator button towards the top-right corner of the activity pane. This will open a drawer to add details of the new non-currency allowance resource. The system configurations allow us to set default values for many UI attributes. Add the data as follows:
   1. In the first field, type the Accumulator Id (mandatory attribute). Some advice is to keep it short. For example, PM for Peak Minutes, AM for Anytime Minutes and more.
   2. Type the Symbol (mandatory attribute) that you want associated with the allowance. Some advice is to use FM, IM, FC, IC for the advised name field.
   3. The next field Name (mandatory attribute) is auto populated with a value same as the ID of the resource. Users can change the default value.
   4. Choose the Rounding Method (mandatory attribute) in the next field using the dropdown list. The Rounding methods supported are:
      1. DOWN—Round Down where a value 0.8 would round down to 0.00
      2. HALF_DOWN—Round half down where 0.5 would round to 0.00.
      3. HALF_UP—Round half up where 0.5 would round to 1.0
      4. UP—Round UP where a value 0.2 would round up to 1.0
      5. NEAREST—Round to the nearest integer with 0.3 would round to 0 and 0.7 would round to 1.0. A 0.5 would round to 1.0
   5. In the next field, add an integer value for Decimal Precision (mandatory attribute). For 2 decimal places, enter or use the increment/decrement counter to value 2.
   • In the next field Accumulate Quantity (optional attribute), select the Boolean true/false value from the dropdown list. 
     1. Value True suggests that the accumulator is going to be used to accumulate the quantity of the usage record.
     2. Value False suggests that the accumulator is going to be used to accumulate the amount of the usage record.
   • In the next field Expression (optional, but mandatory if the previous field is not set), enter the expression or use the expression builder. Refer the Expression builder sub-section.
   • 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 accumulator resource.

Modify Existing Accumulator Configuration

The most common case to modify an existing resource configuration is to modify the rounding method and/or the rounding precision. 

1. Navigate using "To view existing accumulator resources"
2. Click the Id link button with the ID highlighted in the Aria Blue color to open the drawer to modify some attribute of an existing allowance resource. 
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.
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.

Delete an Accumulator Resource for the Client

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

1. Navigate using "To view existing accumulator resources"
2. Select the accumulator resource 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 accumulator resource. Please note that if the accumulator resource 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.

Expression Builder with Accumulators

The expression can be required if you want more with what you are accumulating. This field is mutually exclusive with the Quantity Accumulator true/false Boolean value. In other words, if you are not doing a quantity accumulation (value false) then you are using to do an amount accumulation. If you are doing a quantity accumulation (value true) then you are performing a quantity accumulation. Alternatively, when you do not wish to do quantity or amount accumulation, then the accumulator expression can be used which can in turn use the quantity or amount fields. To add an expression,

1. Click on the expression field in the accumulator. This will open a sub-drawer from the right side of the screen.
2. 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.
3. 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. Usage container fields—When there are multiple sources of usage data ingestion, then the mediation mapping configurations allow homogenizing different forms of data into an Aria Allegro usage container model. This included up to 25 flexible fields that can be used for mapping. For the expression builder, the usage container model is available as dropdown list. This is supported by the following two fields:
      1. Select Record—For now, this dropdown will show a DETAIL record only with provisions for using custom records as well.
      2. Select Field—This will show all the fields that are included in the Aria Allegro usage container DETAIL record.
4. To build the expression both ways, let us take an example of an expression which has to use the 75% factor of the maximum of the download volume and upload volume attributes on the usage record.
   1. Typing the expression manually—This assumes that you know the exact fields from the usage container.
      1. In the expression pane type the following. Please note the use of spaces before and after each operator and operand. It is advisable to keep a space "max<space>(<space>DETAIL.uploadvolume<space>,DETAIL.downloadvolume<space>)<space>0.75"
   2. Using the operators and operands from the toolbox
      1. Select the max operator from the toolbox. You will see the expression shows as "max" in the expression pane.
      2. Select the left bracket from the toolbox. You will see the expression shows as "max (" in the expression pane.
      3. Select the DETAIL record from the Select Record dropdown list and select the uploadvolume field from the Select Field dropdown list and press the Add Field button. You will see the following expression "max ( DETAIL.uploadvolume" in the expression pane.
      4. Select the comma operator from the toolbox. You will see the expression shows as "max ( DETAIL.uploadvolume , " in the expression pane.
      5. Select the DETAIL record from the Select Record dropdown list and select the downloadvolume field from the Select Field dropdown list and press the Add Field button. You will see the following expression "max ( DETAIL.uploadvolume , DETAIL.downloadvolume" in the expression pane.
      6. Select the right bracket from the toolbox. You will see the expression shows as "max ( DETAIL.uploadvolume , DETAIL.downloadvolume )" in the expression pane.
      7. Select the multiply operator from the toolbox. You will see the expression shows as "max ( DETAIL.uploadvolume , DETAIL.downloadvolume ) *" in the expression pane.
      8. In the expression pane add, "<space> 0.75" for the 75% factor of the max value. You will see the expression shows as "max ( DETAIL.uploadvolume , DETAIL.downloadvolume ) * 0.75" in the expression pane. Your expression is now complete.
5. 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.
6. 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.