MIM 2016 with SharePoint 2016 User Profile Service: Import Custom Property from Active Directory
Introduction
Now, we have the MIM installed and configure the SharePoint Server and apply the connection filter. Next, we want to import the custom AD attribute in the SharePoint.
In our company, we have a couple of custom attribute which we want to import and display in SharePoint 2016. In this example, we will use the employeeNumber property which is already created by our Active Directory Admin ( not covered here). Employee Number will be String type with a size of 100.
To import custom AD attribute we have to perform the following steps:
- Create the New User profile Property in the User Profile Service
- Create a matching property in the Metaverse Designer
- Map the Custom Property in the ADMA
- Refresh the Schema for SPMA
- Map the Custom Property in the SPMA
- Run Full Sync
Create Property in the UPA
Please log in to the Central Admin with Farm administrator account
Go to Central Admin > Application Management > Manage Service Application > Click on the User Profile Service. On this Page, click on the Manage User Properties
http://i0.wp.com/krossfarm.com/wp-content/uploads/2016/04/2016-04-05_22h36_13.png?resize=720%2C573
Click on New Property
http://i2.wp.com/krossfarm.com/wp-content/uploads/2016/04/2016-04-05_22h36_26.png?resize=720%2C203
On this page please enter the following information:
- Name: employeeNumber
- Display Name: Employee Number
- Type: String(Single Value)
- Length: 100
- Sub-type of profile: check this
- User Discerption:
- Policy Settings: select the value as per your requirement
- http://i0.wp.com/krossfarm.com/wp-content/uploads/2016/04/2016-04-05_22h40_05.png?resize=720%2C749http://i0.wp.com/krossfarm.com/wp-content/uploads/2016/04/2016-04-05_22h39_34.png?resize=720%2C306
Click OK. Now you will see the new property
http://i0.wp.com/krossfarm.com/wp-content/uploads/2016/04/2016-04-05_22h40_35.png?resize=720%2C13
Create a matching property in the Metaverse
Click Start Windows and click Synchronization Service
Click on the Metaverse Designer (1) and then click on Person (2). Click on Add Attribute (3)http://i2.wp.com/krossfarm.com/wp-content/uploads/2016/04/2016-04-05_22h42_26.png?resize=720%2C561
Click on New Attribute (1)
http://i2.wp.com/krossfarm.com/wp-content/uploads/2016/04/2016-04-05_22h43_33.png?resize=713%2C903
Enter the
Attribute name
Attribute type
Select Indexed
http://i0.wp.com/krossfarm.com/wp-content/uploads/2016/04/2016-04-05_22h43_58.png?resize=720%2C348
Click OK.
Create the Mapping in the ADMA
- On the Synchronization Service manager, click on Management Agents (1), then ADMA (2) and then click on Properties (3)http://i0.wp.com/krossfarm.com/wp-content/uploads/2016/04/2016-04-05_22h44_36.png?resize=720%2C343
- Click on Select Attribute (1), then Check the Show All (2), then check the Employee Number (3) and then click OK.http://i2.wp.com/krossfarm.com/wp-content/uploads/2016/04/2016-04-05_22h45_15.png?resize=720%2C534
- Reopen the ADMA Properties
- Select the following information:
Click Configure Attribute Flow
Data source object Type: User
Data Source Attribute: employeeNumber
Mapping type: Direct
Flow Detection: Import
Metaverse Object Type: Person
MetaVerse Attribute employeeNumber
Click New.
http://i0.wp.com/krossfarm.com/wp-content/uploads/2016/04/2016-04-05_22h45_52.png?resize=720%2C541
- Now you will see new mapping under the Configure Attribute Flow like figure below.http://i1.wp.com/krossfarm.com/wp-content/uploads/2016/04/2016-04-05_22h46_16.png?resize=720%2C308
Now you need to refresh the Schema for the SPMA in order to see the employee Number. Whenever you create / map a brand new property in the ADMA or User profile, you have to refresh Schema in order to see that attribute.
Refresh the Schema for SPMA
On the Synchronization Service manager, click on Management Agents (1), then SPMA(2) and then click on Refresh Schema (3)http://i1.wp.com/krossfarm.com/wp-content/uploads/2016/04/2016-04-06_00h18_32.png?resize=720%2C342
Click OK on the Refresh Schema popup
http://i0.wp.com/krossfarm.com/wp-content/uploads/2016/04/2016-04-06_00h18_46.png?resize=720%2C417
Now you have to enter the Password for the account which we configured during the configuration of MIM. Click OK.
http://i0.wp.com/krossfarm.com/wp-content/uploads/2016/04/2016-04-06_00h18_59.png?resize=720%2C645
You will see the message ”The New Schema Has Been committed to the server”. Click Closehttp://i2.wp.com/krossfarm.com/wp-content/uploads/2016/04/2016-04-06_00h19_20.png?resize=720%2C536
Create the Mapping in the SPMA
On the Synchronization Service manager, click on Management Agents (1), then SPMA (2) and then click on Properties (3)
http://i1.wp.com/krossfarm.com/wp-content/uploads/2016/04/2016-04-05_22h46_31.png?resize=720%2C352
Click on Select Attribute (1), then check Show All (2), then check the Employee Number (3) and then click OK.http://i1.wp.com/krossfarm.com/wp-content/uploads/2016/04/2016-04-05_22h46_49.png?resize=720%2C539
Reopen the ADMA Properties
Select the following information:
Click Configure Attribute Flow
Data source object Type: User
Data Source Attribute: employeeNumber
Mapping type: Direct
Flow Detection: Export, Allow Nulls
Metaverse Object Type: Person
MetaVerse Attribute: employeeNumber
Click New.
http://i0.wp.com/krossfarm.com/wp-content/uploads/2016/04/2016-04-05_22h48_09.png?resize=720%2C541
Now you will see new mapping under Configure Attribute Flow like figure below.http://i1.wp.com/krossfarm.com/wp-content/uploads/2016/04/2016-04-05_22h48_31.png?resize=720%2C290
Click OK.
Run Full Sync
Now time to run the Full Sync. This step will validate our efforts and also import the values from AD into the User profile. Please run the full Synchronization using the Start-SharePointSync.
This completes the post.
See Also:
Please see the other parts of this series.
- SharePoint 2016 User profile Service Step by Step: Installation of MIM 2016
- SharePoint 2016 User profile Service Step by Step: Configuration of MIM 2016
- MIM 2016 with SharePoint 2016 User Profile service: Import Custom Property from Active Directory
- SharePoint 2016 User profile Service and MIM: Apply the Connection Filter
- MIM with SharePoint Server 2016 User profile: Add more Active Directory Domain for Synchronization.
Additional Resources:
Please read these other posts about the MIM and User Profile Service.
- Step by Step: Installation of Microsoft Identity Manager for SharePoint 2016 User profile Service.
- Step by Step: Configuration of Microsoft Identity Manager for SharePoint 2016 User profile Service.
- SharePoint 2016 User profile Service and MIM: Apply the Connection Filter.
- MIM 2016 with SharePoint 2016 User Profile service: Import Custom Property from Active Directory.
- MIM with SharePoint Server 2016 User profile: Add more Active Directory Domain for Synchronization.