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