SharePoint 2007 Shared Services Provider User Profile Property Replicator

COMMENTED ISSUE: New functionality

Zvonimir — Wed, 02 Apr 2008 15:28:39 GMT

Hi,

I did some changes on the profile replicator that I would like to upload,

- replicates sections
- replicates the order of the properties
- update a previous created properties
- update the OOTB display name and checkboxes.
- does NOT update the mapped properties from the AD due the fact each environment has a different AD connection instance.

TODO:
-export AD connections and mapped properties.

I'm waiting my membership aproval.

Alex
Comments: ** Comment from web user: Zvonimir **

Really looking forward to this update :)

CREATED ISSUE: New functionality

alexbacchin — Fri, 14 Mar 2008 03:51:03 GMT

NEW POST: Localized Strings

bcorrea — Mon, 03 Mar 2008 19:19:35 GMT

Did anyone changed this code to be able to import/export the properties with Localized strings for DisplayName/Description for the fields?

Project License Changed

Fri, 30 Nov 2007 19:54:39 GMT

Microsoft Public License (Ms-PL) This license governs use of the accompanying software. If you use the software, you accept this license. If you do not accept the license, do not use the software. 1. Definitions The terms "reproduce," "reproduction," "derivative works," and "distribution" have the same meaning here as under U.S. copyright law. A "contribution" is the original software, or any additions or changes to the software. A "contributor" is any person that distributes its contribution under this license. "Licensed patents" are a contributor's patent claims that read directly on its contribution. 2. Grant of Rights (A) Copyright Grant- Subject to the terms of this license, including the license conditions and limitations in section 3, each contributor grants you a non-exclusive, worldwide, royalty-free copyright license to reproduce its contribution, prepare derivative works of its contribution, and distribute its contribution or any derivative works that you create. (B) Patent Grant- Subject to the terms of this license, including the license conditions and limitations in section 3, each contributor grants you a non-exclusive, worldwide, royalty-free license under its licensed patents to make, have made, use, sell, offer for sale, import, and/or otherwise dispose of its contribution in the software or derivative works of the contribution in the software. 3. Conditions and Limitations (A) No Trademark License- This license does not grant you rights to use any contributors' name, logo, or trademarks. (B) If you bring a patent claim against any contributor over patents that you claim are infringed by the software, your patent license from such contributor to the software ends automatically. (C) If you distribute any portion of the software, you must retain all copyright, patent, trademark, and attribution notices that are present in the software. (D) If you distribute any portion of the software in source code form, you may do so only under this license by including a complete copy of this license with your distribution. If you distribute any portion of the software in compiled or object code form, you may only do so under a license that complies with this license. (E) The software is licensed "as-is." You bear the risk of using it. The contributors give no express warranties, guarantees or conditions. You may have additional consumer rights under your local laws which this license cannot change. To the extent permitted under your local laws, the contributors exclude the implied warranties of merchantability, fitness for a particular purpose and non-infringement.

CREATED ISSUE: Export Sections

cvbluecher — Fri, 27 Jul 2007 13:46:37 GMT

Sections which where defined are not exported

Project License Changed

Thu, 31 May 2007 23:36:13 GMT

Microsoft Permissive License (Ms-PL) This license governs use of the accompanying software. If you use the software, you accept this license. If you do not accept the license, do not use the software. 1. Definitions The terms "reproduce," "reproduction," "derivative works," and "distribution" have the same meaning here as under U.S. copyright law. A "contribution" is the original software, or any additions or changes to the software. A "contributor" is any person that distributes its contribution under this license. "Licensed patents" are a contributor's patent claims that read directly on its contribution. 2. Grant of Rights (A) Copyright Grant- Subject to the terms of this license, including the license conditions and limitations in section 3, each contributor grants you a non-exclusive, worldwide, royalty-free copyright license to reproduce its contribution, prepare derivative works of its contribution, and distribute its contribution or any derivative works that you create. (B) Patent Grant- Subject to the terms of this license, including the license conditions and limitations in section 3, each contributor grants you a non-exclusive, worldwide, royalty-free license under its licensed patents to make, have made, use, sell, offer for sale, import, and/or otherwise dispose of its contribution in the software or derivative works of the contribution in the software. 3. Conditions and Limitations (A) No Trademark License- This license does not grant you rights to use any contributors' name, logo, or trademarks. (B) If you bring a patent claim against any contributor over patents that you claim are infringed by the software, your patent license from such contributor to the software ends automatically. (C) If you distribute any portion of the software, you must retain all copyright, patent, trademark, and attribution notices that are present in the software. (D) If you distribute any portion of the software in source code form, you may do so only under this license by including a complete copy of this license with your distribution. If you distribute any portion of the software in compiled or object code form, you may only do so under a license that complies with this license. (E) The software is licensed "as-is." You bear the risk of using it. The contributors give no express warranties, guarantees or conditions. You may have additional consumer rights under your local laws which this license cannot change. To the extent permitted under your local laws, the contributors exclude the implied warranties of merchantability, fitness for a particular purpose and non-infringement.

CREATED ISSUE: Display Order

mparrill — Fri, 13 Apr 2007 20:00:19 GMT

In your next release, can you incorporate the display order of the properties. Currently, it will create the property again, but not place it in the same display order. Thanks, Mike Parrill

Source code checked in

dmatthews — Fri, 13 Apr 2007 16:02:51 GMT

Updated to support Multi-Value Choice Lists - exports and imports additional XML nodes containing the values

UPDATED WIKI: Home

alogan — Sun, 01 Apr 2007 09:58:06 GMT

What is this utility?
The "SharePoint 2007 Shared Services Provider User Profile Property Replicator" was designed to take custom user profile properties and export/import them into another MOSS 2007 server. During most development cycles you will create custom user profile properties and currently the only way to move these from DEV/TEST/PROD is to backup/restore the Shared Services Provider. This tool will now reduce the amount of manual interaction required.

It saves you from manually creating the profile properties during deployment.

How to use this utility?
The utility comes with online help. Just type in "ProfilePropertyMgr -help" at commandline to get the help screen.

Want the code?
http://www.codeplex.com/MOSSProfileReplicate/SourceControl/ListDownloadableCommits.aspx

Want the build?
http://www.codeplex.com/MOSSProfileReplicate/Release/ProjectReleases.aspx

Want more information?
http://blah.winsmarts.com/2007-1-SharePoint_2007_Utility_-1_-_ProfilePropertyMgr_-_Utility_to_Import-Export_profile_properties.aspx

Want Membership?
mailto:ssiadmin@microsoft.com?subject=Membership Request - SharePoint 2007 Shared Services Provider User Profile Property Replicator

UPDATED WIKI: Home

alogan — Tue, 16 Jan 2007 12:55:55 GMT

CREATED ISSUE: Create the build

alogan — Mon, 15 Jan 2007 09:21:48 GMT

Sahil - can you create the build.

CREATED RELEASE: 1.0 Production

Mon, 15 Jan 2007 09:20:21 GMT

UPDATED WIKI: Home

alogan — Mon, 15 Jan 2007 09:16:46 GMT

The "SharePoint 2007 Shared Services Provider User Profile Property Replicator" was designed to take custom user profile properties and export/import them into another MOSS 2007 server. During most development cycles you will create custom user profile properties and currently the only way to move these from DEV/TEST/PROD is to backup/restore the Shared Services Provider. This tool will now reduce the amount of manual interaction required.

What is this utility?
This is a command line utility that will allow you to manage profile properties setup on a SharePoint web's SharedService provider. It allows you to export properties from an SSP to XML, and vice versa.

It saves you from manually creating the profile properties during deployment.

How to use this utility?
The utility comes with online help. Just type in "ProfilePropertyMgr -help" at commandline to get the help screen.

Want the code?
http://www.codeplex.com/MOSSProfileReplicate/SourceControl/ListDownloadableCommits.aspx

Want the build?
http://www.codeplex.com/MOSSProfileReplicate/Release/ProjectReleases.aspx

Want more information?
http://blah.winsmarts.com/2007-1-SharePoint_2007_Utility_-1_-_ProfilePropertyMgr_-_Utility_to_Import-Export_profile_properties.aspx

UPDATED WIKI: Home

alogan — Mon, 15 Jan 2007 09:16:03 GMT

The "SharePoint 2007 Shared Services Provider User Profile Property Replicator" was designed to take custom user profile properties and export/import them into another MOSS 2007 server. During most development cycles you will create custom user profile properties and currently the only way to move these from DEV/TEST/PROD is to backup/restore the Shared Services Provider. This tool will now reduce the amount of manual interaction required.

What is this utility?
This is a command line utility that will allow you to manage profile properties setup on a SharePoint web's SharedService provider. It allows you to export properties from an SSP to XML, and vice versa.

It saves you from manually creating the profile properties during deployment.

Cannot resolve link: [image:http://img77.imageshack.us/img77/3103/audienceuv5.gif]

How to use this utility?
The utility comes with online help. Just type in "ProfilePropertyMgr -help" at commandline to get the help screen.

Want the code?
http://www.codeplex.com/MOSSProfileReplicate/SourceControl/ListDownloadableCommits.aspx

Want the build?
http://www.codeplex.com/MOSSProfileReplicate/Release/ProjectReleases.aspx

Want more information?
http://blah.winsmarts.com/2007-1-SharePoint_2007_Utility_-1_-_ProfilePropertyMgr_-_Utility_to_Import-Export_profile_properties.aspx

UPDATED WIKI: Home

alogan — Mon, 15 Jan 2007 08:54:09 GMT

UPDATED WIKI: Home

alogan — Mon, 15 Jan 2007 08:52:49 GMT

The "SharePoint 2007 Shared Services Provider User Profile Property Replicator" was designed to take custom user profile properties and export/import them into another MOSS 2007 server. During most development cycles you will create custom user profile properties and currently the only way to move these from DEV/TEST/PROD is to backup/restore the Shared Services Provider. This tool will now reduce the amount of manual interaction required.

Recommended Reading/Basics before you dive into this blog post: http://blah.winsmarts.com/2007-1-User_Profiles_and_Audience_Targeting.aspx.

What is this utility?
This is a command line utility that will allow you to manage profile properties setup on a SharePoint web's SharedService provider. It allows you to export properties from an SSP to XML, and vice versa.

How to use this utility?
The utility comes with online help. Just type in "ProfilePropertyMgr -help" at commandline to get the help screen. The help screen reproduced below for your pleasure -

=================================================
Profile Property Manager - Help
=================================================

Usage: ProfilePropertyMgr -url <UrlToWeb> -filename <FileName> -import
ProfilePropertyMgr -url <UrlToWeb> -filename <FileName> -export

or

ProfilePropertyMgr -help

Used For
Export Profile properties from SharePoint to an XML file.
Import Profile properties from an XML file to SharePoint.

Required Parameters are:
-url <UrlToWeb>
-file <FileName.xml>

XML File structure:
*<Properties>

<Property>

<PropertyInfo Name=" Type=" Data="/>
<PropertyInfo ..>

</Property>

<Property>...</Property>

*</Properties>

Sample usage:

ProfilePropertyMgr -url http://moss2007 -filename output.xml -export
ProfilePropertyMgr -url http://moss2007 -filename input.xml -import

Code Explanation
The code accepts input as command line parameters, and passes them to a business object called ProgramInputs as shown below:

static void Main(string[] args)
{
ProgramInputs inputs = new ProgramInputs(args);

The ProgramInputs business object has 3 properties - Boolean "IsValid", String "URL", and "CurrentOperation". CurrentOperation is a custom enum with 3 possible valies - Unspecified, Import and Export. ProgramInputs encapsulates the functionality to validate inputs, and tell the end user if the inputs are accepted, or what was missing.

Once we know that the inputs are valid, we can act upon them. This is done using the following code

if (inputs.IsValid)
{
...
}
else
{
Trace.WriteLine("Invalid inputs specified", true);
Trace.PrintHelp();
}

And the actual code looks like this -

using (SPSite site = new SPSite(inputs.Url))
{
ServerContext context = ServerContext.GetContext(site);
UserProfileManager profileManager = new UserProfileManager(context);

switch (inputs.CurrentOperation)
{
case Operation.Unspecified:
throw new InvalidOperationException("Invalid input operation specified, or input operation omitted, cannot continue");
case Operation.Import:
WorkerBee.ImportProfiles(inputs, profileManager);
break;
case Operation.Export:
WorkerBee.ExportProfiles(inputs, profileManager);
break;
default: // This will never happen, so safely ignored.
break;
}
}

As you would note from the above, the work is delegated to a class called WorkerBee. It has two methods, one to export, and one to import. I first get a hold of all the SharePoint properties using ProfileManager.Properties, and then I use reflection to sniff out which properties are exportable. Basically, anything that can be succesfully imported on the other end, is exportable on this end (duh!). So what is importable/exportable? Anything that is Read/Write, is value-type (or string), and doesn't start with "SSP-" (reserved for SharePoint), or isn't the reserved UserProfileGUID property column. This in C#, is described as below -_

private static bool ShouldExport(PropertyInfo typeProperty, Property profileProperty, bool entireProperty)
{
bool toReturn = false;

toReturn = typeProperty.CanRead & typeProperty.CanWrite &
(
typeProperty.PropertyType.IsValueType |
typeProperty.PropertyType.FullName.Equals("System.String")
);

// Proceed only if toReturn is still true ;
// Also, the following applies to only entire properties
if (toReturn & entireProperty)
{
object reflectedValue = typeProperty.GetValue(profileProperty, null);
string strReflectedValue = (reflectedValue == null) ? String.Empty : reflectedValue.ToString();
toReturn &= !strReflectedValue.Equals("UserProfile_GUID");
toReturn &= !strReflectedValue.StartsWith("SPS-");
}
return toReturn;
}

The full Export Profiles method looks like this -

internal static void ExportProfiles(ProgramInputs inputs, UserProfileManager profileManager)
{
// Variable Naming convention: <objectinConcern><Property/Properties>

PropertyCollection profileProperties = profileManager.Properties;

XmlDocument exportProperties = new XmlDocument();
XmlNode nodeProperties = exportProperties.CreateNode(XmlNodeType.Element, "Properties", "");
exportProperties.AppendChild(nodeProperties);

PropertyInfo[] allProps = typeof(Property).GetProperties();
Dictionary<string, PropertyInfo> typeProperties = new Dictionary<string, PropertyInfo>();
foreach (PropertyInfo typeProperty in allProps)
{
typeProperties.Add(typeProperty.Name, typeProperty);
}

foreach (Property profileProperty in profileProperties)
{
// Should I be even exporting this property?
bool isExportable = ShouldExport(typeProperties"Name", profileProperty, true);

if (isExportable)
{
XmlNode nodeProperty = exportProperties.CreateNode(XmlNodeType.Element, "Property", "");
nodeProperties.AppendChild(nodeProperty);

foreach (PropertyInfo typeProperty in typeProperties.Values)
{
if (ShouldExport(typeProperty, profileProperty, false))
{
XmlNode nodePropertyInfo = exportProperties.CreateNode(XmlNodeType.Element, "PropertyInfo", "");

XmlAttribute attribProfilePropInfo;
object reflectedValue;

//Name
attribProfilePropInfo = exportProperties.CreateNode(XmlNodeType.Attribute, "Name", "") as XmlAttribute;
attribProfilePropInfo.Value = typeProperty.Name;
nodePropertyInfo.Attributes.Append(attribProfilePropInfo);

// Data Type
attribProfilePropInfo = exportProperties.CreateNode(XmlNodeType.Attribute, "Type", "") as XmlAttribute;
attribProfilePropInfo.Value = typeProperty.PropertyType.AssemblyQualifiedName;
nodePropertyInfo.Attributes.Append(attribProfilePropInfo);

// Value
attribProfilePropInfo = exportProperties.CreateNode(XmlNodeType.Attribute, "Data", "") as XmlAttribute;
reflectedValue = typeProperty.GetValue(profileProperty, null);
attribProfilePropInfo.Value = (reflectedValue == null) ? String.Empty : reflectedValue.ToString();
nodePropertyInfo.Attributes.Append(attribProfilePropInfo);

nodeProperty.AppendChild(nodePropertyInfo);
}
}
}
}

exportProperties.Save(inputs.FileName);
}

The ImportProfiles method is the exact anti-thesis of the above, so I am not going to bother copy pasting that here.

UPDATED WIKI: Home

alogan — Mon, 15 Jan 2007 08:50:19 GMT

The "SharePoint 2007 Shared Services Provider User Profile Property Replicator" was designed to take custom user profile properties and export/import them into another MOSS 2007 server. During most development cycles you will create custom user profile properties and currently the only way to move these from DEV/TEST/PROD is to backup/restore the Shared Services Provider. This tool will now reduce the amount of manual interaction required.

Recommended Reading/Basics before you dive into this blog post: http://blah.winsmarts.com/2007-1-User_Profiles_and_Audience_Targeting.aspx.

What is this utility?
This is a command line utility that will allow you to manage profile properties setup on a SharePoint web's SharedService provider. It allows you to export properties from an SSP to XML, and vice versa.

How to use this utility?
The utility comes with online help. Just type in "ProfilePropertyMgr -help" at commandline to get the help screen. The help screen reproduced below for your pleasure -

=================================================
Profile Property Manager - Help
=================================================

Usage: ProfilePropertyMgr -url <UrlToWeb> -filename <FileName> -import
ProfilePropertyMgr -url <UrlToWeb> -filename <FileName> -export

or

ProfilePropertyMgr -help

Used For
Export Profile properties from SharePoint to an XML file.
Import Profile properties from an XML file to SharePoint.

Required Parameters are:
-url <UrlToWeb>
-file <FileName.xml>

XML File structure:
<Properties>
<Property>
<PropertyInfo Name=" Type=" Data="/>
<PropertyInfo ..>
...
</Property>
<Property>...</Property>
...
</Properties>

Sample usage:

ProfilePropertyMgr -url http://moss2007 -filename output.xml -export
ProfilePropertyMgr -url http://moss2007 -filename input.xml -import

UPDATED WIKI: Home

alogan — Mon, 15 Jan 2007 08:47:36 GMT

The "SharePoint 2007 Shared Services Provider User Profile Property Replicator" was designed to take custom user profile properties and export/import them into another MOSS 2007 server. During most development cycles you will create custom user profile properties and currently the only way to move these from DEV/TEST/PROD is to backup/restore the Shared Services Provider. This tool will now reduce the amount of manual interaction required.

Recommended Reading/Basics before you dive into this blog post: http://blah.winsmarts.com/2007-1-User_Profiles_and_Audience_Targeting.aspx.

What is this utility?
This is a command line utility that will allow you to manage profile properties setup on a SharePoint web's SharedService provider. It allows you to export properties from an SSP to XML, and vice versa.

How to use this utility?
The utility comes with online help. Just type in "ProfilePropertyMgr -help" at commandline to get the help screen. The help screen reproduced below for your pleasure -

<b>Test 123</b>
=================================================
Profile Property Manager - Help
=================================================

Usage: ProfilePropertyMgr -url <UrlToWeb> -filename <FileName> -import
ProfilePropertyMgr -url <UrlToWeb> -filename <FileName> -export

or

ProfilePropertyMgr -help

Used For
Export Profile properties from SharePoint to an XML file.
Import Profile properties from an XML file to SharePoint.

Required Parameters are:
-url <UrlToWeb>
-file <FileName.xml>

XML File structure:
<Properties>
<Property>
<PropertyInfo Name=" Type=" Data="/>
<PropertyInfo ..>
...
</Property>
<Property>...</Property>
...
</Properties>

Sample usage:

ProfilePropertyMgr -url http://moss2007 -filename output.xml -export
ProfilePropertyMgr -url http://moss2007 -filename input.xml -import

Code Explanation
The code accepts input as command line parameters, and passes them to a business object called ProgramInputs as shown below:

static void Main(string[] args)
{
ProgramInputs inputs = new ProgramInputs(args);

The ProgramInputs business object has 3 properties - Boolean "IsValid", String "URL", and "CurrentOperation". CurrentOperation is a custom enum with 3 possible valies - Unspecified, Import and Export. ProgramInputs encapsulates the functionality to validate inputs, and tell the end user if the inputs are accepted, or what was missing.

Once we know that the inputs are valid, we can act upon them. This is done using the following code

if (inputs.IsValid)
{
...
}
else
{
Trace.WriteLine("Invalid inputs specified", true);
Trace.PrintHelp();
}

And the actual code looks like this -

using (SPSite site = new SPSite(inputs.Url))
{
ServerContext context = ServerContext.GetContext(site);
UserProfileManager profileManager = new UserProfileManager(context);

switch (inputs.CurrentOperation)
{
case Operation.Unspecified:
throw new InvalidOperationException("Invalid input operation specified, or input operation omitted, cannot continue");
case Operation.Import:
WorkerBee.ImportProfiles(inputs, profileManager);
break;
case Operation.Export:
WorkerBee.ExportProfiles(inputs, profileManager);
break;
default: // This will never happen, so safely ignored.
break;
}
}

As you would note from the above, the work is delegated to a class called WorkerBee. It has two methods, one to export, and one to import. I first get a hold of all the SharePoint properties using ProfileManager.Properties, and then I use reflection to sniff out which properties are exportable. Basically, anything that can be succesfully imported on the other end, is exportable on this end (duh!). So what is importable/exportable? Anything that is Read/Write, is value-type (or string), and doesn't start with "SSP-" (reserved for SharePoint), or isn't the reserved UserProfile_GUID property column. This in C#, is described as below -

private static bool ShouldExport(PropertyInfo typeProperty, Property profileProperty, bool entireProperty)
{
bool toReturn = false;

toReturn = typeProperty.CanRead & typeProperty.CanWrite &
(
typeProperty.PropertyType.IsValueType |
typeProperty.PropertyType.FullName.Equals("System.String")
);

// Proceed only if toReturn is still true ;
// Also, the following applies to only entire properties
if (toReturn & entireProperty)
{
object reflectedValue = typeProperty.GetValue(profileProperty, null);
string strReflectedValue = (reflectedValue == null) ? String.Empty : reflectedValue.ToString();
toReturn &= !strReflectedValue.Equals("UserProfile_GUID");
toReturn &= !strReflectedValue.StartsWith("SPS-");
}
return toReturn;
}
The full Export Profiles method looks like this -

internal static void ExportProfiles(ProgramInputs inputs, UserProfileManager profileManager)
{
// Variable Naming convention: <objectinConcern><Property/Properties>

PropertyCollection profileProperties = profileManager.Properties;

XmlDocument exportProperties = new XmlDocument();
XmlNode nodeProperties = exportProperties.CreateNode(XmlNodeType.Element, "Properties", "");
exportProperties.AppendChild(nodeProperties);

PropertyInfo[] allProps = typeof(Property).GetProperties();
Dictionary<string, PropertyInfo> typeProperties = new Dictionary<string, PropertyInfo>();
foreach (PropertyInfo typeProperty in allProps)
{
typeProperties.Add(typeProperty.Name, typeProperty);
}

foreach (Property profileProperty in profileProperties)
{
// Should I be even exporting this property?
bool isExportable = ShouldExport(typeProperties"Name", profileProperty, true);

if (isExportable)
{
XmlNode nodeProperty = exportProperties.CreateNode(XmlNodeType.Element, "Property", "");
nodeProperties.AppendChild(nodeProperty);

foreach (PropertyInfo typeProperty in typeProperties.Values)
{
if (ShouldExport(typeProperty, profileProperty, false))
{
XmlNode nodePropertyInfo = exportProperties.CreateNode(XmlNodeType.Element, "PropertyInfo", "");

XmlAttribute attribProfilePropInfo;
object reflectedValue;

//Name
attribProfilePropInfo = exportProperties.CreateNode(XmlNodeType.Attribute, "Name", "") as XmlAttribute;
attribProfilePropInfo.Value = typeProperty.Name;
nodePropertyInfo.Attributes.Append(attribProfilePropInfo);

// Data Type
attribProfilePropInfo = exportProperties.CreateNode(XmlNodeType.Attribute, "Type", "") as XmlAttribute;
attribProfilePropInfo.Value = typeProperty.PropertyType.AssemblyQualifiedName;
nodePropertyInfo.Attributes.Append(attribProfilePropInfo);

// Value
attribProfilePropInfo = exportProperties.CreateNode(XmlNodeType.Attribute, "Data", "") as XmlAttribute;
reflectedValue = typeProperty.GetValue(profileProperty, null);
attribProfilePropInfo.Value = (reflectedValue == null) ? String.Empty : reflectedValue.ToString();
nodePropertyInfo.Attributes.Append(attribProfilePropInfo);

nodeProperty.AppendChild(nodePropertyInfo);
}
}
}
}

exportProperties.Save(inputs.FileName);
}
The ImportProfiles method is the exact anti-thesis of the above, so I am not going to bother copy pasting that here.

UPDATED WIKI: Home

alogan — Mon, 15 Jan 2007 08:47:26 GMT

The "SharePoint 2007 Shared Services Provider User Profile Property Replicator" was designed to take custom user profile properties and export/import them into another MOSS 2007 server. During most development cycles you will create custom user profile properties and currently the only way to move these from DEV/TEST/PROD is to backup/restore the Shared Services Provider. This tool will now reduce the amount of manual interaction required.

Recommended Reading/Basics before you dive into this blog post: http://blah.winsmarts.com/2007-1-User_Profiles_and_Audience_Targeting.aspx.

What is this utility?
This is a command line utility that will allow you to manage profile properties setup on a SharePoint web's SharedService provider. It allows you to export properties from an SSP to XML, and vice versa.

How to use this utility?
The utility comes with online help. Just type in "ProfilePropertyMgr -help" at commandline to get the help screen. The help screen reproduced below for your pleasure -

=================================================
Profile Property Manager - Help
=================================================

Usage: ProfilePropertyMgr -url <UrlToWeb> -filename <FileName> -import
ProfilePropertyMgr -url <UrlToWeb> -filename <FileName> -export

or

ProfilePropertyMgr -help

Used For
Export Profile properties from SharePoint to an XML file.
Import Profile properties from an XML file to SharePoint.

Required Parameters are:
-url <UrlToWeb>
-file <FileName.xml>

XML File structure:
<Properties>
<Property>
<PropertyInfo Name=" Type=" Data="/>
<PropertyInfo ..>
...
</Property>
<Property>...</Property>
...
</Properties>

Sample usage:

ProfilePropertyMgr -url http://moss2007 -filename output.xml -export
ProfilePropertyMgr -url http://moss2007 -filename input.xml -import

Code Explanation
The code accepts input as command line parameters, and passes them to a business object called ProgramInputs as shown below:

static void Main(string[] args)
{
ProgramInputs inputs = new ProgramInputs(args);

The ProgramInputs business object has 3 properties - Boolean "IsValid", String "URL", and "CurrentOperation". CurrentOperation is a custom enum with 3 possible valies - Unspecified, Import and Export. ProgramInputs encapsulates the functionality to validate inputs, and tell the end user if the inputs are accepted, or what was missing.

Once we know that the inputs are valid, we can act upon them. This is done using the following code

if (inputs.IsValid)
{
...
}
else
{
Trace.WriteLine("Invalid inputs specified", true);
Trace.PrintHelp();
}

And the actual code looks like this -

using (SPSite site = new SPSite(inputs.Url))
{
ServerContext context = ServerContext.GetContext(site);
UserProfileManager profileManager = new UserProfileManager(context);

switch (inputs.CurrentOperation)
{
case Operation.Unspecified:
throw new InvalidOperationException("Invalid input operation specified, or input operation omitted, cannot continue");
case Operation.Import:
WorkerBee.ImportProfiles(inputs, profileManager);
break;
case Operation.Export:
WorkerBee.ExportProfiles(inputs, profileManager);
break;
default: // This will never happen, so safely ignored.
break;
}
}

As you would note from the above, the work is delegated to a class called WorkerBee. It has two methods, one to export, and one to import. I first get a hold of all the SharePoint properties using ProfileManager.Properties, and then I use reflection to sniff out which properties are exportable. Basically, anything that can be succesfully imported on the other end, is exportable on this end (duh!). So what is importable/exportable? Anything that is Read/Write, is value-type (or string), and doesn't start with "SSP-" (reserved for SharePoint), or isn't the reserved UserProfile_GUID property column. This in C#, is described as below -

private static bool ShouldExport(PropertyInfo typeProperty, Property profileProperty, bool entireProperty)
{
bool toReturn = false;

toReturn = typeProperty.CanRead & typeProperty.CanWrite &
(
typeProperty.PropertyType.IsValueType |
typeProperty.PropertyType.FullName.Equals("System.String")
);

// Proceed only if toReturn is still true ;
// Also, the following applies to only entire properties
if (toReturn & entireProperty)
{
object reflectedValue = typeProperty.GetValue(profileProperty, null);
string strReflectedValue = (reflectedValue == null) ? String.Empty : reflectedValue.ToString();
toReturn &= !strReflectedValue.Equals("UserProfile_GUID");
toReturn &= !strReflectedValue.StartsWith("SPS-");
}
return toReturn;
}
The full Export Profiles method looks like this -

internal static void ExportProfiles(ProgramInputs inputs, UserProfileManager profileManager)
{
// Variable Naming convention: <objectinConcern><Property/Properties>

PropertyCollection profileProperties = profileManager.Properties;

XmlDocument exportProperties = new XmlDocument();
XmlNode nodeProperties = exportProperties.CreateNode(XmlNodeType.Element, "Properties", "");
exportProperties.AppendChild(nodeProperties);

PropertyInfo[] allProps = typeof(Property).GetProperties();
Dictionary<string, PropertyInfo> typeProperties = new Dictionary<string, PropertyInfo>();
foreach (PropertyInfo typeProperty in allProps)
{
typeProperties.Add(typeProperty.Name, typeProperty);
}

foreach (Property profileProperty in profileProperties)
{
// Should I be even exporting this property?
bool isExportable = ShouldExport(typeProperties"Name", profileProperty, true);

if (isExportable)
{
XmlNode nodeProperty = exportProperties.CreateNode(XmlNodeType.Element, "Property", "");
nodeProperties.AppendChild(nodeProperty);

foreach (PropertyInfo typeProperty in typeProperties.Values)
{
if (ShouldExport(typeProperty, profileProperty, false))
{
XmlNode nodePropertyInfo = exportProperties.CreateNode(XmlNodeType.Element, "PropertyInfo", "");

XmlAttribute attribProfilePropInfo;
object reflectedValue;

//Name
attribProfilePropInfo = exportProperties.CreateNode(XmlNodeType.Attribute, "Name", "") as XmlAttribute;
attribProfilePropInfo.Value = typeProperty.Name;
nodePropertyInfo.Attributes.Append(attribProfilePropInfo);

// Data Type
attribProfilePropInfo = exportProperties.CreateNode(XmlNodeType.Attribute, "Type", "") as XmlAttribute;
attribProfilePropInfo.Value = typeProperty.PropertyType.AssemblyQualifiedName;
nodePropertyInfo.Attributes.Append(attribProfilePropInfo);

// Value
attribProfilePropInfo = exportProperties.CreateNode(XmlNodeType.Attribute, "Data", "") as XmlAttribute;
reflectedValue = typeProperty.GetValue(profileProperty, null);
attribProfilePropInfo.Value = (reflectedValue == null) ? String.Empty : reflectedValue.ToString();
nodePropertyInfo.Attributes.Append(attribProfilePropInfo);

nodeProperty.AppendChild(nodePropertyInfo);
}
}
}
}

exportProperties.Save(inputs.FileName);
}
The ImportProfiles method is the exact anti-thesis of the above, so I am not going to bother copy pasting that here.

UPDATED WIKI: Home

alogan — Mon, 15 Jan 2007 08:47:06 GMT

The "SharePoint 2007 Shared Services Provider User Profile Property Replicator" was designed to take custom user profile properties and export/import them into another MOSS 2007 server. During most development cycles you will create custom user profile properties and currently the only way to move these from DEV/TEST/PROD is to backup/restore the Shared Services Provider. This tool will now reduce the amount of manual interaction required.

Recommended Reading/Basics before you dive into this blog post: http://blah.winsmarts.com/2007-1-User_Profiles_and_Audience_Targeting.aspx.

What is this utility?
This is a command line utility that will allow you to manage profile properties setup on a SharePoint web's SharedService provider. It allows you to export properties from an SSP to XML, and vice versa.

How to use this utility?
The utility comes with online help. Just type in "ProfilePropertyMgr -help" at commandline to get the help screen. The help screen reproduced below for your pleasure -

=================================================
Profile Property Manager - Help
=================================================

Usage: ProfilePropertyMgr -url <UrlToWeb> -filename <FileName> -import
ProfilePropertyMgr -url <UrlToWeb> -filename <FileName> -export

or

ProfilePropertyMgr -help

Used For
Export Profile properties from SharePoint to an XML file.
Import Profile properties from an XML file to SharePoint.

Required Parameters are:
-url <UrlToWeb>
-file <FileName.xml>

XML File structure:
<Properties>
<Property>
<PropertyInfo Name=" Type=" Data="/>
<PropertyInfo ..>
...
</Property>
<Property>...</Property>
...
</Properties>

Sample usage:

ProfilePropertyMgr -url http://moss2007 -filename output.xml -export
ProfilePropertyMgr -url http://moss2007 -filename input.xml -import

Code Explanation
The code accepts input as command line parameters, and passes them to a business object called ProgramInputs as shown below:

static void Main(string[] args)
{
ProgramInputs inputs = new ProgramInputs(args);

The ProgramInputs business object has 3 properties - Boolean "IsValid", String "URL", and "CurrentOperation". CurrentOperation is a custom enum with 3 possible valies - Unspecified, Import and Export. ProgramInputs encapsulates the functionality to validate inputs, and tell the end user if the inputs are accepted, or what was missing.

Once we know that the inputs are valid, we can act upon them. This is done using the following code

if (inputs.IsValid)
{
...
}
else
{
Trace.WriteLine("Invalid inputs specified", true);
Trace.PrintHelp();
}

And the actual code looks like this -

using (SPSite site = new SPSite(inputs.Url))
{
ServerContext context = ServerContext.GetContext(site);
UserProfileManager profileManager = new UserProfileManager(context);

switch (inputs.CurrentOperation)
{
case Operation.Unspecified:
throw new InvalidOperationException("Invalid input operation specified, or input operation omitted, cannot continue");
case Operation.Import:
WorkerBee.ImportProfiles(inputs, profileManager);
break;
case Operation.Export:
WorkerBee.ExportProfiles(inputs, profileManager);
break;
default: // This will never happen, so safely ignored.
break;
}
}

As you would note from the above, the work is delegated to a class called WorkerBee. It has two methods, one to export, and one to import. I first get a hold of all the SharePoint properties using ProfileManager.Properties, and then I use reflection to sniff out which properties are exportable. Basically, anything that can be succesfully imported on the other end, is exportable on this end (duh!). So what is importable/exportable? Anything that is Read/Write, is value-type (or string), and doesn't start with "SSP-" (reserved for SharePoint), or isn't the reserved UserProfile_GUID property column. This in C#, is described as below -

private static bool ShouldExport(PropertyInfo typeProperty, Property profileProperty, bool entireProperty)
{
bool toReturn = false;

toReturn = typeProperty.CanRead & typeProperty.CanWrite &
(
typeProperty.PropertyType.IsValueType |
typeProperty.PropertyType.FullName.Equals("System.String")
);

// Proceed only if toReturn is still true ;
// Also, the following applies to only entire properties
if (toReturn & entireProperty)
{
object reflectedValue = typeProperty.GetValue(profileProperty, null);
string strReflectedValue = (reflectedValue == null) ? String.Empty : reflectedValue.ToString();
toReturn &= !strReflectedValue.Equals("UserProfile_GUID");
toReturn &= !strReflectedValue.StartsWith("SPS-");
}
return toReturn;
}
The full Export Profiles method looks like this -

internal static void ExportProfiles(ProgramInputs inputs, UserProfileManager profileManager)
{
// Variable Naming convention: <objectinConcern><Property/Properties>

PropertyCollection profileProperties = profileManager.Properties;

XmlDocument exportProperties = new XmlDocument();
XmlNode nodeProperties = exportProperties.CreateNode(XmlNodeType.Element, "Properties", "");
exportProperties.AppendChild(nodeProperties);

PropertyInfo[] allProps = typeof(Property).GetProperties();
Dictionary<string, PropertyInfo> typeProperties = new Dictionary<string, PropertyInfo>();
foreach (PropertyInfo typeProperty in allProps)
{
typeProperties.Add(typeProperty.Name, typeProperty);
}

foreach (Property profileProperty in profileProperties)
{
// Should I be even exporting this property?
bool isExportable = ShouldExport(typeProperties"Name", profileProperty, true);

if (isExportable)
{
XmlNode nodeProperty = exportProperties.CreateNode(XmlNodeType.Element, "Property", "");
nodeProperties.AppendChild(nodeProperty);

foreach (PropertyInfo typeProperty in typeProperties.Values)
{
if (ShouldExport(typeProperty, profileProperty, false))
{
XmlNode nodePropertyInfo = exportProperties.CreateNode(XmlNodeType.Element, "PropertyInfo", "");

XmlAttribute attribProfilePropInfo;
object reflectedValue;

//Name
attribProfilePropInfo = exportProperties.CreateNode(XmlNodeType.Attribute, "Name", "") as XmlAttribute;
attribProfilePropInfo.Value = typeProperty.Name;
nodePropertyInfo.Attributes.Append(attribProfilePropInfo);

// Data Type
attribProfilePropInfo = exportProperties.CreateNode(XmlNodeType.Attribute, "Type", "") as XmlAttribute;
attribProfilePropInfo.Value = typeProperty.PropertyType.AssemblyQualifiedName;
nodePropertyInfo.Attributes.Append(attribProfilePropInfo);

// Value
attribProfilePropInfo = exportProperties.CreateNode(XmlNodeType.Attribute, "Data", "") as XmlAttribute;
reflectedValue = typeProperty.GetValue(profileProperty, null);
attribProfilePropInfo.Value = (reflectedValue == null) ? String.Empty : reflectedValue.ToString();
nodePropertyInfo.Attributes.Append(attribProfilePropInfo);

nodeProperty.AppendChild(nodePropertyInfo);
}
}
}
}

exportProperties.Save(inputs.FileName);
}
The ImportProfiles method is the exact anti-thesis of the above, so I am not going to bother copy pasting that here.