Default Dial Plan Event Triggers#

In VOSS Automate, you can use one of the default, pre-defined dial plan events to trigger a custom workflow as part of your dial plan schema group.

The default events are located on the Custom Workflow tab, via (default menus) Dial Plan > Dial Plan Schema Group.

Default Dial Plan Event Triggers for Custom Workflows

Dial Plan Event	When Triggered	Notes
preAddSite	When a new site dial plan is deployed, before the Add Dial Plan workflow is executed	For Type 1 to Type 4 schemas, this triggers a Cisco Unified Communications Manager (CUCM) bootstrap workflow that: Updates the CUCM clusterwide “Local Route Group for Redirected Calls” service parameter to the value “Local route group of calling party” Provisions the following clusterwide default local route group names to the CUC: SLRG-Emer, SLRG-FPHN, SLRG-Intl, SLRG-Local, SLRG-Mobl, SLRG-Natl, SLRG-Oper, SLRG-PCSN, SLRG-PRSN, SLRG-Serv, SLRG-SRSN Items in the workflow are executed at the hierarchy node on which the target
		CUCM cluster is added to the VOSS Automate system. Subsequent sites that are added trigger this workflow, but result in an operation that does nothing if these items have already been applied to the target CUCM cluster. The target cluster for this workflow is determined by the CUCM instance that is contained in the Network
		Device List Reference (NDLR) for the site on which this event was triggered.

Dial Plan Event

When Triggered

Notes

preAddSite

When a new site dial plan is deployed, before the Add Dial Plan workflow is executed

For Type 1 to Type 4 schemas, this triggers a Cisco Unified Communications Manager (CUCM) bootstrap workflow that:

Updates the CUCM clusterwide “Local Route Group for Redirected Calls” service parameter to the value “Local route group of calling party”
Provisions the following clusterwide default local route group names to the CUC: SLRG-Emer, SLRG-FPHN, SLRG-Intl, SLRG-Local, SLRG-Mobl, SLRG-Natl, SLRG-Oper, SLRG-PCSN, SLRG-PRSN, SLRG-Serv, SLRG-SRSN

Items in the workflow are executed at the hierarchy node on which the target

CUCM cluster is added to the VOSS Automate system.

Subsequent sites that are added trigger this workflow, but result in an operation that does nothing if these items have already been applied to the target CUCM cluster.

The target cluster for this workflow is determined by the CUCM instance that is contained in the Network

Device List Reference (NDLR) for the site on which this event was triggered.

Dial Plan Event	When Triggered	Notes
addSite	After the Add Site Dial Plan workflow is executed and the context of the new site dial plan is passed	For Type 1 to Type 4 schemas, this triggers a workflow that adds a default location, region, and device pool at the site hierarchy node on which this event is triggered. The target cluster for this workflow is determined by the Cisco Unified Communications Manager (CUCM) instance that is contained in the NDLR for the site on which this event was triggered.
removeSite	Before the Delete Site dial plan workflow is executed and the context of the site dial plan is passed	For Type 1 to Type 4 schemas, this triggers a workflow that removes the default location, region, and device pool at the site hierarchy node on which this event is triggered. The target cluster for this workflow is determined by the CUCM instance that is contained in the NDLR for the site on which this event was triggered.

Dial Plan Event

When Triggered

Notes

addSite

After the Add Site Dial Plan workflow is executed and the context of the new site dial plan is passed

For Type 1 to Type 4 schemas, this triggers a workflow that adds a default location, region, and device pool at the site hierarchy node on which this event is triggered.

The target cluster for this workflow is determined by the Cisco Unified Communications Manager (CUCM) instance that is contained in the NDLR for the site on which this event was triggered.

removeSite

Before the Delete Site dial plan workflow is executed and the context of the site dial plan is passed

For Type 1 to Type 4 schemas, this triggers a workflow that removes the default location, region, and device pool at the site hierarchy node on which this event is triggered.

The target cluster for this workflow is determined by the CUCM instance that is contained in the NDLR for the site on which this event was triggered.

Dial Plan Event	When Triggered	Notes
addVoiceMailPilotNumber	When a new voice mail pilot number is added for a customer	For Type 1 to Type 4 schemas, this triggers a Cisco Unified Communications Manager (CUCM) bootstrap workflow that Creates the voice mail pilot on the target CUCM cluster Creates a voice mail profile on the target CUCM cluster Deploys a custom Cisco Unity Connection schema to provision the following on Cisco Unity Connection: Direct routing rule and forward routing rules based on the new pilot number The target Cisco Unity Connection cluster for this workflow is determined by the Cisco Unity Connection instance contained in the NDLR for the site on which this event was triggered The target cluster for this workflow is determined by the CUCM instance that is contained in the NDLR for the site on which this event was triggered.
removeVoiceMailPilotNumber	When a voice mail pilot number is a customer	The target cluster for this workflow is determined by the CUCM and Cisco Unity Connection instances that are contained in the NDLR for the site on which this event was triggered. For Type 1 to Type 4 schemas, this triggers a workflow that Removes the voice mail profile and pilot number from CUCM Undeploys direct and forward routing rules on Cisco Unity Connection

Dial Plan Event

When Triggered

Notes

addVoiceMailPilotNumber

When a new voice mail pilot number is added for a customer

For Type 1 to Type 4 schemas, this triggers a Cisco Unified Communications Manager (CUCM) bootstrap workflow that

Creates the voice mail pilot on the target CUCM cluster
Creates a voice mail profile on the target CUCM cluster
Deploys a custom Cisco Unity Connection schema to provision the following on Cisco Unity Connection:
- Direct routing rule and forward routing rules based on the new pilot number
- The target Cisco Unity Connection cluster for this workflow is determined by the Cisco Unity Connection instance contained in the NDLR for the site on which this event was triggered

The target cluster for this workflow is determined by the CUCM instance that is contained in the NDLR for the site on which this event was triggered.

removeVoiceMailPilotNumber

When a voice mail pilot number is a customer

The target cluster for this workflow is determined by the CUCM and Cisco Unity Connection instances that are contained in the NDLR for the site on which this event was triggered.

For Type 1 to Type 4 schemas, this triggers a workflow that

Removes the voice mail profile and pilot number from CUCM
Undeploys direct and forward routing rules on Cisco Unity Connection

Dial Plan Event	When Triggered	Notes
associateVoiceMailServiceToCustomer	When voice mail service is associated to a customer	The target Cisco Unified Communications Manager (CUCM) and Cisco Unity Connection clusters for this workflow are determined by the CUCM and Cisco Unity Connection instances that are contained in the NDLR for the site on which this event was triggered.
		For Type 1 to Type 4 schemas, this triggers a workflow that Deploys a SIP trunk to CUCM if voice mail service is partitioned or dedicated Reset the SIP trunk Deploys a route group to CUCM if voice mail service is partitioned or dedicated that contains the SIP trunk created in the previous step Deploys a custom Cisco Unity Connection schema to provision the port group, ports, route partition, calling search space (CSS), and the user template for voice mail service on the Cisco Unity Connection
disassociateVoiceMailServiceFromCustomer	When voice is disassociated from a	The target CUCM and Cisco Unity Connection clusters for this workflow are determined by the CUCM and Cisco Unity Connection instances that are contained in the NDLR for the site on which this event was triggered. For Type 1 to Type 4 schemas, this triggers a workflow that On CUCM, removes Voice Mail service route group and SIP trunk if dedicated or partitioned voice mail service On Cisco Unity Connection, deletes customer-specific route partition, css, user template, ports, and port group.

Dial Plan Event

When Triggered

Notes

associateVoiceMailServiceToCustomer

When voice mail service is associated to a customer

The target Cisco Unified Communications Manager (CUCM) and Cisco Unity Connection clusters for this workflow are determined by the CUCM and Cisco Unity Connection instances that are contained in the NDLR for the site on which this event was triggered.

For Type 1 to Type 4 schemas, this triggers a workflow that

Deploys a SIP trunk to CUCM if voice mail service is partitioned or dedicated
Reset the SIP trunk
Deploys a route group to CUCM if voice mail service is partitioned or dedicated that contains the SIP trunk created in the previous step
Deploys a custom Cisco Unity Connection schema to provision the port group, ports, route partition, calling search space (CSS), and the user template for voice mail service on the Cisco Unity Connection

disassociateVoiceMailServiceFromCustomer

When voice is disassociated from a

The target CUCM and Cisco Unity Connection clusters for this workflow are determined by the CUCM and Cisco Unity Connection instances that are contained in the NDLR for the site on which this event was triggered.

For Type 1 to Type 4 schemas, this triggers a workflow that

On CUCM, removes Voice Mail service route group and SIP trunk if dedicated or partitioned voice mail service
On Cisco Unity Connection, deletes customer-specific route partition, css, user template, ports, and port group.

Dial Plan Event	When Triggered	Notes
addCustomer	When a customer dial plan is added	The target Cisco Unified Communications Manager and Cisco Unity Connection clusters for this workflow are determined by the Cisco Unified Communications Manager and Cisco Unity Connection instances that are contained in the NDLR for the site on which this event was triggered. Currently not used for Type to Type 4 schemas
removeCustomer	When a customer dial plan is removed	The target Cisco Unified Communications Manager (CUCM) and Cisco Unity Connection clusters for this workflow are determined by the CUCM and Cisco Unity Connection instances that are contained in the NDLR for the site on which this event was triggered. Currently not used for Type 1 to Type 4 schemas
updateCustomer	When a customer dial plan is updated	The target Cisco Unified Communications Manager (CUCM) and Cisco Unity Connection clusters for this workflow are determined by the CUCM and Cisco Unity Connection instances that are contained in the NDLR for the site on which this event was triggered. Currently not supported because customer dial plan updating is not supported
updateSite	When a site dial plan is updated	The target Cisco Unified Communications Manager (CUCM) and Cisco Unity Connection clusters for this workflow are determined by the CUCM and Cisco Unity Connection instances that are contained in the NDLR for the site on which this event was triggered. Add the updateSite event with the HcsDpUpdateSiteAreaCodesPWF workflow to update the site dial plan. Currently not supported because site dial plan updating is not supported

Dial Plan Event	When Triggered	Notes
addDnInventory	When an administrator provisions additional specific site	The target Cisco Unified Communications Manager (CUCM) cluster for this workflow is determined by the CUCM instance that are contained in the NDLR for the site on which this event was triggered. If a Type 1 or Type 3 dial plan is provisioned, this executes a workflow that creates directory numbers (DNs) where the extension is prefixed with the Site Location Code of the site on which the event was triggered. If a Type 2 dial plan is provisioned, this executes a workflow that creates DNs where the extension is prefixed with the Intersite Prefix + Site Location Code of the site on which the event was triggered. If a Type 4 dial plan is provisioned, this executes one of the following workflows: Creates DNs where the extension is prefixed with + if the extension entered by the administrator is prefixed with + on the site on which the event is triggered, OR Creates DN with no prefix; the extension on the site on which the event was triggered is used to create the DNs.
associateLboGateway	When a local gateway is associated with a site.	See associateLboGateway Custom Workflow for detailed information.
unassociateLboGateway	When a local gateway is disassociated from a site.	See unassociateLboGateway Custom Workflow for detailed information.

Dial Plan Event

When Triggered

Notes

addDnInventory

When an administrator provisions additional specific site

The target Cisco Unified Communications Manager (CUCM) cluster for this workflow is determined by the CUCM instance that are contained in the NDLR for the site on which this event was triggered.

If a Type 1 or Type 3 dial plan is provisioned, this executes a workflow that creates directory numbers (DNs) where the extension is prefixed with the Site Location Code of the site on which the event was triggered.

If a Type 2 dial plan is provisioned, this executes a workflow that creates DNs where the extension is prefixed with the Intersite Prefix + Site Location Code of the site on which the event was triggered.

If a Type 4 dial plan is provisioned, this executes one of the following workflows:

Creates DNs where the extension is prefixed with + if the extension entered by the administrator is prefixed with + on the site on which the event is triggered, OR
Creates DN with no prefix; the extension on the site on which the event was triggered is used to create the DNs.

associateLboGateway

When a local gateway is associated with a site.

See associateLboGateway Custom Workflow for detailed information.

unassociateLboGateway

When a local gateway is disassociated from a site.

See unassociateLboGateway Custom Workflow for detailed information.