Support-Tip (Connectors): Creating SharePoint Profile Store Management Agent

  • Article

FOCUSED PRODUCT / PRODUCT(S) USED FOR BLOG

Here is the list of products, build versions that I utilized for this blog write up!

  • Microsoft Identity Manager 2016 Service Pack 1 (4.4.1302.0)
    • SharePoint Management Agent for FIM/MIM (4.3.2430.0) [Download]
  • Microsoft SharePoint Server 2016
    • Single Server Farm - User Profile Service

BLOG PURPOSE: My focus here is to provide some information on creating a new SharePoint Management Agent for use in FIM/MIM with a SharePoint Server 2016.

There have been some changes in the User Profile Service for SharePoint Server 2016.  If you are looking to do the same type of synchronization as done in previous versions of SharePoint, you will need to utilize the SharePoint Management Agent for FIM/MIM inside an Identity Management Solution with FIM/MIM.

NOTE: In a default, SharePoint Server 2016 Single Farm scenario, the User Profile Service is not installed/configured.  You will need to install/configure it prior to being able to setup the SharePoint Profile Store Management Agent.  This will not be covered in this blog.

INSTALLATION OF SHAREPOINT MANAGEMENT AGENT

The installation process of this particular management agent is very straight forward and will not be covered in this blog.

Once installed, you can confirm via:

  1. Validate the DLL is in the Extensions folder (%programfiles%\Microsoft Forefront Identity Manager\2010\Synchronization Service\Extensions)
    1. DLL = Microsoft.IdentityManagement.Connector.Sharepoint.dll
      extensionsdll
  2. Validate that you see the SharePoint Profile Store in the Create Management Agent dialog.
    sharepointprofilestorecreate

CREATE THE SHAREPOINT PROFILE STORE MANAGEMENT AGENT

Let's walk through the screens of creating the SharePoint Profile Store Management Agent.  Some of the screens are general across all management agents, so I will not cover much detail there.  If you have questions, feel free to send me an email.  (timmac@microsoft.com).

  1. In the Synchronization Service Manager Console, Select Management Agents
  2. From the Actions Menu, select Create Management Agent
  3. In the Create Management Agent dialog, select SharePoint Profile Store and then provide a name for the new Management Agent.
  4. Click the Next button
    createma1

CONNECTIVITY PAGE

NOTE This Property Page is probably the most difficult to understand because you need to understand how to connect to your SharePoint Farm.  For this, you will need to understand how you have your SharePoint Farm Configured, as well as understand how to access the SharePoint Central Administration Page.

SharePoint Server Info

HTTP PROTOCOL
  • understand how to connect to your SharePoint Farm
  • and which protocol you will be using (HTTP or HTTPS)
HOST NAME
  • Does not require the HTTP(S) prefix
  • Refers to the SharePoint Central Administration page.  Most of the time, this is http://machinename:portnumber
  • E.G.sharepointserverinfo
PORT
  • Refers to the Port Number for the SharePoint Central Administration page
APPLICATION ID

SharePoint User Credential

DOMAIN ·         NETBIOS of the Domain Name
USER NAME ·         User Name of a SharePoint Farm Administrator
NOTE We have found that this works best if the account that installed SharePoint Server is used here.
PASSWORD ·         Password of the SharePoint Farm Administrator Used here.
sharepointusercred

User Picture Flow Settings

PICTURE FLOW DIRECTION ·         Which way will you be flowing the pictures.
Export Only (NEVER from SharePoint) ·         Pushes pictures to the SharePoint Server Farm
Import Only (ALWAYS from SharePoint) ·         Pulls pictures from the SharePoint Server Farm

CONFIGURE PARTITIONS AND HIERACHIES PAGE configurepart

SELECT OBJECT TYPES

Displays the Object Types that are exposed by SharePoint.  In a default configuration, the three object types below should be presented for you to work with here. objecttypes

SELECT ATTRIBUTES

Displays the attributes that are exposed by SharePoint Server. selectattributes

CONFIGURE ANCHORS

Define the Anchor Attribute.  In a default scenario, such as the one I did here, you should be able to just use Anchor. configureanchors

CONFIGURE CONNECTOR FILTER configureconnectorfilter

CONFIGURE JOIN AND PROJECTION RULES

If the identity management solution requires legacy Join and Projection Rules configured through the management agent, this is where it would be done.  The identity management solution, may utilize synchronization rules, which are configured in the Portal under Synchronization Rules.

NOTE If you are new to FIM/MIM and want to understand more about Declarative (Codeless) Provisioning, please review the following information.
Introduction to Inbound Synchronization https://technet.microsoft.com/en-us/library/ee534911(v=ws.10).aspx
Introduction to Outbound Synchronization https://technet.microsoft.com/en-us/library/ee534904(v=ws.10).aspx

configurejoinandprojection

CONFIGURE ATTRIBUTE FLOW

If the solution requires legacy attribute flow configured through the management agent, this is where it would be done.  The identity management solution, may utilize synchronization rules, which are configured in the Portal under Synchronization Rules.

NOTE If you are new to FIM/MIM and want to understand more about Declarative (Codeless) Provisioning, please review the following information.
Introduction to Inbound Synchronization https://technet.microsoft.com/en-us/library/ee534911(v=ws.10).aspx
Introduction to Outbound Synchronization https://technet.microsoft.com/en-us/library/ee534904(v=ws.10).aspx

configureattributeflow

CONFIGURE DEPROVISIONING configuredeprovisioning

CONFIGURE EXTENSIONS configureextensions

 

ADDITIONAL RESOURCES