[Index]

Model: data/UserFieldMapping

User Field Mapping

To access the latest documentation, go to Documentation and Resources at: https://voss.portalshape.com

Overview

User field mapping shows the list of field mappings, at the hierarchy you're working with.

VOSS Automate provides a set of default field mappings (named default) between applications and VOSS Automate user data at the sys level hierarchy. The system uses these field mappings to align data when syncing.

Whenever an application is added at a hierarchy, the default application mapping is cloned to this hierarchy level and provided with an application name (e.g. IP address for Unified CM, business key for LDAP server). The cloned mapping displays on the User Field Mapping page (default menus: User Management > Advanced > User Field Mapping), and applies to user management at this hierarchy.

The mapping that applies at the sync hierarchy (for an application that is the sync source) is used when values are written to VOSS Automate user data. Mapping for the following applications is stored in the data/UserFieldMapping model:

UC Source Model Type Application Name
CUCM device/cucm/User CUCM
MS_LDAP device/ldap/user LDAP
OPEN_LDAP device/ldap/InetOrgPerson LDAP

Example - The default CUCM mapping contains the following mapping:

VOSS Automate CUCM
User Name userid

When syncing user data from a CUCM source, where this default CUCM field mapping applies at the hierarchy, the sync updates the VOSS Automate user. You can view the sync source for these users in the Sync Source column in the list view of the Users page, via (default menus) User Management > Users. In this case, the sync source is CUCM.

Important

If application users related to a custom field mapping exist in VOSS Automate, existing mapped fields are read-only and can't be updated.

Additionally, you can define up to ten custom values for each of the following field types, which can also be mapped:

After a sync, custom values display on the Custom tab of an entry on the Users/username page. To view these values, go to (default menus) User Management > Users, click on a username in the list to open the Users/username page, and select the Custom tab

LDAP Mappings

View User Field Mappings

To view the list of mappings:

  1. Log in to the Admin Portal.

  2. Choose a hierarchy.

  3. Go to (default menus) User Management > Advanced > User Field Mapping to open the User Field Mapping page.

  4. View the list of mappings at the hierarchy.

  5. Click on a user field mapping to view its details.

    Important

    While several fields in the hierarchy-specific field mapping can be edited, any changes you make only apply to new users (field mapping changes won't apply to existing user data at this hierarchy).

The User field mappings from various applications.

Model Details: data/UserFieldMapping

Title Description Details
User Field Mapping Group Assigned by FDP
  • Field Name: User Field Mapping
  • Type: Object
Name * The name of the user mapping object.
  • Field Name: User Field Mapping.name
  • Type: String
Description The description of the user mapping object.
  • Field Name: User Field Mapping.description
  • Type: String
Application name * Application name like CUCM, LDAP, CUC
  • Field Name: User Field Mapping.application
  • Type: String
  • Target: data/UserSyncSource
  • Target attr: name
  • Format: uri
Model Type The model type used for this LDAP server.
  • Field Name: User Field Mapping.model_type
  • Type: String
Data Exist Flag to see if data exists for the server. If data exist the username and email fields will be disabled. These mappings cannot be changed once data exists.
  • Field Name: User Field Mapping.data_exist
  • Type: Boolean
User Name The username corresponding to the the Username in Cisco Unified Communications Manager and Cisco Unity Connection server.
  • Field Name: User Field Mapping.username
  • Type: String
Email Address The email address corresponding to the the Username in Cisco Unified Communications Manager and Cisco Unity Connection server.
  • Field Name: User Field Mapping.email
  • Type: String
First Name The first name corresponding to the user first name in Cisco Unified Communications Manager and Cisco Unity Connection server.
  • Field Name: User Field Mapping.first_name
  • Type: String
Last Name The last name corresponding to user last name in Cisco Unified Communications Manager and Cisco Unity Connection server.
  • Field Name: User Field Mapping.last_name
  • Type: String
Building Name Building name or number.
  • Field Name: User Field Mapping.building_name
  • Type: String
Title Title.
  • Field Name: User Field Mapping.title
  • Type: String
Department Department names and numbers.
  • Field Name: User Field Mapping.department
  • Type: String
Directory URI Alphanumeric Directory URI (e.g. SIP URI)
  • Field Name: User Field Mapping.directory_uri
  • Type: String
Display Name Display name of the user
  • Field Name: User Field Mapping.display_name
  • Type: String
Employee Number Employee number of the user
  • Field Name: User Field Mapping.employee_number
  • Type: String
Employee Type Employee type
  • Field Name: User Field Mapping.employee_type
  • Type: String
Home Phone Contains strings that represent the user's home phone number(s).
  • Field Name: User Field Mapping.home_phone
  • Type: String
IP Phone Contains strings that represent the user's IP phone number(s).
  • Field Name: User Field Mapping.ip_phone
  • Type: String
Telephone Number Telephone Number.
  • Field Name: User Field Mapping.telephone_number
  • Type: String
Mobile Contains strings that represent the user's IP mobile number(s).
  • Field Name: User Field Mapping.mobile
  • Type: String
Other Mailbox Other Mailbox.
  • Field Name: User Field Mapping.other_mailbox
  • Type: String
Facsimile Telephone Number Facsimile Telephone Number
  • Field Name: User Field Mapping.facsimile_telephone_number
  • Type: String
Unverified Mail Box Unverified Mail Box.
  • Field Name: User Field Mapping.unverified_mailbox
  • Type: String
City Contains the name of a person's locality.
  • Field Name: User Field Mapping.city
  • Type: String
Country Country name.
  • Field Name: User Field Mapping.country
  • Type: String
Street Contains site information from a postal address.
  • Field Name: User Field Mapping.street
  • Type: String
State Contains full names of state or province.
  • Field Name: User Field Mapping.state
  • Type: String
Postal Code Contains code used by a Postal Service to identify postal service zones.
  • Field Name: User Field Mapping.postal_code
  • Type: String
Timezone Timezone.
  • Field Name: User Field Mapping.timezone
  • Type: String
Physical Delivery Office Name Physical Delivery Office Name.
  • Field Name: User Field Mapping.physical_delivery_office_name
  • Type: String
Preferred Language Preferred Language.
  • Field Name: User Field Mapping.preferred_language
  • Type: String
Jabber ID Jabber ID
  • Field Name: User Field Mapping.jabber_id
  • Type: String
Manager Manager.
  • Field Name: User Field Mapping.manager
  • Type: String
Member Of The user can be a member of a variety of groups.
  • Field Name: User Field Mapping.member_of
  • Type: String
Object Class Object Class.
  • Field Name: User Field Mapping.object_class
  • Type: String
Organization The name of the person's organization.
  • Field Name: User Field Mapping.organization
  • Type: String
Organizational Unit The name of the person's organization unit.
  • Field Name: User Field Mapping.ou
  • Type: String
Photo URL Photo URL.
  • Field Name: User Field Mapping.photo_url
  • Type: String
Custom String 1 Custom String
  • Field Name: User Field Mapping.customString1
  • Type: String
Custom String 2 Custom String
  • Field Name: User Field Mapping.customString2
  • Type: String
Custom String 3 Custom String
  • Field Name: User Field Mapping.customString3
  • Type: String
Custom String 4 Custom String
  • Field Name: User Field Mapping.customString4
  • Type: String
Custom String 5 Custom String
  • Field Name: User Field Mapping.customString5
  • Type: String
Custom String 6 Custom String
  • Field Name: User Field Mapping.customString6
  • Type: String
Custom String 7 Custom String
  • Field Name: User Field Mapping.customString7
  • Type: String
Custom String 8 Custom String
  • Field Name: User Field Mapping.customString8
  • Type: String
Custom String 9 Custom String
  • Field Name: User Field Mapping.customString9
  • Type: String
Custom String 10 Custom String
  • Field Name: User Field Mapping.customString10
  • Type: String
Custom List of Strings 1 Custom List of Strings
  • Field Name: User Field Mapping.customListOfStrings1
  • Type: String
Custom List of Strings 2 Custom List of Strings
  • Field Name: User Field Mapping.customListOfStrings2
  • Type: String
Custom List of Strings 3 Custom List of Strings
  • Field Name: User Field Mapping.customListOfStrings3
  • Type: String
Custom List of Strings 4 Custom List of Strings
  • Field Name: User Field Mapping.customListOfStrings4
  • Type: String
Custom List of Strings 5 Custom List of Strings
  • Field Name: User Field Mapping.customListOfStrings5
  • Type: String
Custom List of Strings 6 Custom List of Strings
  • Field Name: User Field Mapping.customListOfStrings6
  • Type: String
Custom List of Strings 7 Custom List of Strings
  • Field Name: User Field Mapping.customListOfStrings7
  • Type: String
Custom List of Strings 8 Custom List of Strings
  • Field Name: User Field Mapping.customListOfStrings8
  • Type: String
Custom List of Strings 9 Custom List of Strings
  • Field Name: User Field Mapping.customListOfStrings9
  • Type: String
Custom List of Strings 10 Custom List of Strings
  • Field Name: User Field Mapping.customListOfStrings10
  • Type: String
Custom Boolean 1 Custom Boolean
  • Field Name: User Field Mapping.customBoolean1
  • Type: String
Custom Boolean 2 Custom Boolean
  • Field Name: User Field Mapping.customBoolean2
  • Type: String
Custom Boolean 3 Custom Boolean
  • Field Name: User Field Mapping.customBoolean3
  • Type: String
Custom Boolean 4 Custom Boolean
  • Field Name: User Field Mapping.customBoolean4
  • Type: String
Custom Boolean 5 Custom Boolean
  • Field Name: User Field Mapping.customBoolean5
  • Type: String
Custom Boolean 6 Custom Boolean
  • Field Name: User Field Mapping.customBoolean6
  • Type: String
Custom Boolean 7 Custom Boolean
  • Field Name: User Field Mapping.customBoolean7
  • Type: String
Custom Boolean 8 Custom Boolean
  • Field Name: User Field Mapping.customBoolean8
  • Type: String
Custom Boolean 9 Custom Boolean
  • Field Name: User Field Mapping.customBoolean9
  • Type: String
Custom Boolean 10 Custom Boolean
  • Field Name: User Field Mapping.customBoolean10
  • Type: String