文書参照システムの導入
チケット発行システムは、文書参照システムを導入することでさらに強化できる。システムは、チケットの内容と説明に基づいて関連するドキュメントを自動的に検索し、顧客サポートのワークフローを向上させます。
紹介システムを有効化して展開するには、以下の手順に従ってください。
-
前の
liferay-ticket-batch-object-definitionクライアント拡張機能の/batch/object-definition.batch-engine-data.jsonファイルに移動します。 36 行目のobjectActionsセクションで、activeの値をfalseからtrueに変更します。 -
以下のコマンドを使用して、
liferay-ticket-batch-object-definitionクライアント拡張機能を再デプロイします。./gradlew :client-extensions:liferay-ticket-batch-object-definition:deployなお、 オブジェクトアクション は UI から有効にすることもできます。 Liferay で、 コントロール パネル → オブジェクト に移動します。チケット オブジェクトをクリックし、 アクション タブをクリックします。アクションが
アクティブであることを確認してください。
-
次に、以下のコマンドを実行してください。
./gradlew :client-extensions:liferay-ticket-etc-spring-boot:deployログを確認して、デプロイが成功したことを確認してください。
-
次に、以下のコマンドを実行してSpring Bootアプリケーションを起動します。
./gradlew :client-extensions:liferay-ticket-etc-spring-boot:bootRun書類照会システムが稼働を開始しました。
-
チケット販売システムのサイトページに戻ってください。新しいチケットを生成する をクリックします。新しいチケットが生成されます。
-
グローバルメニュー → _コントロールパネル → J3Y7 チケット に移動します。チケット一覧の右端までスクロールしてください。生成されたばかりのチケットの アクション (
) をクリックし、 表示 をクリックします。提案欄までスクロールしてください。紹介システムに、関連文書へのリンクが含まれていることを確認してください。

紹介システムコードを確認する
ドキュメント参照システムは、 マイクロサービス タイプのクライアント拡張機能です。具体的には、このサンプルは BootJar を使用して構築された Spring Boot アプリケーションです。 client-extension.yamlの「assemble」ブロックセクションでは、これを次のように定義しています:
assemble: - fromTask: bootJar
詳細については、 クライアント拡張機能の組み立て を参照してください。
マイクロサービスクライアント拡張機能がLiferayと連携するには、OAuth2ユーザーエージェントの設定が必要です。したがって、 client-extension.yaml ファイルには、 oAuthApplicationUserAgent タイプのクライアント拡張機能と、 objectAction タイプのクライアント拡張機能の両方が含まれます。
liferay-ticket-etc-spring-boot-oaua クライアント拡張機能は、紹介システムアプリケーションが認証に使用するための OAuth2 アプリケーションを Liferay 内に作成します。以下のように定義されます。
liferay-ticket-etc-spring-boot-oaua:
.serviceAddress: localhost:58081
.serviceScheme: http
name: Liferay Ticket Etc Spring Boot OAuth Application User Agent
scopes:
- C_J3Y7Ticket.everything
type: oAuthApplicationUserAgent
C_J3Y7Ticket.everything ヘッドレス API にアクセス権が付与されている点に注目してください。 serviceAddress パラメータは、サービスがローカルで実行される場所を定義します。
次に、 liferay-ticket-etc-spring-boot-object-action-ticket クライアント拡張機能は、オブジェクトアクションが発生したときにマイクロサービスコードをトリガーする objectAction タイプのクライアント拡張機能です。以下のように定義されます。
liferay-ticket-etc-spring-boot-object-action-ticket:
name: Liferay Ticket Etc Spring Boot Object Action Ticket
oAuth2ApplicationExternalReferenceCode: liferay-ticket-etc-spring-boot-oaua
resourcePath: /object/action/ticket
type: objectAction
なお、 resourcePath パラメータは、マイクロサービスが実行されているエンドポイントを定義します。 oAuth2ApplicationExternalReferenceCode パラメータは、以前の OAuth2 アプリケーション構成を参照します。
各プロパティの説明については、 オブジェクトアクション Yaml 設定 を参照してください。
アプリケーションに関連する Spring Boot ファイルは、 /src フォルダーに含まれています。 Javaコードの詳細な説明はこのチュートリアルの範囲を超えるが、いくつか注意すべき点がある。
-
ObjectActionTicketRestController.javaファイルでは、@PostMappingアノテーションが上記の YAML ファイルで参照されているリソース パスと一致します。新しいチケットオブジェクトが作成されると、オブジェクトのアクションによってこのパスにあるマイクロサービスがトリガーされ、参照結果がLiferayに返されます。 -
参照検索ロジックもこの
ObjectActionTicketRestController.javaファイルにあります。ロジックでは、 learn.liferay.com から関連する記事が見つかり、チケットオブジェクトのエントリに追加されます。
次へ: Cronジョブによるチケット管理。