はじめる

1. Visual Studio 2010 で、” 空のSharePointプロジェクト” から始めます。
   • デバッグの設定は、サンドボックスではなく、”ファーム” にします。
   • 特定のサイトに対するジョブを作成する場合は、デバッグの設定でそのサイトを指定します。
2. Features の下にフィーチャを追加します。
   • タイトル、説明、スコープを設定します。スコープについては、後述。
   • そのフィーチャを右クリックして、イベントレシーバを追加します。イベントレシーバについては、後述。
3. パッケージの名前、タイトル、および説明を必要に応じて設定します。
   • パッケージにフィーチャを追加します。(というか、既定で追加されています)
4. プロジェクトにクラスを追加します。このクラスがジョブの本体になります。後述。

フィーチャのスコープ

フィーチャのスコープは “Farm” または “Site” にしますが、この設定によって、ジョブの Execute() メソッドの中での this.Parent の内容や、FeatureActivated( SPFeatureReceiverProperties properties ) の properties 引数の内容が変わってきます。要するに、コンテキストが変わります。したがって、ジョブの処理内容が特定のサイト コレクションに関係することであれば Site を、ファーム全体に対する処理 (サイトコレクションをまたぐような処理) であれば Farm を選びます。

イベント レシーバ

アクティブ時

フィーチャがアクティブになったときに、次のようにジョブを登録するようにします。

public override void FeatureActivated( SPFeatureReceiverProperties properties ) {
    SPWebService service = properties.Feature.Parent as SPWebService;
    SPFarm farm = service.Farm;
    SPService timer = null;
    timer = getSPTimer( farm );
    if( timer != null ) {
        foreach( SPJobDefinition job in timer.JobDefinitions ) {
            if( job.Name == List_JOB_NAME ) {
                job.Delete();   //  Delete all living jobs.
            }
        }
    } else {
        throw new Exception("Could not get SPTimerV4 Service.");
    }

    // install the job
    Job one = null;
    try {
        one = new Job( List_JOB_NAME, timer, null, SPJobLockType.Job );
    } catch {
        throw new Exception( "Installing the job failed." );
    }
    try {
        SPMinuteSchedule schedule = new SPMinuteSchedule();
        schedule.BeginSecond = 0;
        schedule.EndSecond = 59;
#if DEBUG
        schedule.Interval = 1;
#else
        schedule.Interval = 15;
#endif
        one.Schedule = schedule;
        one.Update();
    } catch {
        throw new Exception( "Scheduling the job failed." );
    }
}

非アクティブ時

フィーチャが非アクティブになったときに、次のようにジョブを削除するようにします。

public override void FeatureDeactivating( SPFeatureReceiverProperties properties ) {
    SPWebService service = properties.Feature.Parent as SPWebService;
    SPFarm farm = service.Farm;
    SPService timer = null;
    timer = getSPTimer( farm );
    if( timer != null ) {
        foreach( SPJobDefinition job in timer.JobDefinitions ) {
            if( job.Name == List_JOB_NAME ) {
                job.Delete();
            }
        }
    } else {
        throw new Exception( "Could not get SPTimerV4 Service." );
    }
}

SPJobDefinition

追加したクラスは、SPJobDefinitionクラスを継承するようにします。

public class Job : SPJobDefinition {
	private const String CoreName = "My Time Job Title";

	public Job()
	    : base() {
	}

	public Job( string jobName, SPService service, SPServer server, SPJobLockType targetType )
	    : base( jobName, service, server, targetType ) {
	    this.Title = CoreName;
	}

	public Job( string jobName, SPWebApplication webApplication )
	    : base( jobName, webApplication, null, SPJobLockType.ContentDatabase ) {
	    this.Title = CoreName;
	}

	public override string Description {
	    get {
	        return "This time job is doing something on entire site collections.";
	    }
	}

	public override string DisplayName {
	    get {
	        return CoreName;
	    }
	}

	public override void Execute( Guid contentDbId ) {
	}
}

この、Execute メソッドに処理を記述します。

その他

配置

一般的な SharePoint プロジェクト同様、Visual Studioの [配置] コマンドでソリューションを配置できますが、配置後にタイマーを再起動する必要があります。

net stop SPTimerV4
net start SPTimerV4

デバッグ

タイマージョブに限りませんが、デバッグのためにトレースログを出すように設定しておくと便利です。

次のようなクラスを追加し、コード中で diag.WriteTrace( 1, cat, TraceSeverity.Verbose, "{0} == {1}", a, b ); といったようにして書き出します。

class Diagnostics : SPDiagnosticsServiceBase {
	public enum CategoryId {
	    None = 0,
	    Deployment = 100,
	    Provisioning = 200,
	    CustomAction = 300,
	    Rendering = 400,
	    WebPart = 500
	}

	private static string DiagnosticsAreaName = "MyTimerJob";

	public Diagnostics()
	    : base() {
	}
	public Diagnostics( String name, SPFarm parent )
	    : base( name, parent ) {
	}

	protected override IEnumerable ProvideAreas() {
	    List categories = new List();
	    foreach( string catName in Enum.GetNames( typeof( CategoryId ) ) ) {
	        uint catId = (uint)(int)Enum.Parse( typeof( CategoryId ), catName );
	        categories.Add( new SPDiagnosticsCategory( catName, TraceSeverity.Verbose, EventSeverity.Error, 0, catId ) );
	    }

	    yield return new SPDiagnosticsArea( DiagnosticsAreaName, categories );
	}

	public static Diagnostics Local {
	    get {
	        return SPDiagnosticsServiceBase.GetLocal();
	    }
	}

	public SPDiagnosticsCategory this[CategoryId id] {
	    get {
	        return Areas[DiagnosticsAreaName].Categories[id.ToString()];
	    }
	}
}

Dispose

トレースログをきちんと確認するようにします。SPSite や SPWeb などをきちんと Dispose していないと、”An SPRequest object was not disposed before the end of this thread.” といったようなメッセージが記録されます。ある意味、便利です。

検索センターをどこに作成していますか?
独立したWebアプリケーション下のサイト コレクションとして作成していますか? それともホームページとなるサイト コレクションの下に作成していますか?

まあ、いずれの場合でも、検索センターを作成すると、ナビゲーションが一般的な他のサイトとは異なってしまいます。

これは、通常のサイトは v4.master というマスターページが使用されているのに対して、検索センターでは minimal.master というマスターページが使用されているためです。
ではマスターページを v4.master にすればよいかというと、それはそれで検索ボックスが非表示になってしまいうまくいきません。

おそらく、検索センターは Google 検索のように、ポータルサイトとして独立して機能するような意図で minimal.master が適用されているのかもしれません。
しかし実際には、 というかアタクシのケースでは、検索の機能はホームページの下に他のサイトや機能と同様に並列にぶらさがる、サイトの機能の一部としてユーザーに提供しています。

そこで、なんとかv4.masterを適用できないかと調べたら、次のサイトに答えがありました。

• Converting a Custom SharePoint 2010 Master Page into a Search Center Master Page

他にもいくつか参考になるサイトがあります。

• SharePoint Search Center uses minimal.master – and why you should care about that!
• SharePoint 2010 – Search Center Controls Missing
• Search box is missing when applied v4.master for search center sites
• Google で検索

通常の検索は問題なく行えます。しかし、ユーザー (ひと) を検索しようとしてもヒットしません。

User Profile 専用のクロール ルールを作成し、

https://somewhere.com

sps3://somewhere.com

といったように、検索先アドレスを指定していたのですが…。もう、ピンと来ましたか?

イベント ログには、次のように記録されています。

ログの名前: Application
ソース: Microsoft-SharePoint Products-SharePoint Server Search
イベント ID: 14
タスクのカテゴリ: Gatherer
レベル: 警告
説明:
開始アドレス sps3://somewhere.comをクロールできません。
コンテキスト: アプリケーション ‘Search_アプリケーション’、カタログ ‘Portal_Content’
詳細 :
指定されたタイムアウト時間内にリポジトリからの応答がなかったので、このアイテムをクロールできませんでした。しばらくしてからリポジトリのクロールを再試行するか、検索管理の [プロキシとタイムアウト] ページでタイムアウトの値を長めに指定してください。オフピーク時にこのリポジトリのクロールを実行することもできます。(0x80040d7b)

さて原因ですが、プロトコル ハンドラの名前 sps3 を、sps3s にすべきだったのです。そう、サイトを SSL で保護していたのです。

脱力しました….。数時間が…..。

あと、検索の構成に関しては、こちらのエントリが、非常に役に立ちました。

Successful SharePoint 2010 People Search

また、プロトコル ハンドラの一覧は、こちら。

http://technet.microsoft.com/ja-jp/library/dd695731(office.12).aspx

Visual Studio 2010 で、とりあえずサイトでも取得するか、というごく簡単なコード

SPSite site = new SPSite("http://mydev");

を実行してみたものの、

System.IO.FileNotFoundException

が出ました。

何が問題だったかというと、プロジェクトのビルド設定で、x86 用になっていたため。環境は64ビットでした。これをなおしたところ、すんなり解決。

というか、影響出るんだ….。

無事にインストールも終了し、さて適当に Company でも追加するかと思い、日本語の会社名を入力して submit したところ、会社名がカラの会社情報が作成されてしまいました。
じかにデータベースを覗いて見ても、company_name 列には何も入っていません。

試しに、データベースの管理ツールで、直接このカラの company_name を編集して日本語を入れてみました。
dotProject 上では、文字化けしました。ブラウザのエンコードをEUC_JPに変更すると、表示されました。どうも、PHP と MySQL 間でエンコードの問題が起きているようです。

解決策として、次の一行を追加することで、修正できました。イタリックの赤字の部分が、挿入した行です。

/includes/db_connect.php

// Quick hack to ensure MySQL behaves itself (#2323)
$db->Execute("SET sql_mode := ''");
mysql_set_charset("utf8");

要は、データベース接続が作成された直後に、文字コードを変えるのです。

この場所が適当かどうか、この変更の後に問題がないか、あまり詳細なテストをしていませんが、とりあえずは期待通り動いています。

ちなみに、当然ながら PHP のコードや MySQL の各種エンコード関係の設定は、UTF-8 にしたうえでの、操作です。