Enduser Setup and companies

What it is for

The Enduser Setup is intended for environments in which an external tool, such as a service portal, orders telephony. The tool sends an order with company, location and user through the Public API. EasyUC looks up the matching configuration and creates in the CUCM what is stored there: desk phone, Jabber clients, device profile, Single Number Reach, voicemail and translation pattern. Delete orders remove the objects again.

For this you assign two things. Companies (Manage Companies) are the tenants that the external tool addresses with a code. Under Config Clusters you connect a CUCM cluster to companies and map every location name of the external tool to an EasyUC location with a package and number ranges. EasyUC takes the number from the stored ranges on its own.

In contrast to automatic provisioning, EasyUC waits here for an order from outside and does not look for new users itself.

Prerequisites

Role ROLE_APP_ADMIN. The interface shows the Administration menu only with this role.
The cucm module is enabled. Without this module the interface locks the page.
An API account for the external tool under Administration → Integrations & Communication → API Access.
The EasyUC locations have packages and number ranges. The location selection shows only locations with a package.
The packages contain templates for all device types that can be ordered.
Company name and company code are agreed with the operator of the external tool, as are the location names it sends.

Step by step: creating a company

Select the EasyUC Cisco workspace in the header.
Open Administration → CUCM & Provisioning → Enduser Setup → Manage Companies. The page is called Companies.
Click Add company. The Create Company dialog opens.
Enter Company Name and Company Code.
Click Create.

Step by step: configuring clusters and locations

Open Administration → CUCM & Provisioning → Enduser Setup → Config Clusters. The page is called Enduser Setup.
Click Config Cluster. The dialog Create an enduser setup opens.
Under CUCM Cluster, select the CUCM connection.
Under Select companies, select the companies that this cluster serves.
In the section Map & Configurations, click configure new location.
Under Associated API Location, enter the location name that the external tool sends.
Under EasyUC Location, select the EasyUC location and then the Package.
Under Number Ranges for auto assignment, select the number ranges for automatic assignment.
With several ranges, define under Number range configuration whether EasyUC fills the ranges one after the other (Pick range order) or uses them alternately (Round robin), and assign the Index for each range.
Click Save & Continue. The next dialog shows the configuration of the location.
Define what an order creates: Enduser Template, IP Phone (model and template), Soft Phones, Device Profile, Single Number Reach, Translation Pattern, Voicemail, Busy Trigger and Send e-mails after job finished.
Under Settings, check the option Use the same phone number if line present.
Click Save.
The configuration then appears in the list. You switch the state config enabled or config disabled with Configuration action → Enable Configuration or Disable Configuration.

Step by step: further locations, companies, e-mails and logs

For an enabled configuration, click Configuration action → Configure new location to map a further API location. The dialog additionally contains Default Language.
Click Configuration action → Update Companies to change the company assignment.
Click Configuration action → Email Notifications. Set Enable, enter recipients and maintain E-mail Subject and E-mail Content separately for creation and deletion. With Preview email content you check the result.
The card of a location offers icons for Configurations, Jobs, Request Logs and Remove location config.
Click Request Logs at the top to see all received orders with Sent At, Status Code, Request and Response.

Fields and options

Fields and options
Field / action	Meaning and use
Company Name / Company Code	Name and short code of the company. EasyUC uses the code to assign an order to the company.
CUCM Cluster	CUCM connection on which the orders of these companies are executed.
Associated API Location	Location name as the external tool sends it in the order.
EasyUC Location / Package	EasyUC location and package whose templates and defaults apply.
Number Ranges for auto assignment	Number ranges of the location from which EasyUC assigns the number.
Pick range order	When all numbers from range 1 are in use, EasyUC uses range 2, and so on.
Round robin	The first number comes from range 1, the next request receives its number from range 2, and so on.
Default Language	Language that EasyUC sets if the order does not specify one.
Use the same phone number if line present	If the user already has a line, EasyUC uses its number for new devices. The number range is then ignored.
Send email notification to the enduser for whom the task was run	Additionally sends the notification to the affected user.
Placeholders in e-mails	Among others `{{firstName}}`, `{{lastName}}`, `{{userID}}`, `{{location}}`, `{{phoneNumber}}`, `{{companyName}}`, `{{companyCode}}` as well as yes/no values such as `{{ipPhoneCreated}}`, `{{windowsCreated}}`, `{{vmCreated}}` and, for deletion, `{{ipPhoneDeleted}}`. The complete list is shown in the dialog.

Checking the result and narrowing down errors

For each cluster the list shows the state, the companies with their code and, for each location, a card with EUC Location, Package and Ranges.
A test order appears under Request Logs with status code and response. The associated job is listed under Jobs on the location card.
The request log shows Enduser Not Found: the user ID from the order does not exist on this cluster.
An order is not assigned to any configuration: Company Code or Associated API Location do not match what the external tool sends.
The entries in the action menu are missing: the configuration is disabled. Only enabling and Delete are then available.
For troubleshooting in real time, use the Live Log; see the chapter “Enduser Setup: live log and sync to the external tool”.