Create a Time Normalizer

This normalizer defines time ranges to associate with different results. When an network message is received, the time field determines which range to use during rating. If the usage spans multiple time ranges, it is distributed across each range and the result associated with each range is used.

Before you begin

My MATRIXX must contain the normalizer template that you want to use for this normalizer that implements the Time normalization algorithm.

Procedure

  1. In Normalizers, click New Normalizer.
  2. In Create New Normalizer:
    1. In Name, enter a unique name.
    2. (Optional) In Description, enter descriptive information about the item.
    3. (Optional) In External ID, enter any alphanumeric character to serve as a unique ID on this pricing object. The external ID can be used for any reason that is meaningful to your implementation of MATRIXX Engine. External IDs are saved to the pricing configuration file and loaded into the Pricing database.
    4. From the Normalizer Template list, select the name of the normalizer template that implements the normalization algorithm you want to use for this normalizer.
    5. Click Create.
  3. In Start Date/Time, use the date picker to select the date on which the object becomes active in the Pricing database and is first available for use, or enter the date in the format YYYY-MM-DD. Optionally, enter a time for when the object becomes active. The default start date/time is 2000–01–01 00:00:00. If applicable, the range in which the start date/time must fall is listed. For example:
    • Select a date on or before 2021–12–01.
    • Select a date on or after 2020–01–27.
    • Select a date between 2000–01–02 and 2021–10–04.
    Note: If you are creating a new revision of this object, the start date/time must be after the start date/time of the preceding revision and before the start date/time of the next revision. If you are making a copy of this object, the start date/time is not copied. The new object is the first revision, so it has the default start date/time of 2000–01–01 00:00:00.
  4. Skip the Value If Field Not Present setting. This list is populated in the next steps.
  5. If any metadata fields were defined in the normalizer template, they are listed under Default Metadata. For each piece of metadata, enter the fixed value to be associated with a result. The value entered must correspond to the configured data type. This value is used in the following ways:
    • No default value is defined in the normalizer template and --default-- is used to define the metadata value in the normalizer instance using the Edit Normalizer Values dialog.
    • The default value is defined in the normalizer template under the Values table as --default--.
  6. Click or hover over the Rows menu icon and select Edit Values to open Edit Normalizer Values. You can add new values manually or by selecting a normalizer value list.
    Note: If using a normalizer value list, metadata is not supported. Therefore, any metadata listed under Default Metadata in Edit Normalizer does not display as columns in the Values table in Edit Normalizer Values if Use Normalizer Value List is selected.
  7. If defining values by selecting a normalizer value list, perform the following steps for each time range to create.
    1. If the normalizer already has values defined, click Create a Normalizer Value List to save the list of manually created values as a normalizer value list. Enter a unique name and click Create. The new normalizer value list is added to the Normalizer Value List drop-down menu and can be selected for this and other normalizers.
      Important: Any existing values in the normalizer that are not saved as part of creating a normalizer value list are deleted after you click Save.
    2. Check Use Normalizer Value List to enable the menu. This disables the option to add a value manually by clicking New Value. Any existing values assigned to the normalizer are removed.
    3. Select a normalizer value list from the drop-down menu. Values from the selected list are displayed in the table.
  8. If the normalizer template does not define any normalizer values and you are not using a normalizer value list, then you can define the values within the normalizer instance by clicking Edit Values to open Edit Normalizer Values and performing the following steps for each time range to create.
    Tip: You can also add a new time and value by clicking on the day of the week heading of the time table, entering the values, and then clicking Add. However, any metadata columns are read-only.
    1. Click New Value.
      A row is added to the list with an ID that is used internally to look up the parameter value during rating. Any metadata defined in the normalizer template is displayed as columns in the Values table.
    2. Click the Name cell in the row and enter a descriptive name for the range.
      For example, to create a time range normalizer that rates based on whether it is a weekday or weekend day, the range name might be Weekday or Weekend.
    3. Click the Description cell in the row and enter information about the purpose of the parameter value.
    4. To assign a color to the parameter that displays as the background color for each row in the Rows table, do one of the following:
      • Hover your mouse over the Color cell in the row and select a color from the color palette.
      • Click the Color cell in the row and assign a color to the value by setting the color's hue, saturation, and lightness. The following methods are available:
        • Use the eyedropper tool to select any color on your screen or select a color on the color strip to pick a main color. Then use the color gradient area to fine tune the color.
        • Enter the RGB/HSL/Hex values of a certain color if they are known.
    5. If metadata columns are displayed and no values were defined for the metadata in the normalizer template, enter the value for the metadata. Metadata can be associated with each result value. The value entered must correspond to the configured data type.
      Default and non-values can be defined as follows:
      • Enter --none-- if no value is assigned to this field.
      • Enter --default-- to use the default value for this field.
      For example:
      1. The test1 metadata has a default value of 1, and the test2 metadata has a default value of 2 as defined in the Default Metadata table in Edit Normalizer.
      2. In Edit Normalizer Values, the string value for test1 is configured as --default--, and test2 is configured as --none--.
      3. When a row is added to the Rows table, test1 has the value of 1 and test2 is empty.
      If actual values are defined for the metadata in Edit Normalizer Values, then those values are displayed in the metadata columns in the Rows table.
  9. Click Save.
  10. Perform the following steps to define time ranges for each day of the week.
    Note: Ranges cannot span days. To define time ranges, you specify the start time of the range. The end time of the range is automatically set to the start time of the next range. The first range to define has a start time of 12 AM. For example, if you have a Peak period that spans from 8 AM to 5 PM and an Off-Peak period that spans all other times, you specify the first range as an Off-Peak period with a start time of 12 AM (00:00:00), the second range as the Peak period with a start time of 8:00 AM (08:00:00), and a final Off Peak period with a start time of 5:00 PM (17:00:00). Each time range is inclusive at both the start and end times.
    1. Click the name of the day to display the time schedule for that day. Any metadata defined in the normalizer template is displayed as columns in the table after the Value column.
    2. In Define Time Normalizer Values, in New Time, enter the start time for the time range. If this is the first time range, enter 00:00:00.
      Note: MATRIXX uses a 24-hour clock for specifying start times.
    3. In New Value, select the name of the time range.
    4. Click Add to update the schedule in the Edit Normalizer page with the new time range.
    5. Repeat this process for each time range to create.
      To delete a row, click the delete icon next to the row. To edit the data in a row, click the cell containing the data you want to edit.
    Note: If you add a new range that starts in the middle of an existing range, the end of the existing range changes to end at the start of the new range, and the new range ends where the existing range ended before.
  11. (Optional) Click or hover over the Rows menu icon and select Validate to check the normalizer values for errors.
    Validation checks for errors caused by duplicate rows, gaps in ranges, overlapping ranges, and any other missing or invalid configurations. To perform the validation, My MATRIXX sorts the rows in the rate table according to the first parameter value.
  12. In Value If Field Not Present, select a parameter value to use when the field value is not set at the time of rating.
  13. Click Save.