Adobe Workfront Planning モジュール
Adobe Workfront Planning モジュールを使用すると、Workfront Planningでイベントが発生したときにシナリオをトリガーできます。 レコードを作成、読み取り、更新、削除したり、Adobe Workfront Planning アカウントへのカスタム API の呼び出しを実行したりできます。
アクセス要件
| table 0-row-2 1-row-2 2-row-2 layout-auto html-authored no-header | |
|---|---|
| Adobe Workfront パッケージ |
任意の Adobe Workfront Workflow パッケージと任意の Adobe Workfront Automation および Integration パッケージ Workfront Ultimate Workfront Fusion を追加購入した Workfront Prime および Select パッケージ。 |
| Adobe Workfront ライセンス |
標準 Work またはそれ以上 |
| 製品 | 組織が Workfront Automation および Integration を含まない Select またはPrime Workfront パッケージを持っている場合は、Adobe Workfront Fusion を購入する必要があります。 |
この表の情報について詳しくは、ドキュメントのアクセス要件を参照してください。
前提条件
Workfront Planningにアクセスするには、次の情報が必要です。
- 新しいWorkfront パッケージとライセンス。 Workfront Planningは、従来のWorkfront パッケージまたはライセンスでは使用できません。
- Workfront計画パッケージ。
- 組織のWorkfront インスタンスをAdobe Unified Experienceにオンボーディングする必要があります。
Adobe Workfront計画APIの情報
Adobe Workfront Planning コネクタでは、次の機能が使用されます。
Workfront PlanningとWorkfront Fusionの連携
Workfront Planning コネクタは、OAuth 2.0を使用してWorkfront Planningに接続します。
Workfront Planning Fusion モジュール内から直接Workfront Planning アカウントへの接続を作成できます。
クライアント IDとクライアントシークレットを使用してWorkfront Planningに接続する
-
任意のAdobe Workfront計画モジュールで、「接続」フィールドの横にある「追加」をクリックします。
-
次のフィールドに入力します。
table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2 5-row-2 layout-auto html-authored no-header Connection type Adobe Workfront認証接続を選択します。 Connection name 新しい接続の名前を入力します。 Client ID Workfront クライアント ID を入力します。 これは、Workfront の設定エリアの OAuth2 アプリケーションエリアにあります。 接続している特定のアプリケーションを開いて、クライアント ID を確認します。 Client Secret Workfront クライアントシークレットを入力します。 これは、Workfront の設定エリアの OAuth2 アプリケーションエリアにあります。 Workfront で OAuth2 アプリケーションのクライアントシークレットがない場合は、別のシークレットを生成できます。 手順について詳しくは、Workfront ドキュメントを参照してください。 Authentication URL これはデフォルト値のままにすることもできますし、Workfront インスタンスの URL に続けて
/integrations/oauth2を入力することもできます。例：
https://mydomain.my.workfront.com/integrations/oauth2Host prefix ほとんどの場合、この値は originにしてください。 -
「続行」をクリックして接続を保存し、モジュールに戻ります。
Workfront Planningにログインしていない場合は、ログイン画面が表示されます。 ログイン後、接続を許可できます。
- Workfront API への OAuth 2.0 接続は API キーに依存しなくなりました。
- Workfront サンドボックス環境への接続を作成するには、その環境で OAuth2 アプリケーションを作成し、接続でそのアプリケーションによって生成されたクライアント ID とクライアントシークレットを使用する必要があります。
サーバー間接続を使用したWorkfront Planningへの接続
-
任意のAdobe Workfront計画モジュールで、「接続」フィールドの横にある「追加」をクリックします。
-
次のフィールドに入力します。
table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2 5-row-2 6-row-2 7-row-2 layout-auto html-authored no-header Connection type 「Adobe Workfront サーバー間接続」を選択します。 Connection name 新しい接続の名前を入力します。 Instance name インスタンス（ドメインとも呼ばれます）の名前を入力します。
例：URL が
https://example.my.workfront.comの場合は、exampleと入力します。Instance lane この接続の接続先となる環境タイプを入力します。
例：URL が
https://example.my.workfront.comの場合は、myと入力します。Client ID Workfront クライアント ID を入力します。 これは、Workfront の設定エリアの OAuth2 アプリケーションエリアにあります。 接続している特定のアプリケーションを開いて、クライアント ID を確認します。 Client Secret Workfront クライアントシークレットを入力します。 これは、Workfront の設定エリアの OAuth2 アプリケーションエリアにあります。 Workfront で OAuth2 アプリケーションのクライアントシークレットがない場合は、別のシークレットを生成できます。 手順について詳しくは、Workfront ドキュメントを参照してください。 Scopes この接続に適用可能なスコープを入力します。 Host prefix ほとんどの場合、この値は originにしてください。 -
「続行」をクリックして接続を保存し、モジュールに戻ります。
Workfront Planningにログインしていない場合は、ログイン画面が表示されます。 ログイン後、接続を許可できます。
- Workfront API への OAuth 2.0 接続は API キーに依存しなくなりました。
- Workfront サンドボックス環境への接続を作成するには、その環境で OAuth2 アプリケーションを作成し、接続でそのアプリケーションによって生成されたクライアント ID とクライアントシークレットを使用する必要があります。
Adobe Workfront Planning バージョン 2 モジュールとそのフィールド
Workfront計画モジュールを設定すると、Workfront Fusionに次のフィールドが表示されます。 これらと共に、アプリやサービスのアクセスレベルなどの要因に応じて、追加の Workfront フィールドが表示される場合があります。 モジュール内の太字のタイトルは、必須フィールドを示します。
フィールドまたは関数の上にマップボタンが表示されている場合は、このボタンを使用すると、そのフィールドの変数や関数を設定できます。 詳しくは、モジュール間での情報のマッピングを参照してください。
ワークスペース （V2）
ワークスペースの作成（V2）
このアクションモジュールは、Planningで新しいワークスペースを作成します。
ワークスペースの削除（V2）
このアクションモジュールは、IDで指定された1つのワークスペースを削除します。
すべてのワークスペースを取得（V2）
このモジュールは、すべてのワークスペースのリストを取得します。
ワークスペースを取得（V2）
このモジュールは、IDでワークスペースを取得します。
ワークスペースの更新（V2）
このアクションモジュールは、Planningの新しいワークスペースを更新します。
レコードタイプ （V2）
レコードタイプ（V2）の作成
このアクションモジュールは、選択したワークスペースに新しいレコードタイプを作成します。
レコードタイプの削除（V2）
このアクションモジュールは、IDで指定された1つのレコードタイプを削除します。
グローバルなレコードタイプを取得（V2）
このモジュールは、Adobe Workfront Planning アカウント内のレコードタイプのリストを取得します。
レコードタイプ（V2）を取得
このモジュールは、レコードタイプをIDで取得します。
レコードタイプを取得（V2）
このモジュールは、特定のワークスペースで使用可能なレコードタイプのリストを取得します。
レコードタイプの更新（V2）
このモジュールは、レコードタイプを更新します。
レコード （V2）
レコードの作成（V2）
このアクションは、Workfront計画で1つのレコードを作成します。
レコードの削除（V2）
このアクションモジュールは、IDで指定された1つのレコードを削除します。
レコードの取得（V2）
このアクションモジュールは、IDで指定されたレコードを取得します。
レコードタイプ （V2）別にレコードを取得
このモジュールは、指定されたレコードタイプのすべてのレコードのリストを取得します。
レコードの移動（V2）
このモジュールは、レコードタイプ内の1つ以上のレコードの並べ替え先を指定します。
レコードの検索（V2）
指定した条件に基づいてレコードを返します
レコードの更新（V2）
このモジュールは、指定されたレコードを更新します。
フィールド （V2）
フィールドの作成（V2）
このアクションモジュールは、指定したレコードタイプに新しいフィールドを作成します。
フィールドの削除（V2）
このアクションモジュールは、IDで指定された1つのフィールドを削除します。
フィールドを取得（V2）
このモジュールは、IDでフィールドを取得します。
レコードタイプ （V2）でフィールドを取得
このモジュールは、特定のレコードタイプのフィールドのリストを取得します。
フィールドの更新（V2）
このモジュールは、フィールドをIDで部分的に更新します。
ビュー（V2）
ビューの作成（V2）
このアクションモジュールは、選択したレコードタイプの新しいビューを作成します。
ビューの削除（V2）
このアクションモジュールは、IDで指定された単一のビューを削除します。
ビューを取得（V2）
このモジュールは、IDでビューを取得します。
レコードタイプ別のビューの取得（V2）
このモジュールは、特定のレコードタイプのビューのリストを取得します。
ビューの更新（V2）
このアクションモジュールは、指定したビューを更新します。
権限（V2）
アクセス要求を閉じる（V2）
このアクションモジュールは、IDで指定された1つ以上のアクセス要求を却下します。
リソースのすべてのメンバーとその役割を取得（V2）
このモジュールには、リソースに明示的な共有関係を持つすべてのユーザー、グループ、およびチームが一覧表示されます。 このモジュールの接続で使用される資格情報には、リソースに対する管理権限が必要です。
リソースに対する現在のユーザーの効果的な権限を取得する（V2）
このモジュールは、特定のリソースに対する現在のユーザーのビュー、編集、削除、および追加の権限を返します。
リソースの保留中のアクセス要求のリスト （V2）
このモジュールは、特定のリソースに対するすべての保留中のアクセス要求を返します。
リソースへのアクセスの要求（V2）
このモジュールは、特定のリソースに対する現在のユーザーのアクセスリクエストを作成または更新します。
その他（V2）
Workfront ID （V2）から認証IDを取得
このモジュールは、Workfront ユーザーIDを取得し、Planningで使用する一致する認証IDを返します。
カスタム API呼び出しを行う（V2） <table
このモジュールは、Workfront Planning APIに対するカスタム呼び出しを行います。
https://<WORKFRONT_DOMAIN>/maestro/api/. への相対パスを入力します。リクエストのヘッダーを標準 JSON オブジェクトの形式で追加します。 これにより、リクエストのコンテンツタイプが決まります。
例： {"Content-type":"application/json"}
API 呼び出しのクエリを標準 JSON オブジェクトの形式で追加します。
例： {"name":"something-urgent"}
ヒント：情報は、クエリパラメーターではなく、JSON 本文を使用して送信することをお勧めします。
標準の JSON オブジェクトの形式で、API 呼び出しの本文の内容を追加します。
メモ：
if などの条件文を JSON で使用する場合は、条件文を引用符で囲みます。
イベントを見る（V2）
このトリガーモジュールは、レコード、レコードタイプ、またはワークスペースがWorkfront Planningで作成、更新、または削除されたときにシナリオを開始します。
- 編集されたWebhookは、Workfront イベントサブスクリプションによって新しいサブスクリプションとして扱われます。 イベントのサブスクリプション履歴は、別のイベントのサブスクリプションと見なされるため、以前のWebhook設定では保持されません。
- 古いイベント サブスクリプションから新しいイベント サブスクリプションへの切り替えは、完全に同期されていない可能性があります。 したがって、イベントを2回受信したり（新しいサブスクリプションが古いサブスクリプションの実行開始前に開始された場合）、イベントを見逃したり（古いサブスクリプションが新しいサブスクリプションの実行開始前に停止した場合）することができます。
このモジュールで高度なロジックを使用する例については、監視イベントモジュールの高度なロジックの例を参照してください。
Adobe Workfront Planning バージョン 1 モジュールとそのフィールド
Workfront計画モジュールを設定すると、Workfront Fusionに次のフィールドが表示されます。 これらと共に、アプリやサービスのアクセスレベルなどの要因に応じて、追加の Workfront フィールドが表示される場合があります。 モジュール内の太字のタイトルは、必須フィールドを示します。
フィールドまたは関数の上にマップボタンが表示されている場合は、このボタンを使用すると、そのフィールドの変数や関数を設定できます。 詳しくは、モジュール間での情報のマッピングを参照してください。
トリガー
イベントの監視
このトリガーモジュールは、レコード、レコードタイプ、またはワークスペースがWorkfront Planningで作成、更新、または削除されたときにシナリオを開始します。
- 編集されたWebhookは、Workfront イベントサブスクリプションによって新しいサブスクリプションとして扱われます。 イベントのサブスクリプション履歴は、別のイベントのサブスクリプションと見なされるため、以前のWebhook設定では保持されません。
- 古いイベント サブスクリプションから新しいイベント サブスクリプションへの切り替えは、完全に同期されていない可能性があります。 したがって、イベントを2回受信したり（新しいサブスクリプションが古いサブスクリプションの実行開始前に開始された場合）、イベントを見逃したり（古いサブスクリプションが新しいサブスクリプションの実行開始前に停止した場合）することができます。
このモジュールで高度なロジックを使用する例については、監視イベントモジュールの高度なロジックの例を参照してください。
アクション
レコードタイプの削除
このアクションモジュールは、Workfront Planningの1つのレコードタイプをIDで削除します。
カスタム API 呼び出しの実行
このモジュールは、Adobe Workfront Planning API に対してカスタム API 呼び出しを実行します。
https://(YOUR_WORKFRONT_DOMAIN)/maestro/api/リクエストのヘッダーを標準 JSON オブジェクトの形式で追加します。
例： {"Content-type":"application/json"}
Workfront Fusion は認証ヘッダーを自動的に追加します。
標準の JSON オブジェクトの形式で、API 呼び出しの本文の内容を追加します。
メモ：
if などの条件文を JSON で使用する場合は、条件文を引用符で囲みます。
検索
レコードの検索
このアクションモジュールは、指定した条件に基づいてレコードのリストを取得します。
未分類
レコードの作成
このアクションは、Workfront計画で1つのレコードを作成します。
レコードの削除
このアクションモジュールは、Workfront Planningで指定されたレコードを削除します。
レコードを取得
このアクションモジュールは、Adobe Workfront Planning から、ID で指定された、1 つのレコードを取得します。
レコードタイプ別にレコードの取得
このアクションモジュールは、指定されたタイプのすべてのレコードを取得します。
レコードタイプの取得
このアクションモジュールは、Adobe Workfront Planning アカウント内のレコードタイプのリストを取得します。
レコードの更新
このアクションは、Workfront Planningの1つのレコードを更新します。
読み取り可能なrecord-typesの分類にJSONataを使用
次のJSONata式は、レコードタイプの内訳を示す、人間が読み取り可能なPlanning クエリの出力を作成します。 これにより、レコードタイプ名、フィールド名、およびフィールドオプション名（該当する場合）が名前で読みやすくなり、構造の残りの部分はそのまま維持されます。
(
$s0 := ({"data":$ ~> | fields | {"options":(options){name:$}} |});
$s1 := ({"data":$s0.data ~> | **.fields | {"options_name":(options.*){displayName:$}} | });
$s2 := $s1 ~> | data | {"fields":(fields){displayName:$}} |;
$s2.data{displayName:$}
)
JSONata モジュールの使用について詳しくは、JSONata モジュール を参照してください。
監視イベントモジュールの高度なロジックの例
これは、Workfront計画/監視イベントモジュールを使用する際に高度なロジックが実行するフォーマットの例です。
[
{
"fieldName": "recordTypeId",
"fieldValue": "Rt68c886502d4b5554ee80896b",
"comparison": "eq",
"state": "newState"
},
{
"fieldName": "data",
"fieldValue": {
"F68c886502d4b5554ee808975": "planning"
},
"comparison": "eq",
"state": "newState"
},
{
"fieldName": "data",
"fieldValue": {
"F68c886502d4b5554ee808975": "active"
},
"comparison": "eq",
"state": "newState"
}
]
Watch Event モジュールで高度なロジックを使用する場合は、次の点を考慮してください。
- 最初の
"fieldvalue":エントリは、URLから取得した計画レコードタイプ IDです。 この例では、計画レコードタイプ IDはRt68c886502d4b5554ee80896bです。 - 計画データは
dataという名前の配列内で返されます。この例では"fieldName": "data"と表示されます。 - 計画フィールド名は、
Fで始まるIDとして返されます。 - この例は
ORフィルターコネクタに対して評価しているため、同じフィールド （F68c886502d4b5554eec808975）に2つのエントリがあります。 モジュールがフィルタリング対象にしている2つのドロップダウンオプションは"planning"と"active"です。