Site Map CSV File

Workcloud Communication Profile Manager Provisioning Guide

Site Map CSV File

The Site Map File determines the Profile Manager and Zebra PTT Pro server in which to provision users. In each of the three example regions, there are up to six PFM Proxy. Profile Manager/Zebra PTT Pro sets. When Profile Manager initiates the import job, the single, populated user file and site map file are downloaded from the file repository into PFM Proxy. Profile Manager processes the user file, examines the Site field of each user, and compares it with the Site field in the Mapping file to determine the server combination in which to provision the user.

If the deployment can be housed on one Profile Manager instance, the Site Mapping file is not required.

To ensure the Sites are populated in the correct and expected PTT Pro Instance, they are required to be created prior to the User Import job being executed. Do not create sites manually in the PTT Pro console. All Site creation must be performed in the Profile Manager's API interface (Swagger). When Adding Sites via the API, the AD Connector and all other necessary configuration elements are also updated to ensure the entire Workcloud Communication System knows the correct PTT Pro Instance of the Site.

Any Site referenced in the User File must be included in the Site Map File. Failure to include it in the Site map creates ambiguous error messages during the import process.

The following Site mapping file example is followed by the field description.

Store Mapping File
site	siteName	pfmurl	customerid	pfmApiKey	proserverId
1001	Site 1001	https://<pfm-server1>.pttpro.com/admin-service/v1	1	12345	Dev03
1002	1002 Store	https://<pfm-server1>.pttpro.com/admin-service/v1	1	12345	Dev03
1003	St. Louis	https://<pfm-server2>.pttpro.com/admin-service/v1	1	98765	Dev03b
1004	1004	https://<pfm-server2>.pttpro.com/admin-service/v1	1	98765	Dev03b
1005	Site-1005	https://<pfm-server3>.pttpro.com/admin-service/v1	1	1a2b3c	Dev03c
1005	North Oaks	https://<pfm-server3>.pttpro.com/admin-service/v1	1	1a2b3c	Dev03c

The Zebra PTT Pro Server URL is not included in the Mapping file. The Profile Manager server configuration has an existing Zebra PTT Pro server definition table for each PFM Tenant.

The Site Map file name is configured explicitly in the Profile Manager database and the file name must be jointly agreed upon between the customer and Zebra. Because the file name is configured in the database, it is unnecessary to specify it in the import job.

Like the User file, the Site Map file should be encrypted. A file encryption script can be provided to ensure compatibility. Note: If using encryption, both files must be encrypted using the same algorithm.

If the user file references a site number not included in the mapping file, an error occurs, and the users associated with that site are not added to the system.

The column headings in the csv file are case sensitive and must match those specified in the example above. If extra columns are present in the file, they are ignored.

Store Mapping Elements
Field	Description
Site	Identifies the Customer’s Site name (or Department) in the Zebra PTT Pro server. The Site string may contain alpha characters that are acceptable to the Zebra PTT Pro Department entry requirements.
Site Name	Description of the Site. Any string is possible
PFM URL	The URL for the Profile Manager includes the ‘admin-service/v1’ declaration.
Customer ID	The Profile Manager Customer (or Tenant) ID is found in the PFM Tenant definition.
PFM API Key	The API Key for the PFM Tenant is assigned at tenant creation time. The key is found in the console browser interface of the PFM Tenant definition, or through the API interface for each tenant.
Pro Server ID	Name of the PTT Pro server instance where the site is created. For example, if the dev03 PTT Pro cluster has 6 instances, then these names could be one of dev03, dev03b, dev03c, dev03d, dev03e, dev03f If these instances are configured, then the unique PTT Pro server name is determined as dev03.

The number of unique PTT Pro instances configured determines the number of users who are created/updated in parallel. The number of unique PTT Pro server names determines the number of users who are deleted in parallel.