ZEBRA Profile Manager Workcloud Communication User Guide
- August 19, 2024
- ZEBRA
Table of Contents
Profile Manager Workcloud Communication
“`html
Specifications:
- Product Name: Profile Manager
- Manufacturer: Zebra Technologies Corporation
- Model Number: MN-003433-15EN Rev A
- Copyright: 2024/04/09
Product Information:
The Profile Manager is a software tool provided by Zebra
Technologies Corporation for managing user profiles within the
Workcloud Communication system. It is designed to assist Customer
Administrators in configuring and updating user profiles
efficiently.
Product Usage Instructions:
About This Guide:
The Profile Manager Customer Administrator Guide offers detailed
information on using the Workcloud Communication Profile Manager.
Note that the images of windows shown in the guide are samples and
may differ from the actual interface.
Chapter Descriptions:
The guide includes chapters that provide specific information on
different aspects of using the Profile Manager. It covers topics
such as updating users via Flat File (PFM) to include Manager
Association.
Notational Conventions:
-
NOTE: Supplementary information for
users. -
IMPORTANT: Important information for users to
know. -
CAUTION: Indicates potential minor or moderate
risks if precautions are not taken. -
WARNING: Indicates potential serious risks
that could lead to injury or death if not avoided. -
DANGER: Indicates imminent danger that could
result in serious injury or death if not avoided.
Service Information:
If you encounter issues that cannot be resolved by Zebra
Customer Support, you may need to return the equipment for
servicing. Proper shipping procedures must be followed to avoid
damage during transit and prevent voiding the warranty. Contact
your Zebra business partner if you purchased the product through
them for support.
FAQ:
Q: Can the Profile Manager be used to update user profiles in
bulk?
A: Yes, the Profile Manager allows Customer Administrators to
update users via Flat File (PFM) to include Manager Association,
facilitating bulk updates efficiently.
“`
Profile Manager
Workcloud Communication
Customer Administrator Guide
MN-003433-15EN Rev A
Copyright
2024/04/09
ZEBRA and the stylized Zebra head are trademarks of Zebra Technologies
Corporation, registered in many jurisdictions worldwide. All other trademarks
are the property of their respective owners. ©2023 Zebra Technologies
Corporation and/or its affiliates. All rights reserved.
Information in this document is subject to change without notice. The software
described in this document is furnished under a license agreement or
nondisclosure agreement. The software may be used or copied only in accordance
with the terms of those agreements.
For further information regarding legal and proprietary statements, please go
to:
SOFTWARE: zebra.com/linkoslegal. COPYRIGHTS: zebra.com/copyright. PATENTS:
ip.zebra.com. WARRANTY: zebra.com/warranty. END USER LICENSE AGREEMENT:
zebra.com/eula.
Terms of Use
Proprietary Statement
This manual contains proprietary information of Zebra Technologies Corporation
and its subsidiaries (“Zebra Technologies”). It is intended solely for the
information and use of parties operating and maintaining the equipment
described herein. Such proprietary information may not be used, reproduced, or
disclosed to any other parties for any other purpose without the express,
written permission of Zebra Technologies.
Product Improvements
Continuous improvement of products is a policy of Zebra Technologies. All
specifications and designs are subject to change without notice.
Liability Disclaimer
Zebra Technologies takes steps to ensure that its published Engineering
specifications and manuals are correct; however, errors do occur. Zebra
Technologies reserves the right to correct any such errors and disclaims
liability resulting therefrom.
Limitation of Liability
In no event shall Zebra Technologies or anyone else involved in the creation,
production, or delivery of the accompanying product (including hardware and
software) be liable for any damages whatsoever (including, without limitation,
consequential damages including loss of business profits, business
interruption, or loss of business information) arising out of the use of, the
results of use of, or inability to use such product, even if Zebra
Technologies has been advised of the possibility of such damages. Some
jurisdictions do not allow the exclusion or limitation of incidental or
consequential damages, so the above limitation or exclusion may not apply to
you.
Contents
About This Guide…………………………………………………………………………………………………………………………… 9 Chapter
Descriptions………………………………………………………………………………………………………………9 Notational
Conventions…………………………………………………………………………………………………………10 Icon
Conventions………………………………………………………………………………………………………………….. 10 Service
Information………………………………………………………………………………………………………………..10 Revision
History………………………………………………………………………………………………………………………11
Getting Started………………………………………………………………………………………………………………………………12 Introduction
to Workcloud Communication Profile Manager……………………………………………. 12
Interconnection Details…………………………………………………………………………………………………..13 Logging In to
Profile Manager Portal…………………………………………………………………………………..13 Logging Out of
Profile Manager Portal………………………………………………………………………………. 14 Resetting Your
Administrator Password………………………………………………………………………………14 Resetting Your
Administrator Password Before Logging In………………………………………..14 Resetting Your
Administrator Password After Logging In………………………………………….. 14 Main Screen in
Profile Manager…………………………………………………………………………………………..15 System Controls
Panel………………………………………………………………………………………………….. 15 Navigating the Profile Manager
Portal Dashboard……………………………………………………………. 16 Dashboard Quick Link
Buttons…………………………………………………………………………………….. 16 Return to the
Dashboard………………………………………………………………………………………………. 16 Required
Information………………………………………………………………………………………………………16
Icons………………………………………………………………………………………………………………………………… 16 Slider
Switches………………………………………………………………………………………………………………..17 Success and Error
Messages……………………………………………………………………………………….. 18 Search and Filter
Functionality…………………………………………………………………………………….. 18
3
Contents
System Management……………………………………………………………………………………………………………………. 19 Tenant
Configuration……………………………………………………………………………………………………………. 19 View Tenant
Configuration…………………………………………………………………………………………… 19 Update Tenant
Configuration……………………………………………………………………………………….20 Portal User Role
Management…………………………………………………………………………………………….26 View Portal User
Roles………………………………………………………………………………………………… 26 Create Portal User
Roles……………………………………………………………………………………………… 26 Edit Portal User
Roles……………………………………………………………………………………………………27 Delete Portal User
Roles……………………………………………………………………………………………… 28 Portal User
Management……………………………………………………………………………………………………..29 Create Portal
Users………………………………………………………………………………………………………. 29 Edit Portal
Users…………………………………………………………………………………………………………….30 Delete Portal
Users………………………………………………………………………………………………………. 32 Device User Attribute
Management…………………………………………………………………………………… 33 Create Device User
Attributes…………………………………………………………………………………….. 33 Edit Device User
Attributes…………………………………………………………………………………………..35 Device User Role
Management…………………………………………………………………………………………..35 Create Device User
Role……………………………………………………………………………………………… 36 Edit Device User
Roles………………………………………………………………………………………………….37 Delete Device User
Roles……………………………………………………………………………………………. 38 Device User
Management……………………………………………………………………………………………………38 View Device
Users……………………………………………………………………………………………………….. 38 Add and Update Device
Users…………………………………………………………………………………….39 Add or Update Multiple Device
Users…………………………………………………………………………39 Add a Device
User……………………………………………………………………………………………………….. 39 Edit a Device
User…………………………………………………………………………………………………………40 Delete a Device
User……………………………………………………………………………………………………. 41 Refresh a Device User
Status………………………………………………………………………………………. 41 Device
Management……………………………………………………………………………………………………………. 42 License Management
Through Device Licenses………………………………………………………..42 View
Devices………………………………………………………………………………………………………………….42 Add/Enroll and Update
Devices………………………………………………………………………………….. 43 Add a
Device………………………………………………………………………………………………………………….44 Edit a
Device…………………………………………………………………………………………………………………. 45
4
Contents
Delete/De-Enroll a Device……………………………………………………………………………………………. 45 Refresh a
Device Status………………………………………………………………………………………………..47 Profile Definition
Management…………………………………………………………………………………………….47 Create Profile
Definitions……………………………………………………………………………………………… 47 Edit Profile
Definitions………………………………………………………………………………………………….. 49 Delete Profile
Definitions……………………………………………………………………………………………… 49 Profile Configuration
Management…………………………………………………………………………………….. 49 Create Profile
Configurations………………………………………………………………………………………. 49 Edit Profile
Configurations……………………………………………………………………………………………..51 Delete Profile
Configurations……………………………………………………………………………………….. 51 Rule
Management………………………………………………………………………………………………………………….51 View
Rules…………………………………………………………………………………………………………………….. 52 Create
Rules………………………………………………………………………………………………………………….. 52 Publish
Rules…………………………………………………………………………………………………………………. 54 Delete
Rules………………………………………………………………………………………………………………….. 55 System Report
Management………………………………………………………………………………………………. 56 Generate
Reports…………………………………………………………………………………………………………..56 Export
Reports………………………………………………………………………………………………………………..57 Create Report
Templates…………………………………………………………………………………………….. 58 Edit Report
Templates…………………………………………………………………………………………………..58 Delete Report
Templates………………………………………………………………………………………………59
Identity Provider Import Management…………………………………………………………………………………………. 60
Device User Attribute Mappings…………………………………………………………………………………………60 View
Mappings……………………………………………………………………………………………………………… 60 Add an Attribute,
Constant or Function………………………………………………………………………. 61 Add
Attributes……………………………………………………………………………………………………………….. 62 Add
Function…………………………………………………………………………………………………………………. 63 Find
Function………………………………………………………………………………………………………………….64 Substitute
Function………………………………………………………………………………………………………..65 Replace
Function………………………………………………………………………………………………………….. 68 Create Extension During
User Import………………………………………………………………………….69 Integrating Zebra Enterprise
Messaging Server (ZEMS) During User Import…………… 69 Clear an Attribute
Mapping…………………………………………………………………………………………..70
5
Contents
Import Job Management……………………………………………………………………………………………………….71 View Import
Jobs…………………………………………………………………………………………………………… 71 Create Import
Jobs………………………………………………………………………………………………………… 71 Edit
Jobs………………………………………………………………………………………………………………………… 73 Delete
Jobs……………………………………………………………………………………………………………………. 73 Run Import
Jobs……………………………………………………………………………………………………………. 74 Import Job
Notifications………………………………………………………………………………………………..80 Import Job
Scheduler…………………………………………………………………………………………………… 82
Client Device Setup Using Telephony Manager and Profile
Manager………………………………………….. 85 Configure Telephony Manager Using a CSV
File…………………………………………………………….. 85 Confirm Successful Import of Data from the
CSV File……………………………………………………… 85 Manually Configure Telephony Manager (for
technical support)…………………………………….. 86 Enter the Store or Site ID
Information……………………………………………………………………………….. 86 Enter the PBX
Information……………………………………………………………………………………………………87 Add Department
Information……………………………………………………………………………………………….89 Enter PBX Extension
Information……………………………………………………………………………………….. 90 Configure Zebra Profile
Manager……………………………………………………………………………………….. 91 Confirm the End-to-End
Configuration of Telephony Setup………………………………………………91 Important Notes About
Verifying Correct End-to-End Configuration………………………………. 95
Telephony Management………………………………………………………………………………………………………………. 96
Extensions…………………………………………………………………………………………………………………………….. 96 View
Extensions……………………………………………………………………………………………………………. 96 Refresh
Extensions……………………………………………………………………………………………………….. 97 Extension Import
Management…………………………………………………………………………………………… 97 Other Telephony Management
Options……………………………………………………………………………. 98
Profile Manager Licenses…………………………………………………………………………………………………………….. 99 Profile
Manager Device Licenses………………………………………………………………………………………. 99 View Application
Licenses………………………………………………………………………………………………….. 99 Update Application
Licenses…………………………………………………………………………………………….. 100
6
Contents
Intents and Actions…………………………………………………………………………………………………………………….. 101 Profile
Manager Client Configuration File Elements………………………………………………………… 101 Support
for Third-Party Launchers……………………………………………………………………………………. 104 Access
Tokens…………………………………………………………………………………………………………………….106 ADB Supported
Commands……………………………………………………………………………………………….106 Install the PFM
Client………………………………………………………………………………………………….. 106 Handling the PFM
Configuration File……………………………………………………………………………….. 106 Starting the Profile
Client……………………………………………………………………………………………………106 Reconfiguring a Running
Client………………………………………………………………………………………….107 Start/Restart the Client with a
New Configuration…………………………………………………………… 107 Sending Credentials from a Third
Party Launcher……………………………………………………………107
Bulk Import Device Users……………………………………………………………………………………………………………109
Description………………………………………………………………………………………………………………………….. 109
Assumptions…………………………………………………………………………………………………………………………. 110 Import
Process…………………………………………………………………………………………………………………….. 110
Multiple Role Values from Attributes………………………………………………………………………………………….. 118
Description…………………………………………………………………………………………………………………………….118
Assumptions…………………………………………………………………………………………………………………………. 118 Configuration
Process………………………………………………………………………………………………………….119
Overview……………………………………………………………………………………………………………………….. 119 Identification of
AD Attributes………………………………………………………………………………………119 Import Attribute
Transformations………………………………………………………………………………… 121 Create an Import
Job………………………………………………………………………………………………….. 125 Researching Provisioning
Errors………………………………………………………………………………… 129 Successful Provisioning and
Attribute Mapping……………………………………………………….. 130
Role Level Selection……………………………………………………………………………………………………………………. 131
Dependencies……………………………………………………………………………………………………………………….131 Adding and
Assigning Role Levels……………………………………………………………………………. 132 Applying the Role
Level……………………………………………………………………………………………….137 Device
Operation………………………………………………………………………………………………………….139
7
Contents ZEMS and Profile Manager…………………………………………………………………………………………………………. 141
Updating Users via Flat File (PFM) to Include Manager
Association………………………………..141
8
About This Guide
About This Guide
This guide provides information about using the Workcloud Communication
Profile Manager. NOTE: and windows pictured in this guide are samples and can
differ from actual screens.
Chapter Descriptions
Topics covered in this guide are as follows: · Getting Started provides an
introduction and description of the graphical conventions used in this
document. · System Management provides information on the management of users,
devices, and roles. · Identity Provider (IDP) Import Management provides
information on the bulk import of users, devices,
and extensions. · Client Device Setup Using Telephony Manager and Profile
Manager provides information on client
device setup for sites using advanced features. · Telephony Management
provides information on importing extensions. · Profile Manager Licenses
provides information on the device licenses for your enterprise. · Intents and
Actions provides information on how to install and configure the Zebra Profile
Client. · Bulk Import Device Users provides information on how to import users
into Profile Manager and PTT
Pro. · Multiple Role Values from Attributes provides information on how to
read an AD attribute with multiple
roles and proliferate it to the UI of the mobile device. · Role Level
Selection provides information about assigning a collection of roles under a
role-level name.
9
About This Guide
Notational Conventions
The following conventions are used in this document: · Bold text is used to
highlight the following:
· Dialog box, window and screen names · Drop-down list and list box names ·
Checkbox and radio button names · Icons on a screen · Key names on a keypad ·
Button names on a screen. · Bullets (·) indicate: · Action items · List of
alternatives · Lists of required steps that are not necessarily sequential. ·
Sequential lists (for example, those that describe step-by-step procedures)
appear as numbered lists.
Icon Conventions
The documentation set is designed to give the reader more visual clues. The
following visual indicators are used throughout the documentation set. NOTE:
The text here indicates information that is supplemental for the user to know
and that is not required to complete a task. IMPORTANT: The text here
indicates information that is important for the user to know.
CAUTION: If the precaution is not heeded, the user could receive a minor or
moderate injury.
WARNING: If danger is not avoided, the user CAN be seriously injured or
killed.
DANGER: If danger is not avoided, the user WILL be seriously injured or
killed.
Service Information
If you have a problem with your equipment, contact Zebra Global Customer
Support for your region. Contact information is available at:
zebra.com/support. When contacting support, please have the following
information available: · Serial number of the unit · Model number or product
name · Software type and version number Zebra responds to calls by email,
telephone, or fax within the time limits set forth in support agreements.
10
About This Guide
If your problem cannot be solved by Zebra Customer Support, you may need to
return your equipment for servicing and will be given specific directions.
Zebra is not responsible for any damages incurred during shipment if the
approved shipping container is not used. Shipping the units improperly can
possibly void the warranty.
If you purchased your Zebra business product from a Zebra business partner,
contact that business partner for support.
Revision History
Change MN-003433-01 Rev A MN-003433-01 Rev B MN-003433-02 Rev A
MN-003433-03 Rev A
MN-003433-04 EN Rev A MN-003433-05EN Rev A
MN-003433-06EN Rev A MN-003433-07EN Rev A MN-003433-08EN Rev A MN-003433-09EN
Rev A MN-003433-10EN Rev A MN-003433-11EN Rev A MN-003433-12EN Rev A
MN-003433-13EN Rev A
MN-003433-14EN Rev A
MN-003433-15EN Rev A
Date 06/2019 12/2019 04/2020
08/2020
04/2021 07/2021
12/2021 03/2022 06/2022 10/2022 12/2022 03/2023 07/2023
10/2023
01/2024
04/2024
Description Initial Release
Updates for RRR delivery.
Updates for RRR delivery for WFC Profile Manager Version 4.0.
Updates for RRR delivery for WFC Profile Manager Version 4.2.
Updates for custom delivery.
Added Add, Find, Substitute, and Replace functions and whitelist attributes.
Added the Update Tenant Configuration.
Added Client Authentication for THD.
Import Job History status details provided.
Added Transfer Role and Import Job run.
Added Device role and device user naming convention.
Added Device Cleanup Threshold and Landing Application.
Added Role Display Preference, Role Selection Quantity, updated Edit Job, and
View Import Job History.
Updated Add to AllDynamicGroup parameter in Update Tenant Configuration.
Added the ZEMS Tenant Configuration parameters and User Import.
Rebranded Workforce Connect and WFC as Workcloud Communication and Zebra.
11
Getting Started
Getting Started
This chapter includes the following topics: · Introduction to Zebra Workcloud
Communication Profile Manager · Interconnection Details · Logging In to the
Profile Manager Portal · Logging Out of the Profile Manager Portal · Resetting
Your Administrator Password · Resetting Your Administrator Password Before
Logging In · Resetting Your Administrator Password After Logging In · Main
Screen in Profile Manager · System Controls Panel (Dashboard) · Navigating the
Profile Manager Portal Dashboard
Introduction to Workcloud Communication Profile Manager
The Workcloud Communication Profile Manager (Zebra Profile Manager) provides a
user interface (dashboard) for administrators or technical representatives to
manage an organization’s use of mobile devices. The target audience for this
guide is Zebra administrators and customer administrators who configure and
control the operation of mobile device deployment. The portal includes role-
based access to the following functions: · Authentication of portal user
accounts · Creation and management of
· Portal users · Device users · Applications · Importing · Devices users ·
Extensions · Presence service management
12
Getting Started
· Monitoring of user and device activity · Real-time usage · Historical data
· Report generation
Interconnection Details
The Zebra Profile Manager has direct and indirect connections and
relationships to many devices, including but not limited to the following: ·
Zebra Voice Client · PTT Pro Client · PTT Pro Management Portal · Zebra
Profile Client · Active Directory Server
Logging In to Profile Manager Portal
Administrator must have an account in the Profile Manager portal. 1. Navigate
to the Profile Manager portal. 2. Enter the User ID, Password, and Customer
ID.
Figure 1 Profile Manager Portal Login Dialog Box
13
Getting Started
3. Click Log in. If incorrect credentials are entered, the Login dialog box
displays an error message. If correct credentials are entered, the main screen
of the Profile Manager Portal appears.
NOTE: Other system events, including but not limited to server re-
installation, server upgrade, server restart, or clearing of cache on browser
might require you to re-enter the Customer ID as a first-time user on your
next login to the Profile Manager Portal.
Logging Out of Profile Manager Portal
To log out of the Profile Manager Portal, do the following: 1. Navigate to the
Profile Manager Portal screen that has the following icon in the top right
corner.
2. Click the icon and select Logout in the drop-down list.
Resetting Your Administrator Password
There are two ways to reset your administrator password. · Resetting Your
Administrator Password Before Logging In · Resetting Your Administrator
Password After Logging In
Resetting Your Administrator Password Before Logging In
To reset your password from the login dialog box, do the following: 1. In the
login dialog box, click the link for Forgot password? 2. In the Reset Password
dialog box, enter your email address and Customer ID. 3. Select Reset. 4.
Follow the instructions in your email to reset your password.
Resetting Your Administrator Password After Logging In
To reset your password after successfully logging in to the Profile Manager
Portal, do the following: 1. Navigate to a Profile Manager Portal screen that
has the following icon in the top right corner.
14
Getting Started
2. Click the icon and select Change Password in the drop-down list.
3. Complete the fields in the Reset Password dialog box and click Save. NOTE:
The Zebra Administrator may create two administration accounts. One account is
for the customer administrator. The second account is used by the Active
Directory Connector, which is specified during the deployment. Do not change
the password used by the Active Directory Connector without consulting the
Zebra Administrator, otherwise, the connector is not able to communicate with
the Profile Manager.
Main Screen in Profile Manager
After you log in to the Profile Manager Portal, the System Controls panel
(dashboard) appears.
System Controls Panel
The left panel of the System Controls (Dashboard) panel is the Navigation
panel. The Navigation panel contains shortcut links to the functions in the
right panel. In the System Controls (Dashboard) panel, the links in the left
panel take you to the same categories as the Profile Manager administration
screens listed on the left panel. Or you can click the quick link buttons in
the right panel to access the administration screens. For more information,
see Dashboard Quick Link Buttons. Figure 2 System Controls Panel (Dashboard)
15
Getting Started
Your access to functions and actions in the dashboard is controlled by the
permissions in your assigned role(s) for any Profile Manager portal functions,
such as the following: · System Management
· Portal User Management · Device User Management · Profile Management · Rules
· System Reports · Active Directory Import Management · Telephony Management ·
Licenses.
Navigating the Profile Manager Portal Dashboard
This chapter describes the features linked to each icons and provides the
details of those icons.
Dashboard Quick Link Buttons
Each Quick Link button displays the function name and number of items defined
for that function. Click a Quick Link button to manage that function.
Return to the Dashboard
· Click the Zebra logo or
Dashboard to return to the Dashboard from any Profile Manager screen.
Required Information
An asterisk (*) appears for required information.
Icons
Icons represent actions, shortcut links, or descriptions. Click an icon to perform the action or navigate to the link. Hover on the icon for a description of the action, shortcut link, or parameter. Shortcut links are on the side Navigation bar or top bar of every page.
Permission Category
Action
Description View or edit
Action
· Delete · Delete/De-enroll the device
16
Getting Started
Permission Category
Action Action Action Action Action Action Action Action Action Action Action Shortcut Shortcut Shortcut Shortcut Shortcut Shortcut
Slider Switches
Click slider switches to enable and disable features.
Setting
Disabled
Enabled
Refresh
Description
Reset password
Mask Unmask Expand side navigation Expand drop-down Collapse drop-down Display history Run
Search Search Opens dashboard Opens Device User Management Opens Rules Opens Reports Opens Telephony Manager Dashboard
State
17
Getting Started
Success and Error Messages
When an action such as Create, Edit, or Delete is successful, a message
similar to the following appears. Figure 3 Action Message-Success
When an action such as Create, Edit, or Delete is unsuccessful, a message
similar to the following appears. Figure 4 Action Message-Error
Search and Filter Functionality
All items inside each function are searchable. · There are search options in
many screens throughout the portal. · Some screens also have drop-down
filters. · Wild card characters limit the search results. For example, use an
asterisk to enter part of a search term. Figure 5 Portal User Search Field and
Drop-Down Filter
18
System Management
System Management
This chapter describes how to use Profile Manager to control and manage the
system. · Tenant Configuration · Portal User Role Management · Portal User
Management · Device User Attribute Management · Device User Role Management ·
Device User Management · Device Management · Profile Definition Management ·
Profile Configurations Management · Rule Management · System Report Management
Tenant Configuration
This section describes how to: · View Tenant configuration · Update Tenant
configuration
View Tenant Configuration
You must have privileges to view tenant configuration. From the dashboard,
click Customer icon. The View Customer screen appears.
19
System Management
Update Tenant Configuration
You must have privileges to update tenant configuration. 1. From the
dashboard, click Customer icon.
The Update Tenant Configuration screen appears. 2. Edit the fields. 3. Click
Update.
Figure 6 Edit Customer Screen
Use the following table to set up the Tenant Configuration:
Parameter
Description
Customer ID
Customer Identifier. View only field.
20
System Management
Parameter Hidden Department
Authentication Method Landing Application
Description
Name of the hidden department configured in the extension manager. This field
is used to reserve the extension for the user.
Authentication method. Possible values include: OAUTH, IMPRIVATA, LAUNCHER
This feature enables the customer to choose which application to display in
the foreground after the role is selected in the Profile Client.
Possible values:
· BACKGROUND: This feature enables the customer to choose which application to
display in the foreground after the role is selected in the Profile Client.
· VOICE: If the roles selected have both PTT PRO and VOICE profiles, then 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 both PTT PRO and VOICE profiles, then
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 which are not logged in to the PFM system for
this cleanup and threshold days are deleted from PFM, PTT PRO, and obsoleted
from Extension Manager and PVM systems. If the Extension Manager and the PVM
device are obsoleted instead of forced delete. 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 Authentication Path
URL to the OAuth server. URI endpoint for the OAuth server.
21
System Management
Parameter Token Path Client ID Client Secret Key Token Username
Client Authentication
Active Directory Details Group Class User Class AD Whitelist Limits Return to
Foreground Interval (earlier it is called Interval)
No of attempts to return to foreground
Description
Token path to the OAuth server.
Customer-generated Client ID (comes from the Customer’s OAuth server).
Client secret key. It is an optional field for some of the OAUTH
configurations.
The user field within the token is used to identify the individual user.
NOTE: OAUTH details fields are applicable for all authentication methods.
Possible values:
· Send client credentials in the body.
· Send as Basic Auth header.
NOTE:
For the existing tenants, if this field is not configured, then the client
credentials are sent in both header and body.
All existing tenants are not able to modify any tenant configurations and save
them unless they select one of the values in client authentication. And after
selecting the value, the default value changes, and the client configurations
are only sent either in the header or body.
Active Directory ObjectClass value is used to identify the type of object
during user roles import. Default value: group
Active Directory ObjectClass value is used to identify the type of object
during user roles import. Default value: group
Active Directory ObjectClass value is used to identify the type of object
during user import. Default value: person.
List of AD attribute names. Changes to these attributes are ignored during the
user import.
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 some other application Default value: 0 (disabled)
Sets the number of attempts to return to the foreground. Possible values: 0 to
100. Default Value: 0 (disabled).
22
System Management
Parameter Return to Login Interval Max Report Records Pttpro Settings Default
Callee group
AllStoreGroup Name
Add to AllDynamicGroup
Description
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)
A maximum number of records can be downloaded from System Reports.
The default group name is used to make a call when the PTT key is pressed.
NOTE: This does not work when a voice command is enabled.
Configures Default dynamic group name where all the users are added. For
example, all. store
Default value: Empty (User is not added to any group).
NOTE: The group name should be added as a role in the system.
Configures how users are added to the dynamic group. When true, the user is
added to all of the 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 the receiveCall=false, originateCall =true, and talker override=false.
The user can initiate a group call but is not able to listen to the group
calls. 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.
NOTE:
· During the logout, the users are not removed from the group, so the login
time is reduced as less number of API requests are triggered to PTT Pro server
during login.
· When Profile Manager is deployed with the ZEMS server, if there is a
broadcast message to a group
23
System Management
Parameter
Site Selection
Role Settings Transfer Role Settings Transfer Role Transfer Role Count Down in
Seconds
Role Display Preference
Role Selection Quantity
Description when the user is logged out, those messages are visible when the
user logs in again. It happens because the Profile Manager does not remove the
user from the group during logout and the ZEMS server does not keep track of
receiveCall group membership settings while sending the message.
Configures whether the user has the capability to 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.
NOTE: List of sites is taken from the PTT Pro Side configuration (ESN).
Displays the preference in the Profile Client Role Selection page.
Enable/Disable
Default Value: Disable
If it is disabled, Transfer Role settings during Role configuration are
ignored at the time of device login.
Countdown Timer in seconds
Possible values: 5 to 300
Default value: 15
Notification is displayed on both devices until this countdown timer elapses.
It is considered a force transfer if the countdown timer elapses without the
user replying to the message.
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.
The number of roles allowed for the selection in the Profile Client Role
Selection page.
Possible Values: 1 to 4
24
System Management
Parameter
Flat File Variance Threshold in %
Notification Email
Zebra Enterprise Messaging Server (ZEMS) ZEMS Url ZEMS API Key License
Utilization Threshold In %
Description Default Value: 4 If this field is not configured, a maximum of 4
roles are allowed in the Role Selection Page during device login.
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 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 which are not present in the flat file. If this field is
not configured, then there is no validation during the user import. Possible
Values: 1 to 100
One or more email addresses are separated by commas. If the job execution
fails, the mail is sent to these emails
NOTE: 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.
ZEMS Server URL. Requires if the ZEMS Manager association is required during
user import.
ZEMS Server API Key Requires if the ZEMS Manager association is required
during user import.
Device License Utilization Threshold in Percentage. Sends the email to the
configured emails if the defned threshold value exceeds. Possible values: 1 to
100 Default Value: Empty
NOTE: NOTE: Threshold check is done based on the cron job setting
(scheduler.notification.cron) specified
25
System Management
Parameter Utilization Notification Email
Description in the deployment configuration. This should be set to once in a
day
List of email addresses separated by comma (,) or can be a group email ID.
Must be a valid email address.
Default Value: Empty
Email body contains tenant name and license utilization details.
Portal User Role Management
This section describes how to: · View user roles · Create user roles · Update
user role permissions · Delete user roles.
View Portal User Roles
Your privileges must permit you to view portal user roles. · From the
dashboard,expand the Portal User Management , click Portal User Roles.
The Portal User Roles screen appears. Figure 7 Portal User Roles Screen
Create Portal User Roles
Your privileges must permit you to create portal user roles.
26
System Management
1. From the dashboard, click Portal User Roles. The Portal User Roles screen
appears.
2. Click Create Portal User Role. The Create Portal User Role dialog box
appears. Figure 8 Create Portal User Role Dialog Box
3. Enter the Role Name and Description. 4. Click on each drop-down and click
the slider switches to enable or disable permissions for each
category. 5. After setting the permissions, click Create.
The Create Portal User Role dialog box closes and the role can now be assigned
to portal users.
Edit Portal User Roles
Your privileges must permit you to edit portal user roles. 1. From the
dashboard, click Portal User Roles.
The Portal User Roles screen appears.
27
System Management
2. Click for the role you wish to edit. The Edit Portal User Role dialog box
appears, with granted permissions displayed in bold blue text. Figure 9 Edit
Portal User Role Dialog Box
3. Update the permission fields as in Create Portal User Roles . 4. Click
Update.
The Edit Portal User Role dialog box closes and the new settings applies to
anyone who is assigned the updated portal user role.
Delete Portal User Roles
Your privileges must permit you to delete portal user roles. 1. From the
dashboard, click Portal User Roles.
The Portal User Roles screen appears.
28
System Management
2. Click for the user role you wish to delete The Delete Portal User Role
dialog box appears. Figure 10 Delete Portal User Role
3. Click Yes to delete.
Portal User Management
This section describes the following: · Create Portal Users · Edit Portal
Users · Delete Portal Users
Create Portal Users
· Your privileges must permit you to create portal users. · The user roles
must be created if you want to assign them while creating portal users. 1.
From the dashboard, click Portal Users.
The Portal Users screen appears.
29
System Management
2. Click Create Portal User. The Create Portal User dialog box appears.
Figure 11 Create Portal User Dialog Box
3. Complete the fields in the Create Portal User dialog box. 4. Click the
slider switches to enable the applicable user role(s). 5. Click Create.
Edit Portal Users
Your privileges must permit you to edit portal users.
30
System Management
1. From the dashboard, click Portal Users. The Portal Users screen appears.
Figure 12 Portal Users Screen
NOTE: If your role allows you to reset the passwords of Profile Manager portal
users, you can use the Portal Users screen to do this. To reset the password
of another Profile Manager Portal User, do the following at the Portal Users
Screen. 2. Click Reset icon for the portal user whose password you want to
reset. 3. Choose the type of reset: Manual or email. Complete the other fields
in the dialog box. 4. Click Reset to close the Reset Password dialog box.
31
System Management
5. Click for the portal user, you wish to edit. The Edit Portal User dialog
box appears. Figure 13 Edit Portal User Dialog Box
6. Update entries in the fields in the Create Portal User dialog box. 7.
Click the slider switches to enable/disable the user role(s). 8. Click Update.
The Edit Portal User dialog box closes, and the portal user is updated with
the user role(s).
Delete Portal Users
Your privileges must permit you to delete portal users. 1. From the dashboard,
click Portal Users.
The Portal Users screen appears. 2. Click for the portal user, you wish to
delete.
The Delete Portal User dialog box appears. 3. Click Yes to delete. NOTE: If
there is a PTT Pro Group defined for the role, deleting a role also deletes
the corresponding PTT Pro Group asynchronously. This may take some time to
reflect in the PTT Pro portal.
32
System Management
Device User Attribute Management
This section describes the following: · Create Device User Attributes · Edit
Device User Attributes
Create Device User Attributes
Use this procedure to create device user attributes. Your privileges must
permit you to create device user attributes. 1. From the dashboard, click
Device User Attributes.
The Device User Attributes screen appears. Figure 14 Device User Attributes
Screen
33
System Management
2. Click Create User Attribute. The Create Device User Attribute dialog box
appears. Figure 15 Create Device User Attribute Dialog Box
3. Use the following table to set up the device user attribute.
Parameter Name Display Name UI Order
Required
Unique Editable (on update) Type
Description The internal name of the attribute. The name displayed in the
Create Device User dialog box. Sequence of where the attribute appears in the
Create Device User dialog box. Enable to make the attribute a required field
in the Create Device User dialog box. Enable to make the attribute unique for
each user. Enable to allow edits for the device user attribute.
Data type, for example: string, string array, password, boolean, or
enumeration.
4. Click Create.
The Create Device User Attribute dialog box closes and the new attribute
appears on the Device User Attributes screen.
34
System Management
Edit Device User Attributes
Your own role must allow editing device user attributes. 1. From the
dashboard, click Device User Attributes.
The Device User Attributes screen appears. 2. Click for the device user
attribute you wish to edit.
The Edit Device User Attribute dialog box appears. Figure 16 Edit Device User
Attribute Dialog Box
3. Update the fields as in Create Device User Attributes. 4. Click Update.
Device User Role Management
This section describes how to: · Create a device user role · Edit Device User
Roles · Delete Device User Roles
35
System Management
Create Device User Role
Your privileges must permit you to create device user roles. 1. From the
dashboard, click Device User Roles.
The Device User Roles screen appears. Figure 17 Device User Roles Screen
2. Click Create Device User Role. The Create Device User Roles dialog box appears. Figure 18 Create Device User Role Dialog Box
3. Enter the role name in Name. Only alphanumeric and _.*#!/?$ characters are
allowed. Roles are mapped to the PTT Pro group name. The maximum length
allowed for the PTT Pro group is 33 characters. Generally, the group name is
prefixed with the site name. Hence, one must limit the role name’s length to
33 characters to accommodate the site name.
4. Enter a description of the role in Description box.
5. Make a selection in PTT Pro Group.
Setting
Definition
None
No Device User Role (a.k.a. group) is created in PTT Pro.
36
System Management
Setting Static
Dynamic
Definition
The Device User Role is created as a Static group in PTT Pro when users are
imported from Active Directory (AD) to PTT Pro. The Static group in PTT Pro
contains all imported users and the static group does not allow users to be
added or removed when the Device User changes/switches their Device User Role
in the Zebra Profile Client application.
The Device User Role is created as a Dynamic group in PTT Pro when users are
imported from Active Directory (AD) to PTT Pro. The Dynamic group is created
empty, without any users inside of it. When a Device User changes/switches
their Device User Role in the Zebra Profile Client application, the group
settings are updated appropriately in PTT Pro based on the “Add to
AllDynamicGroup” tenant configuration.
6. Enable Transfer Role, if the Voice Role is transferable between 2 users.
It enables the user to take ownership of the Role/Extension from another user
who is currently owning the Role/Extension but may not be actively using it.
If the Transfer Role configuration is turned off at the Tenant configuration
level, and then nobody can change this configuration. This configuration
applies only to the Voice Profile. The PTT Pro group must not be assigned to
this role.
7. Click Create.
The Create Device User Roles dialog box closes, and the new role appears on
the Device User Roles screen.
Edit Device User Roles
Your privileges must permit you to edit device user roles. 1. From the
dashboard, click Device User Roles.
The Device User Roles screen appears. 2. Click for the device user role you
wish to edit.
The Edit Device User Role dialog box appears.
Figure 19 Edit Device User Role Dialog Box
3. Transfer Role is disabled if the Transfer Role Configuration is turned off
at the Tenant configuration level.
4. Update the fields.
37
System Management
5. Click Update.
Delete Device User Roles
Your privileges must permit you to delete device user roles. NOTE: No Device
User may be assigned to the role you wish to delete. · To cancel, click No. To
continue, click Yes. 1. From the dashboard, click Device User Roles.
The Device User Roles screen appears. 2. Click for the device user role you
wish to delete.
The Delete Device User Role dialog appears. Figure 20 Delete Device User Role
Dialog Box
Device User Management
This section describes the following: · View Device Users · Add and Update
Device Users · Delete a Device User · Refresh a Device User’s Status
View Device Users
The Device Users screen displays the current information for all device users,
such as login status and logged-in users. Your privileges must permit you to
view device users. From the dashboard, click Device Users.
38
System Management
The Device Users screen appears. Figure 21 Device Users Screen
Add and Update Device Users
For device users to connect to the Profile Manager network, they must be added
in the Profile Manager application. There are two ways to add device users. ·
add/update multiple device users (bulk import device users). · add a device
user. · through the AD Connector Service. · through the Flat File Import. The
Profile Manager Provisioning Guide describes how to import users through bulk
import, the AD Connector, or a flat file using Google Cloud Platform and
Secure FTP. The Profile Manager Provisioning Guide provides detailed
information regarding the architecture of the various methods of importing
multiple users into the Profile Manager and PTT Pro, where applicable. In
addition, the guide describes the process for each import method, the
associated Attribute Transformations, and the information required from the
customer to enable each method.
Add or Update Multiple Device Users
The support of Bulk Import Device Users (Bulk Import Device Users) is detailed
in the Bulk Import Device Users.
Add a Device User
Use this procedure to create device users. · Your privileges must permit you
to create device users. · User role(s) to assign must already have been
created, as in Create Device User Roles.
39
System Management
1. From the dashboard, click Device Users. The Device Users screen appears.
2. Click Create Device User. The Create Device User dialog box appears.
Figure 22 Create Device User Dialog Box
3. Complete the fields in the Create Device User dialog box. 4. Select either
Role Level or Roles for the user. If the Role Level is selected, the
associated roles to
the Role Level are assigned to the user. If both Roles and Role Level are
provided, Role Level takes precedence over the Roles 5. If the Authentication
Type in the Tenant Configuration is LAUNCHER or IMPRIVATA, the Force Logout
box is hidden. The values set earlier for this box are ignored during the
device’s login. 6. Click Create.
Edit a Device User
Your privileges must permit you to edit device users. 1. From the dashboard,
click Device Users.
The Device Users screen appears. 2. Click for the device user you wish to
edit.
The Edit Device User dialog box appears.
40
System Management
3. Update the fields as in Add a Device User. 4. Select either Role Level or
Roles for the user. If the Role Level is selected, the associated roles to
the Role Level are assigned to the user. If both Roles and Role Level are
provided, the Role Level takes precedence over theRoles. If the user enables
Save Role Selection during the device Login, any changes to the associated
user roles clear the Save Role Selection flag so that the user is presented
with a Role Selection screen when the user logs in next time. NOTE: If your
role allows you to reset the passwords of device users, you can use the Edit
Device User dialog to do this. To reset the password of the device user, add a
temporary password to the Password and Confirm Password fields. Provide the
device user with a temporary password. Then the device user can log into the
system and change their temporary password to a different password. 5. Click
Update.
Delete a Device User
Use this procedure to delete a device user. Your privileges must permit you to
delete device users. NOTE: To bulk delete more than one device user, see the
procedure for Add/Update Multiple Devices/Enroll Multiple Devices (Bulk Import
Devices). 1. From the dashboard, click Device Users.
The Device Users screen appears. 2. Click for the device user you wish to
delete.
The Delete Device User dialog box appears. Figure 23 Delete Device User
3. Click Yes to delete.
Refresh a Device User Status
1. From the dashboard, click Device Users. The Device Users screen appears.
41
System Management
2. Click for the device user whose presence you wish to refresh. The User
Presence Indicator displays the latest information.
Device Management
This section describes the following: · License management Using Device
Management · View devices · Add/Enroll and Update Devices · Delete/De-Enroll a
Device · Refresh devices
License Management Through Device Licenses
Device Licenses allow users to access the system, devices can be
added/enrolled, updated and deleted/de-enrolled to control device licenses.
The procedures in this section describe device license management.
View Devices
The Devices screen displays current information for all devices, such as login
status and logged in users. Your privileges must permit you to view devices.
From the dashboard, click Devices.
42
System Management
The Devices screen appears. Figure 24 View Devices Screen
Add/Enroll and Update Devices
For devices to connect to the Profile Manager network, they must be
added/enrolled in the Profile Manager application. There are two ways to
add/enroll devices. · add/update multiple devices (bulk import devices) · add
a device.
Add/Update Multiple Devices/Enroll Multiple Devices (Bulk Import Devices)
Use this procedure to upload a file from another system to replace an entire
database or to synchronize changes. · Your privileges must permit you to bulk
import devices. · The import file must be CSV format. · The devices to be
synchronized must already exist in the database. · The Profile Manager
database is case sensitive. Review the CSV file before upload. NOTE: You can
delete devices in a bulk using this procedure, by bulk importing an updated
devices list that does not contain the devices that you like to delete, and
using the Replace entire database option during the bulk import. 1. From the
dashboard, click Device.
The Devices screen appears.
43
System Management
2. Click Import Devices. The Bulk Import Devices dialog box appears. Figure
25 Bulk Import Devices Dialog Box
3. Select an option. · To synchronize the database updates from the import
file, select Overwrite deltas. · To overwrite the existing database, select
Replace entire database.
4. To upload a file, click Upload or Drag csv file here and browse to select
the CSV file. NOTE: To download a CSV template file to use to create the file
to upload, click the link at bottom right of the dialog box, prepare the CSV
file, and then return to this procedure. 5. Follow the screen prompts to
complete the bulk import.
Add a Device
Your privileges must permit you to add devices. 1. From the dashboard, click
Device.
The Devices screen appears.
44
System Management
2. Click +Add Device. The Add Device screen appears. Figure 26 Add Device
Screen
3. In the Device Id field, enter the device ID. NOTE: Device Id usually is a
unique combination of a device model and a device serial number (Example:
TC5111111111111111) The device ID must be from 10 to 64 alphanumeric
characters in length. The allowed special characters are underscore () hyphen
(-) and period (.).
The other fields may be completed now or later. 4. Click Create.
If you entered invalid information, the system displays an error message. The
device created is listed in the Devices screen.
Edit a Device
Your privileges must permit you to edit devices. 1. From the dashboard, click
Devices.
The Devices screen appears. 2. Click for the device you wish to edit.
The Edit Device dialog box appears. 3. Update the changes and click Update.
Delete/De-Enroll a Device
Use this procedure to delete/de-enroll a device. Your role privileges must
permit you to delete/de-enroll devices.
45
System Management
1. Click for the device(s) to delete/de-enroll. Figure 27 Devices Screen
The De-Enroll Device dialog box appears. Figure 28 De-Enroll Device Dialog Box
2. Click Yes to delete/de-enroll. The device is deleted/de-enrolled, and the
device is removed from the device list. The device is deleted from the Zebra
PTT Pro system, obsoleted from Extension Manager/Provisioning Manager, and
deleted from the Profile Manager system. If the device is not found in Zebra
PTT Pro
46
System Management
and Extension Manager, it further deletes the device from the Profile Manager
system. Displays either the consolidated message with the deletion status of
each system or the system error message. If a device is deleted/de-enrolled
while a user is logged into the device, the user’s session of the Zebra
Profile Client is ended automatically, and the user is automatically logged
out of the device. If login is attempted on a deleted/de-enrolled device, the
login is denied and the device displays a message that the device is not
activated. NOTE: Device Id is usually a unique combination of a device model
and a device serial number (Example: TC51_11111111111111). The device ID in
the Zebra PTT Pro system is expected to be just the serial number part of it.
After the last underscore, the system strips the characters and treats that as
the serial number. If there is no underscore, it deletes the complete device
ID specified in the Zebra PTT Pro system. If multiple devices are selected for
deletion, then there is a consolidation message about whether the devices are
deleted successfully or failed. If any device is failed to delete, a failure
message is displayed. In case of Extension Manager, there should be at least
one super administrator-defined for this tenant in the Extension Manager to
delete/obsolete the device. Otherwise, the delete activity fails. If the
device is present in a different tenant than the one which we are trying to
delete, then the delete activity continues deleting from other systems with an
appropriate status message.
Refresh a Device Status
1. From the dashboard, click Device. The Devices screen appears.
2. Click for the device whose presence you wish to refresh. The status
indicator displays the latest information.
Profile Definition Management
This section describes how to: · Create profile definitions · Edit profile
definitions · Delete profile definitions.
Create Profile Definitions
Use this procedure to add profile definitions. Your privileges must permit you
to create profile definitions.
47
System Management
1. From the dashboard, click Profile Definitions. The Profile Definition
screen appears. Figure 29 Profile Definitions Screen
2. Click Create Profile Definition. The Create Profile Definition dialog box appears. Figure 30 Create Profile Definition Dialog Box
3. In the Name field, enter a name for the profile definition.
4. In the Description field, enter a description for the profile definition.
5. Click Next.
6. Click
to enter the profile definition in JSON format, include app_info and app_setting
definitions.
48
System Management
7. Click 8. Click Create.
to verify the JSON.
Edit Profile Definitions
Your privileges must permit you to edit profile definitions. 1. From the
dashboard, click Profile Definitions.
The Profile Definition screen appears. 2. Click for the profile definition you
wish to edit.
The Edit Profile Definition dialog box appears. 3. Update the fields as in
Create Profile Definitions. 4. Click Update.
Delete Profile Definitions
Your privileges must permit you to delete profile definitions. 1. From the
dashboard, click Profile Definitions.
The Profile Definition screen appears. 2. Click for the profile definition you
wish to delete.
The Delete Application Definition dialog box appears. 3. Click Yes to delete.
Profile Configuration Management
This section describes how to: · Create profile configurations. · Edit profile
configurations. · Delete profile configurations.
Create Profile Configurations
· Your privileges must permit you to create profile configurations. · The
necessary profile definitions must already be created if you want to assign
them while creating
profile configurations.
49
System Management
1. From the dashboard, click Profile Configurations. The Profile
Configurations screen appears. Figure 31 Profile Configurations Screen
2. Click Create Profile Configuration. The Create Profile Configuration dialog box appears. Figure 32 Profile Configuration Dialog Box Screen
3. Use the following table to complete the Create Profile Configuration dialog box.
Parameter Name Description Profile Definition
Description Unique name for this configuration.
Description of the profile configuration.
Depending on the profile definition you choose, options appear in Settings.
4. Click Next. A list of options associated with the profile definition, if
any, appears.
5. Click Create.
50
System Management
Edit Profile Configurations
Your privileges must permit you to edit profile configurations. 1. From the
dashboard, click Profile Configurations.
The Profile Configurations screen appears. 2. Click for the profile
configuration you wish to edit.
The Update Profile Configuration screen appears. 3. Make desired changes on
the General Info tab. 4. Click Next. 5. Make desired changes on the Settings
tab. 6. Click Update.
Delete Profile Configurations
Your privileges must permit you to delete profile configurations. 1. From the
dashboard, click Profile Configurations.
The Profile Configurations screen appears. 2. Click for the profile
configuration you wish to delete.
Rule Management
The Rules function provides rules that control actions in the Profile Manager
portal. This section describes how to: · View list of rules · Create rules ·
Publish rules · Delete rules
51
System Management
View Rules
The role you own must allow you to view the list of rules. · From the
dashboard, click Rules.
The list of rules appears. Figure 33 Rules Screen
Create Rules
You own role must allow you to create rules. 1. From the dashboard, click
Rules.
The Rules screen appears. Figure 34 Rules Screen
52
System Management
2. Click Create Rule. The Create Rule dialog box appears. Figure 35 Create
Rule Dialog Box
3. Enter a name in the Name field. 4. Enter a description in the Description
field. 5. Click Next.
The Event screen appears. Figure 36 Create Rule — Event Screen
6. Select options for User Actions, Automation, and Location Events.
53
System Management
7. Click Next. The Conditions screen appears. Figure 37 Create Rule –
Conditions Screen
8. Leave setting at AND, or select OR. 9. To add a rule, click +Add Rule.
Otherwise, to add a rule set click +Rule Set.
If you enter invalid information, the system displays an error message. 10.
Select options from the Field, Operator, and Value drop-downs. 11. Click Next.
The Actions screen appears. Figure 38 Create Rule – Actions Screen
12. Select Actions. 13. Select User. 14. Click Create.
The new rule is created.
Publish Rules
NOTE: Once the rule is created and any time a rule is edited, it must be
published.
54
System Management
The role that you own allows you to publish rules. 1. From the dashboard,
click Rules.
The Rules screen appears. Figure 39 Rules Screen
2. Click Publish. The Publish Rules dialog box appears. Figure 40 Publish
Rules Dialog Box
3. Click Yes. The rules are published.
Delete Rules
The role that you own must allow you to delete rules.
55
System Management
1. From the dashboard, click Rules. The Rules screen appears. Figure 41 Rules
Screen
2. Select the checkbox for the rule(s) you wish to delete. The Delete Rules
button appears.
3. Click Delete Selected Rule(s). The rule(s) are deleted.
System Report Management
The System Reports function provides historical reporting of actions performed
in the Profile Manager portal. This section describes how to: · Generate
system reports · Export system reports · Create report templates · Edit report
templates · Delete report templates.
Generate Reports
The role that you own must allow you to generate system reports.
56
System Management
1. From the dashboard, click System Reports. The Generate System Report
screen appears. Figure 42 Generate System Report Screen
2. Click the Select Saved Report drop-down and select the report that you
wish to generate. 3. Click Generate Report.
The report appears. Figure 43 Generate Report
Export Reports
· Your privileges must permit you to export system reports. · You must
generate a report to export it, see Generate Reports.
57
System Management
1. Generate a report, as previously described. The Generated Report screen
appears.
2. From the Generated Report screen, select the icon for the export (Print,
PDF, CSV, or XLS). If you selected Print, options for printing the report
appear. Otherwise, the file (PDF, CSV, or XLS) is generated and automatically
downloaded.
Create Report Templates
Your privileges must permit you to create report templates. 1. From the
dashboard, click System Reports.
The Generate System Report screen appears. 2. Enter the start and end times in
the To and From Time Frame fields. 3. Select one or more Level boxes. 4. Click
the Services drop-downs and use the slide switches to enable functions for the
report. 5. Enter a report name in the Create Saved Report box in the bottom
left of the Generate Report screen. 6. Click Save.
The report template appears in the Select Saved Report drop-down. Figure 44
Create Saved Report
Edit Report Templates
Your privileges must permit you to edit report templates. 1. From the
dashboard, click System Reports.
The Generate System Report screen appears. 2. Click Select Saved Report from
the upper right and select the report template you wish to edit.
The saved report populates the screen.
58
System Management
3. Make the desired changes to the General and Advanced tabs as in Create
Report Templates. 4. Scroll down and click Save.
The report template is updated.
Delete Report Templates
Your privileges must permit you to delete report templates. 1. From the
dashboard, click System Reports.
The Generate System Report screen appears. 2. Click Select Saved Report from
the upper right and click for the report template you wish to delete.
The Delete Template confirmation dialog box appears. 3. Click Yes to delete.
The report template is removed from the Select Saved Report list.
59
Identity Provider Import Management
Identity Provider Import Management
This chapter describes how to manage: · Device user attribute mappings ·
Import jobs · Import job notifications · Import job scheduler. This next
section provides the ability to import specific fields from your Identity
Provider (IDP) user characteristics into PTT Pro and Profile Manager Systems.
The Profile Manager Provisioning Guide describes how to import users through
bulk import, the AD Connector, or a flat file using Google Cloud Platform and
Secure FTP. The Profile Manager Provisioning Guide provides detailed
information regarding the architecture of the various methods of importing
multiple users into the Profile Manager and PTT Pro, where applicable. In
addition, the guide describes the process for each import method, the
associated Attribute Transformations, and the information required from the
customer to enable each method.
Device User Attribute Mappings
View Mappings
Your privileges must permit you to view device user attribute mappings.
60
Identity Provider Import Management
1. From the dashboard, click Device User Attribute Mappings. The PTT Pro
System tab displays the System Attributes and Transformations sub tabs. Figure
45 PTT Pro System Tab
2. To view a mapping for the PTT Pro System, click System Attribute.
Otherwise, click the Profile Manager System tab and click System Attribute.
The Transformations content are populated.
Add an Attribute, Constant or Function
Your privileges must permit you to modify user attribute mappings. 1. From the
dashboard, click Device User Attribute Mappings.
The PTT Pro System tab displays the System Attributes and Transformations
subtabs.
61
Identity Provider Import Management
2. Click a system attribute. The Transformations content is populated. Figure
46 PTT Pro System Tab
3. From the Transformations subtab, click the Add Attribute button or the Add
Constant button or theAdd Function button.
4. In the box that appears, enter the required information. 5. Select an
option from the drop-down. 6. Add more attributes or constants, if needed. 7.
Click Save. NOTE: · All the mandatory user attributes are mapped to either
attribute, constant, or function. In case
of Profile Manager, · User Roles and User Role Levels are optional user
attributes. However, one of them must
be mapped properly. · If the Authentication Type in the Tenant Configuration
is IMPRIVATA or LAUNCHER, the
Force Logout mapping can be anything. This is ignored during the device Login.
Add Attributes
User attributes can be mapped any of the attributes coming from LDAP or flat
file system, in case of LDAP, the attribute name should be given in lowercase.
In case of a flat file system, the attribute name should be given in the same
case as given in the CSV file header fields. User attributes can be mapped
with IF THEN ELSE conditional expression by using the Else separator between
the attributes. If the first attribute is not present or the attribute value
is not present, then the second attribute value is used for user attribute
mapping. One can define multiple LDAP attributes with an Else separator
between them. Subsequent attributes are evaluated only when the previous
evaluation does not result in any value.
62
Identity Provider Import Management
Example The Map user attributes First Name to preferred_name or fist_name LDAP
attribute with Else separator. In this case, the First Name is mapped with
preferred_name if it is present; otherwise, it maps with the first_name
attribute. NOTE: There is special support given to the LDAP member of
attribute for user attribute Role Level and Roles. This converts the list
having attribute name CN into comma-separated values. Example
[ “CN=Smartphones_SM1,OU=Security
Groups,OU=Groups,OU=East,OU=Resources,DC=rona,DC=ca”,
“CN=Smartphones_SM2,OU=Security
Groups,OU=Groups,OU=East,OU=Resources,DC=rona,DC=ca”,
“CN=Smartphones_SM3,OU=Security
Groups,OU=Groups,OU=East,OU=Resources,DC=rona,DC=ca” ] is converted as
Smartphones_SM1, Smartphones_SM2, Smartphones_SM3
Add Function
This feature is added to extract the part of the AD attribute value or
substitute with lookup feature to map with the user attribute value. Function
can be mapped with any of the PTT Pro or Profile Manager user attribute.
Function is added as JSON string with required parameters for each function.
An example of JSON is added in the text field when the Add Function button is
clicked. User can modify as per the requirement.
Default Function Template { “function”:”find”, “params”:{ “value”:”Enter
here”, “pattern”:”Enter here”, “index”: 0, “group”: 0
63
Identity Provider Import Management
} }
Table 1 Function JSON Parameters
Attribute Name
Data Type
function
String
params
JSON
Description Name of the function. Supported functions: find, substitute, and
replace.
Parameters for the function. List of parameter attributes varies for.
Find Function
This function is used to extract the part of the AD attribute value. Params
JSON Parameters for Find Function
Attribute Name value
pattern index (optional)
group (optional)
Data Type String
String Integer
Integer
Description
Value field on which regex pattern is applied. This could be the combinations
of one or many AD attributes or constants strings.
For example, if the AD attribute value of given name is paul,
${givenname}@pttpro is evaluated as paul@pttpro
NOTE: If the value requires backslash () or double quotes, then these
characters should be escaped with another backslash ().For example, value
pttpro ${givenname} should be given as pttpro\${givenname}.
regex pattern to be applied on the value.
NOTE: If the pattern requires backslash () or double quotes, then these
characters should be escaped with another backslash (). For example; pattern ^
For example; pattern ^d{4} should be given as ^\d{4}
If the pattern matches with multiple values:-
If value is less than 0, then returns all the matching regex expression value
separated by comma.
If value is greater than or equal to 0, then returns the pattern value at the
given index.
Default Value: 0
If the regex uses grouping, it returns the group value.
Default value:0
64
Identity Provider Import Management
Example 1 Map the user attribute department to the AD attribute
extensionattribute7. The extensionattribute7 value in AD is 1024-0843 SS-
Apparel function mapping for department attribute.
” function”:”find”, “params”:{ “value”:”${extensionattribute7}”,
“pattern”:”^\d{4}”, “index”: 0, “group”: 0 }}
This should extract first 4 digits from extensionattribute7 AD attribute value
and map to the user attribute department. Example 2 if the member of AD
attribute has the following value
[ “CN=Smartphones_SM1,OU=Security
Groups,OU=Groups,OU=East,OU=Resources,DC=rona,DC=ca”,
“CN=Smartphones_SM2,OU=Security
Groups,OU=Groups,OU=East,OU=Resources,DC=rona,DC=ca”,
“CN=Smartphones_SM3,OU=Security
Groups,OU=Groups,OU=East,OU=Resources,DC=rona,DC=ca” ] User Role Level mapping
mapping with below find function mapping results in same list of role levels
with comma separation { “function”: “find”, “params”: { “value”:
“${memberof}”, “pattern”: “CN=(.?),”, “index”: -1, “group”: 1 } }
is converted as Smartphones_SM1, Smartphones_SM2, Smartphones_SM3
Substitute Function
This function is used to extract the part of the AD attribute value and use it
as key for a lookup table provided in the function to get the corresponding
value from the lookup table.
65
Identity Provider Import Management
Table 2 Params JSON Parameters for Substitute Function
Attribute Name
Data Type
Description
value
String
Value field on which regex pattern is applied. This could be the combinations of one or many AD attributes or constants strings.
For example, if the AD attribute value of extensionattribute7 is 10245-0843 -SRE-Apparel, ${extensionattribute7} is evaluated as 10245-0843-SRE-Apparel
pattern
String
NOTE: If the value requires backslash () or double quotes, then these
characters should be escaped with another backslash ().For example, value
pttpro${givenname} should be given as pttpro\ ${givenname}.
regex pattern to be applied on the value.
NOTE: If the pattern requires backslash () or double quotes, then these
characters should be escaped with another backslash ().
For example; pattern ^d{4} should be given as ^\d{4}.
index (optional) Integer
If the pattern matches with multiple values, it returns the pattern value at the given index. Default Value: 0
group (optional) Integer
If the regex uses grouping, it returns the group value. Default value:0
map
Map of Name and List of name and value pair for replacing the key name with
Value
value.
For example;
{ “1023”: “admin”, “1024”: “sme”, “1025”:”associate”, “1026”:”standard” }
Example 1
Map the user attribute department to the AD attribute extensionattribute7. The
extensionattribute7 value in AD is 10245-0843-SRE-Apparel.
Function of mapping the department attribute
{
66
Identity Provider Import Management
“function”:”substitute”, “params”:{ “value”:”${extensionattribute7}”,
“pattern”:”^\d{4}”, “index”: 0, “group”: 0, “map”: {
“1023”: “admin”, “1024”: “associate”, “1025”:”sme”, “1026”:”standard”
} } }
This should extract first 4 digits from extensionattribute7 AD attribute value
and lookup for the map attribute to get the value pair for this name and map
to the user attribute.department. In the above example first 4 digit extracted
to 1024. Look up for 1024 in the map attribute which is associated with user
attribute department and user attribute department sets with associated value.
Example 2 Map the user attribute department to the AD attribute
extensionattribute7. Theextensionattribute7 value in AD is jobid=1024.
Function of mapping the department attribute
{ “function”:”substitute”, “params”:{ “value”:”${extensionattribute7}”,
“pattern”:”(jobid=)(\d{4})”, “index”: 0, “group”: 2, “map”: {
“1023”: “admin”, “1024”: “associate”, “1025”:”sme”, “1026”:”standard” } } }
In this example, pattern is used to divide the value in 2 groups. This should
return the 4 digit value from the second group. (group 0 always returns the
entire source string). Once the digits are extracted, look up for the map
attribute to get the value pair for this name and map to user attribute
department . In the above example first 4 digit extracted to 1024. Look up for
the 1024 in the map attribute which is associated with the user attribute
department and user attribute department sets with the associated value.
67
Identity Provider Import Management
NOTE: · if the key (1024 in this example) is not found in the map, it sets the
null value to the
department user attribute. · If user attribute is mandatory type, then
importing of user fails.
Replace Function
This function is used to replace the ad attribute value with replace string.
Table 3 Params JSON parameters for replace function
Attribute Name
Data Type
Description
value
String
Value field on which regex pattern is applied. This could be the combinations of one or many AD attributes or constants strings.
For example; if the AD attribute value of extensionattribute7 is 10245-0843 -SRE-Apparel, ${extensionattribute7} is evaluated as 10245-0843-SRE-Apparel
search
String
NOTE: If the value requires backslash () or double quotes, then these
characters should be escaped with another backslash ().For example, the value
pttpro ${givenname} should be given as pttpro\${givenname}
Search pattern to be applied.
replace
String
NOTE: If the value requires backslash () or double quotes, then these
characters should be escaped with another backslash (). For example; pattern
^d{4} should be given as ^\d{4}
Replace the string for all the search patterns.
Search pattern is checked by ignoring the case.
max (optional)
Interger
Number of occurrences to replace. Default value: -1 (ALL) Case sensitive 1 Replace first string Case sensitive N Replace nth string Ignore Case
Example
Map the user attribute department to the AD attribute extensionattribute7. The
extensionattribute7 value in AD is 1024-0843-SRE-Apparel.
Function mapping for department attribute
{” function”:”replace”, “params”:{ “value”:”${extensionattribute7}”, “search”:”1024″,
68
Identity Provider Import Management
“replace”: “software” }
It replaces all search strings 1024 in extensionattribute7 AD attribute value
with replace string software and map to user attribute department. In the
above example 1024 is replaced with software. The user attribute department
uis set with value of software-0843-SRE-Apparel.
NOTE: If the key is not found in the map, it does not replace the string.
Create Extension During User Import
When importing the user into the Profile Manager system, it can automatically create and reserve an extension in the Extension Manager. The following details are needed for reserving an extension during the user import.
Name Department Hidden Department Name
PBX Extension
Description
User attribute mapping for Profile Manager. This field should contain a valid
site name defined in the Extension Manager.
Name of the department in the extension manager. This should be configured for
this tenant in the tenant configuration. If the department is not present in
the extension manager, it creates one for the first user import. Extensions
are created under this department.
This is the sip_mac or extension value of the PBX, depending on the target
PBX. Target PBX is configured as the default PBX for the customer in the
Extension Manager.
If the PBX Extension is changed during subsequent user import, the old
extension is deleted, and a new one is created.
NOTE: · Create PBX Extension using the User Create/Edit UI. · Creating the PBX
extension is not supported in the user import using a CSV file.
Integrating Zebra Enterprise Messaging Server (ZEMS) During User Import
During the user import, one can associate the user as a manager of the site or
region in the ZEMS system. Actual association happens when the ZEMS system is
synced with the PTT PRO server. Usually, ZEMS syncs once a day unless sync is
triggered manually. One must configure the ZEMS sync time after the Profile
Manager user import job scheduled time.
The following details are needed for the association:
1. Configure the ZEMS URL and API key in the tenant configuration.
2. Add the manager and region fields in the user input CSV file or identify
these fields in LDAP attributes.
69
Identity Provider Import Management
3. Add the PTT PRO user mapping for the manager and region attributes, as shown in the following table.
Name Manager
Description
The mapping attribute value in LDAP or CSV file should be either true or
false.
If the field value is true, and it was false or empty during the last import,
a user is associated as a manager to the site and region list specified in the
region field.
If the field value is true, and it was true during the last import, the user
is associated as a manager to the site and region list, which are newly added.
Also removed from the association if it is removed from the list.
If the field value is false, and it was true during the last import, the user
is removed from the previous site and region association.
If the field value is false, and it was false during the last import, no
changes in the association.
Region
The mapping attribute value in an LDAP or CSV file should contain a list of
sites or regions separated by a comma.
By default, the user’s current site is associated using the Department field.
If the user needs to be associated with other sites, it should be included in
the region field.
Clear an Attribute Mapping
To clear a user attribute mapping: 1. Navigate to the attribute mapping to
clear, as in View Mappings. 2. Click Clear.
70
Identity Provider Import Management
Import Job Management
The Import Job takes the information from the attribute mappings, and
populates the information in the Profile Manager and PTT Pro Systems.
View Import Jobs
Your privileges must permit you to view import jobs. · From the dashboard,
click Import Jobs.
The Import Jobs screen appears. Figure 47 Import Jobs Screen
Create Import Jobs
Your privileges must permit you to create import jobs. 1. From the dashboard,
click Import Jobs.
The Import Jobs screen appears.
71
Identity Provider Import Management
2. Click Create Job. The Create Job dialog box appears. Figure 48 Create a
Job Dialog Box
3. Use the following table to complete the fields in the Create Job dialog box.
Field Name Name Scope
Description Job Name Active Directory Search Scope · Object: base object · One Level: immediate children of the base object · Subtree: base object and all child objects.
Query
Search the Active Directory. For example: OU=users,DC=PTTPRO,DC=ZEBRA
For Flat file import, this field is ignored. Users can enter any value. For
clarity, users can enter GCP for the Google Cloud storage and SFTP for the
SFTP server.
Filter
Search for a subset of the user(s).
For example, to search for anyone with the name Andrew: (name=andrew*)
For Flat file import, this field should be filled with the file name that
needs to be downloaded from the Google Cloud bucket or SFTP server.
Description
Optional description of the purpose of the import.
72
Identity Provider Import Management
Edit Jobs
Your privileges must permit you to edit import jobs. 1. From the Dashboard,
click Import Jobs.
The Import Jobs screen appears. 2. Click next to the job you wish to edit.
The Edit Job dialog box appears. Figure 49 Edit Job Dialog Box
3. Update the fields as in Create Job Dialog Box. 4. Click Update.
It is recommended not to change the Query and Filter parameter values during
the editing job. Instead, one should create a new job if any changes are
required in the query. This is mostly applicable to the LDAP-based import job.
If there are users imported with the original job, those users might get
imported again with the new job if the query matches. Because the job is
created new, all those users are displayed as New records in the job history
for the first run. However, job execution creates or updates the record
depending on whether a user exists in Profile Manager or in the PTT Pro
system. If the job import has huge sets of users, then creating a new job
takes a lot of time to import the users for the first time. In this case, one
can change the query/filter. It adds or deletes the new set of users based on
new query/filter criteria. If the same user is imported with multiple import
jobs, irrespective of the job history status for that user (New, Modified, or
Deleted), if the user already exists, it updates the user with new details.
The user has the details from the job which is executed last. NOTE: If you
change the name of a job, be sure to edit the job name in any Import Job
Notifications associated with the job.
Delete Jobs
Your privileges must permit you to delete jobs.
73
Identity Provider Import Management
1. From the dashboard, click Import Jobs. The Import Jobs screen appears.
2. Click next to the job you wish to delete. The Delete Job dialog box
appears.
3. Click Yes to delete.
Run Import Jobs
· Your privileges must permit you to run import jobs. · The mapping must be
set up correctly. 1. From the dashboard, click Import Jobs. 2. From the Import
Jobs screen, click for the job you wish to run.
The Run Job dialog box appears. Figure 50 Run Job Dialog Box
3. Click Yes to run the job. NOTE: Jobs run using the Run Job option are
executed sequentially even if more than one Job run is triggered
simultaneously.
View Import Job History
Your privileges must permit you to view the job history. 1. From the
dashboard, click Jobs.
74
Identity Provider Import Management
2. Click For the import job history you wish to view. The Import Job History
screen appears. Figure 51 Import Job History Screen
Process State displays the job execution status. The status gets periodically
updated depending on the BULK_UPDATE_RECORD_SIZE (Default Value = 50)
configuration in the AD-Connector service. The import job execution runs
parallel with multiple threads depending on the number of PTT Pro instances
configured for that tenant. BULK_UPDATE_RECORD_SIZE is applicable per thread.
Hence the exact number of records processed in each status update varies for
each deployment.
For example, if the number of PTT Pro instances is 24 and
BULK_UPDATE_RECORD_SIZE = 50, the status is updated and displayed after 24*50
= 1200 records.
Along with the status update, all relevant job history and delta records also
get updated in the Profile Manager.
After the job is executed, it goes through the following statuses:
Job Status IN_PROGRESS FAILURE SUCCESSFUL STOP_TRIGGERE
Description
When the job started execution.
When the job execution fails.
When the job execution becomes successful.
If the user has initiated the Stop feature on the running job. From this
state, jo,b status can go into the following status:
· FAILURE: If execution fails before the stop is processed.
· STOPPED: If more records are pending to be completed, and can stop the job
before processing all the records.
· SUCCESSFUL: If no more records are pending processing. All the records are
already processed before the Stop feature is processed.
75
Identity Provider Import Management
STOPPED
If the job execution is stopped and records remain to be processed. The stopped jobs can be restarted like any other jobs.
The Message column displays the error message in case of FAILURE or a summary
of the import relevant to job configuration.
This includes:
· The number of records processed.
· The number of successful and failed records for the Profile Manager and PTT
Pro.
· The number of modified, unmodified, new, and deleted Profile Manager and PTT
Pro records.
· The number of ignored records is because of either no matching site entry
defined in the sitemap file or the site is defined for a different Profile
Manager cluster (This applies only to the non-proxy environment with sitemap
present in AD-Connector-service).
· In case of Flat File Import, the job can also fail if the number of records
in the usermap CSV file exceeds the flat-file variance threshold percentage
allowed for this tenant. Variance is checked against the previous successful
run on upper and lower boundaries. This would prevent any wrongly generated
CSV file from being used for import which causes deleting previous records not
present in the current CSV file.
· In case of Flat File Import, the job can also fail if the usermap CSV file
does not contain the header row. Two mandatory columns Department and
UserName, identify the header row. The name of these columns can be changed
during deployment based on the usermap header format.
· The Department column header name can be changed using the general site-
header-name or CSV_SITE_HEADER environment variable. (Default Value:
Department).
· The UserName column header name can be changed using ldap.uniqueName or
LDAP_UNIQUE_NAME environment variable (Default value: samaccountname).
· For all other header columns, it just loads the column as is. The sample
error message for missing header follows:
NOTE:
· In case of PFM-Proxy, the number of records processed is equal to the number
of records of either Profile Manager or PTT Pro, depending on the selected
dispatcher.
· In case of non-proxy, the number of records processed is equal to the number
of records of either Profile Manager or PTT Pro.
NOTE: The sitemap file contains the mapping for the site to the Profile
Manager instance.
Actions available on the Import Job History screen are view details, view
deltas, and view dispatcher. 3. Click to view details.
76
Identity Provider Import Management
4. Click to stop the running job. This icon is visible only for the jobs that
have started execution.
After clicking the Stop icon, the job goes into the STOP_TRIGGERED state. The
execution of the job stops after processing all the current set of records as
defined by the BULK_UPDATE_RECORD_SIZE (Default Value = 50 per thread). The
exact number of records in a chunk depends on the number of threads (number of
PTT Pro instances). When all the records in the current chunk are processed,
the job goes to either STOPPED (if there are more records to be processed) or
SUCCESSFUL (if all the records are processed). If the job status is in the
STOPPED state, during the next subsequent execution, all unprocessed records
from the previous run, along with any error and modified records, are
processed. NOTE: · The number of enhanced PTT Pro instances configured in the
sitemap determines the number of users created/updated in parallel. The number
of enhanced PTT Pro server names determines the number of users deleted in
parallel. Refer to the Profile Manager Provisioning Guide for information
about importing the users using flat files. · Clicking the Stop icon stops the
execution of the jobs that are in process with a large number of records,
allows fixing the configuration error, and then restarts the jobs. 5. Click
View Deltas to view more information. The Deltas dialog box appears. The Type
column displays the status of the record, such as new, modified, deleted, or
unmodified. Whether or not the unmodified records are listed depends on the
AD-Connector service configuration. Typically, we should turn this off for the
user import using a flat file to reduce the required storage. The Import
function checks for changes to the user data by comparing it with the current
user data and ignoring the AD whitelist attributes configured for the tenant.
If there is no AD whitelist configured for
77
Identity Provider Import Management
the tenant, it uses the default whitelist attributes configured in the ad-
connector service system setting (general.attributesWhitelist). In the AD-
Connector service, the default whitelist attributes are: “uncreated,
whenchanged, dscorepropagationdata, unchanged, whencreated, pwdlastset,
lastlogontimestamp” unless it is changed in the deployment configuration. This
page supports sorting for entire database records instead of just the
displayed page. All the displayed columns are included in the sorting. This
page also supports search on the following columns: · User/Group · System
(Profile Manager/PTT Pro) · Type (new/modified/unmodified/deleted) Figure 52
Deltas Dialog Box
78
Identity Provider Import Management
6. Click an option in the Dispatchers column to more information. The
Dispatcher History dialog box appears in the STOPPED in this example, and it
is for the PTT Pro dispatcher: This page supports sorting for entire database
records instead of just the displayed page. All the displayed columns are
included in the sorting. This page also supports search on the following
columns: · User/Group · Action (new/modified/deleted) · Process State
(FAILURE/SUCCESSFUL) Figure 53 Dispatcher History (PTT Pro) Dialog Box
NOTE: The User/Group field is populated using the LDAP_UNIQUE_NAME attribute
value specified in the AD Connector service. By default, this is mapped to
samaccounname during deployment.
79
Identity Provider Import Management
Import Job Notifications
Import job notifications are email messages based on the result of LDAP jobs.
Profile Manager can send messages to one or more email addresses for import
job success, failure, or both.
View Import Job Notifications
You must have privileges to view import job notifications. · From the
dashboard, click Import Job Notifications.
The Import Job Notifications screen appears. Figure 54 Import Job
Notifications Screen
Create Import Job Notifications
· Your privileges must permit you to create import job notifications. · At
least one query must already be created. To 1. From the dashboard, click
Import Job Notifications.
The Import Job Notification screen appears.
80
Identity Provider Import Management
2. Click Create Notification. The Create Notification dialog box appears.
Figure 55 Create Notification Dialog Box
3. Enter a name for the notification in the Name field. 4. Select one or more
checkboxes from the right. 5. Enter one email address in the To field and
press Enter. Repeat for any additional email addresses. 6. Click Create.
Edit Import Job Notifications
Your privileges must permit you to edit import job notifications. 1. From the
dashboard, click Import Job Notifications. 2. Click for the notification you
wish to edit. 3. Modify the Edit Import Job Notification dialog box as in
Create Import Job Notifications. 4. Click Update.
Delete Import Job Notifications
Your privileges must permit you to delete an import job notification. 1. From
the dashboard, click Import Job Notifications.
81
Identity Provider Import Management
2. Click for the notification you wish to delete. The Delete Notification
dialog box appears. Figure 56 Delete Notification Dialog Box
3. Click Yes to delete.
Import Job Scheduler
Use the Import Job Scheduler to set schedules for when import jobs occur.
View Import Job Schedules
Your privileges must permit you to view import job schedulers. · From the
dashboard, click Import Job Scheduler.
The Import Job Scheduler screen appears. Figure 57 Import Job Notifications
Screen
Create Import Job Scheduler
Your privileges must permit you to create import job schedulers. 1. From the
dashboard, click Import Job Scheduler.
The Import Job Scheduler screen appears. 82
Identity Provider Import Management
2. Click Create Scheduler. The Create Scheduler dialog box appears. Figure 58
Create Scheduler Dialog Box
3. Enter a name for the scheduler in the Name field. 4. Select one or more
checkboxes from the right. If more than one job is selected, then all those
jobs get
executed parallelly during the scheduled time. Even if the jobs are part of
two different scheduled times, they get executed parallel. If more than one
job is scheduled at the same time, one must ensure that those jobs must not
have the same user. 5. Select an option from the Frequency drop-down. 6.
Select an option from the Time drop-down. 7. Click Create.
Edit Import Job Schedulers
Your privileges must permit you to edit import job schedulers. 1. From the
dashboard, click Import Job Scheduler. 2. Click for the scheduler you wish to
edit. 3. Modify the Edit Scheduler dialog box as in Create Import Job
Scheduler. 4. Click Update.
Delete Import Job Schedulers
Your privileges must permit you to delete an import job scheduler. 1. From the
dashboard, click Import Job Scheduler.
83
Identity Provider Import Management
2. Click for the scheduler you wish to delete. The Delete Scheduler dialog
box appears. Figure 59 Delete Scheduler Dialog Box
3. Click Yes to delete.
84
Client Device Setup Using Telephony Manager and Profile Manager
Client Device Setup Using Telephony Manager and Profile Manager
Client device setup using Telephony Manager and Profile Manager is for sites
that use other Telephony Manager features and functions in addition to viewing
and refreshing. For information on setting up the Client Device, refer to the
Workcloud Communication Profile Client User Guide.
This chapter describes the following:
· Configure Telephony Manager Using a CSV File
· Manually Configure Telephony Manager (for technical support)
· Configure Zebra Profile Manager
· Confirm the End-to-End Configuration of Telephony Setup
· Important Notes About Verifying Correct End-to-End Configuration
· For an overview of Telephony Manager, see Telephony Management
Configure Telephony Manager Using a CSV File
A CSV file (automated option) is used to automate the data import process.
Using a CSV import eases the effort of initial deployment, configuration and
incremental updates. To import the list of Extensions using a CSV file, see
the Extension Import Management on page 97.
Confirm Successful Import of Data from the CSV File
1. Open the Zebra Profile Manager application. 2. In the Dashboard, navigate
to Telephony Management and then open the Extensions screen. 3. In the list of
extensions, confirm that the expected entries and their corresponding values
appear,
including the information for the following: · Store_Name · Dep_Name ·
Extension Name · Profile_type · Sip_remhost · Sip_Mac_address or
Exension_Password (depending on your site’s configuration) 4. Close the Zebra
Profile Manager application.
85
Client Device Setup Using Telephony Manager and Profile Manager
Manually Configure Telephony Manager (for technical support)
The procedures in this section are for manually entering the required
information into Telephony Manager. This is done to itemize the details and
dependencies of specific fields. Typically, this information is imported into
Telephony Manager using a CSV file. A CSV file is used to automate the data
import process. Using a CSV import eases the effort of initial deployment,
configuration and incremental updates. Accessing the Console as described here
is considered more appropriate for minor (manual) configuration updates. There
are several steps to configure the Telephony Manager. The basic elements that
must be configured first are the following: · Store_Name · Dep_Name ·
Extension Name · Profile_type · Sip_remhost · Sip_Mac_address or
Exension_Password (depending on your site’s configuration)
Enter the Store or Site ID Information
NOTE: In Telephony Manager, the Store (Site ID), Departments, and PBXs must be
added before Extensions can be added. In Telephony Manager, the Store (Site
ID), Departments, and PBXs must be added before Extensions can be added. 1. In
Telephony Manager, navigate to the Stores tab and select Update to add a Store
entity. The Store
value must be numerically, from 1 to 19 digits long. Figure 60 Update Store
Screen
86
Client Device Setup Using Telephony Manager and Profile Manager
2. Click Update. The Store Data screen appears. Figure 61 Store Data Screen
NOTE: In Telephony Manager, ensure that the value for Store ID is the same as
the Site ID value from the Zebra Profile Client (in this case, 9999). For
instructions on finding the Site ID for a Zebra Profile Client for a device,
see the Workcloud Communication Profile Client User Guide.
Enter the PBX Information
Establishing the targeted PBX is required. The targeted PBX can be one unique
PBX per site location, or one PBX shared across several or all sites. The
required fields are PBX Type and PBX Address.
87
Client Device Setup Using Telephony Manager and Profile Manager
1. In Telephony Manager, navigate to the PBX tab and select Update to add a
PBX entity. The Update screen appears. Figure 62 PBX Update Screen
2. Enter the information for PBX Type and PBX Address. NOTE: For the PBX
Type, enter a string value. The PBX Type parameter is passed to the Profile
Client device and must be identifiable by the device for specific PBX
activation. For the valid PBXs supported for the Zebra Voice Client, refer to
the Workcloud Communication Voice Client PBX Administrator Guide. 3. Select
Update.
The following are sample PBX entries. Figure 63 Sample PBV Entries
88
Client Device Setup Using Telephony Manager and Profile Manager
Add Department Information
NOTE: In Telephony Manager, the Store (Site ID), Departments and PBXs must be
added before Extensions can be added.
Phones are assigned extensions based on Departments. There might be multiple
unique extensions defined for a Department. The Telephony Manager controls the
distribution of the extensions provided by the PBX Administrator.
The following are the inter-relationships of the data across the subsystems.
· When adding Departments, the Department Name value in Telephony Manager must
match the User Role/Department value in Profile Manager.
· After a device becomes activated on a PBX, the User Role/Department value is
displayed on the Profile Client device.
The following shows the relationship of the values in Telephony Manager,
Profile Manager, and Zebra Profile Client.
Telephony Manager
must match —> Department
Profile Manager
<— must match User Role/ Department
PBX
Zebra Client Device becomes activated –>
Workcloud Communication Profile Client Device
As a result of device activation on PBX– —> User Role/Department is populated
into the Zebra Client Device from Profile Manager
After a device becomes activated on a PBX, the User Role/Department field is
displayed on the Profile Client device.
Figure 64 User Role/Department Field on Zebra Profile Client Device (After
Device Activation on PBX)
89
Client Device Setup Using Telephony Manager and Profile Manager
1. Select the Store ID and Enter the Department Name and Description. Figure
65 Sample Add Store Screen
2. Select the Site ID from drop-down list and enter the Department Name and
Description. 3. Check the Auto Assign Extensions box. This allows Telephony
Manager to distribute available
extensions to a device. NOTE: The Department Name must match the User Role
Definition field in Profile Manager.
When completed, the Departments are displayed. The sample Department list
shows results filtered on Store 9999. Figure 66 Sample Department List
Enter PBX Extension Information
NOTE: In Telephony Manager, the Store (Site ID), Departments and PBXs must be
added before Extensions can be added.
90
Client Device Setup Using Telephony Manager and Profile Manager
1. Navigate to the Add Extension screen. Figure 67 Sample Add Extension
Screen
2. Add the Extension Name and Extension Description. NOTE: For the CUCM
Premium PBX, the MAC address for the Specific Extension is entered.
The Department assignment for the given extension is selected from the Drop
Down list. This has been previously created. The PBX Configuration is selected
from the drop-down list previously created. 3. Click Add. After all extensions
are created, the extension list displays a list of the extensions. Figure 68
Sample Extensions List (on Extensions Data Screen)
Configure Zebra Profile Manager
Create device user roles. See Device User Role Management: 1. Create device
user roles. See Device User Role Management. 2. Create device users. See
Device User Management. 3. Create profile configurations. See Profile
Configuration Management. 4. Create rule sets. See Rule Management.
Confirm the End-to-End Configuration of Telephony Setup
1. On a client device, log into Zebra Profile Connect as the user whose User
Profile you want to confirm. In this procedure, the example shown is for user
Joe Mechanic.
91
Client Device Setup Using Telephony Manager and Profile Manager
2. During login, at the Profile Client Role Selection Screen, select Switch
Roles.
The Role Selection screen appears
92
Client Device Setup Using Telephony Manager and Profile Manager
3. In the Role Selection screen, the user Joe Mechanic has three roles
available: · Line.Manager.1 · Quality.Control · Shipping
4. Compare the list of roles that is in the Role Selection screen in the
Zebra Profile Client for this user to the list of roles configured for this
user in the Zebra Profile Manager application. See Edit Device User Roles. If
the roles in Zebra Profile Client and in the Zebra Profile Manager application
match for this user, continue with this procedure. Otherwise, check with your
system administrator to confirm the list of roles to be assigned to the device
user.
93
Client Device Setup Using Telephony Manager and Profile Manager
5. In the Zebra Profile Client, select all roles listed to activate the
provisioning of extensions for all the roles. A check mark indicates that a
role has been selected.
94
Client Device Setup Using Telephony Manager and Profile Manager
6. Click Apply. Telephony Manager provisions the available extensions for
those departments in the Zebra Profile Client device. All configured roles for
the user are defined in the user profile.
7. To switch among roles, select the back arrow to navigate to the Profile
Client Role Selection screen.
Important Notes About Verifying Correct End-to-End Configuration
The extensions provisioned from Telephony Manager are determined by the
following: · The Roles presented to the User, which are defined in the User
Profile · The Role(s) that are selected by the user · If the User selects only
one role, Telephony Manager finds the extension attributes associated with
that
Role and provisions that information to the mobile device. · If the User
selects multiple roles, Telephony Manager provisions the extension attributes
to the mobile
device. · At Rule Evaluation Time, all rules are evaluated. NOTE: If a user is
defined in multiple Rule Sets, all the Rule Sets where the user is defined are
applied simultaneously to the user. It is important to make sure that this is
the desired result for the user. Otherwise, it might be necessary to adjust
the Rule Set definitions to get the desired result.
95
Telephony Management
Telephony Management
This chapter describes how to manage the following: · Extensions (viewing and
refreshing) · Extension Import Management · Other Telephony Management Options
When you use the Telephony Management links in Profile Manager, they take you
to the Extension Manager Web Portal login screen, which lets you manage these
Telephony options directly in Extension Manager Web Portal.
Extensions
This section describes how to: · view extensions. · refresh extensions.
View Extensions
Prerequisite Your privileges must permit you to view extensions.
96
Telephony Management
To view extensions: · From the dashboard, click Extensions.
The Extensions screen appears. Figure 69 Extensions Screen
Refresh Extensions
Your privileges must permit you to refresh extensions. 1. From the dashboard,
click Extensions.
The Extensions screen appears. 2. Click for the extension to refresh.
Extension Import Management
· Your privileges must permit you to bulk import extensions. · The import file
must be CSV format. · The extensions to be synchronized must already exist in
the database. · The Profile Manager database is case sensitive. Review the CSV
file before importing. 1. From the dashboard, click Extensions.
The Extensions screen appears.
97
Telephony Management
2. Click the Import Extensions tab. The Import Extensions screen appears.
3. Select an option: · To synchronize the database updates from the import
file, select Overwrite deltas. · To overwrite the existing database, select
Replace entire database.
4. To upload a file, click Upload or Drag csv file here and browse to select
the CSV file. Otherwise, click and drag the CSV file from its folder to the
box.
5. Follow screen prompts to complete the import.
Other Telephony Management Options
The following telephony options are also available to be managed: · History
(this option is view only) · Store IPs · Contacts · Stores · Departments ·
PBXs · Configurations. NOTE: When you use the Telephony Management links in
Profile Manager, they take you to the Extension Manager Web Portal Login
screen, which lets you manage these Telephony options directly in Extension
Manager Web Portal.
98
Profile Manager Licenses
Profile Manager Licenses
The Zebra Profile Manager Administrator can view the license information for
the Administrator user. This chapter describes the following: · View Profile
Manager Application Licenses · Update Profile Manager Application Licenses
Profile Manager Device Licenses
the device licenses for the Zebra Profile Client application are shared among
a larger number of devices. When you log into a device for Zebra Profile
Client, a license from a license server is provided to the device. The system
administrator must manually control which devices are enabled to be provided
the device licenses.
View Application Licenses
Your privileges must permit you to view application licenses. From the bottom
of the dashboard, click License.
99
Profile Manager Licenses
The Licenses screen appears. Figure 70 Licenses Screen
Update Application Licenses
Your privileges must permit you to update application licenses. 1. From the
bottom of the dashboard, click License.
The Licenses screen appears. 2. In the Licenses screen, select +Update
Licenses.
The Licenses screen is updated with the latest information.
100
Intents and Actions
Intents and Actions
This document describes the installation and configuration capabilities of the
Profile Client. The capabilities described in the document are based on
version 2.0.20207 or greater
Profile Manager Client Configuration File Elements
needs to configure the required Profile Manager connectivity parameters
manually through the client UI. Sample WFCDFSConfig.json file:
{ “customer_id”: “3001”, “sfs_url”: “https://<PFM_server.com>”, “site_id”:
5000, “log_level”: “debug”, “confirm_role”:false,
“power_connected_logout”:true, “log_file”: true, “dnd_switch”:true,
“config_settings”:0, “secret_key”: “my_secret_key”, “login_page_delay”: 500,
“key_user_name”: “userNameInput”, “key_user_pwd”: “passwordInput”,
“key_submit”: “submitButton”, “key_domain”: “pttpro” } See JSON Configuration
Variables for the Zebra Profile Client Table for descriptions of JSON
elements.
101
Intents and Actions
Table 4 JSON Configuration Variables for the Zebra Profile Client
Profile Client JSON Config Variables Supported in version 2.0.20207+
Label
Description
Type
Default
customer_id
Maps to the Profile Manager’s Tenant ID provided by the system administrator.
sfs_url
The system administrator provides the FQDN of the Profile Manager secure web socket connection.
log_level
Log options are Info (default), Debug, Warning, Error, and Verbose.
log_file
Enable the application to record logs and store them on the device’s SD card. Logs are available at /sdcard/DFS/
confirm_role
When set to True, once the roles are selected, the user is prompted to confirm the selections.
site_id
Is the value correlated in the Extension Manager’s Store ID value. Upon match, it aligns the group of extensions available to the User based on the Roles configured.
dnd_switch
Allows the user to display/ remove the dnd_switch in Profile Client.
config_settings
Configures the user’s visibility of the Settings Menu where: 0 = (default)
Allows the user to access and edit the client’s settings
1 = Show the Client’s setting but not to allow modification
2 = Hides the Settings Menu.
disable_signout_btn_bluefletch Configures whether the Signout button is
visible when the auth type is bluefletch. false = (default) Signout button is
visible
true = Hides the Signout button
string
Boolean TRUE integer 0
Boolean FALSE
Config via UI?
Yes Yes Yes Yes Yes Yes
No No
No
102
Intents and Actions
Table 4 JSON Configuration Variables for the Zebra Profile Client (Continued)
Profile Client JSON Config Variables Supported in version 2.0.20207+
Label
Description
Type
Default
supress_network_disconnect_baCr onfigures whether the network disconnect bar
is visible at the bottom of the screen during a network disconnect.
true = (default) Network disconnect bottom bar is not visible.
false = Network disconnect bottom bar is visible.
power_connected_logout
When enabled, the Profile Client User is signed out, and when the device is put in a cradle for charging
secret_key
Key used to decrypt the login blob delivered from the Launcher app via intent to the Profile Client.
key_user_name
Used in conjunction with 3rd Party Launcher apps. This tag identifies the Username ID field and allows input on the presented login web page. Sample html: <input type=”text” name=”username” id=”username” class=”textinput” value=””>
key_user_pwd
Used in conjunction with 3rd Party Launcher apps. This tag identifies the
Password ID field and provides input on the presented login web page. Sample
html
<input type=”password” name=”password” id=”password” class=”textinput”
autocomplete=”off”>.
key_submit
Used in conjunction with 3rd Party Launcher apps. This tag identifies the
Submit ID field for acceptance of credentials on the presented login web page.
Sample.html:
<input type=” submitButton” value=”Login” id=”submit” class=”submit”
tabindex=”4″ role=”button” >
Boolean TRUE
Boolean FALSE string
string
Config via UI?
No
Yes No No
No
No
103
Intents and Actions
Table 4 JSON Configuration Variables for the Zebra Profile Client (Continued)
Profile Client JSON Config Variables Supported in version 2.0.20207+
Label
Description
Type
Default
Config via UI?
key_domain
Used in conjunction with 3rd
string
No
Party Launcher apps. This tag
provides the insertion of a
Domain name string to add
before username. The slash
separators are automatically
added. IE: “pttpro” becomes
“pttpro\
username_layout
Used to configure the user name field of the customized EKB layout in EC30
devices.
May require a change if the layout encryption file uses a different name in
the future.
string
usernamela yout No
password_layout
Used to configure the password field of the customized EKB layout in EC30
devices.
May require a change if the layout encryption file uses a different name in
the future.
string
passwordla yout No
Support for Third-Party Launchers
In the varied environments where the Profile Manager solution is installed,
there may be an existing launcher application running on the device. This
provides the customer with the ability to keep their existing launcher for the
user sign-on process and then pass the user information to the Profile Client
to authenticate with the Profile Manager.
The four tags used in this environment are:
· Key_user_name
· Key_user_pwd
· Key_submit
· Key_domain
The values entered in these tags identify the input fields to automate the
login process. As an illustration, shown below is the actual html of a sample
login screen:
|
|