ご覧のページは、お客様の利便性のために一部機械翻訳されています。また、ドキュメントは頻繁に更新が加えられており、翻訳は未完成の部分が含まれることをご了承ください。最新情報は都度公開されておりますため、必ず英語版をご参照ください。翻訳に問題がある場合は、こちらまでご連絡ください。

ワークフローアクションYAML設定リファレンス

client-extension.yaml ファイルを使用して、ワークフローアクションのクライアント拡張を定義することができます。

使用法の詳細

この client-extension.yaml ファイルは、ワークフローアクションと OAuth ユーザーエージェントを定義しています。

easy-workflow-action-1:
    name: Easy Workflow Action 1
    oAuth2ApplicationExternalReferenceCode: easy-oauth-application-user-agent
    resourcePath: /easy-workflow/action/1
    type: workflowAction

easy-oauth-application-user-agent:
    scopes:
        - Liferay.Headless.Admin.Workflow.everything
    type: oAuthApplicationUserAgent

必須の resourcePath プロパティは、ワークフローアクションハンドラーの場所を定義します。外部アプリケーション（Java Spring Bootアプリケーションなど）としてアクセス可能なワークフローアクションハンドラーの実装を指します。この値は、OAuth2 アプリケーションプロファイルの homePageURL 値と組み合わされて、完全な URL を形成します。

ワークフローアクションクライアント拡張は、Liferayのワークフローアクションによってトリガーされるリクエストを保護するためにOAuth2アプリケーションプロファイルを必要とします。上記の例では、このプロファイルに対して追加の OAuth ユーザーエージェントクライアント拡張を定義し、 oAuth2ApplicationExternalReferenceCode プロパティがそのクライアント拡張の キー 値を参照します。

サンプルワークスペースは、ワークフローアクションクライアント拡張機能の追加方法を示しています。

YAML プロパティ

これらのプロパティは、ワークフローアクションクライアントエクステンションに固有のものです。

名前	データ型	説明
`resourcePath`	文字列（URLの一部）	(必須) ワークフローアクションハンドラへのパス。この値は、OAauth2アプリケーションプロファイルの `homePageURL` の値と組み合わされて、完全なURLとなります。
`oAuth2ApplicationExternalReferenceCode`	文字列	(必須) リクエストを保護するために必要な、OAuth2アプリケーションプロファイルの外部参照コード。