Provisionable Object Definitions (PODs) let you configure the properties and values that are sent with the provisioning request for a product. A POD is mapped to one or more SKUs in the IDI Desktop Client Product Catalog. The properties you configure in the POD come with the SKU during order processing. Certain properties are established by the system such as account or service number, and you can create additional custom properties based on your unique business processes. You define the name and data type. You can also set a default value or require the property to be set directly on the Order.
Guidelines for POD to SKU Mapping:
Do not create a separate POD for each provisioning action that may be taken on a SKU. Generally, while a POD may be mapped to more than one SKU, a SKU should have only one POD per Provider. A SKU may require more than one POD if the SKU is being provisioned on more than one Provider and each Provider requires different property definitions.
Getting Started
To begin working with PODs, click the PROVISIONABLE OBJECTS option in the main menu.
Show Picture
This displays the Provisionable Objects page which lists any PODs you’ve configured. You can add new PODs and edit existing PODs as needed. There’s also a search tool to help you locate a specific POD if you have a large number of PODs in your system.
Show Picture
Adding a Provisioning Object Definition
Click + NEW PROVISIONABLE OBJECT to display the dialog for adding a POD.
Show Picture
Enter a Name, Code and Description.
Code
Code basically replaces the SKU’s Service Ordering Code (USOC). It typically comes from the endpoint you’re provisioning to, and is used to understand what to provision. Some endpoints may not have a code. For example, Metaswitch does not need one. In that case you can use the CostGuard product catalog SKU.
Then use the PROPERTY DEFINITION and ASSOCIATIONS tabs to add properties and associate the POD to one or more SKUs.
Adding Property Definitions
On the PROPERTY DEFINITION tab click + ADD DEFINITION. This adds a blank row. Enter:
Name – Property name
Type – Select a data type (Integer, Text, List, etc…) from the drop down menu.
Notes:
The List data type lets you select a global or user-defined List as a source to populate the property value. When you select List, a second drop down menu is presented for selecting the List.
Show Picture
See below for guidelines when adding a Variable type property.
Default Value – This is optional. If you specify a default, it sets the initial value on the order. You can change the value on the order as needed if the property is set to Visible; otherwise, the value is fixed and cannot be changed. If no default is specified, the property should be set to Visible so a value can be entered on the order.
Always Required – This determines whether or not the property requires a value. Note: If the property applies to one action that may be applied to the SKU (e.g. Disconnect), but is not applicable to others (e.g. Activate), do not make the property Required.
Always Visible – This determines whether or not users can see and edit the property on the Order. If you choose to make the property not visible, the value must be specified in the Default Value field.
Advanced Options – This lets you make the Property Definition required and/or visible based on one or more selected transitions. To display the Advanced Options dialog click the corresponding button on the right side of the New Provisionable Object dialog.
Show Picture
The Advanced Options dialog lets you choose to use the global Always Required and Always Visible as described above, or base these parameters on one or more selected transitions.
Show Picture
Note
You need to save twice. Click OK on the Advanced Options dialog, and then save the POD.
In the example below, the Business Group property is a Text field with no Default Value. The field is not required and will be visible on the Order to let users enter a value as needed.
Show Picture
Associating SKUs
Note
The POD must be saved (click SAVE) before you can associate SKUs. To associate one or more SKUs to the POD, click the ASSOCIATIONS tab. Then click +ADD ASSOCIATIONS. This displays a dialog for navigating the Product Catalog to find and select one or more SKUs to associate to this POD.
Show Picture
Guidelines for Variables
When you add a Variable property, you can choose an existing Variable, or create a new Variable on-the-fly.
Show Picture
When you add a new Variable here, you can complete nearly all of the definition, except that you’ll need to go back to MANAGE > Variables to manage the SKU Associations.
Variable Parameter Considerations:
The Default Value is only used if none of the outcomes defined on the Variable match. If no matching SKUs are assigned to the service, the system will assign the default value. For example, if no Voicemail MRCs are assigned to the order, set the Voicemail parameter to False.
The Always Visible check box is disabled to ensure the Variable is not displayed on Orders to prevent users from altering it.
Editing a POD
Clicking on a POD name on the Provisionable Objects page displays the POD details. The details view has the same two tabs for managing properties and SKU associations. From the PROPERTY DEFINITIONS tab you can add new properties, edit an existing property definition or delete an existing property by hovering the mouse over it and clicking the red X.
Show Picture
From the ASSOCIATIONS tab you can add or remove SKU associations as needed.