Configure a Design and Assign function example
This example demonstrates how you can create and configure a playbook to design and assign a network service in the Telecommunications Network Inventory application.
Example overview
Consider you have an order requests from a customer to fulfill a network service that must create Optical Network Terminals (ONT) for a specified location. To design and assign this network service, you must capture the ONT details such as an ONT site and equipment template details. By creating and configuring a playbook for the Design and Assign function, you can automate these tasks by following step-by-step guidance for designing the network service.
As a playbook admin, you create and configure the playbook to design and assign your inventory for the network service. The playbook contains the following activities to create the ONT device.
- Setup Network Service - Collects service details of your design request.
- Capture ONT Details - Capture the ONT site and inventory template details to instantiate the equipment.
- Review and Submit - You review the activity details and creates the ONT devices for the specific location according to the template.
As a part of this playbook workflow, you automate the following.
- Creates a change request for the ONT design.
- Creates change tasks for the activities such as capturing ONT details.
- Execute the change tasks to instantiate the equipment using an inventory template.
As a playbook agent, you can fulfill your customer orders and requests for the network service by using this Design and Assign function.
Prerequisites
Prior to creating a playbook, as an inventory core admin, you create and configure the following.
- Create a Change model and add model states.
| Item | Description |
|---|---|
| Change model name | Set name as Network Service Automated Flow. |
| Model state | Add the following model states and set the model state transitions.- Design in progress Set model state transition to Design complete.
Set model state transition to Closed.
Don't set any model state transition for this state. Note: You must add Allow CI Modification attribute to the Design in progress and Design complete model states. |
To learn more about the detailed steps, see [Create a Change Model for Design and Assign function](create-change-model-design-assign-playbook.md).
- Create a record producer to capture the ONT input details such as ONT site and inventory template. This record producer is used in the second activity in the playbook.
| Item | Description |
|---|---|
| Record producer |
|
To learn more about the detailed steps, see [Create a record producer for the Design and Assign function](create-record-producer-design-assign-playbook.md).
- Add variables to the record producer.
| Item | Description |
|---|---|
| Variable 1 | Set the following details for Variable 1.- Set the Type field as Reference. - On the Question tab, set the Question field as ONT site. - On the Specification tab, set Reference field as Network Site [cmdb_ci_ni_site]. |
| Variable 2 | Set the following details for Variable 1.- Set the Type field as Reference. - On the Question tab, set the ONT Template field as ONT site. - On the Specification tab, set Reference field as Inventory Template [sn_ni_core_inventory_template]. |
To learn more about the detailed steps, see [Create variables for Design and Assign function](create-variables-record-producer-design-assign-playbook.md).
Select DA common variables as a variable set to the record producer.
To learn more about the detailed steps, see Add variable set to the record producer for Design and Assign function.
Create a subflow for the request definition that you use to configure the second activity in the playbook.
| Item | Description |
|---|---|
| Subflow name | Set the subflow name as Capture ONT Details. |
| Input fields | Add the following input fields for the subflow.- Set Label as Ignore Validation Error and the Type as true/false for input 1. - Set Label as Change task and the Type as Reference.Change Task for input 2. |
| Actions | Add the following actions to the subflow.- Add the Get Catalog Variable action to read the details from the record producer. - Add the TNI Create CI from Template action to create the equipment from the inventory template. - Add the Update Record action to update the equipment to the affected Configuration Items (CI) |
To learn more about the detailed steps, see [Create subflow for Design and Assign function](create-subflow-design-assign-playbook.md).
- Create a request definition that you use to configure the second activity in the playbook.
| Item | Description |
|---|---|
| Request definition name | Set the following details for the request definition.- Set the request definition name as Capture ONT Details. - Set the Task type field as Change Task. |
To learn more about the detailed steps, see [Create subflow for Design and Assign function](create-subflow-design-assign-playbook.md).
Creating and configuring a playbook
As a playbook admin, you create and configure the playbook for the Design and Assign function in the Workflow Studio. For the detailed information about the following steps, see Create a playbook for the Design and Assign function.
- Create a playbook and set the name as Design Network Service.
- Add and configure your trigger.
| Item | Description |
|---|---|
| Additional properties window | On the Schedule tab, set the following details for the trigger.- Set the Define your own conditions for when your process runs as Create Record. - Set trigger condition as Network Service Automated Flow Change model. You configure additional property to trigger the playbook when a change request is created using the Network Service Automated Flow Change model. |
- Create a stage and add activities such as Setup Network Service, Capture ONT Details, and Review and Submit.
- Create and configure the Setup Network Service activity.
| Item | Description |
|---|---|
| Add activity | Select the Display Form default activity. |
| Details tab | Rename the activity as Setup Network Service. |
| UI Layout tab | Set the following details in the UI Layout tab.- Set the Associated table field as Chang Request. - Set the Associated record field as Flow DataTrigger - change_request > change_request Record - Set the Experience Status Table field as Flow Data. - Set the Experience Status Record field as Automation plan > Create Flow Data > Outputs > Flow Data Record. - Set the Form View field as Playbook. |
2. Create and configure the Capture ONT Details activity.
| Item | Description |
|---|---|
| Add activity | Select the Auto Create Change Task default activity. |
| Details tab | Rename the activity as Capture ONT Details. |
| Automation tab | Set the following details in the Automation tab.- Set the Request Type field as Capture ONT Details. The Capture ONT Details is the request definition that you created. - Set the Record Producer field as Capture ONT Details. - Set the Change Request field as Flow DataTrigger - change_request > change_request Record |
| UI Layout tab | Set the following details in the UI Layout tab.- Set the Associated table field as Chang Task. - Set the Associated record field as Automation plan > Create Change Task Data > Outputs > Change Tasks. - Set the Experience Status Table field as Flow Data. - Set the Experience Status Record field as Automation plan > Create Flow Data > Outputs > Flow Data Record. - Set the Form View field as Playbook. |
3. Create and configure the Review and Submit activity.
| Item | Description |
|---|---|
| Add activity | Select the Display Form default activity. |
| Details tab | Rename the activity as Review and Submit. |
| UI Layout tab | Set the following details in the UI Layout tab.- Set the Associated table field as Chang Task. - Set the Associated record field as Automation plan > Create Change Task Data > Outputs > Change Tasks. - Set the Experience Status Table field as Flow Data. - Set the Experience Status Record field as Automation plan > Create Flow Data > Outputs > Flow Data Record. - Set the Form View field as Playbook. |
4. Select **Save and close**.
- Select Activate.
The following example shows the playbook that you created and configured in the Workflow Studio.
Playbook in Workflow Studio with the list of activities.
Adding playbook to home page
You add the sys_id of the Network Service Automated Flow Change model in the sn_ni_ws.tni_design_assign_chg_models record. To learn more about the detailed steps, see Update system property to configure the Design and Assign home page.
Using a Design and Assign function
As an agent, you use the playbook for the Design and Assign function to fulfill the requirement of the network service by following the steps.
- Navigate to Workspaces > Network Inventory Workspace.
- Select the design and assign icon (
Design and Assign Icon\) to open the Design and Assign home page.
- On the Design Assign home page, select New > Network Service Automated Flow.
- Complete the activities on the playbook to design and assign your network service.
This process creates an ONT device based on the template and site that you selected in the playbook activity.
The following example is the Design and Assign function that you created.
Playbook view with the list of activities
Parent Topic:Configuring Design and Assign function for your network services
Related topics
Configuring Design and Assign function for your network services