Models

View Existing Rate Units

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

Filter Attributes for the Multi-rate Usage Type

1. Code: Search based on the code associated with the rate unit. This is a case-insensitive partial match filter.

Sort Attributes for the Multi-rate Usage Type

1. Code: Ascending or descending sort based on the code associated with the rate unit.

This is shown in the following screenshot:

View Details of a Specific Rate Unit

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

Add a New Rate Unit

1. Navigate using "To view existing rate units"
2. Click the Add Rate Unit button towards the top-right corner of the activity pane. This will open a drawer to add details of the new rate unit. The system configurations allow us to set default values for many UI attributes. Add the data as follows:
   • In the first field, type the Code (mandatory attribute). Some advice is to keep it short and follow a consistent naming pattern with use of underscores or Hyphens if required. For example, METER_READ
   • In the second field for Unit (mandatory attribute), select the value from the pre-configured list of dropdown values. 
   • In the next field Status, select the status value from the dropdown list. In most cases this will be set as ACTIVE using default properties.
   • In the next field Expression, refer to the Expression builder with Rate Units.
   • In the next Function name, enter the name of the database function. For complex rules, Aria Allegro allows setting up a database function to determine the quantity for the usage record. It is expected that the database function will return a decimal quantity value only as output.
   • The next checkbox field Quantity Scalable, select the field to determine whether the Rate unit quantity determined is scalable with the monetization model or not.
   • The next checkbox field Meter Read, needs to be selected for utility verticals where the meter reads only provides the current meter value and does not provide the previous meter read and current meter read to determine the utility used. Few points to note are:
     1. This checkbox will enable Allegro usage processing engine to log each meter read in a database. Each subsequent meter read will be able to fetch the previous meter read and then determine the utility used between the two meter reads to monetize.
     2. The first meter read is usually provided with the Activation of the utility meter which may not start from 0. Aria Billing Cloud would have to capture the current meter read with activation and call an API in Allegro to save it. In absence of that data, the initial meter read will assume 0 and overcharge the customer for the 1st meter read, post activation.
     3. The Meter Read has an Info icon next to it with the following information currently.
        • If the rate unit is defined for Meter reading use case (Utility services like water, electricity etc.), the quantity to be rated will be calculated based on the current meter read and the previous meter read.
   • Please note that the expression or the d/b function or the Meter Read are mutually exclusive, and Allegro UI will not allow more than one selection. 
   • 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 Rate Unit

1. Navigate using "To view existing rate unit"
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 a Rate Unit for the Client

A delete of rate unit is not allowed. However, you can modify and update the status of the rate unit.

Add an Expression

1. Click on the expression field in the rate unit. 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', average operator 'avg'. These operators can take two or more operands as may be required.
   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.
   3. Balance of Accumulator option. Please note that the Usage Container field and Balance of Accumulator for now are mutually exclusive. If a combination is required, then that can be looked at in the future. This is supported by two pieces of information:
      1. Balance operator
      2. Select Accumulator - Select the accumulator which is to be used in the expression from the dropdown list. This dropdown list is based on all the accumulators configured for the client.
4. Refer the expression builder with Accumulators for expressions that use the Allegro usage container fields. Here we will take the example of the new balance function. To build the expression both ways, let us take an example of an expression that gives us a difference in the value of two Accumulators
   1. MIN_SPEND that keeps track of the commitment value for the commitment term (e.g. 1Million Dollar commitment for a year or 5Million Units of usage commitment for a 6-month term)
   2. MIN_SPEND_CONTRIB an accumulator that keeps track of the usage towards commitment during the commitment term.
   3. Now to manage the expression,
      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 "bal<space>(<space>MIN_SPEND<space> ) <space> - bal<space>(<space>MIN_SPEND_CONTRIB<space> )". This can be prone to typos; hence it is advised you use the toolbox to build the expression.
      2. Using the operators and operands from the toolbox
         1. Select the Accumulator 'MIN_SPEND' from the dropdown list with the "Balance of"  from the toolbox. You will see the expression shows as "bal ( MIN_SPEND )" in the expression pane.
         2. Select the subtract operator from the toolbox. You will see the expression show as "bal ( MIN_SPEND ) - "  in the expression pane.
         3. Select the Accumulator 'MIN_SPEND_CONTRIB' from the dropdown list with the "Balance of"  from the toolbox. You will see the expression shows as "bal ( MIN_SPEND )—bal ( MIN_SPEND_CONTRIB )" in the expression pane.
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.

The following screenshot shows the expression builder with Rate Units:

View Existing Rate Unit Maps

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 Models menu option in the navigation pane
4. Click on the Rate Unit Map tab in the Activity Pane.
5. This will fetch the existing set of rate unit maps configured for the client and show a line for each resource on the table.

Filter Attributes for the Rate Unit Map

1. Rate Unit Code: Search based on the code associated with the rate unit. This is a case-insensitive partial match filter.
2. Service Type: Search for the rate unit map configurations for a given service-type by selecting the service-type from a dropdown list. This is an exact match filter.
3. Transaction Type: Search for the rate unit map configurations for a given transaction-type by selecting the transaction type from the dropdown list. For foreseeable future, this may not be required as the transaction-type associated for usage records is always 'USAGE'.

Sort Attributes for the Rate Unit Map

1. Rate Unit Code: Ascending or descending sort based on the rate unit code associated with the rate unit map configurations.
2. Service Type: Ascending or descending sort based on the service type associated with the rate unit map configurations.
3. Transaction Type: Ascending or descending sort based on the transaction type associated with the rate unit map configurations.

This is shown in the following screenshot:

View Details of a Specific Rate Unit Map

1. Navigate using "To view existing rate unit maps".
2. Select and click the rate unit map ID link. This will open the drawer and allow you to view and modify the data.

Add a New Rate Unit Map for a New Rate Unit Added

1. Navigate using "To view existing rate unit maps".
2. Click the Add Rate Unit Map 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. Please note that the same rate unit can be mapped to multiple services, if required. Add the data as follows:
   • In the first field, select the Rate Unit Code (mandatory attribute) from the dropdown list of configured rate units.
   • In the next field, select the Service Type (mandatory attribute) from the dropdown list of service-types configured. This maps the rate unit to the service type
   • The next field Transaction Type (mandatory attribute), select the transaction type to map the Rate Unit, Service Type to a transaction Type.
   • In the next optional field for Usage Class, type the usage class that can further map to specific usage attributes. We currently do not foresee the mapping to include other usage attributes. However, the configuration is easily extendible to add more attributes in the future.
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 rate unit maps.

Modify Existing Allowance Configuration

1. Navigate using "To view existing rate unit maps"
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 rate unit map. 
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 rate unit map.

Delete an Allowance Resource for the Client

This ideally should not be required at all and will be permission controlled. However, over a period if the configuration includes more noise than meaningful data, admins can use the delete option to delete the rate unit map. You need to be sure that the configuration is wrong or not required anymore before deleting the entry. To delete,

1. Navigate using "To view existing rate unit map"
2. Identify the rate unit map from the table that needs to be deleted.
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 rate unit map. 
5. To cancel the deletion prior to Saving it, press the Cancel button to revert.

View Existing Time Unit Configured

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 Models menu option in the navigation pane
4. Click on the Time Unit tab in the Activity Pane.
5. This will fetch the existing set of time units configured. You should only see one row on the table.

This is shown in the following screenshot:

View Details of a Time Unit

1. Navigate using "To view existing time unit".
2. Select and click the rate unit map ID link. This will open the drawer and allow you to view and modify the data.

Add a New Rate Unit Map for a New Rate Unit Added

This will only be required if you do not see a single entry on the table. If there is an entry, then you will not see the Add option. For most Allegro deployment, you will see a default time unit configured which you can modify as per the client requirements.

1. Navigate using "To view existing time unit"
2. Click the Add Time Unit 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. 
3. Refer the "To modify an existing time unit" for changes 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 time unit.

Modify Existing Time Units

1. Navigate using "To view existing time unit"
2. Click the Id link button with the ID highlighted in the Aria Blue color to open the drawer to view and modify the time unit configuration. 
3. There is a slider bar at the top of the drawer that allows you to use the start time from the usage data or the end time from the usage data for time unit analysis. For now, the split of the time unit is not allowed. Work with the Allegro team by opening a ticket if a split configuration is required. 
   • For example, a voice call starts at 16:45:00 and ends at 17:15:00 with a peak or working hours configured as 9:00 to 5:00, then based on the slider, the call may be considered as a peak call or an off peak call depending on how the Use Start time or End time slider is used.
   • The same can apply to day end boundary with day of the week Vs. Weekend or holiday start/end boundaries.
4. You will see 3 Minimize/Maximize bar in the Drawer. 
5. To manage Day-of-Week configuration, maximize the 'Day of Week Configuration' bar
   • Select the check boxes for each weekday that make up the work week for the client setup. The weekdays selected become the WEEKDAY and the ones not selected become part of the WEEKEND. This is shown in the screenshot below
     
6. To manage Time-Of-Day configuration, maximize the 'Time of day Configuration' bar
   • You can use this subset to define Peak hours, off-peak hours, premium hours and any other time slot configuration required for the client.
   • If there are timeslots already configured, then you will see a table of Time-of-day rows. 
     1. To modify an existing time slot row,
        • Modify inline the Start Time, End time in line. You can type the time in "HH:MM:SS" format or use the dropdown for Time input. 
        • For the Type field in the row, select a value available from the dropdown list OR type a simple type in capital letters to associate the Type. This value will show up in the monetization model.
     2. To remove an existing time slot row,
        • Press the X mark at the end of the row to remove the row from the UI view. Use of the SAVE button only will save your changes
     3. To add a new row for a time slot
        • Press the Add Row button
        • Type or use the Time input for the Start time for new time slot
        • Type or use the Time input for the End time for new time slot
        • Type a new value for Type field for your new time slot or select the value from the dropdown list. Please note that the TYPE field has to be unique across the rows in the configuration.
          
          The following screenshot shows the Time-Of-Day configuration,
          
          
7. To manage Holiday configuration, maximize the 'Holiday Configuration' bar
   • You can use this subset to set your holiday calendars. The holiday, 
     1. be a one-day holiday (e.g., Memorial Day) or 
     2. OR it can span a few days. For example, a Christmas special that can start from Christmas Eve to the day after New year. The name against the holiday is important as that can be used in the Monetization models. Please note that for holiday schedule, midnight hour (00:00:00) is assumed.
     3. Please note that the Monetization models will allow the use of HOLIDAY (type) or the name you provide.
   • If there are holidays already configured, then you will see a table of Holiday rows. 
     1. To modify an existing holiday row,
        • Modify the Start Date, End Date in line. You can type the date in "yyyy-mm-dd" format or use the dropdown for Date input. 
        • For the Name field in the row, type a name that you want associated with the holiday. It is advised that you do not use spaces in the name.
        • For the Type field, Allegro UI by default sets a read-only HOLIDAY value.
     2. To remove an existing holiday row,
        •  Press the X mark at the end of the row to remove the row from the UI view. Use of the SAVE button only will save your changes
     3. To add a new row for a holiday entry
        • Press the Add Row button
        • Type or use the Date input for the Start Date for new holiday.
        • Type or use the Date input for the End Date for new holiday.
        • Type a new value for Name field for your new holiday. Please note that the NAME field has to be unique across the rows in the configuration.
        • Allegro UI will automatically set the next field Type as Holiday
          
          The following screenshot shows the Holiday configuration 
          
          
8. 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 and take you back to the activity pane
9. 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 time unit.

View Existing Zone Units Configured

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 Models menu option in the navigation pane
4. Click on the Zone Unit tab in the Activity Pane.
5. This will fetch the existing set of zone units configured. You should only see one row on the table.

Filter Attributes for the Zone Unit

1. Name: Search based on the name associated with the zone unit configuration. This is a case-insensitive partial match filter.
2. Service Type: Search for the zone unit configurations for a given service-type by selecting the service-type from a dropdown list. This is an exact match filter.
3. Status: Search for the zone unit configurations based on the status of the zone map configuration by selecting the status value from the dropdown list. This is an Exact match filter.
4. Zone Type: Search for the zone unit configurations based on the zone Type configured by selecting the value from the dropdown list. This is an Exact match filter.

Sort Attributes for the Zone Unit

1. Name: Ascending or descending sort based on the name of the zone unit configurations.
2. Service Type: Ascending or descending sort based on the service type associated with the zone unit configurations.
3. Zone Type: Ascending or descending sort based on the zone type associated with the zone unit configurations.

This is shown in the following screenshot:

View Details of a Zone Unit

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

Add a New Zone Unit

1. Navigate using "To view existing zone unit"
2. Click the Add Zone Unit 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. 
3. In the first field ID (optional) enter an ID if you wish to provide your own. It is free text. If not provided, Allegro will assign an id. Do not use spaces in the id definition as a general practice.
4. In the next field Name (mandatory and unique), type a name for your zone unit configuration. Keep it short and precise and try to avoid using spaces.
5. In the next field Zone Type, select the zone type value from the dropdown list. The allowed zone types are:
   • Standard Zone—based on from where a call is made to where (e.g., US call to Australia)
   • Geographical Zone—based on distance between two points (between the caller and called party for example. For B2B office voice service, this could be the distance between two data centers)
6. In the next field Service Type, select the service type from the dropdown list of configured service-types for the client. For most scenarios the zone unit configuration would be for VOICE or VOIP service. 
7. In the next field Status, UI will default the status to ACTIVE for a new configuration.
8. In the next field Description, add a free text description for your zone unit configuration to relate to the configuration.
9. Now, based on the zone type selected,
   • If the Zone Type selected is "Standard", UI enables the Origin and the Destination field and disables the Distance field.
     1. Select the field as the Origin field from the dropdown list. This is the field that is mapped to the Allegro usage container to identify the origin field to be used. For a Telecom set up and a standard zone configuration, the A-Party number (the caller) is the Origin field that will identify who made the phone call.
     2. Select the field as the Destination field from the dropdown list. This is the field that is mapped to the Allegro usage container to identify the destination field to be used. For a Telecom set up and a standard zone configuration, the B-Party number (the called party) is the Destination field that will identify who made the phone call.
   • If the Zone Type selected is "Geographic", UI enables the Distance field and disables the Origin and the Destination field.
     1. Select the field as the Distance field from the dropdown list. This is the field that is mapped to the Allegro usage container to identify the distance field to be used. For a Telecom set up and a geographical zone configuration, distance field may be provided or may be enriched using Allegro mediation rules.
10. To add zones to your configuration, Press the Add Zone button on the right-hand side, below the description field.
    • This will add a new row in the table
    • Please note,
      1. If the Zone Type selected is Standard, then the UI disables the entry for Distance value field, and the Origin Value and Destination value fields are enabled for each row in the zone unit configuration.
      2. If the zone Type selected is Geographic, then the UI disables the Origin Value and the Destination Value fields, and enables the Distance value fields.
    • For the next field 'Origin value' (enabled for Standard Zone Type),
      1. Note that the raw usage record may not have the a-party phone number values normalized. For example, a USA number 123-456-7890 may appear as '+11234567890' or '0011234567890' or '+1-123-456-7890' or '001-123-456-7890 or '+1-1234567890' or '001-1234567890'.
      2. The more sources of raw usage data for VOICE or VOIP, the more combinations are possible.
      3. You are required to normalize the values of these attributes using the Enrichment rules in Mediation and then keep the normalized values in mind when setting up the zones. For example, the combination values in the previous bullet can all be normalized as '11234567890'.
      4. For the zones, usually the first few digits are only required or a wild card *' is required. Some examples are:
         • If you only care about destination value, for example for any call made from anywhere, to USA, then the origin value can be *'.
         • If you only care for all calls from India, then the origin value can be '91'
      5. You set zones for each unique rate and minimize the rows in the zone configuration. For example, if any calls to USA from anywhere except Brazil will have the same rate, then you only need two rows
         • One where the origin value is *' and
         • One where the origin value is '55' (for Brazil).
      6. The Allegro engine will look for the BEST MATCH first. For calls from Brazil to USA, it will match the 2nd row and for calls from any other country to USA will match with the 1st row.
    • In the next field 'Destination Value' (enabled for Standard Zone Type), 
      1. Note that the raw usage record may not have the b-party phone number values normalized. For example, a USA number 123-456-7890 may appear as '+11234567890' or '0011234567890' or '+1-123-456-7890' or '001-123-456-7890 or '+1-1234567890' or '001-1234567890'.
      2. The more sources of raw usage data for VOICE or VOIP, the more combinations are possible.
      3. You are required to normalize the values of these attributes using the Enrichment rules in Mediation and then keep the normalized values in mind when setting up the zones. For example, the combination values in the previous bullet can all be normalized as '11234567890'.
      4. For the zones, usually the first few digits are only required or a wild card *' is required. Some examples are:
         • If you only care about the origin value, for example for any call made from USA to anywhere in the world, then the destination value can be *'.
         • If you only care for all calls made to India, then the destination value can be '91'
      5. You set zones for each unique rate and minimize the rows in the zone configuration. For example, if any call from USA to anywhere in the world, except Brazil will have the same rate, then you only need two rows
         • One where the destination value is *' and
         • One where the destination value is '55' (for Brazil).
      6. The Allegro engine will look for the BEST MATCH first. For calls from USA to Brazil, it will match the 2nd row and for calls from USA to any other country will match with the 1st row.
    • The next field 'Distance Value' (enabled for Geographic Zone Type) will only be enabled when the Zone model selected is Geographical zone model. 
      1. Select the field in the usage container that will hold the distance value by selecting the field from the dropdown list.
      2. For the next field 'Destination Value' enter the value that you want to set a unique zone for.
    • In the next field Name, type a name value (avoid spaces) that will uniquely identify the zone from other entries in your zone configuration.
    • In the next field 'Description', type a description value that is more relatable to the zone configured.
    • In the next field 'Start Date' set the start date from when the new zone is effective. By default, it will take the current date.
    • In the next field 'End Date' set the end date from when the new zone is effective. By default, it will be blank to indicate that it never ends. You can come back to modify the end-date if that zone is no longer required after that date.
    • To add more zones in your current zone configuration, repeat step 9 until you are done adding all zones.
11. 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.
12. ​​​​​​​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 zone unit.

Modify an Existing Zone Unit

1. Navigate using "To view existing zone unit"
2. Click the Zone Unit ID link. This will open a drawer to view and modify the zone model configuration. 
3. Allegro UI will control what attributes are not modifiable. Otherwise, perform in line edits and refer the "To add a new zone unit" for each attribute or row.
4. To remove a row from the zone unit configuration, click the X icon on the right-hand side of the row to remove the row from the view. Please note a SAVE button is required to Save your edits.
5. To change the status of a zone unit configuration, change the status field at the top of the drawer by selecting a value from the dropdown list. The possible values are ACTIVE, INACTIVE, CLOSED. Allegro Usage processing engine will only consider zone units that are in ACTIVE status.
6. To add a new row in the zone unit configuration, refer the Add row sub-section in "To add a new zone unit"
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 zone unit.