REST サービス 事始め
※この投稿は Office 365 Advent Calendar 2012 に参加しています。
はじめに
SharePoint 2013 では、プログラミングインターフェイスの一つとして REST サービスという API を使うことができます。 REST サービスはマイクロソフト独自の企画というわけではなく、Open Data Protocol(OData) という業界団体が決めた標準規約に基づいています。 そのため、OData に対応するアプリケーションがあれば、マイクロソフト製品やマイクロソフトのサードパーティ製品ではなくても、SharePoint 2013 からのデータ取得や登録、削除といった一連の処理を実行することができるわけですが、この処理を行う仕組みが Representational State Transfer (REST) Web サービスとして、SharePoint 2013 に実装されています。 もちろん、REST サービスは 次期 Office 365 でも実装されており、今後の主力 API として位置づけられています。 実は REST サービスは SharePoint 2010 や今の Office 365 にも実装されているため利用可能ではあるのですが、記述方法が違っていたり、まだまだ機能としては十分ではない部分があります。 2013 になってついに本格的に使われる時が来たという感じですね。 ということで、この記事では、2013 版の REST サービスについて紹介をします。
[User Profile Service Application]をクリックし、プロファイル サービスの管理ページに遷移します。
[同期設定の構成]をクリックし、同期設定の構成ページに遷移します。
[同期のオプション]にある[SharePoint Active Directory インポートを使用する]を選択し、[OK]をクリックします。
デフォルトは[SharePoint のプロファイル同期を使用する]になっていて、これが SharePoint 2010 から採用された FIM を使ったプロファイル同期を行うことを指しています。
次に同期元となる AD を指定するため、プロファイルサービスの管理ページに戻り、[同期接続の構成]をクリックします。
同期接続ページにて、[新しい接続の作成]をクリックします。
新しい同期接続の追加ページで、プロファイルインポートを行う AD への接続情報を設定します。
設定する内容は下図の通りで、AD への接続情報さえ事前におさえておけば、特に問題はないと思います。
ですが、ここで一点だけ注意事項。
ページ内のコメントにも書いてありますが、[アカウント名]で指定したアカウントには[完全修飾ドメイン名]で指定した AD に対して、ディレクトリ同期権限が必要です。
この権限を持たないアカウントを指定していると、インポート時にエラーが発生してしまいます。
詳細は後述します。
[接続設定]を入力した後、ページ下部の[コンテナーの作成]をクリックします。
[コンテナーの作成]をクリックすると、AD のオブジェクトがツリー形式で表示されます。
この中から、インポートするオブジェクトを選択します。
下図では、“Users"を選択しているので、“Users"に含まれるオブジェクト、今回の場合はすべてのユーザーアカウントがインポート対象となります。
このインターフェイスは、SharePoint 2007 と一緒なので、2007 経験者であれば簡単に設定できるかと思います。
インポート対象を指定したら、[OK]をクリックします。
以上で設定は完了です。
同期接続のページに戻ると、今追加した接続が一覧に表示されています。
最後にきちんとインポート処理が動くかどうか、確認をしてみます。
プロファイルサービスの管理ページに戻り、[プロファイルの同期の開始]をクリックします。
[完全同期の開始]を選択して[OK]をクリックし、インポート処理を実行します。
きちんと設定ができていれば、プロファイルサービスの管理ページで、プロファイルが増えたことを確認できます。
下図ではユーザープロファイルの数は6しかないですが、元は1でした。
また、プロファイルの同期状態というところがアイドルになっていますが、エラーがあった場合は、ここにエラーと表示されます。
＜ディレクトリ同期権限とは＞
前述のとおり、インポート処理に利用するアカウントがディレクトリ同期権限を持っていない場合、上記設定はうまくできていても、インポート処理自体は失敗します。
エラーは以下の通りで、イベントログに ID 2896 として「クライアントが、ディレクトリ パーティションに対して DirSync LDAP 要求を行いましたが、次のエラーのために拒否されました。」と記録されます。
エラーメッセージの最後の方に、「“Replicating Directory Changes"制御アクセス権」という言葉が出ていますが、これがディレクトリ同期権限のことを指しています。
では、ディレクトリ同期権限をどうやってアカウントに付与するかですが、以下の手順となります。
＜ディレクトリ同期権限の付与手順＞
Windows Server の 管理ツールから [Active Directory ユーザーとコンピューター]を起動します。
起動後、下図の通り権限付与の対象となる AD をツリーから選択し、右クリックメニューから、[制御の委任]をクリックします。
オブジェクト制御の委任ウィザードが起動するので、[次へ]をクリックして作業を開始します。
権限を付与するユーザーを追加するため、[追加]をクリックします。
[選択するオブジェクト名を入力してください]欄に、権限を付与するユーザー名を入力し、[名前の確認]をクリックします。
正しいユーザー名が指定されていると、ユーザー名にアンダーラインが引かれます。
その後、[OK]をクリックします。
これでユーザーを選択することができました。
[次へ]をクリックします。
[委任するカスタム タスクを作成する]を選択し、[次へ]をクリックします。
[このフォルダー、このフォルダー内の既存のオブジェクト、およびこのフォルダー内の新しいオブジェクトの作成]を選択し、[次へ]をクリックします。
[全般]にチェックを入れて、[アクセス許可]のリストから[ディレクトリの変更のレプリケート]を探し、チェックを入れます。
これが、ディレクトリ同期権限の正体です。
チェックを入れたら、[次へ]をクリックします。
これで指定のアカウントに、ディレクトリ同期権限が付与されました。
[完了]をクリックして、ウィザードを終了します。
初めてプロファイル同期を構成するときには、このディレクトリ同期権限の付与を忘れずに行うようにしてください。
参考URL：
こうして作られた 2010 ベースのサイトが、2013 ベースのサイトと何が違うのか、見た目に関してさらっとですが調べてみました。
画面ショットでざっとご紹介します。
最初にサイトを開くと、ページ上部に警告が出ます。
「SharePoint 15 のすべてのエクスペリエンスを・・・・」と。
SharePoint 15 ですって。はい、こちらRTM版でございますが、 SharePoint 15 という表現が残ってしまっています。
普通の方が見たら何のことかわからないと思いますが、SharePoint 2013 のことを言っています。
つまり、エクスペリエンスを “2010” にしているとすべての機能を利用できませんが、“2013” にするとすべての機能を利用できますということです。
右端の×を押すと消えるので、2010 でいきたい場合には、×を押して消しておきましょう。
それ以外の見た目は、2010 を知る方であれば、これが 2010 なのか 2013 なのか見分けはつかないのではないでしょうか。
リボンも見た目は 2010 と変わりません。
SharePoint Workspace のボタンもあります。使えるかどうかは試していません。。。
ドキュメントライブラリの設定ページも 2010 と変わらないようでした。
2010 が出た時にも 旧バージョンの 2007 モードでサイトを作ることができたのですが、その時は多少 2010 の痕跡が残っていたかと思います。
「サイトの操作」メニューが代表的な痕跡を残す部位だったかと思います。（違ったらごめんなさい。）
今回は・・・2010 の見た目と何一つ変わりません！
あ、あれ？？
ユーザーと権限のメニュー位置がおかしい。。。
下にずれてますね。
2010 はこうなっていないので、これは痕跡というか 2013 かどうかを見分けるポイント、ということですかね。
最後に、サイトコレクションの機能と、サイトの機能を。
これらも、他と同様、並んでいる機能は 2010 と同じでした。
まだまだ確認したのは一部のページ、機能だけですが、前バージョンに比べてより再現性が高くなっていると感じました。
ただ、大事なのは見た目よりも中身の動作、仕様だとは思いますので、それはそれで調べないと。
ライセンス条項。
[使用許諾契約書の条項に同意します]をチェックして、[次へ]をクリック。
必須コンポーネントが順次インストールされるので、終わるまで待ちます。
終了しました！
これで必須コンポーネントのインストールは完了です。
[完了]をクリックして、元の画面に戻ります。
２．SharePoint 本体のインストール
いよいよ、SharePoint本体のインストールです。といっても、ここまでは何も難しいことはありません。
[SharePoint Server のインストール]をクリックして、SharePoint 本体のインストールを開始します。
プロダクトキーを入力して、[続行]をクリック。
[「マイクロソフト ソフトウェア ライセンス条項」に同意します]にチェックを入れ、[続行]をクリック。
サーバーの種類は[完全]のまま、[今すぐインストール]をクリック。
ちなみに、必要に応じて製品の各種ファイルの格納先と、検索インデックスの格納先を指定できます。
検証環境として作る分には、特に変える必要はないと思います。
インストールが始まります。
あとは勝手に進行しますので、インストールが終わるまでしばし待ちます。。。
インストールが完了しました！！
[SharePoint 製品構成ウィザードを今すぐ実行する]にチェックを入れたまま、[閉じる]をクリックして、製品構成ウィザードの実行に進みます。
3. 更新プログラムのインストール
パブリック更新プログラムと、必要に応じて最新の累積的更新プログラムをインストールしてください。
パブリック更新プログラムは、すべての環境でインストールすることが推奨されている更新プログラムとなります。
以下よりダウンロードして、ウィザードの手順に従いインストールしてください。
製品構成ウィザード実行中に、IIS が停止するとのこと。
検証環境構築中なので特に問題はないかと思います。[はい]をクリック。
新しく環境を構築するので[新しいサーバーファームの作成]を選択し、[次へ]をクリック。
SQL Server への接続設定を行います。
[データベースサーバー]には、SharePoint の設定情報やデータを保存する先となる SQL Server のコンピュータ名を入力します。
[データベース名]は、デフォルトで"SharePoint_Config"になっており、特に変える必要はないかと思いますが、もし SQL Server に既に別の SharePoint ファームが構築されている場合や、その予定がある場合は、データベース名に環境名がわかるように文字を追加するのが良いかと思います。
なお、データベースには、SharePoint のファームに関する各種設定情報が保存されます。
[ユーザー名]には、SharePoint から SQL Server に接続するときに使用する、ドメインアカウントを指定します。
ここで指定するユーザーがいわゆるシステム管理者のような位置づけになります。
TechNetにも詳しく書いてあるので、よく読んでアカウントを決めてください。
[パスワード]には、[ユーザー名]で指定したユーザーのパスワードを入力します。
すべて入力したら、[次へ]をクリック。
ファームにサーバーを追加する時に必要となるパスフレーズを設定します。
[パスフレーズ]と[パスフレーズの確認]を入力し、[次へ]をクリック。
SharePoint のファームレベルの管理画面となる、全体管理サイトの設定をします。
ポート番号と認証プロバイダーを指定して、[次へ]をクリック。
ちなみに私はいつも、下の画面ショットにあるような設定にしています。
ポート番号はわかりやすい方が管理がしやすいですし、認証プロバイダーはNTLMがわかりやすいので。
全体管理サイトは特にネゴシエートでなければならない理由もないのではないかと思いますので・・・
確認画面になります。
これまでに指定した内容が表示されるので、間違いがないか確認して、[次へ]をクリック。
ここから構成が始まるので、完了するまでしばし休憩。。。
これで構成完了です。
この時点でファームは完成し、全体管理サイトが起動している状態になります。
でも、まだ検証で使うサイトが作られておらず、各種サービスアプリケーションも作られていないため、何もできません。
ということで、[完了]をクリックすると自動的にブラウザが起動し、次のウィザードが立ち上がります。
5．ファーム構成ウィザードの実行
ここまでで、SharePoint ファームの初期状態が出来上がり、全体管理サイトも起動しました。
次に、ファーム構成ウィザードを使って各種サービスアプリケーションの構成と初期サイトコレクションを作成します。
ブラウザが起動すると、まず品質向上にご協力くださいということで、以下のページが開きます。
検証環境なので、私はいつも迷わず[参加する]にチェックし、[OK]をクリック。
ファームの構成をウィザードで行うか、手動で行うかを選択するページが表示されます。
今回はウィザードを使うので、[ウィザードの開始]をクリックします。
このファームで動かすサービスアプリケーションのアカウントを指定します。
私の場合はいつも事前にアカウントを作っているので、[既存の管理アカウントを使用する]を指定していますが、もちろんここで[新しい管理アカウントを作成する]を指定して、新規作成しても問題ありません。
サービスは、検証環境で起動させたいサービスのチェックを付けた状態にしておきます。
検証する内容にもよりますが、色々機能を確認したいということであれば、ひとまずデフォルト設定のままでよいかと思います。
設定を確認したら、[次へ]をクリック。
※画面ショットは４つに分かれていますが、これで１つのページです。
ウィザードが処理を開始すると、このような画面になります。
次に、最初のサイトコレクションを作成します。
[タイトル]には、サイトコレクションの名前を付けます。ここでつけた名前が、サイトを開いた時にページ左上に表示されます。
[説明]には、このサイトの簡単な説明を入れます。
[URL]は、このサイトコレクションのURLを指定するのですが、画面ショットのようにルートサイトコレクションとして作成するか、"/sites/“など特定のパスの下になるようにするかを指定します。
特定のパスの下になるようにした場合は、"/sites/○○○“の赤丸部分のURLを指定します。
[エクスペリエンス バージョンの選択]は、“2013"と"2010"が選べるのですが、これにより選べるテンプレートが変わります。
そして、“2010"を選ぶと、見た目も SharePoint 2010 の見た目になります。
[テンプレート]は、これから作成するサイトの検証内容に合わせて選択してください。
全部設定を終えたら、[OK]をクリックします。
ここまでに設定した内容が表示されるので、確認して問題なければ[完了]をクリックします。
これで最初のサイトコレクション構築も完了し、検証環境が完成しました。
（実際にはこの後、検索設定やユーザープロファイル同期の設定も必要なのですが、また別の機会に）