This feature provides support for Microsoft Operator Connect in VOSS Automate, which allows service providers to manage the numbers that customers can order from them, from within VOSS Automate.

Data is synced between VOSS Automate and the service provider's Operator Connect portal to automate the process of setting up customers, and the ordering and assignment of numbers.

Service provider customers log in to their Operator Connect portal to order numbers. These requests are sent to the service provider's Operator Connect portal as Customer Consents, which are synced in to VOSS Automate via the service provider's Operator Connect tenant that is set up in VOSS Automate.

Providers use the MS Operator Connect functionality in VOSS Automate only when they're providing Operator Connect numbers to customers. Operator Connect support in VOSS Automate is intended as an additional feature, alongside the MACDs and other Microsoft capabilities, for those service providers offering additional services.

Creating an Operator Connect tenant in VOSS Automate allows for syncing of data between the service provider's Operator Connect tenant on their Operator Connect portal, and VOSS Automate.

As a service provider, you can create an Operator Connect tenant in VOSS Automate at the Provider level in the hierarchy, and add the details to connect to your Operator Connect tenant.

Once you've added the tenant, you can test this connection, then initiate a sync to import data, using the default data sync that is created when saving the new Operator Connect tenant in the VOSS Automate Admin Portal.

Imported data is automatically moved from the sync-in level (Provider) to the Customer level, when data is added or updated, based on the Tenant ID configured for each Customer in relation/MicrosoftTenant. For updated data, this is also based on any data that was previously at the Provider level.

Add an Operator Connect Tenant

This procedure adds the Operator Connect tenant and creates the default data syncs.

In the VOSS Admin Portal, log in as Provider admin, then go to (default menus) MS Operator Connect Management > Operator Connect Tenant.
Choose the Provider hierarchy.

Note

You can only add a tenant for Operator Connect at the Provider level.
In the list view, click the Plus icon (+) to add an Operator Connect tenant, then fill out the following details for the new tenant:
- Fill out a name (mandatory), and a description (optional).
- (Mandatory) Fill out the client ID (application ID) from the Azure AD app registration portal.
- (Mandatory) Fill out the tenant ID (directory ID) from the Azure AD app registration portal.
- (Optional) Fill out the client secret previously created in the Azure AD app registration portal.
- (Optional) Fill out the details of the Microsoft proxy and the Microsoft secure proxy.

Click Save to add the new tenant, and wait for the transaction to complete.
Click Action > Test Connection to verify that the tenant can connect to Azure.
Click Action > Sync to import data.
- Default syncs are added.
- Imported data is automatically moved from the Provider level to the Customer level (based on the tenant ID configured for each customer (in relation/MicrosoftTenant).
Note

In subsequent syncs, previously imported data may be updated based on the tenant ID configured for each customer (in relation/MicrosoftTenant), for any data that was previously at the Provider level.

Operator Connect Default Data Syncs

When adding an Operator Connect tenant, a number of default data syncs are added to VOSS Automate for retrieving data from the Operator Connect tenant.

To view these data syncs, go to (default menus) Administration Tools > Data Sync.

Note

In the Data Sync list view, type all or part of the phrase Operator Connect in the Name column or the Device Type column to filter the list for only the data syncs relevant to Operator Connect.

The default data syncs for Operator Connect simplify scheduling; that is, you can add a schedule at any time, and use the default data syncs.

The table describes the default data syncs for Operator Connect:

OperatorConnect Sync Type	Description
`SyncMSOperatorConnect`	A full pull sync that syncs in all data.
`SyncMSOperatorConnectNumber`	Contains a model type list that syncs in just numbers.
`SyncPartnerOperatorConsents`	Syncs in new or updated partner consents.
`PurgeMSOperatorConnect`	A purge sync that removes all locally synced data from the Automate database.

Partner Operator Consent

Partner operator consents define the progress of a service provider's relationship with their customer. For example, when the customer first contacts the service provider, the partner consent status is set to Customer Contacted.

You can view and manage partner consent statuses for your customers (at Provider or Customer level), via (default menus) MS Operator Connect Management > Partner Operator Consent.

Provider or customer-level partner operator consents are initially synced in from the MS Operator Connect portal to Automate once you add the Operator Connect tenant and run a full pull sync. Thereafter, you can run a SyncPartnerOperatorConsents sync to sync in only new or updated partner consents.

Related Topics

Introduction to MS Operator Connect
Operator Connect Tenant
Operator Connect Default Data Syncs

View Partner Operator Consents

Log in to the Admin Portal at the Provider or Customer level hierarchy.
Go to (default menus) MS Operator Connect Management > Partner Operator Consent.
In the summary list, view the list of existing partner operator consents:

Note

The list of partner operator consents can also be viewed via the MS Operator Connect portal.

The table describes the columns on the Partner Operator Consents page list view:

Column	Description
Tenant ID	Unique tenant IDs for each of the end customers. Once the tenant ID is matched to a customer, all new or updated details for the consent is moved to the relevant customer. Each of the service provider's customers are associated with a unique tenant ID that displays in both the VOSS Automate Admin Portal and on the MS Operator Connect portal. This is the tenant belonging to the end customer, and you can use this tenant ID to onboard the customer with the Customer Build tool in VOSS Automate, and add the tenant ID to the tenant so that when you sync in data, the system associates the data with the customer's tenant ID so that the data is moved to the appropriate customer.
Latest Consent Status	Status of the latest consent.
Consented On	Date of latest consent.
Relationship Status	The currently configured relationship status, in the order history, for the consent (last synced in from the API), for example: Consent Acknowledged Customer Contacted - the first time the customer contacts you Agreement Signed Consent Declined Contract Terminated
Comment	Notes for the consent.
Last Modified On	The last time the consent was updated.
Product Context	The product associated with the partner consent.
Located At	The hierarchy level, either Provider or Customer. Since the tenant is first added at Provider level, the first sync pulls in the consents initially to the Provider level. Once you start provisioning and adding customers, the consents are moved to the relevant customer level.
Device

Click on a row in the list view to view more details for the customer and the associated partner consent.

Note

The only change you can make to a partner consent in the management page is to update the relationship status. See Update Partner Operator Consent Relationship Status.

All other values are read-only on this page.

Update Partner Operator Consent

The only change you can make to a partner consent in the Admin Portal's Partner Operator Consent management page is to update its relationship status.

Log in to the Admin Portal at the Provider or Customer hierarchy.
Go to (default menus) MS Operator Connect Management > Partner Operator Consent.
In the summary list, click on a relevant row.
Click the down-arrow at Relationship Status, then select a new value.
Save your change.

Numbers (for MS Operator Connect Tenants)

Numbers belonging to your customers are initially synced in to VOSS Automate from the Operator Connect portal, at the Provider level. Once you add customers and start start provisioning and syncing, the numbers are moved to the relevant customers, based on their unique tenant IDs.

You can view the numbers associated with your Operator Connect customers, including the level where the numbers exist (Provider or Customer level) via (default menus) MS Operator Connect Management > Numbers.

Once numbers are synced in, a number inventory entry is added to the VOSS Automate Number Inventory (accessible via, default menus, Number Management > Number Inventory).

When adding a new number or number range (via the Upload Number Range menu) from the Operator Connect tenant, at the customer or site level:

An inventory instance is added to the VOSS Automate number inventory (data/InternalNumberInventory) for each number in the range.
If this is a new number, or if the number already exists in the number inventory, the internal number type on the directory number is set to "OperatorConnect".
No SBC provisioning occurs.

When removing a number or number range from a customer or site (via Release Number Range):

The inventory instance for each number is removed from the number inventory, if the number is in state, Available.
If the directory number is not being deleted, then "Operator Connect" is removed as its internal number type .
No SBC provisioning occurs.

Related Topics

Upload Number Range

Number Order History

The Number Order History page displays a record of the number ranges and individual numbers your customers have ordered.

You can view the number order history via (default menus) MS Operator Connect Management > Number Order History, then click on a number to view its order history details.

Note

In the list view, numbers are sorted in the list view from earliest to latest.
The value for Product Context is read-only.

Number Release History

The Number Release History page displays the history of numbers that have previously been released. Number release history is synced in at the Provider level until you've added customers, and started syncing and provisioning. The release history can be viewed at the relevant customer level once you add the customer and make changes in the provisioning.

You can view the number release history via (default menus) MS Operator Connect Management > Number Release History, then click on a number to view its release history details.

Note

In the list view, numbers are sorted in the list view from earliest to latest.
The value for Product Context is read-only.

Upload Number Range

The Upload Number Range feature allows you to add a new number or new number range.

Note

Data is provided via a view that is integrated with the customer build tool. The customer build step calls the Upload Number Range tool to perform provisioning and ordering, and adds or updates directory numbers based on the specified range values so that SBC provisioning forms part of the customer build tool. See Onboard Customers for Operator Connect using the Customer Build Tool.

Note

Once you start ordering numbers, you can edit the number range, if required.

Add a Number or Number Range

This procedure uploads a new number or a new number range.

In the Admin Portal, go to (default menus) MS Operator Connect Management > Upload Number Range.
Set the hierarchy to the relevant customer or site.
At the Tenant field, choose the customer name.

Note

At the time of writing (for 21.4-PB2), since you're at the relevant customer level, the customer's name is the only available value to select from the drop-down. However, auto-populating the Tenant field with the customer name is reserved for future development, so for now, you'll need to select the customer name from the drop-down.
Choose a calling profile.
At Usage, select the calling user assignments (one or more).

Note

Once the number is provisioned to the end-customer, this value restricts or defines how the number can be used, for example, Mobile and/or InboundCalling, and/or OutboundCalling.
At Start Telephone Number, fill out the number that should be ordered, for example, +91868416580. If you're ordering a range of numbers, the starting telephone number should have an X at the end, for example, +9186841658X
At Range, fill out the range value.

Note

To order just one number, use 1, or for a range of 10 numbers, beginning with the first number you specified in the previous step, use 10, and so on.

You can specify a range from 1 to 1000. For example, to order a range of 10 numbers with starting telephone number, +9186841658X, fill out a range value of 10, to order numbers from +91868416580 to +91868416589 (0-9).
If you're using civic addresses (for emergency calling), you can select the civic address specified on the Operator Connect tenant. Choosing a civic address associates the number with the civic address.

Note

By default, Allow Tenant Address Update is enabled (set to True), which means you won't need to select a civic address ID.

The drop-down contains valid addresses (for emergency numbers), imported from the MS Operator Connect portal for the associated tenant.
Save your changes to order the number/s.
Note

The number/s you ordered:
- Will be available on the Operator Connect portal.
- Will display in the VOSS Automate Number Inventory, as described in Numbers (for MS Operator Connect tenants)
- Will display in the Number Order History list view (see Number Order History), from where you can track it.

Related Topics

Numbers (for MS Operator Connect tenants)
Number Order History

Release Number Range

The Release Number Range page allows you to remove a number or range of numbers.

Note

Data is provided via a view that is integrated with the customer build tool. See Onboard Customers for Operator Connect using the Customer Build Tool.

Remove a Number or Range of Numbers

This procedure removes a number or a range of numbers from a customer.

In the Admin Portal, go to (default menus), MS Operator Connect Management > Release Number Range.
Set the hierarchy to the relevant customer.
Choose the customer name from the drop-down.
Fill out the telephone number you wish to remove, and the range.
Note
- To remove one number, fill out the number, and specify range as 1.
- To remove a range of numbers, fill out the starting telephone number, and specify a range from 1 to 1000.
At Remove Numbers from Operator Connect Tenant, define whether to also remove the number or number range from the Operator Connect tenant.

Note

By default, Remove Numbers from Operator Connect Tenant is enabled (True). When set to False (unchecked), the provisioning workflow skips the step to remove numbers from the Operator Connect tenant. This is required where, for example, a customer cancels their contract and is off-boarded, and their numbers no longer exist on the Operator Connect tenant. In this case, if Remove Numbers from Operator Connect Tenant is enabled, the transaction will fail if the workflow attempts to remove numbers that no longer exist on the tenant.
Save your changes.

When removing a number or number range from a customer:
- The inventory instance for each number is removed from the number inventory, if the number is in state, Available.
- If the directory number is not being deleted, then "Operator Connect" is removed as its internal number type .
- No SBC provisioning occurs.

Related Topics

Numbers (for MS Operator Connect tenants)

Calling Profiles

MS Operator Connect calling profiles are synced in from the Operator Connect portal, and an admin user can view the list of calling profiles at the Provider level in the Admin Portal.

Note

Calling profiles are always at the Provider level since they're associated with the service provider and not with a specific customer.

To view the calling profiles, go to (default menus) MS Operator Connect Management > Advanced > Calling Profiles.

You can click on a calling profile in the list to view its details.

Number Usage Capabilities

VOSS Automate queries the Operator Connector portal to retrieve and display number usage capabilities, which are imported to, and remain at, the Provider level.

To view imported number usage capabilities, go to (default menus) MS Operator Connect Management > Advanced > Number Usage Capabilities, then click on an item in the list view to inspect its details.

Onboard Customers for Operator Connect using the Customer Build Tool

You can add customers for Operator Connect using the Customer Build template tool.

Note

VOSS Automate's Customer Build tool allows you to add and onboard customers (and their sites, if provided), with defined number ranges, or to update or delete a customer.

Using this tool, you can create a re-usable template of a customer, with all of the provisioning steps required for adding a customer, modeled in the tool. You can set up one or more customer build tools for different types of customers, depending on the provisioning requirements and the type of customer, for example, whether managed or not, or whether they're Cisco-only, Microsoft-only, hybrid, or just require number management, such as Operator Connect customers.

In the Customer Build tool, you can choose the type of customer you wish to build, fill out minimum details for this type of customer, and set up the workflow steps for provisioning.

Please contact VOSS support services if you wish to use the tool and have it exposed in your menus.

To create and onboard a customer for Operator Connect:

Log in to the Admin Portal, and set the hierarchy to Reseller.
Go to (default menus) Customer Management > Customer Build.
Fill out the tenant ID.
Select the customer build type used for Operator Connect (MicrosoftOperatorConnectOnlyCustomer).
Note

The Operator Connect build type allows you to add Operator Connect-only customers, which don't need to be managed since you're only managing numbers.

In this case, you only need to provide the Microsoft tenant name and the tenant ID (customer secrets are not required).

If you wish to use the Customer Build tool for managed customers (direct routing customers), you can choose another customer build type, either of the following:
- CiscoCustomer
- MicrosoftCustomer
- HybridCustomer
- CallRedirectionOnlyCustomer (used for disaster recovery)
At Customer Build Configuration Template, select the customer build configuration template for Microsoft Operator Connect customers, CustomerBuild_StandardMicrosoftOperatorConnectCustomersOnly_CFT, which contains all the steps to allow the standard provisioning.

Note

You can clone and customize this template, if required.
For the provisioning of numbers, add numbers and number ranges.

Note

The SBC may be provisioned with the number ranges you specify in the Number Ranges fields of the customer build tool, or via (default menus) MS Operator Connect Management > Upload Number Range.

When specifying number ranges for Operator Connect customers through the customer build tool, you can choose the default Microsoft Operator Connect usage template (Default_OC_CallingUser_Assignment), which contains the pre-configured number range usage requirements. This template can be cloned and customized for different number ranges, if required.

Numbers are ordered and provisioned once you save and trigger the workflow for the customer build tool.
Choose a build action, in this case, Add, then save to trigger the workflow.

The table describes the available customer build actions:

Customer build action	Description
AddDataOnly
Validate
Add	On-boards (adds) a new customer. Saving the customer build tool with this action selected triggers the customer build workflow, which: Adds the tenant Adds the customer Uploads the selected number range to the Operator Connect tenant Adds directory numbers (DNs) to the customer Provisions the SBC with the numbers and appropriate routing elements. Once the workflow completes, you can: View the new customer in the Customers summary list view. Go to the Numbers page (in the default menu, MS Operator Connect > Numbers), and choose the new customer from the hierarchy picker to view the numbers added for this customer and the specified ranges. Go to (default menu) MS Operator Connect > Number Order History, to view the numbers ordered for the new customer. View directory numbers added to the number inventory for the customer and the specified range (via, default menus, Number Management > Number Inventory). Note that the number status remains Available until the numbers are assigned, and the internal number type is OperatorConnect.
Modify	Updates the customer. Allows the admin to add or release number ranges. In this case, the SBC is provisioned with the ordered or released number ranges, and the DNs are added or removed. For example, if the customer requires additional numbers, you can remove already provisioned number ranges and/or add additional number ranges, then save to trigger the workflow.
DeleteCustomer	Deletes the customer. The workflow is as follows: SBC is configured to remove the number ranges belonging to the customer, as well as number ranges for released numbers. The Microsoft Operator Connect tenant is removed. Customers are removed, as well as any sites added for the customer.
DeletecustomerData	Removes the relation/CustomerBuild_CustomerData_REL instance.
DeleteCustomerAndcustomerData	Runs the Delete steps (as for DeleteCustomer) and removes the relation/CustomerBuild_CustomerData_REL instance.

The new customer is created and saved, and is added to the list of customers under (default menus) Customer Management > Customers. The workflow for setting up the customer executes as described in the table for the Add build action.

The build tool template used for the customer can be viewed and updated (to add or remove numbers or number ranges, for example). Note that removing a number range via the customer build tool will de-provision numbers that were previously provisioned.

Related Topics

Create a Customer

Title		Details
Tn Upload Job Id		Field Name: TnUploadJobId Type: String
	Acquired Capabilities	Field Name: AcquiredCapabilities.[n] Type: Array
	Available Capabilities	Field Name: AvailableCapabilities.[n] Type: Array
Acquired On		Field Name: AcquiredOn Type: String
Calling Profile		Field Name: CallingProfileId Type: String Target: device/msoperatorconnect/CallingProfilesV2 Target attr: Id Format: uri
Iso Country Code		Field Name: IsoCountryCode Type: String
Product Context		Field Name: ProductContext Type: String
Telephone Number		Field Name: TelephoneNumber Type: String
Tenant Id		Field Name: TenantId Type: String

Model: device/msoperatorconnect/Numbers

Microsoft Operator Connect

Add an Operator Connect Tenant

Operator Connect Default Data Syncs

View Partner Operator Consents

Add a Number or Number Range

Remove a Number or Range of Numbers

Model Details: device/msoperatorconnect/Numbers