ユーザープロファイルプロパティの移行サンプルアドイン (SharePoint)

2023-04-08

Core.ProfileProperty.Migration サンプルは、SharePoint Server から SharePoint Online にユーザープロファイルデータを移行する方法を示しています。

このサンプルには、2 つのコンソールアプリケーションが含まれています。その両方とも userprofileservice.asmx Web サービスを使用して、単数値または複数値を持つユーザープロファイルデータを XML ファイルに抽出し、抽出したデータを SharePoint Online 内のユーザープロファイルサービスへインポートします。

このコードサンプルは、以下の操作を行う場合に使用します。

SharePoint Server 内のユーザープロファイルデータを抽出します。
ユーザープロファイルデータを SharePoint Online へインポートします。

はじめに

まず、Core.ProfileProperty.Migration サンプルアドインを、GitHub 上の Office 365 Developer patterns and practices プロジェクトからダウンロードします。

注:

この記事で提供されるコードは、明示または黙示のいかなる種類の保証なしに現状のまま提供されるものであり、特定目的への適合性、商品性、権利侵害の不存在についての暗黙的な保証は一切ありません。

コードサンプルには、2 つのプロジェクトが含まれています。

Contoso.ProfileProperty.Migration.Extract
Contoso.ProfileProperty.Migration.Import

Contoso.ProfileProperty.Migration.Extract プロジェクト

このコードサンプルではサーバー側オブジェクトモデルが使用されているので、SharePoint Server がインストールされているサーバー上でプロジェクトを実行していることを確認してください。

SharePoint ファーム管理者権限のあるアカウントを使用してください。
表 1 で一覧表示されている構成情報を使用して App.config ファイルを編集してください。
すべてのユーザーについて、勤務先電子メール ユーザープロファイルプロパティが空でないことを確認してください。 勤務先電子メール ユーザープロファイルプロパティの値が空の場合は、抽出手順が途中で終了します。

このコードサンプルは SharePoint Server 2010 からユーザープロファイルを抽出します。 SharePoint Server 2013 からユーザープロファイルを抽出する場合は、次に示す操作を実行します。

[Contoso.ProfileProperty.Migration.Extract]>[プロパティ] を右クリックして、ショートカットメニューを開きます。
[アプリケーション] の下の [対象のフレームワーク] で、[.NET Framework 4] を選択します。
[はい] を選択してから、[保存] を選択します。

表 1. App.config ファイルの構成設定

構成設定名	説明	例
MYSITEHOSTURL	ソース SharePoint Server ファーム上の個人用サイトの URL。	`http://my.contoso.com`
PROPERTYSEPARATOR	複数値を持つユーザープロファイルプロパティ内で複数の値を区切るのに使う文字。
USERPROFILESSTORE	抽出されたユーザープロファイルデータの書き込みに使用する XML ファイルパス。	`C:\temp\ProfileData.xml`
LOGFILE	抽出されたユーザープロファイルデータの書き込みに使用する XML ファイルパス。	`C:\temp\Extract.log`
ENABLELOGGING	ディスクログを有効にします。	True
TESTRUN	テスト抽出を実行して、App.Config 内の構成設定が正しいことを確認します。	テスト抽出を実行しようとしている場合は、`TESTRUN=true` を設定します。テストを実行すると、ユーザープロファイルサービスから 1 人のユーザーのみ抽出します。ユーザープロファイルサービスからすべてのユーザーを抽出しようとしている場合は、`TESTRUN=false` を設定します。

Contoso.ProfileProperty.Migration.Import プロジェクト

Office 365 内にユーザープロファイルがあることを確認してください。
ユーザーの [勤務先の電子メール] のアドレスが、SharePoint Server オンプレミスと Office 365 ユーザープロファイルサービスで同じであることを確認してください。

以下の例のように、App.config ファイル内の Contoso_ProfileProperty_Migration_Import_UPSvc_UserProfileService 設定の value 要素を変更して、SharePoint Online 管理センター内のユーザープロファイルサービスへの参照を組み込んでください。

  <applicationSettings>
  <Contoso.ProfileProperty.Migration.Import.Properties.Settings>
  <setting name="Contoso_ProfileProperty_Migration_Import_UPSvc_UserProfileService" serializeAs="String">
  <value>https://contoso-admin.sharepoint.com/_vti_bin/userprofileservice.asmx</value>
  </setting>
  </Contoso.ProfileProperty.Migration.Import.Properties.Settings>
  </applicationSettings>

表 2 で一覧表示されている構成設定を使用して App.config ファイルを編集してください。

表 2. App.config ファイルの構成設定

構成設定名	説明	例
tenantName	テナントの名前です。	テナントの URL が `http://contoso.onmicrosoft.com` の場合、テナント名として「contoso」と入力します。
PROPERTYSEPARATOR	複数値を持つユーザープロファイルプロパティ内で値を区切るのに使う文字。
USERPROFILESSTORE	抽出されたユーザープロファイルのデータの読み取りに使用する XML ファイル。	`C:\temp\ProfileData.xml`
LOGFILE	イベントログ収集に使用するログファイル。	`C:\temp\Extract.log`
ENABLELOGGING	ディスクログを有効にします。	True
SPOAdminUserName	Office 365 管理者のユーザー名。	該当なし。
SPOAdminPassword	Office 365 管理者のパスワード。	該当なし。

Core.ProfileProperty.Migration サンプルアドインの使用

このコードサンプルは、コンソールアプリケーションとして実行します。このコードサンプルを実行すると、Program.cs の Main 関数により次の処理が実行されます。

個人用サイトのホストに接続し、UserProfileManager をユーザープロファイルサービスへの接続に使用します。 UserProfileManager は、Microsoft.Office.Server.UserProfiles.dll アセンブリに属しています。
pData という一覧を作成して、抽出されたユーザープロファイルデータを格納します。
ユーザープロファイルサービス内のすべてのユーザーについて、以下の処理を行います。
- GetSingleValuedProperty を使用して、WorkEmail と AboutMe のユーザープロファイルプロパティを userData という UserProfileData オブジェクトにコピーします。
- GetMultiValuedProperty を使用して、SPS-Responsibility ユーザープロファイルプロパティを userData にコピーします。
- UserProfileCollection.Save を使用して、userData を XML ファイルにシリアル化します。この XML ファイルは、App.config で指定したファイルパスに保存されます。

static void Main(string[] args)
        {
            int userCount = 1;

            try
            {

                if (Convert.ToBoolean(ConfigurationManager.AppSettings["TESTRUN"]))
                {
                    LogMessage(string.Format("******** RUNNING IN TEST RUN MODE **********"), LogLevel.Debug);
                }
                
                LogMessage(string.Format("Connecting to My Site host: '{0}'...", ConfigurationManager.AppSettings["MYSITEHOSTURL"]), LogLevel.Info);
                using (SPSite mySite = new SPSite(ConfigurationManager.AppSettings["MYSITEHOSTURL"]))
                {
                    LogMessage(string.Format("Connecting to My Site host: '{0}'...Done!", ConfigurationManager.AppSettings["MYSITEHOSTURL"]), LogLevel.Info);

                    LogMessage(string.Format("getting Service Context..."), LogLevel.Info);
                    SPServiceContext svcContext = SPServiceContext.GetContext(mySite);
                    LogMessage(string.Format("getting Service Context...Done!"), LogLevel.Info);

                    LogMessage(string.Format("Connecting to Profile Manager..."), LogLevel.Info);
                    UserProfileManager profileManager = new UserProfileManager(svcContext);
                    LogMessage(string.Format("Connecting to Profile Manager...Done!"), LogLevel.Info);

                    // Size of the List is set to the number of profiles.
                    List<UserProfileData> pData = new List<UserProfileData>(Convert.ToInt32(profileManager.Count));
                    
                    // Initialize Serialization Class.
                    UserProfileCollection ups = new UserProfileCollection();

                    foreach (UserProfile spUser in profileManager)
                    {
                        // Get profile information.
                        LogMessage(string.Format("processing user '{0}' of {1}...", userCount,profileManager.Count),LogLevel.Info);                       
                        UserProfileData userData = new UserProfileData();
                        
                        userData.UserName = GetSingleValuedProperty(spUser, "WorkEmail");
                        
                        if (userData.UserName != string.Empty)
                        {
                            userData.AboutMe = GetSingleValuedProperty(spUser, "AboutMe");
                            userData.AskMeAbout = GetMultiValuedProperty(spUser, "SPS-Responsibility");
                            pData.Add(userData);
                            // Add to Serialization Class List of Profiles.
                            ups.ProfileData = pData;
                        }
                        
                        LogMessage(string.Format("processing user '{0}' of {1}...Done!", userCount++, profileManager.Count), LogLevel.Info);

                        // Only process the first item if we are in test mode.
                        if (Convert.ToBoolean(ConfigurationManager.AppSettings["TESTRUN"]))
                        {
                            break;
                        }

                    }
                    
                    // Serialize profiles to disk.
                    ups.Save();

                }
            }
            catch(Exception ex)
            {
                LogMessage("Exception trying to get profile properties:\n" + ex.Message, LogLevel.Error);
            }

GetSingleValuedProperty メソッドは userprofileservice.asmx を使用して、単一値を持つユーザープロファイルプロパティを取得します。次のコード例のように、GetSingleValuedProperty は以下の処理を実行します。

spuser[userProperty] を使用して、データの抽出元のプロパティオブジェクトを取得します。
値が null でない場合、UserProfileValueCollection 内の最初の値を返します。

private static string GetSingleValuedProperty(UserProfile spUser,string userProperty)
        {
            string returnString = string.Empty;
            try
            {
                UserProfileValueCollection propCollection = spUser[userProperty];

                if (propCollection[0] != null)
                {
                    returnString = propCollection[0].ToString();
                }
                else
                {
                    LogMessage(string.Format("User '{0}' does not have a value in property '{1}'", spUser.DisplayName, userProperty), LogLevel.Warning);                       
                }
            }
            catch 
            {
                LogMessage(string.Format("User '{0}' does not have a value in property '{1}'", spUser.DisplayName, userProperty), LogLevel.Warning);                       
            }


            return returnString;
            
        }

GetMultiValuedProperty メソッドは userprofileservice.asmx を使用して、複数値を持つユーザープロファイルプロパティを取得します。次のコード例のように、GetMultiValuedProperty は以下の処理を実行します。

spuser[userProperty] を使用して、更新対象のユーザープロファイルプロパティオブジェクトを取得します。
App.config ファイルで指定された PROPERTYSEPARATOR でユーザープロファイルプロパティ値を区切った文字列を構築します。

private static string GetMultiValuedProperty(UserProfile spUser, string userProperty)
        {
            StringBuilder sb = new StringBuilder("");
            string separator = ConfigurationManager.AppSettings["PROPERTYSEPARATOR"];

            string returnString = string.Empty;
            try
            {

                UserProfileValueCollection propCollection = spUser[userProperty];

                if (propCollection.Count > 1)
                {
                    for (int i = 0; i < propCollection.Count; i++)
                    {
                        if (i == propCollection.Count - 1) { separator = ""; }
                        sb.AppendFormat("{0}{1}", propCollection[i], separator);
                    }
                }
                else if (propCollection.Count == 1)
                {
                    sb.AppendFormat("{0}", propCollection[0]);
                }

            }
            catch
            {
                LogMessage(string.Format("User '{0}' does not have a value in property '{1}'", spUser.DisplayName, userProperty), LogLevel.Warning);
            }

            return sb.ToString();

        }

Contoso.ProfileProperty.Migration.Import サンプルアドインの使用

このコードサンプルは、コンソールアプリケーションとして実行します。このコードサンプルを実行すると、Program.cs の Main メソッドにより次の処理が実行されます。

InitializeConfiguration と InitializeWebService を使用してコンソールアプリケーションを初期化します。
抽出されたユーザープロファイルデータが含まれている XML ファイルを逆シリアル化します。
XML ファイル内のすべてのユーザーについて、以下の処理を行います。
- XML ファイルから UserName プロパティを抽出します。
- SetSingleMVProfileProperty を使用して、ユーザーのプロファイル上で SPS-Responsibility を設定します。
- SetSingleMVProfileProperty を使用して、ユーザーのプロファイル上で AboutMe を設定します。

InitializeWebService は、SharePoint Online に接続し、インスタンス変数にユーザープロファイルサービスの参照を設定します。このコードサンプル内の他の方法では、ユーザープロファイルプロパティに値を書き込むためにこのインスタンス変数を使用します。ユーザープロファイルを管理するために、このコードサンプルは、SharePoint Online 管理センターの userprofileservice.asmx Web サービスを使用します。

static bool InitializeWebService()
        {
            try
            {
                string webServiceExt = "_vti_bin/userprofileservice.asmx";
                string adminWebServiceUrl = string.Empty;
                
                if (_profileSiteUrl.EndsWith("/"))
                    adminWebServiceUrl = _profileSiteUrl + webServiceExt;
                else
                    adminWebServiceUrl = _profileSiteUrl + "/" + webServiceExt;

                LogMessage("Initializing SPO web service " + adminWebServiceUrl, LogLevel.Information);

                SecureString securePassword = GetSecurePassword(_sPoAuthPasword);
                SharePointOnlineCredentials onlineCred = new SharePointOnlineCredentials(_sPoAuthUserName, securePassword);

                string authCookie = onlineCred.GetAuthenticationCookie(new Uri(_profileSiteUrl));

                CookieContainer authContainer = new CookieContainer();
                authContainer.SetCookies(new Uri(_profileSiteUrl), authCookie);

                // Setting up the user profile web service.
                _userProfileService = new UPSvc.UserProfileService();
                _userProfileService.Url = adminWebServiceUrl;

                // Assign previously created auth container to admin profile web service. 
                _userProfileService.CookieContainer = authContainer;
                return true;
            }
            catch (Exception ex)
            {
                LogMessage("Error initiating connection to profile web service in SPO " + ex.Message, LogLevel.Error);
                return false;

            }
            
        }

SetSingleMVProfileProperty メソッドは、以下のようにして、SPS-Responsibility などの複数値を持つユーザープロファイルプロパティを設定します。

ユーザープロファイルプロパティ値を格納するために、PropertyValue を arrs と呼ばれる文字列配列に切り離します。 App.config で指定された PROPERTYSEPERATOR 構成設定を使用して文字列を切り離します。
arrs の値を、ユーザープロファイルサービス上の ValueData 配列に割り当てます。
ユーザープロファイルサービスに PropertyData 配列を作成します。ユーザープロファイルプロパティの名前と ValueData 配列は、PropertyData オブジェクト上のプロパティに渡されます。この配列は、複数値を持つユーザープロファイルプロパティを 1 つだけインポートするので、1 つの要素だけがあります。

SharePoint Online 管理センターの userprofileservice.asmx Web サービス上で ModifyUserPropertyByAccountName を使用することにより、データがユーザープロファイルサービスに書き込まれます。このコードサンプルを実行するユーザーは Office 365 管理者でなければなりません。

static void SetSingleMVProfileProperty(string UserName, string PropertyName, string PropertyValue)
        {

            try
            {
                string[] arrs = PropertyValue.Split(ConfigurationManager.AppSettings["PROPERTYSEPARATOR"][0]);
                
               UPSvc.ValueData[] vd = new UPSvc.ValueData[arrs.Count()];
               
               for (int i=0;i<=arrs.Count()-1;i++)
               {
                    vd[i] = new UPSvc.ValueData();
                    vd[i].Value = arrs[i];
                }
               
                UPSvc.PropertyData[] data = new UPSvc.PropertyData[1];
                data[0] = new UPSvc.PropertyData();
                data[0].Name = PropertyName;
                data[0].IsValueChanged = true;
                data[0].Values = vd;
                               
                _userProfileService.ModifyUserPropertyByAccountName(string.Format(@"i:0#.f|membership|{0}", UserName), data);

            }
            catch (Exception ex)
            {
                LogMessage("Exception trying to update profile property " + PropertyName + " for user " + UserName + "\n" + ex.Message, LogLevel.Error);
            }

        }

SetSingleValuedProperty メソッドは、AboutMe のような単一値を持つユーザープロファイルプロパティを設定します。 SetSingleValuedProperty は SetSingleMVProfileProperty と同じ技法を実装しますが、1 つの要素のみを含む ValueData 配列を使用します。

static void SetSingleProfileProperty(string UserName, string PropertyName, string PropertyValue)
        {

            try
            {
                UPSvc.PropertyData[] data = new UPSvc.PropertyData[1];
                data[0] = new UPSvc.PropertyData();
                data[0].Name = PropertyName;
                data[0].IsValueChanged = true;
                data[0].Values = new UPSvc.ValueData[1];
                data[0].Values[0] = new UPSvc.ValueData();
                data[0].Values[0].Value = PropertyValue;
                _userProfileService.ModifyUserPropertyByAccountName(UserName, data);
            }
            catch (Exception ex)
            {
                LogMessage("Exception trying to update profile property " + PropertyName + " for user " + UserName + "\n" + ex.Message, LogLevel.Error);
            }

        }

次の方法で共有

ユーザー プロファイル プロパティの移行サンプル アドイン (SharePoint)

はじめに

Contoso.ProfileProperty.Migration.Extract プロジェクト

Contoso.ProfileProperty.Migration.Import プロジェクト

Core.ProfileProperty.Migration サンプル アドインの使用

Contoso.ProfileProperty.Migration.Import サンプル アドインの使用

関連項目

その他のリソース

ユーザープロファイルプロパティの移行サンプルアドイン (SharePoint)

Core.ProfileProperty.Migration サンプルアドインの使用

Contoso.ProfileProperty.Migration.Import サンプルアドインの使用