Update Tenant Configuration

Workcloud Communication Profile Manager Administrator Guide

You must have privileges to update tenant configuration.

From the dashboard, click

Customer

icon.

The

Update Tenant Configuration

screen appears.

Edit the fields.

Click

Update

Use the following table to set up the Tenant Configuration:

Parameter	Description
Customer ID	Customer Identifier. View only field.
Hidden Department	Name of the hidden department configured in the extension manager. This field is used to reserve the extension for the user.
Authentication Method	Authentication method. Possible values include OAUTH, IMPRIVATA, LAUNCHER
Landing Application	This feature enables the customer to choose which application to display in the foreground after selecting the role in the Profile Client. Possible values: BACKGROUND: This feature enables the customer to choose which application to display in the foreground after selecting the role in the Profile Client. VOICE: If the roles selected have PTT PRO and VOICE profiles, the VOICE application displays in the foreground after the role selection. If there is only a PTT PRO profile, then the PTT PRO application appears in the foreground. PTT PRO: If the selected roles have PTT PRO and VOICE profiles, the PTT PRO application displays in the foreground after the role selection. If there is only a VOICE profile, then the VOICE application appears in the foreground. PROFILE CLIENT: Profile Client displays in the foreground. Default Value: BACKGROUND
Device Cleanup Threshold in Days	All the devices in this tenant that are not logged in to the PFM system for this cleanup and threshold days are deleted from PFM, PTT PRO, and obsoleted from the Extension Manager and PVM systems. If the Extension Manager and the PVM device are obsoleted instead of forced deleted, this is important when we cannot get the permanent device identifier for the devices. For example, in Third-Party Android devices or in the future version of Android OS, the device ID is changed after the factory reset. If this field is not configured, then device cleanup for this tenant is not performed. Possible values: 2 to 365 days If there are no third-party devices, we recommend not configuring this parameter.
OAUTH Details
Host Url	URL to the OAuth server.
Authentication Path	URI endpoint for the OAuth server.
Token Path	Token path to the OAuth server.
Client ID	Customer-generated Client ID (comes from the Customer's OAuth server).
Client Secret Key	Client secret key. It is an optional field for some of the OAUTH configurations.
Token Username	The user field within the token is used to identify the individual user. OAUTH details fields are applicable for all authentication methods.
Client Authentication	Possible values: Send client credentials in the body. Send as Basic Auth header. header and body. All existing tenants cannot modify and save any tenant configurations unless they select one of the values in client authentication. After selecting the value, the default value changes, and the client configurations are only sent in the header or body.
Zebra Enterprise Messaging Server (ZEMS)
ZEMS API Keys	ZEMS Server API Key Requires if the ZEMS Manager association is required during user import.
ZEMS URL	ZEMS Server URL. Requires if the ZEMS Manager association is required during user import.
License
Utilization Threshold In %	Device License Utilization Threshold in Percentage. Sends the email to the configured emails if the defined threshold value exceeds. Possible values: 1 to 100 Default Value: Empty NOTE: Threshold check is done based on the cron job setting (scheduler.notification.cron) specified in the deployment configuration. This should be set to once a day
Utilization Notification Email	List of email addresses separated by comma (,) or can be a group email ID. Must be a valid email address. Default Value: Empty The email body contains the tenant's name and license utilization details.
License Source	The source from where the licenses are fetched. The default value is the old license source. Contact Zebra for migration to the new license source,
License Grace Period	The number of days the license is extended. The value must be from 1 to 30 days. If the value is not specified, it fetches the default value. The default value is 30 days. This field is active if the new license source is selected.
Active Directory Object Class Names
Group Class	The active Directory ObjectClass value is used to identify the object type while importing user roles. Default value: group
User Class	The Active Directory ObjectClass value is used to identify the object type during user import. The default value is the person.
AD Whitelist	List of AD attribute names. Changes to these attributes are ignored during the user import.
Limits
Return to Foreground Interval (earlier it is called Interval)	Sets the interval, in minutes, to bring the profile client to the foreground if the client is already logged in and waiting for the user input to select a site or a role. This is required when the user has not completed his login and returned to another application. Default value: 0 (disabled)
No of attempts to return to foreground	Sets the number of attempts to return to the foreground. Possible values: 0 to 100. Default Value: 0 (disabled).
Return to Login Interval	Sets the interval, in minutes, to show the Click Login button to remind the user to log in and select a role. Default value: 0 (disabled)
Max Report Records	A maximum number of records can be downloaded from System Reports.
PttPro Settings
Default Callee group	The default group name makes a call when the PTT key is pressed. This does not work when a voice command is enabled.
AllStoreGroup Name	Configures the default dynamic group name to which all the users are added. For example, all. store Default value: Empty (User is not added to any group). The group name should be added as a role in the system.
Add to AllDynamicGroup	Configures how users are added to the dynamic group. When true, the user is added to all dynamic groups/roles. is added to the currently selected dynamic group with receiveCall and originateCall as true and talker override as false. The user can initiate or listen to group calls. During logout, the group membership is set with receiveCall, originateCall, and talker override as false. is added to the non-selected dynamic group to which the user is assigned with receiveCall=false, originateCall=true, and talker override=false. The user can initiate a group call but cannot listen to it. During logout or switching roles, the group membership is set with receiveCall, originateCall, and talker override as false. When false (default), the user is added to the currently selected dynamic group with receiveCall, originateCall, and talker override based on the group user template selected for the user during import. If no template is selected, the STANDARD template is used. During logout or switching roles, the group membership is set with receiveCall, originateCall, and talker override as false. During the logout, the users are not removed from the group, so the login time is reduced as fewer API requests are triggered to the PTT Pro server during login. When Profile Manager is deployed with the ZEMS server, if there is a broadcast message to a group when the user is logged out, those messages are visible when the user logs in again. This happens because the Profile Manager does not remove the user from the group during logout, and the ZEMS server does not keep track of the receiveCall group membership settings while sending the message.
Site Selection	Configures whether the user can change the site dynamically during the profile client login. When true, the device user is presented with a Site Selection page. When false (default), the user has no capability to change the site dynamically. of sites is taken from the PTT Pro Side configuration (ESN).
Role Settings
Transfer Role	Enable/Disable Default Value: Disable If it is disabled, Transfer Role settings during Role configuration are ignored at the time of device login.
Transfer Role Count Down in Seconds	Countdown Timer in seconds Possible values: 5 to 300 Default value: 15 Notification is displayed on both devices until the countdown timer elapses. If the countdown timer elapses without the user replying to the message, it is considered a force transfer.
Role Display Preference	Displays the preference in the Profile Client Role Selection Page. Possible Values: Roles and Description – Displays both the Role and the Description. Roles Only– Displays role name only. Description Only – Displays description only. Default Value: Displays roles and descriptions. If this field is not configured, the role and the description are displayed on the Role Selection Page during the device login.
Role Selection Quantity	The number of roles allowed for selection is on the Profile Client Role Selection page. Possible Values: 1 to 4 Default Value: 4 If this field is not configured, a maximum of 4 roles are allowed in the Role Selection Page during device login.
Flat File Variance
Threshold in %	This is the file variance threshold allowed in percentage. Variance is checked for a higher or lower boundary. Import job execution fails if the number of records in the user import flat file is beyond the allowed variance after comparing it with the previous successful run. This is to prevent any incomplete user import flat file from being used during import, which would result in deleting the records not present in the flat file. If this field is not configured, there is no validation during the user import. Possible Values: 1 to 100
Notification Email	. If the job execution fails, the mail is sent to these emails If the same email ID is configured in the job scheduler, email notifications for failure, or both, the user receives multiple emails if the job fails.

The grace period is not applicable when the old license source is selected, and the default value for this field is 0 (zero).

The overage license percentage is not applicable for PFM.

The user cannot change the license source once it is updated.

The label for the field has been modified from License CLS ID
to License ID
.

The License ID must be updated with the correct Badge ID for successful migration to the new license source.

Only active licenses are migrated.

The license Badge ID must start with 'BDG-' followed by 8 uppercase alphanumeric characters. If this format is not followed, the user gets an error and cannot add/update the customer.