Variables let you dynamically update provisioning properties on the service based on other products assigned to the order. When a provisioning request is created, the system will review the SKUs on the service and update the provisioning properties to the correct value. For example, if a Voicemail MRC is assigned to the service, the system will automatically update the Voicemail provisioning parameter to True.
By updating provisioning properties based on assigned products, Variables will reduce the need to assign provisionable objects at the product level, decreasing the amount of configuration required to provision a service. Variables also improve order accuracy by ensuring the values sent on the provisioning request match the SKUs and MRCs assigned to the service.
When you add a POD property you can select Variable as the data type. You can track Variables on provisioning requests via the Request Detail view in Provisioning.
Variables High-level Walk-Through
This walks you through a high-level example. It covers configuring the Variable, creating the order, and generating the provisioning request.
Variable Configuration:
The Variable definition Update Bandwidth is configured to assign a value of 21 on the provisioning request when SKUs associated with the Outcome Code of 100/100 are assigned to the order.
The Outcome code 100/100 has SKU 100U100D associated with it. When SKU 100U100D is assigned to the order, the provisioning system will send 21 as the parameter value.
Provisionable Object Configuration:
The Provisioning Property BW Profile - Variable is assigned a data definition type of Variable and is assigned the Variable definition Update Bandwidth.
If the system finds a matching Outcome/SKU combination on the order, it will assign the configured value to the BW Profile – Variable property.
If no Outcome/SKU combination is detected, the system will default the property to the value associated with 30 MB Up and 5 MB Down.
Profile Configuration:
The BW Profile -Variable POD property is mapped to the BW Profile parameter on the Calix - xDSL Add Data Service provisioning action.
Order Creation:
An order is created and submitted with SKU 100U100D assigned to the service.
Provisioning Request Generation:
Once the workflow provisioning action is submitted for the order, the system will evaluate the assigned SKUs on the service and update the provisioning property values based on the Outcomes configured on the variable.
SKU 100U100D was assigned to the service in the example above.
The value 21 is sent in the provisioning request for the BW Profile -Variable property
Notes:
Variables functionality requires IDI Desktop client version 22.3 or higher.
Adding/editing variables requires Manage Variables permission.
Access
Selecting MANAGE > Variables displays a page that lists existing Variables. From here you can choose an existing Variable to edit or click + NEW VARIABLE to create a new Variable.
Show Picture
On selecting an existing Variable the page opens a right-hand pane for configuring the Variable parameters.
Show Picture
Creating a New Variable
To create a new Variable, click + NEW VARIABLE. The page opens the right-hand pane for configuring the Variable parameters. Creating a Variable is similar to adding a List in Provisioning or Workflow. You’ll start by naming the list, providing a descriptive Code, setting the value's data type, and setting whether or not the Variable should be active.
Next you’ll assign Outcomes. Outcomes contain the value sent in the provisioning request based on the SKU on the order.
Show Picture
Variable parameters marked with an asterisk are required.
Parameter | Description |
|---|---|
Name | Enter a unique name for the Variable. The value can be any combination of alphanumeric characters. |
Code | Enter a unique code or description for the Variable. The value can be any combination of alphanumeric characters. These codes are displayed on the Provisioning Request to facilitate troubleshooting provisioning errors. |
Type | Select a data type from the drop-down menu. For example: Date & Time, Integer, Text, etc… |
Active | This check box lets you specify whether or not the variable will be available for selection when you add a new property to a POD. Check to make the Variable available or leave unchecked to defer availability. |
Outcomes Filter | This field lets you filter the Outcomes list (after adding Outcomes). This can be handy when you have a long list of Outcomes. |
Add Outcomes | Click to add a new Outcome. See details below. |
Adding Outcomes
Configuration requires two steps. First, add and save the Outcomes. Then, associate one or more SKUs to each Outcome. As with Lists, the Value field on the Outcome will be sent in the provisioning request when the SKU(s) is assigned to the order.
Step 1 – Add one or more Outcomes.
Click + ADD OUTCOME to add a new row and fill in the required information. Each Outcome maps a value to one or more SKUs. Create a new Outcome each time you add a new value. Multiple Outcomes may be needed to cover the various SKU and value combinations.
Show Picture
Outcome parameters marked with an asterisk are required.
Parameter
Description
Rank
Rank applies when multiple SKUs and Variable Outcomes are assigned to the order. The system will choose the Outcome with the highest rank. This can aid in handling order assembly errors where a user mistakenly assigns multiple SKUs or where one SKU should take precedence over another.
Description
The value can be any combination of alphanumeric characters.
Value
Enter a value based on the selected data type. The value is what will be sent in the provisioning request.
Code
Enter a unique code for the Outcome. The value can be any combination of alphanumeric characters. These codes are displayed on the Provisioning Request to facilitate troubleshooting provisioning errors.
Step 2 – Manage SKU Associations
Once the Outcomes are saved, you’ll see additional controls at the right of each row.
Show Picture
The blue edit icon lets you update the Outcome’s Code.
The ellipsis icon is for managing SKU associations. This is where you associate one or more SKUs with the value you entered in this row.
Click the ellipsis then select Manage SKU Association.
Show Picture
This displays a form for adding SKUs to associate to the value.
Show Picture
Click + Add to display a list of SKUs in your Product Catalog.
The system returns your entire Product Catalog and is presented over a number of pages. You can use the controls on the bottom of the form to page through the content, or you can use the Search field to zero in on the specific products.
Select one or more SKUs by checking the associated check box(es) and then click Associate to add the selected SKUs.
Show Picture
The next time you open the Manage SKU Associations form you’ll see the SKUs you added.
Notes:
If you need to delete an Outcome from the list of added Outcomes, hover over the row to display the delete (red X) icon at the right end of the row and then click on it.
Show Picture
If you have a long list of Outcomes, you can use the Search field to filter the list.
Show Picture
Once all your Outcomes are created, you can rank the order of precedence by simply dragging and dropping the Outcome within the list. The system will apply the value with the highest rank if multiple SKUs appear for the same provisioning property.
Show Picture
