Provide the enduser portal

What it is for

The enduser portal is a separate web interface for telephone users. They set up call forwarding there, assign line keys, listen to voicemails, read faxes and sign in to or out of hunt groups. These tasks no longer end up with the administrators.

The portal is switched on per CUCM connection. For each connection you define which areas the users see. The switches work twice: an area that is switched off disappears from the menu, and the matching server functions reject requests.

EasyUC does not check the sign-in itself. User ID and password are passed to CUCM through AXL, and CUCM confirms or rejects the sign-in. EasyUC does not store an enduser password.

Prerequisites

Role ROLE_APP_ADMIN in the admin interface.
The licence includes the enduser portal. Without it the portal rejects requests with “You need to activate enduser site license!”. Phonebook and block list also need the phonebook licence.
The CUCM connection is set up and enabled. The AXL account of the connection works.
The endusers exist in CUCM and have been imported into EasyUC by the user scan. Users that have not been imported cannot sign in.
For the call list: the CDR input of the connection is set up. For voicemail: the Unity connection. For fax: a personal fax box per user. For sending faxes: SMTP and a mail-to-fax gateway.

Step by step: switch on the portal

Open Administration → CUCM & Provisioning → CUCM Connections.
In the row of the connection, click Actions and select Enduser Local Site.
The End-user site window shows the portal address of this connection at the top, in the form https://<appliance address>/enduser/?connection=<ID>. Note the address.
Switch on Enable Enduser Local Site. The other switches appear only after that.
Under Dashboard capabilities, select which areas the users see on the start page.
Under Fax and voicemail capabilities, select whether the fax inbox, fax sending, the voicemail menu and the text view of greetings are available.
Set the remaining switches: Show Only Call Forward All, Enduser Phonebook, Enduser Device Request and the three voicemail panels.
Click Save.
Pass the portal address on to the users. With the connection parameter the right connection is already selected on the sign-in page.

Step by step: secure the sign-in and set a logo

Two-factor sign-in by email for everyone: switch on 2FA in the System Configuration. After the password check the user receives a six-digit code by email. SMTP must work and the CUCM user needs an email address.
Two-factor sign-in with an authenticator app: each user sets this up in the portal (user menu → 2FA). You do not need to release anything for it.
Reset an authenticator: open the enduser's profile in the admin interface and click Disable authenticator 2FA in the side panel. Confirm the prompt Disable two-factor authentication?.
Own logo: open Administration → Access & Appearance → Branding, click Upload Logo, select an image file and click Upload. PNG with a transparent background is recommended. The portal shows the logo on the sign-in page.
Rules for generated passwords and PINs are set separately, see the chapter on enduser password and PIN settings. The portal itself does not offer a password or PIN change.

Fields and options

Fields and options
Field / action	Meaning and use
Enable Enduser Local Site	Main switch of the portal for this connection. Default: off. When it is off, the sign-in page reports “The enduser portal is disabled for the selected cluster.”
Forwarders on dashboard	Shows the user who forwards calls to their lines. Default: on.
Busy control on dashboard	Shows the current busy trigger of the user's phones. Default: on.
Allow users to change busy trigger	Lets the user set the busy trigger to 1 or 2. Works only together with busy control. Default: off.
Call history on dashboard	Shows the user's own calls from the CDR data. Default: on.
User phones and line details	Releases the Devices menu item and the device cards on the dashboard. Default: on.
Phone registration status	Shows Registered, Not registered or Status unknown per device. Works only together with the phones. Default: on.
Pickup groups on dashboard	Shows the user's pickup groups with their members. Default: on.
Hunt groups on dashboard	Shows the user's hunt groups and the Group sign-in area. Default: on.
Fax inbox	Fax Inbox menu item. It appears only for users with their own fax box. Default: on.
Allow users to send faxes	Send fax button. Needs the fax inbox, the fax gateway email pattern and SMTP. Default: off.
Voicemail menu	Voicemails menu item. Default: on.
Greeting speech to text	Show greeting as text button on the voicemail greetings. Needs the voicemail menu and a transcription endpoint. Default: off.
Fax gateway email pattern	Under Fax delivery and transcription integrations. Recipient address of the mail-to-fax gateway with the placeholder `{number}`, for example `{number}@fax.example.org`. At most 254 characters. The gateway must accept PDF attachments.
Greeting transcription endpoint	HTTPS address of a service you operate, at most 2048 characters. It receives the greeting as a WAV file and the language code, and only when the user requests the text view.
Transcription access token	Optional token for the transcription service, at most 4096 characters. It stays on the server and is not delivered to the users' browsers.
Show Only Call Forward All	Hides all forwarding types except Forward All in the portal. Default: off.
Enduser Phonebook	Releases Global Directory, Personal Directory and Block Numbers. Needs the phonebook licence. Default: off.
Ecc Profile	Appears when the enduser phonebook is switched on. The selected External Call Control Profile is assigned to every number plan entry newly created in EasyUC. Below it is the Enduser CURRI address for this profile.
Enduser Device Request	Users can request devices and membership in pickup and hunt groups. Group members decide on group requests themselves. Default: off.
Voicemail Mailbox Panel	Shows the message list with Inbox, Sent and Deleted in the portal. Default: off.
Voicemail Action Panel	Shows the Action area (accept, reject or relay messages, relay address). Default: off.
Voicemail Alternate Extension Panel	Shows the Alternate Extension area. Default: off.

Check the result and troubleshoot

Open the portal address in a private browser window and sign in with a test user. Check that menu and dashboard show exactly the released areas.
“The enduser portal is disabled for the selected cluster. Please contact your administrator.”: the main switch of the connection is off.
“The selected cluster is unavailable or disabled.”: the CUCM connection is disabled or the ID in the address is wrong.
“Username or password is incorrect” although the password is right: the user has not yet been imported into EasyUC by the user scan, or CUCM rejects the sign-in. The portal does not distinguish these cases on purpose.
“Too many failed sign-in attempts. Please wait a moment and try again.”: after several failed attempts the portal requires a waiting time.
“This feature is disabled for your CUCM connection.”: the user opened a page directly whose switch is off.
Phonebook menu items are missing although Enduser Phonebook is on: check the phonebook licence. The user must sign in again afterwards.
Fax Inbox menu item is missing: no fax box is assigned to the user, or the Fax inbox switch is off.