Enduser Setup: live log and sync to the external tool

What it is for

The Enduser Setup works together with an external tool that orders telephony. Two aids make this coupling traceable. The Live Log shows everything the external tool sends to EasyUC, what EasyUC does with it, and every response that goes back to the tool. You see an order from receipt through processing to the reply.

The Sync to external tool goes in the other direction. EasyUC checks every CUCM cluster of the Enduser Setup: which user has a configuration (Jabber, desk phone, device profile) on which cluster, and which location and company it belongs to. EasyUC sends this inventory as JSON in batches to an address you enter. This way the external tool knows the inventory before it triggers orders. The CUCM is only read during this process.

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.
• At least one cluster is configured under Config Clusters.
• For the sync: the address of the external tool that accepts JSON over HTTPS, and the authentication required there.
• The EasyUC system can reach this address on the network.

Step by step: reading the live log

1. Select the EasyUC Cisco workspace in the header.
2. Open Administration → CUCM & Provisioning → Enduser Setup → Config Clusters.
3. Click Live Log at the top. The page External tool: live log & sync opens.
4. Leave the display on Live to see new entries immediately, or stop it with Paused.
5. Narrow the list with the filters: direction (Inbound, EasyUC, Outbound), channel (Public API, Task, Webhook, Sync), status (Success, Warning, Error, Info), Request ID and search text.
6. Click an entry. The detail view shows the data sent, the response, the section What EasyUC did and the Headers.
7. Click the request ID of an entry to see all steps of this order under Timeline of this order.
8. Use Load older entries to page back and Clear view to tidy up the display.

Step by step: setting up and testing the sync target

1. On the page External tool: live log & sync, click Sync to external tool.
2. In the section External tool (sync target), tick Sync target active.
3. Enter the URL of the external tool.
4. Under Authentication, select None, Basic Auth or Bearer Token and enter the Username and password or the token.
5. Enter Users per batch.
6. Leave Verify TLS certificate ticked and decide on Also send users without configuration.
7. Click Save.
8. Click Test connection. The page reports Connection works or Connection failed with the HTTP status and the duration.

Step by step: starting the sync

1. In the section Sync CUCM enduser configurations, first click Dry run (build inventory only).
2. Follow the run under Sync runs. For each cluster the page shows the progress and then the counters for users, configurations, Jabber, desk phones and device profiles.
3. Click Download inventory (JSON) on the run and check the file.
4. Click Sync all CUCM enduser configs to the external tool for the complete inventory, or Send user base only for the users without configurations.
5. Check the counter batches sent on the run and the individual transfers in the live log with the channel Sync.

Fields and options

Checking the result and narrowing down errors

• A successful connection test shows Connection works with the HTTP status and the duration in milliseconds.
• Sync runs lists the number, status, type, time and triggering user for each run. A dry run is marked as such.
• Counter without location mapping greater than zero: these configurations do not match any location of the Enduser Setup. Add the location mapping under Config Clusters.
• A cluster is marked red: EasyUC could not read it. The error message is shown next to it. Check the CUCM connection.
• Connection failed: check the address, reachability, certificate and authentication. The HTTP status shown narrows down the cause.
• The live log stays empty and shows No communication yet: the external tool has not sent a request yet, or the filters are too narrow.
• Responses to orders go back to the tool through the webhook of the enduser task. They appear in the live log under the channel Webhook.