.. _intro-ms-operator-connect: Microsoft Operator Connect management in Automate ---------------------------------------------------- .. _21.4-PB2|VOSS-1150: .. _25.1|EKB-24226: .. tip:: :ref:`use-action-search-to-navigate-automate` Overview ......... This feature provides support for Microsoft Operator Connect in Automate, allowing service providers to manage the numbers that customers can order from them, from within Automate. Data is synced between 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 Automate via the service provider's Operator Connect tenant that is set up in Automate. Automate supports the following MS Operator Connect management features: * Customer onboarding * Pushing numbers via the service provider's Operator Connect APIs to their customer tenants and into the service provider's Session Border Controller (SBC) infrastructure * Removing numbers * Removing customers Providers use the MS Operator Connect functionality in Automate only when they're providing Operator Connect numbers to customers. Operator Connect support in Automate is intended as an additional feature, alongside the MACDs and other Microsoft capabilities, for those service providers offering additional services. The workflow for MS Operator Connect is as follows: 1. The admin user adds an Operator Connect tenant at the Provider level, which also creates a number of default syncs in the Admin Portal. 2. The admin user initiates a test connection on the Operator Connect tenant. 3. The admin user can initiate a sync on the Operator Connect tenant to import data from the Operator Connect tenant. Imported data is automatically moved from Provider level to Customer level: * When the imported data is added (based on the Tenant ID configured for each Customer in ``relation/MicrosoftTenant``) * When imported data is updated (based on the Tenant ID configured for each Customer in ``relation/MicrosoftTenant`` for any data that was previously at the Provider level). MS Operator Connect functionality in Automate: * View and update the partner consent status, at Provider or Customer level. See :ref:`partner-operator-consent` * View a list of calling profiles at the Provider level. See :ref:`calling-profiles` * View a list of number usage capabilities at the Provider level. See :ref:`number-usage-capabilities` * View a list of previously ordered numbers, at Provider or Customer level. See :ref:`number-order-history` * View a list of previously released numbers, at Provider or Customer level. See :ref:`number-release-history` * Add or remove numbers and number ranges, at the Customer or Site level. See :ref:`upload-number-range` and :ref:`operator-connect-numbers` .. rubric:: Related Topics * :ref:`operator-connect-tenant` * :ref:`partner-operator-consent` * :ref:`operator-connect-numbers` * :ref:`number-order-history` * :ref:`operator-connect-customer-build` .. _operator-connect-tenant: Operator Connect tenant ........................... Creating an Operator Connect tenant in Automate allows for syncing of data between the service provider's Operator Connect tenant on their Operator Connect portal, and Automate. As a service provider, you can create an Operator Connect tenant in 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 Automate Admin Portal. .. note:: Default syncs are created in Automate for adding and updating data from your Operator Connect tenant on the Operator Connect portal. See :ref:`operator-connect-default-data-syncs` 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. .. image:: /src/images/operator-connect-tenant.png .. rubric:: Related topics * :ref:`intro-ms-operator-connect` * :ref:`operator-connect-default-data-syncs` * :ref:`partner-operator-consent` Add an Operator Connect tenant '''''''''''''''''''''''''''''''''' This procedure adds the Operator Connect tenant and creates the default data syncs. 1. In the Automate Admin Portal, log in as Provider admin, then go to the **Operator Connect Tenant** page. 2. Choose the Provider hierarchy. .. note:: You can only add a tenant for Operator Connect at the Provider level. 3. 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. 5. Click **Save** to add the new tenant, and wait for the transaction to complete. 6. Click **Action > Test Connection** to verify that the tenant can connect to Azure. 7. 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: Operator Connect default data syncs '''''''''''''''''''''''''''''''''''''''' When adding an Operator Connect tenant, a number of default data syncs are added to Automate for retrieving data from the Operator Connect tenant. To view these data syncs, go to the **Data Sync** page. .. 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: .. tabularcolumns:: |p{7cm}|p{8cm}| +-----------------------------------+-------------------------------------------------------------+ | 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 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 the **Partner Operator Consent** page. 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. .. rubric:: Related topics * :ref:`intro-ms-operator-connect` * :ref:`operator-connect-tenant` * :ref:`operator-connect-default-data-syncs` View partner operator consents '''''''''''''''''''''''''''''''''''' 1. Log in to the Admin Portal at the Provider or Customer level hierarchy. 2. Go to the **Partner Operator Consent** page. 3. 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. .. image:: /src/images/partner-operator-consents.png The table describes the columns on the **Partner Operator Consent** page list view: .. tabularcolumns:: |p{5cm}|p{10cm}| +---------------------------+-------------------------------------------------------------+ | 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 | | +---------------------------+-------------------------------------------------------------+ 4. 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 :ref:`update-consent-relationship-status`. All other values are read-only on this page. .. rubric:: Related topics * :ref:`operator-connect-customer-build` .. _update-consent-relationship-status: 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. 1. Log in to the Admin Portal at the Provider or Customer hierarchy. 2. Go to **Partner Operator Consent**. 3. In the summary list, click on a relevant row. .. image:: /src/images/partner-operator-consents-edit.png 4. Click the down-arrow at **Relationship Status**, then select a new value. 5. Save your change. .. _operator-connect-numbers: Numbers (for MS Operator Connect Tenants) ............................................. Numbers belonging to your customers are initially synced in to 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 the Operator Connect **Numbers** page. .. note:: Automate supports import up to a maximum of one thousand (1000) numbers in total from the Operator Connect tenant. .. image:: /src/images/operator-connect-numbers.png Once numbers are synced in, a number inventory entry is added to the Automate **Number Inventory**. When adding a new number or number range (via the :ref:`upload-number-range` menu) from the Operator Connect tenant, at the customer or site level: * An inventory instance is added to the 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 :ref:`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. .. image:: /src/images/operator-connect-numbers-in-number-inventory.png .. rubric:: Related topics * :ref:`upload-number-range` .. _number-order-history: 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 the **Number Order History** page, 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. .. image:: /src/images/number-order-history.png .. _number-release-history: 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 the **Number Release History** page, 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: 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 :ref:`operator-connect-customer-build`. .. note:: Once you start ordering numbers, you can edit the number range, if required. Upload a number or number range '''''''''''''''''''''''''''''''''' This procedure uploads a new number or a new number range. 1. In the Admin Portal, go to the **Upload Number Range** page. #. 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. 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 **Type of Service**, select the type of service. Options are: * Geographic * Toll Free * Mobile * No Selection #. 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 Automate Number Inventory, as described in :ref:`operator-connect-numbers` * Will display in the **Number Order History** list view (see :ref:`number-order-history`), from where you can track it. .. rubric:: Related topics * :ref:`operator-connect-numbers` * :ref:`number-order-history` .. _release-number-range: 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. Refer to :ref:`operator-connect-customer-build`. Remove a number or range of numbers ''''''''''''''''''''''''''''''''''''''' This procedure removes a number or a range of numbers from a customer. 1. In the Admin Portal, go to the **Release Number Range** page. 2. Set the hierarchy to the relevant customer. .. image:: /src/images/release-number-range.png 3. Choose the customer name from the drop-down. 4. 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. 5. 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. 6. 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. .. rubric:: Related topics * :ref:`operator-connect-numbers` .. _calling-profiles: 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 the **Calling Profiles** page, then click on a calling profile in the list to view its details. .. _number-usage-capabilities: Number usage capabilities ............................ 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 the **Number Usage Capabilities** page, then click on an item in the list view to inspect its details. .. image:: /src/images/number-usage-capabilities.png .. _operator-connect-customer-build: Onboard customers for Operator Connect using the Customer Build Tool ..................................................................... You can add customers for Operator Connect using the Customer Build template tool. .. note:: 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. .. image:: /src/images/customer-build-tool.png .. rubric:: To create and onboard a customer for Operator Connect: 1. Log in to the Admin Portal, and set the hierarchy to *Reseller*. 2. Go to **Customer Build**. 3. Fill out the tenant ID. 4. 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) 5. 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. 6. 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 the **Upload Number Range** page. 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. 7. Choose a build action, in this case, Add, then save to trigger the workflow. The table describes the available customer build actions: .. tabularcolumns:: |p{5cm}|p{10cm}| +-------------------------------+-----------------------------------------------------------------------------------------------------------------+ | 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, then select the new customer from the hierarchy picker to view the numbers | | | added for this customer and the specified ranges. | | | * Go to the **Number Order History** page 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 the **Number Inventory** page. 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 on the **Customers** page. 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. .. rubric:: Related topics * :ref:`create-a-customer`