このアクティビティでは、ワークフローに REST または SOAP Web サービスを統合できるようになります。Web サービスを使用すると、システム間で自動的にデータを交換したり、ワークフローを介して他のアプリケーションで情報の作成、更新、削除を行えるようになります。
逆に、他のプログラムのデータをお客様のワークフローで使用することも可能です。たとえば、財務会計システムや CRM を DocuWare に接続することができます。
Workflow Manager で Web サービスを使用するには、最初に「Web サービス」にある「DocuWare の構成」に Web サービスを登録します。
Workflow Designer の Web サービスアクティビティでは、Web サービスの呼び出しを作成するために、あるワークフローの種類を用いたアシスト付きのシステムを提供しています。ここでは、REST Web サービスを例に最も重要な手順を説明していきます。
1. 概要
最初に、REST Web サービスを選択してデータ交換の形式を指定します (JSON または XML)。DocuWare 構成の [Web サービス] ですでに設定されているサービスを選択することができます。必要とされる詳細情報については、選択した Web サービスのタイプによって異なります。
Web サービスが OpenAPI 仕様ファイル (*.json、*.txt、*.yml または *.yaml) を提供している場合は、それをインポートするオプションがあります。一度インポートすると、利用可能なすべてのエンドポイントが次のとおりドロップダウンに表示されます。
2. リクエスト
メソッドを選択し、HTTP リクエストを構成します。リクエストのプレビュー (URL) が上部に表示されます。URL パスの設計、クエリパラメータの定義、固定値、インデックスが作成されているデータ、またはグローバル変数とシステム変数のいずれかを使用して HTTP body コンテンツの構造を柔軟に設定できます。
最後に、[送信] ボタンを使ってリクエストをテストし、[応答] を調べて操作の成功を確認します。テストを実行するには、各変数にテスト値を与える必要があることに注意してください。
HTTP Body の検証
HTTP body の検証は、[送信] によって実行されるか、構成の保存時に自動的に実行されます。コンテンツの一部が無効であることが判明した場合、特定のエラーが強調表示され、対応するメッセージが表示されます。
検証に問題がある場合でも、構成を保存するオプションがあることに注目してください。
ドキュメントは、注釈付き（DocuWare バージョン 7.14 以降）または注釈なしの PDF として、もしくは元のドキュメントとしてエクスポートできます。
DocuWare 7.12: RESTful Web サービスに HTTP リクエストを送信する際にテストドキュメントを指定するために、そのようなドキュメントを添付できるようになりました。
HTTP requests のエンコーディング
HTTP Request をエンコードする際に、3 つのオプションから選択できます。
1.特殊文字のエンコード (推奨): すべての特殊文字はエンコードされます (この例は英語用です)。例えば、「AT&T」は「AT%26T」に、「Rapid Transport」は「Rapid%20Transport」になります。
2.URL の予約文字を除く特殊文字のエンコード、つまり、?#[]@!$&/*+,;='() をエンコードします。URL の予約文字を除き、すべての特殊文字はエンコードされます。例えば、「AT&T」は維持されますが、「Rapid Transport」は「Rapid%20Transport」になります。
3.特殊文字をエンコードしない: 特殊文字およびスペースはエンコードされません。
このエンコーディングは、[ルート] タブと [クエリ] タブで転送が指定されているすべての値に適用されますが、[HTTP Header] タブと [HTTP Body] タブの値には適用されません。
エンドポイントの構成
OpenAPI 仕様ファイルまたはデフォルトの REST Web サービス「DocuWare Platform API」を使用する場合は、前のステップで選択したエンドポイントを構成します。構成を簡素化するために、すべての必要なパラメータは、選択したエンドポイントに基づいて自動的に事前設定されます。
DocuWare プラットフォーム API の場合、具体的には、[ルート] セクションと [クエリ] セクション内で、アクセスするファイルキャビネットやドキュメントなどの欠損値を定義します。
[HTTP Body] セクションで、選択した操作を実行に必要な情報とプロパティ (配置するスタンプの GUID など) を指定します。
3. データの割り当て
このステップでは、応答からの値をグローバル変数またはインデックスデータのいずれかに割り当てます。ツリー表示のインターフェース (以下参照) を使用して、JSON または XML から必要な値を直接選択します。
これによって、応答から特定の情報を抽出して保存し、ワークフロー内でさらに利用できるようになります。
返されたすべてのエントリを処理したい場合は、配列インデクサー内のインデックスをアスタリスク (*) に手動で置き換えます。これにより、配列内のすべてのエントリーを包括的に処理することができます。
デフォルトの Web サービス DocuWare Platform API
「デフォルトのWebサービス DocuWare Platform API」の記事で、あらかじめ設定済みのエンドポイントを確認してください。
サンプルユースケース
「documentAnnotations」エンドポイントのサンプルユースケースは次のとおりです。
会計ソフトウェアで請求書が処理された後、DocuWare 内で請求書に「支払い済み」のスタンプを自動的に押すように設定することを希望しています。
そのためには、請求書のインデックスエントリを「支払い済み」に変更する Autoindex ジョブを作成します。請求書のインデックスエントリを変更するとワークフローがトリガーされ、その Web サービスアクティビティによって請求書ドキュメントに「支払い済み」スタンプが自動的に押されます。
自動アクティビティを実行するには、ワークフローに指定されたユーザーに「支払い済み」スタンプを構成して割り当てる必要があることに注意してください。
「documentAnnotations」エンドポイントの構成は次のようになります。
