チェーン・テンプレートを使えば、部分的なスニペットとして、または完全なチェーンとして使用するために、コマンドとイベントのシーケンスを事前に作成することができます。たとえば、テンプレートを使えば、こんなことができる:
- チェーン作りを容易にするためのヘッドスタートを提供する。
- 記録システムからのデータ抽出など、共通のワークフローを標準化する。
注: チェーンビルダー で、複数のチェーン、ワークスペース、環境を持つテンプレートを使用できます。
既存のチェーンからテンプレートを作成する
テンプレートを作成するには、公開されているチェーンをベースとして使うこともできるし、コマンドとイベントのシーケンスをゼロから新たに構築することもできる。既存のチェーンからテンプレートを作ることには、多くの利点がある:
- 最初の鎖を出発点として、他の鎖を作ることができる。
- Chain Builderを使って、他の人とチェーンを共有することができます。Workiva Community など、他の組織の人も含まれます。
既存のチェーンからテンプレートを作成するには
- Chains から、Chain Builder をクリックする。
- Chains タブを選択し、Edit for chain を選択する。
- チェーン右上の三点メニューから、Create template を選択する。
- テンプレートを識別するために、固有の名前と説明を入力します。
- フォルダー で、テンプレートの保存先を選択する。
- [保存]をクリックします。
- チェーンに変数がある場合は、それぞれのテンプレート変数を設定する:
- テンプレート変数のデフォルト名を入力する。
ヒント: 変数で使用する値を識別しやすくするために、変数名の前に接頭辞を付けることをお勧めします。例えば、
WSV-
はワークスペース変数、CV-
はチェーン変数、DCV-
はダイナミック・チェーン変数、Resource-
はワークスペース・リソース。 - 移植と再利用を容易にするため、デフォルト値を削除する。
- ダイナミック・チェーン変数またはワークスペース・リソースのどちらから値を提供するかを選択します。
注: チェーン変数、ワークスペース変数、またはランタイム変数が値を提供する場合、ダイナミック もリソース も選択しない。
- テンプレート変数のデフォルト名を入力する。
- [保存]と[公開]をクリックします
ゼロからテンプレートを作成する
チェーン用の再利用可能なフレームワークとして、コマンドとイベントの新しいシーケンスを構築するには、以下の一連のステップに従う。
ステップ1:テンプレートの追加
- Chain Builder で、Templates タブから、Create=>Template を右上にクリックする。
- Default フォルダー以外の場所にテンプレートを作成するには、Edit for its folderをクリックし、テンプレートを保存するフォルダーを選択し、Move をクリックします。
- テンプレートとその意図を識別しやすくするために、固有の名前と説明を入力します。
ヒント: テンプレートが提供するシーケンスが全チェインか部分チェインかを識別しやすくするために、その名前に接頭辞をつける。例えば、完全なチェーンなら
Full-
、部分的なチェーンやスニペットならPart-
。
ステップ2:テンプレートの変数を設定する
カスタマイズや再利用を容易にするため、テンプレートには、コマンドの変数やワークスペース・リソースに必要な値のプレースホルダーとして変数が含まれています。テンプレートからチェーンを作成すると、チェーンの変数とリソースがテンプレートの変数に置き換わります。
テンプレートに含める各変数について:
- テンプレート変数 の下で、追加 をクリックする。
- 変数名とデフォルト値を入力する。
ヒント: テンプレート変数で使用する値を識別しやすくするために、その名前に接頭辞を付けることをお勧めします。例えば、
WSV-
はワークスペース変数、CV-
はチェーン変数、DCV-
はダイナミック・チェーン変数、Resource-
はワークスペース・リソース。 -
Type で、変数の値を提供するのがダイナミック・チェーン変数かワークスペース・リソースかを選択します。
注: チェーン変数、ワークスペース変数、またはランタイム変数が値を提供する場合、ダイナミック もリソース も選択しない。
テンプレートの変数をすべて追加したら、Save をクリックします。
注: テンプレートから変数を削除するには、アクション の下にあるX をクリックする。
ステップ3:テンプレートのノードを定義する
テンプレートを構築する際、そのシーケンスでノードを設定し、リンクする:
- コマンド または、テンプレートから作成されたチェーンによって実行されるタスク(Workiva プラットフォームや別のデータソースとのやり取りなど)。
- イベント 承認ワークフローやファイルの手動アップロードを可能にするなど、テンプレート内で発生するイベント。
- トリガー・イベント(Trigger Events) 、ランタイム・インプット(Runtime Input) 、テンプレートから作成されたチェーンを実行する際に、特定のアカウント、リージョン、期間などの変数を設定したり、接続されているソースの変更に基づいて自動的にチェーン(Chain) を開始したりする。
注: カスタマイズと再利用を可能にするため、テンプレートのコマンドは、チェーンやワークスペースで設定された接続、ランナー、変数を使用しません。テンプレートからチェーンを作成するときに、これらを指定します。
ノードを追加したら、そのノードをシーケンス内のどこに移動させ、次のステップと前のステップにリンクさせる。
- テンプレートの最初のノードを追加するには、Start に移動する。
- ノードをロジックツリーの新しいブランチの開始点として追加するには、テンプレート の前のステップを複数のブランチの最初のノードにリンクします。
- コマンドを互いに並行して、あるいはシリアル・プロセスの一部として一緒に実行するには、、ステップとしてのコマンド・グループ 。
注: デフォルトでは、リンクされた前のノードが成功したときにノードが実行される。前のノードが失敗した場合のみノードを実行するなど、条件付きロジックを有効にするには、リンクをダブルクリックし、その条件-成功
、失敗 、警告 、または任意の を選択します。テンプレートのノードを定義したら、Publish をクリックします。
テンプレートの設定を編集する
テンプレートの名前や説明を調整したり、変数を管理する:
- Chain Builder で、Templates タブから、テンプレートの名前をクリックし、Template Settings をクリックする。
- 必要に応じて、テンプレートの名前、説明、変数を編集します。
- [保存]と[公開]をクリックします
テンプレートを使用するチェーンを表示する
テンプレートから作成されたチェーンを表示するには、テンプレート
タブを開き、表示 チェーン使用 の下にあるテンプレートをクリックします。In Use パネルから、テンプレートから作成されたチェーンが表示されます。チェーンを開くには、その名前をクリックする。
ヒント:特定のチェーンを見つけるには、その名前で検索する。
コピーテンプレート
テンプレートを新しいテンプレートの出発点として使用するには、そのコピーを作成します。Chain Builder で、Templates
タブから、Copy for template をクリックする。テンプレートを他の人と共有する
他の人がチェーンを作成するのを助けるために、チェーンビルダーを使用している他の人と、公開されているテンプレートへのリンクを共有することができます。Workiva コミュニティ など、他の組織の人も含まれます。
-
チェーンビルダー で、テンプレート
タブから、その共有可能なリンクを取得 をクリックする。 - クリッククリップボードにコピー と閉じる.
- 必要に応じてリンクを貼り付け、他の人と共有する。
テンプレートは、両方のワークスペースが同じコネクタとコマンドにアクセスできることに依存することに留意してください。テンプレートを別のワークスペースと共有する場合、必要なコネクターがすべて有効になっていないと、インポートしたチェーンが機能しません。
チェーンをインポートする際、不足しているコネクターを設定する機会があります:
共有テンプレートへのアクセスを取り消す
共有テンプレートへの他の人のアクセスを取り消すには、そのURLをリフレッシュして新しいリンクを作成します:
- Chain Builder で、Templates タブから、Get shareable link for template をクリックする。
- Regenerate token andClose をクリックする。
アーカイブテンプレート
テンプレートが不要になった場合は、アーカイブすることができます。Chain Builder で、Templates
をクリックし、Archive for template をクリックする。