10. MagicfolderとRemoteObjectの連携¶

10.2.1. Magicfolder のジョブの有効期限の設定¶

Magicfolder へログインし、ホーム画面から 「ジョブ設定」 をクリックします。

「日数指定」 を選択し、 「30」 と指定して 「設定」 ボタンをクリックします。 「保存して再起動する」 ボタンが表示されるので、クリックします。

以上で Magicfolder のジョブの有効期限の設定は完了です。

10.2.2. RemoteObject のジョブの有効期限の設定¶

RemoteObject へログインし、ホーム画面から 「ジョブ設定」 をクリックします。

「日数指定」 を選択し、 「30」 と指定して 「設定」 ボタンをクリックします。 「保存して再起動する」 ボタンが表示されるので、クリックします。

以上で RemoteObject のジョブの有効期限の設定は完了です。

10.3.1. ジョブの生成と再実行¶

ジョブの有効期限の設定が正しく行われている場合、Magicfolder の監視フォルダで実行したジョブが RemoteObject のクライアントAPIから参照できるようになります。

まず、Magicfolder で任意のジョブIDを割り当てるための設定を行います。 Magicfolder へログインし、ホーム画面から 「監視フォルダ設定」 をクリックします。 監視フォルダ設定画面から監視フォルダを新規追加するか既存の監視フォルダ情報を開きます。 監視フォルダ情報画面にある 「ルール」 タブをクリックし、以下の設定を行います。

ファイル名からパラメータを取得

有効

区切り文字

._

パラメータ (1項目)

[ジョブ] ジョブID

「変更内容を確定する」 ボタンをクリックして監視フォルダの設定を保存します。

この設定により、ファイル名の「1項目」が「ジョブID」として認識されます。 例えば、「abc123_data.csv」というデータファイルを監視フォルダへ投入した場合、「abc123」としてジョブIDが割り当てられ、ジョブが生成されます。 このジョブIDを RemoteObject のクライアントAPIで指定してジョブを取得し、再実行します。

CreateForm server = CreateForm.getInstance("localhost", 56789);
Job job = server.lookupJob("abc123");                           // ジョブIDが「abc123」のジョブを取得
JobResult result = job.execute();                               // ジョブを再実行

このように、RemoteObject のクライアントAPIで取得した Magicfolder のジョブは、そのまま RemoteObject のクライアントAPIで再実行することができます。

10.3.2. ジョブ一覧の取得¶

ジョブIDは指定せず、ジョブの一覧を取得してすべてのジョブを再実行することができます。

CreateForm server = CreateForm.getInstance("localhost", 56789);
for (JobDescriptor jobDesc : server.listJobs()) {
   // ジョブを一件ずつ処理
   Job job = server.lookupJob(jobDesc.getId());                 // ジョブを取得
   job.execute();                                               // ジョブを再実行
}

10.3.3. ジョブの設定変更と再実行¶

印刷ページや部数、ランタイム種別など、ジョブの設定を変更して再実行することができます。

CreateForm server = CreateForm.getInstance("localhost", 56789);
Job job = server.lookupJob("abc123");                           // ジョブIDが「abc123」のジョブを取得
job.addOpt("pse", "2");                                         // 2 ページ目だけを再印刷
job.addOpt("nc", "3");                                          // 3 部印刷
job.setMode(CreateFormMode.PRINTSTAGE);                         // PrintStage に変更
JobResult result = job.execute();                               // ジョブを再実行

String name = job.getProperty("in.name");

10.3.4. フリーパラメータ¶

Magicfolder で利用可能なジョブプロパティの中に「user.1」～「user.5」という「フリーパラメータ」があります。 このフリーパラメータには、値を自由に格納して使用することができます。 これを活用することで、ジョブに固有のIDなどを埋め込んで RemoteObject のクライアントAPIで追跡するようなことも実現できます。

例えば、監視フォルダ情報の「ルール」タブで以下のような設定にしておきます。

ファイル名からパラメータを取得

有効

区切り文字

._

パラメータ (1項目)

[未分類] フリーパラメータ1

この監視フォルダに「abc123_sheet.csv」のようなファイル名でデータを投入します。 すると「abc123」の部分が「user.1」に割り当てられます。

この値は RemoteObject のクライアントAPIで以下のように取得することができます。

String value = job.getProperty("user.1"); // -> "abc123"

さらに Magicfolder のアノテーション機能を利用すると、独自のジョブプロパティを定義することもできます。

例えば、「xyz」というジョブプロパティは定義されていないため、通常は Magicfolder のルールからは設定することができません。 また、RemoteObject のクライアントAPIで取得しても「null」が返されます。

String value = job.getProperty("xyz"); // -> null

しかし、アノテーションで入力データファイルに記述することで、任意のジョブプロパティを定義することができます。

<cf:mf-annotation>
xyz = abc123
</cf:mf-annotation>
...

このように、アノテーションを利用してジョブプロパティを定義することで、RemoteObject のクライアントAPIで独自のジョブプロパティを扱うことができます。

String value = job.getProperty("xyz"); // -> "abc123"