REST Webサービスへのステータス送信を準備する
- アプリケーションのREST Webサービスとの通信要件を確認します。
- アプリケーションでの認証のための値
- REST Webサービスにデータを要求するための値
- 応答で提供されるデータ形式
アプリケーションの使用説明書を参照するか、アプリケーションをホストしている会社にお問い合わせください。
- RICOH ProcessDirectorで、アプリケーションとの通信を準備するには、以下のタスクを実行してください。
- アプリケーションにセキュリティー証明書が必要な場合は、RICOH ProcessDirectorの1次コンピューターに証明書をインストールします。
- 環境内でプロキシサーバーがWebサービスと通信する必要がある場合は、プロキシを使用するようにシステムをセットアップします。
詳しくは、関連タスクを参照してください。
- アプリケーションで認証してREST Webサービスに応答を要求する手動テストを実行します。Webサービスが予期した応答を返すことを確認します。多くのブラウザーには、Boomerang for Google Chromeなど、テストWebサービスがRESTクライアントに対して呼び出すプラグインがあります。
- 通知をトリガーするイベントを決定し、さらに通知でWebサービスを呼び出すタイミングを決める条件を設定します。特定のワークフローがジョブを処理するときにのみ発生するイベントの通知を送信する場合は、そのワークフローを条件として指定します。
- REST Webサービスの通知を定義するには、以下の手順に従ってください。
- 管理タブをクリックします。
- 左のペインでをクリックします。
- をクリックします。
または、付属のRestfulWebServiceSampleNotifyREST Webサービスの通知をコピーすることもできます。 - 一般タブで、通知の名前を入力します。
- 要求タブでの操作:
- 要求URLプロパティーに、通知するWebサービスのURLを設定します。
- 要求メソッドプロパティーに、Webサービスで必要な値を設定します。
- 要求ペイロードプロパティー値には、入力装置がアプリケーションに送信するWebサービス要求の本文を指定します。このXMLの例では、ペイロードに次の2つのXMLエレメントが含まれます。<Token>および<OrderNumber>。
<Token>${WSNotification.WebService.Credential}</Token> <OrderNumber>${Job.Info.Attr1}</OrderNumber>
各エレメントの値は、プロパティーを含む RICOH ProcessDirectorシンボルです。アプリケーションでの認証のためにWebサービスを使用している場合は、シンボルに WSNotification.WebService.Credentialプロパティーを含めます。その他のエレメントとプロパティーを、アプリケーションに送信するエレメントとプロパティーで置き換えます。通知は、REST Webサービスにステータスを送信するときにシンボルを解決します。
- 要求ヘッダーと 要求パラメータープロパティーの値を必要に応じて設定します。各ヘッダーフィールドやパラメーターは、キーワードと値のペアです。各ペアは個別の行に指定して、キーワードと値をコロン（:）または等号（=）で区切る必要があります。
キーワードと値は複数の単語にすることができます。RICOH ProcessDirectorは、各行の最初のコロンまたは等号を使用して、語句をキーワードと値のペアに分割します。
この例では、次の3つのパラメーターが含まれます。token、orderNumberおよびcustomerName。各キーワードの値は RICOH ProcessDirectorシンボルです。各シンボルには、次のいずれかのプロパティーが含まれています。 WSNotification.WebService.Credential、 Job.Info.Attr1および Job.CustomerName。
token:${WSNotification.WebService.Credential}orderNumber:${Job.Info.Attr1}customerName:${Job.CustomerName}
入力装置は、REST Webサービスにステータスを送信するときにシンボルを解決します。
- 環境内でプロキシサーバーがWebサービスと通信する必要がある場合は、プロキシを使用プロパティーに正しいプロキシサーバーを設定します。
- 認証タブで、アプリケーションによる認証に必要な値を指定します。詳しくは、REST Webサービスでの認証の関連タスクを参照してください。
アプリケーションで認証が要求されない場合は、［認証］プロパティーをすべて空白のままにします。
- イベントタブで、次の操作を実行します。
- 監視するオブジェクトのタイプを選択します。
- 監視するプロパティー、アクションおよび値を選択します。
- 別のイベントを定義するには、任意のイベントの右側にある+をクリックします。
- イベントを削除するには、削除するイベントの右側の-をクリックします。
例えば、ジョブの状態が保存に変更されたときに通知を送信するには、 現行ジョブの状態、 変更後および 保存を選択します。 - 条件タブで、次の操作を実行します。
- 通知が送信される前に満たす必要があるプロパティーおよび値を選択します。
- 別の条件を定義するには、任意のイベントの右側にある+をクリックします。条件の組み合わせ方法を指定するには、任意、 すべて、または カスタムを選択します。
- 条件を削除するには、削除する条件の右側の-をクリックします。
例えば、子ジョブがProcessWebOrdersワークフローに組み込まれている場合にのみ通知を送信するには、次の2つの条件を指定します。- Workflow = ProcessWebOrders
- Job number like*.*
ジョブが両方の条件を満たした場合にのみ条件を適用するには、すべてを選択します。
- 完了したら、OKをクリックします。
入力装置、通知、およびワークフローのセットアップが完了したら、RICOH ProcessDirector とアプリケーションの間でデータの交換をテストします。
付属のRestfulWebServiceSampleNotifyREST Webサービスの通知を確認してください。