ワークフローからREST Webサービスを呼び出す
- アプリケーションのREST Webサービスとの通信要件を確認します。
- アプリケーションでの認証のための値
- REST Webサービスにデータを要求するための値
- 応答で提供されるデータ形式
アプリケーションの使用説明書を参照するか、アプリケーションをホストしている会社にお問い合わせください。
- RICOH ProcessDirectorで、アプリケーションとの通信を準備するには、以下のタスクを実行してください。
- アプリケーションにセキュリティー証明書が必要な場合は、RICOH ProcessDirectorの1次コンピューターに証明書をインストールします。
- 環境内でプロキシサーバーがWebサービスと通信する必要がある場合は、プロキシを使用するようにシステムをセットアップします。
詳しくは、関連タスクを参照してください。
- アプリケーションで認証してREST Webサービスに応答を要求する手動テストを実行します。Webサービスが予期した応答を返すことを確認します。多くのブラウザーには、Boomerang for Google Chromeなど、テストWebサービスがRESTクライアントに対して呼び出すプラグインがあります。
- Webサービスにペイロードが含まれる場合は、情報の提供方法を決定します。
- 要求ペイロードプロパティーの値としてペイロードを入力できます。
- ジョブの処理中にCallRESTServiceステップがアクセスできるテキストファイルに、ペイロードを保存できます。
- ワークフロータブをクリックします。
- 変更するワークフローの名前をクリックします。
- オプション: ワークフロー名の左にあるスイッチをクリックして、ワークフローを使用不可にします。 編集中にワークフローを無効にしないと、このワークフローを使用するジョブは引き続きステップ内を進みます。保存するときに、ワークフローが一時的に無効になり、その後再度有効になります。ワークフローで処理されているジョブでエラーが発生する可能性があります。
- ワークフローに組み込まれているステップと、そこで設定されているデフォルト値を確認します。
- CallRESTServiceステップテンプレートを基にしたステップを、ワークフローの適切な場所に追加します。
- ジョブプロパティーに値を設定します。
- 要求URLプロパティーに、ステップが呼び出すWebサービスのURLを設定します。URL は、HTTP または HTTPS プロトコルを使用できます。
- 要求メソッドプロパティーに、Webサービスで必要な値を設定します。
- パスワードプロパティーに、アプリケーションによる認証のためにステップがREST Webサービスに提供するパスワードを設定します。このプロパティーの値としてパスワードを入力します。REST Webサービスにパスワードを提供するには、要求ペイロードプロパティー、 要求ヘッダープロパティー、または 要求パラメータープロパティー内のシンボルとして Job.WebService.Passwordプロパティーを指定します。${Job.WebService.Password} 使用するプロパティーを判断するには、Webサービスの使用説明書を参照してください。
- 要求ペイロードタイププロパティーを設定するには、以下の手順に従ってください。
- 要求ペイロードプロパティーの値としてWebサービス要求の本文を指定するには、 テキストを選択します。
- ジョブの処理中にCallRESTServiceステップがアクセスできるテキストファイルにWebサービス要求の本文を指定するには、 ファイルを選択します。
- 注意:
- ペイロードを指定していない場合は、RICOH ProcessDirectorはこのプロパティーの値を無視します。
- Webサービスにペイロードが含まれる場合は、要求ペイロードプロパティーを設定します。
- 要求ペイロードタイププロパティーを テキストに設定する場合は、このプロパティーの値としてペイロードを入力します。
- 要求ペイロードタイププロパティーを ファイルに設定する場合は、完全なディレクトリーパス、名前、テキストファイル拡張子をこのプロパティーの値として入力します。
テキストファイルの内容としてペイロードを入力します。
ペイロードでパスワードを送信するには、シンボルとしてJob.WebService.Passwordプロパティーを指定します。
このXMLの例では、注文IDはCustom 3ジョブプロパティー（ Job.Info.Attr3）の値として保存されます。ペイロードには、<Token>エレメントの値としてパスワード、<OrderID>エレメントの値として注文IDが含まれます。
<Token>${Job.WebService.Password}</Token><OrderID>${Job.Info.Attr3}</OrderID>
このステップは、REST Webサービスの呼び出し時にシンボルを解決します。
- 要求ヘッダーと 要求パラメータープロパティーの値を必要に応じて設定します。
各ヘッダーフィールドやパラメーターは、キーワードと値のペアです。各ペアは個別の行に指定して、キーワードと値をコロン（:）または等号（=）で区切る必要があります。
キーワードと値は複数の単語にすることができます。RICOH ProcessDirectorは、各行の最初のコロンまたは等号を使用して、語句をキーワードと値のペアに分割します。
これらの例には、tokenとorderIdという2つのパラメーターが含まれています。各キーワードの値は RICOH ProcessDirectorシンボルです。各シンボルには、次のいずれかのプロパティーが含まれています。 Job.WebService.Passwordおよび Job.Info.Attr3。
token:${Job.WebService.Password}orderId:${Job.Info.Attr3}
このステップは、REST Webサービスの呼び出し時にシンボルを解決します。
- 環境内でプロキシサーバーがWebサービスと通信する必要がある場合は、プロキシを使用プロパティーに正しいプロキシサーバーを設定します。
- 応答ファイルプロパティーに、RICOH ProcessDirectorがアプリケーション応答の保存に使用するファイルの、完全なディレクトリーパスとファイル名を設定します。一般的に、この値はアプリケーションが返す応答の種類に応じて、${getFileName(print,json,write)}または${getFileName(print,xml,write)}になります。応答がこのファイルに保存されると、ワークフロー内の他のステップが応答を処理できるようになります。
- 要求URLプロパティーに、ステップが呼び出すWebサービスのURLを設定します。
- 完了したら、OKをクリックします。
- ワークフローを保存し、使用可能にします。
ワークフローのセットアップが完了したら、RICOH ProcessDirectorとアプリケーションの間でデータの交換をテストします。
例
Web Services Enablement機能には、付属の RestfulWebServiceWFワークフローと CallRESTServiceステップが含まれています。