Set up Platform Manager for licensing

This section explains how Platform Manager uses its AMC access. Platform Manager can create ARIDs and work with new and existing ULMs to assign and allocate AMC license parts.

Register AMC credentials

You must obtain a set of AMC API credentials. These are different from your AMC account credentials, but are tied to your AMC account.
Supply the following information when performing initial configuration of the Platform Manager.

  • AMC oAuth credentials for a Service Provider's hosted account. All ARIDs created by Platform Manager are stored under this account.

  • Default Service Provider master Customer Name. Unless otherwise indicated, all ARIDs created by Platform Manager will be stored under this account.

Partition ARIDs by customer

In your AMC account, you are traditionally encouraged to partition your ARIDs by Customer, where Customer is typically the end-user of the license. In the Platform Manager license model, the AMC Customer is Platform Manager. and so Platform Manager holds all Platform Manager-created ARIDs.

Platform Manager places all ARIDs it creates into the AMC Customer that you configure on the Platform Manager AMC Account page.
The one exception to this is that for MiCollab Multi-Tenant instances, Platform Manager creates ARIDs under the customer that owns the ULM. If Platform Manager created the ULM, then the ULM will be under this AMC Customer. If the ULM was not created by Platform Manager, then any MiVoice Business ARIDs created by Platform Manager for this ULM will be created under the AMC Customer that owns the ULM.

In the AMC Account for which you have AMC API credentials:

  1. Create a customer.

  2. Assign the new customer an account ID and name (e.g. name=MyCustomerPM).

  3. On the Platform Manager AMC Account Configuration page, enter this Customer name (that is, MyCustomerPM).

Register AMC sales orders

Platform Manager creates instances of Mitel product. To do this, Platform Manager generates ARIDs and assigns parts. Platform Manager searches for available parts from the AMC License Bank Sales Order numbers that you have registered with Platform Manager.

Obtain one or more Sales Order numbers and add them to Platform Manager using the Platform Manager > Configuration > AMC Account web panel. After registering Sales Orders, you will be able to view the aggregate total of all parts available to Platform Manager.

Platform Manager licensing models

  • Global AMC customer: The Service Provider has one AMC Customer for use by Platform Manager. This AMC Customer will be used to manage licenses of resources controlled by Platform Manager.

  • UCC License Manager (ULM): Using the AMC API, Platform Manager creates ARIDs, DLMs, and ULM records.

  • UCC License Manager per MiCollab: Place every MiCollab server, shared or dedicated, into its own unique ULM. Place the ARIDs of all MiVoice Business instances into the ULM of the MiCollab to which it is associated.

  • Designated License Manager (DLM): A DLM enables an administrator of a group of MiVoice Business instances to move user license parts among the group members. This is done using the MiVoice Business System Administration Tool.

There are two parts to creating a DLM:

  • On AMC, a DLM group ARID is created and all member MiVoice Business ARIDs are added to the DLM.

  • MiVoice Business Programming is required. You need to program the DLM ARID number into the MiVoice Business instance that you are designating as license manager. In the System Administration Tool, navigate to Licenses > Application Group Licensing.

Note

Designated License Manager (DLM) capabilities are not completely supported at this time. If you are using DLMs, Platform Manager prevents the creation of a Blueprint using certain Platform Manager features.

Building ARIDs

For any Platform Manager resource, define its corresponding ARID needs in blueprints. Unallocated licenses are held in purchase/sales records in the license bank of the AMC account. When a resource needs an ARID, Platform Manager does the following:

  • Determines parts requirements from the Platform Manager blueprint. The blueprint has lists of AMC part numbers. Platform Manager has no AMC part knowledge. Platform Manager does not validate the appropriateness of parts; this is done by the AMC.

  • Searches through all (or a filtered subset) purchase and sales records in the license bank to find the parts needed.

  • Creates an ARID and assigns licenses from the license bank.

  • On created ARIDs, Platform Manager adds a verbose ARID description, including product name, Platform Manager platform ID, and resource ID.

  • If the ARID type is ULM or DLM, Platform Managers adds this information to the ARID description.

  • Adds the MiVoice Business ARID to the ULM of the associated MiCollab.

  • Fails if insufficient part quantities are found in the license bank.

How Platform Manager builds an ARID

The ARID needed for a platform resource is defined in blueprints. Unallocated licenses are held in purchase or sales records in the AMC account license bank.
When a resource needs an ARID, Platform Manager does the following:

  • Determines parts requirements from the Platform Manager Blueprint. The Blueprint contains lists of AMC part numbers. Platform Manager has no knowledge about AMC parts, so it cannot validate appropriateness of parts—this is done by the AMC.

  • Crawls through all (or filtered subset) purchase/sales records in the license bank to find the required parts.

  • Creates the ARID and assigns licenses from the license bank.

  • Adds a verbose description on created ARIDS, includin product name, Platform Manager platform ID, and resource ID.

  • Shows the ARID type (ULM or DLM) in the ARID description.

  • Adds the MiVoice Business ARID to the ULM of the associated MiCollab.

Creation of a new Platform fails if there are insufficient quantities of parts available in the license bank.

Deleting ARIDs

When deleting a platform instance, ARID cleanup is done before resource instance deletion, as follows:

  • Remove unallocated group parts from the ULM and return them to the original purchase/sales reference license bank record. Any failures are logged, but failures do not block deletion of the platform instance.

  • Remove assignments of any parts from the ARID, returning them to the original purchase/sales license bank record. Base parts cannot be unassigned and will fail. Any failures are logged but will not block instance delete.

  • Clear the hardware ID. If this operation fails, deletion of the instance does not continue and the resource instance remains in place. You can retry the delete operation, if necessary. Platform Instance deletion succeeds only when the hardware ID has been cleared.

Note

Do not delete empty Sales Orders from Platform Manager. Parts returned to the license bank are returned to their original Sales Order. As long as the original Sales Order is registered with Platform Manager, parts will be available for reuse

How Platform Manager deletes ARIDs

When Platform Manager deletes a platform instance, it does an ARID clean-up before the resource instance is deleted. This clean-up includes:

  • De-allocates group parts from the ULM and returns them to the original purchase/sales license bank record. Failures are logged, but do not block deletion of instances.

  • Un-assigns parts from ARIDs, and returns them to the original purchase/sales license bank record. Base parts cannot be unassigned and will fail with a log message. Failures are logged, but they do not prevent the instance from being deleted.

  • Clears the hardware ID. If Platform Manager cannot clear the hardware ID, the instance deletion is abandoned, and the resource instance remains in place. You can retry the deletion, if necessary. Deletion succeeds only when the hardware ID has been cleared.