チェーンテンプレートは、チェーン環境内のチェーンとチェーン実行に関する包括的な情報を提供するように設計されています。モニターログを補完し、チェーンのアクティビティに関する追加インサイトを提供します。
- 在庫と追跡: 在庫プロセスを簡素化し、ユーザーは使用されていないチェーンや需要の高いチェーンを素早く識別することができます。これは、より良いリソース割り当てと効率化を助ける。
- 詳細レポート :ユーザーは、ID、日付、名称など、説明書や分析に重要なメタデータの詳細なレポートを生成できます。
- クリーンアッププロセス :このテンプレートは、システムを乱雑にしているテスト中のチェーンや古くなったチェーンを識別して削除し、メンテナンスを容易にするために非常に有用である。
- 複数のチェーンビルダーに対する最適化 :複数のチェーン開発者がいる環境では、このテンプレートはチェーンの使用状況をクリアに表示し、不必要なチェーンを排除するための調整と最適化の努力を容易にします。
全体として、このテンプレートは、チェーンとチェーン実行のモニタリングのコントロールを強化し、ユーザーがその管理とメンテナンスに関して、十分な情報に基づいた決定を下すことを可能にする。
〔はじめに〕
チェーンテンプレートは、実行されるワークスペース内の1つまたは複数のチェーン環境のチェーンとチェーン実行(実行)のリストを取得します。実行時に、レポートスプレッドシートは、分析のための環境、チェーン、およびチェーン実行を選択するために指定されます。
メモ: このテンプレートは、デプロイされたワークスペースに存在するチェーン環境でのみ実行可能です。
テンプレートはチェーン のデータを収集し、指定された各環境のチェーンリスト Wdata テーブルに読み込みます。チェーンごとに収集される情報には以下のものが含まれる:
- チェーンID
- チェーン名称
- 作成日
- 更新日
- チェーンURL
- ワークスペースID
- ワークスペース名
- 環境ID
- 環境名称
さらに、環境内のチェーン実行 に関するデータを収集し、チェーン実行 Wdata テーブルに読み込みます。各チェーン実行で収集される情報は以下の通り:
- チェーンID
- ワークスペースID
- 環境ID
- 実行者
- 開始点
- 終了点
- 状態
- 打ち上げタイプ
- 実行ID
すべてのチェーンデータが収集され、Wdataテーブルに読み込み中となると、テンプレートは、Days Since QueryのSelect Listに、前回の実行以降に新規のEnvironmentsがないことを確認します。新規のエンバイロメントが識別された場合、選択リストはそれに応じて更新されます。
テンプレートの最終ステップでは、Refresh Connection を実行し、テンプレートが収集した最新の情報で接続シートを更新する。接続シートは、使用開始からの日数クエリによって生成された出力で更新されます。
要件
- ワークスペースでは、以下のテンプレートを有効にして構成する必要があります:
- ワークスペースでは、以下のコネクターを有効にして構成する必要があります:
チェーンの展開
チェーン使用状況トラッカー・テンプレートは、Templates 画面の Workiva Chains セクションにあります。
検索方法はこうだ:
- チェーンビルダー で、テンプレート タブに移動します。
- 上部のメニューからWorkiva チェーン を選択する。
- 右上のChain Usage Tracker を検索し、テンプレートを開く。
-
テンプレートを見つけたら、新規チェーン をクリックし、ワークスペースに配置する。
- 構成 以下の「テンプレートの構成」セクションのステップに従って、テンプレートを構成します。
テンプレートの構成
-
Chain User Tracker.cb をダウンロードし、それをワークスペースにインポートする。
- このインポートにより、テンプレートに必要なWdataテーブルとクエリが作成されます。
注: テーブルID チェーン変数の構成時に後で使用するための各テーブルのID。
- WdataでDays Since Useクエリを開いて編集
- 右クリックメニューParametersをクリックします。
-
Environments パラメータをクリックする。
メモ: クエリパラメータの編集 を参照のこと。
- List Options を修正し、1つ以上のチェーン環境を含むようにする。大文字と小文字の区別を含め、各名称が対応するチェーン環境とまったく同じ であることを確認する。
-
デフォルト値 を必要に応じて変更する。
- 適用をクリック
- 保存をクリックします。
- このインポートにより、テンプレートに必要なWdataテーブルとクエリが作成されます。
-
チェーン使用状況トラッカー.tar.gz をダウンロードし、 それをワークスペース にインポートする。このインポートにより、必要なチェーン使用状況トラッカー スプレッドシートが作成される。
- ファイルが正常にインポートされたら、チェーン使用状況トラッカー・スプレッドシートを探し、開きます。
-
パラメータ シートで、セルB1 の使用開始からの日数 閾値を-1 以上の値に更新する。
メモ: -1の値は、すべてのデータを検索する。
- Process Tracking Sheet を使用して、テンプレートの実行状況を監視する。
- 特定のチェーン環境 をテンプレートでプロセスできるようにするには、環境 シートの下に1つ以上の子シートを追加する。チェーン環境シート プレースホルダーシートの削除または名前の変更
- 各子シートの名称が、対応するチェーン環境に対応するものと、大文字小文字まで含めて全く同じであることを確認
-
Days Since Use Wdata クエリから受信接続 を作成し、Days_Since_Use およびEnvironments パラメータを構成する。
メモ: DEV、デモ、SSCはチェーン環境名称の一例。これらの環境はあなたの環境名称と一致しないかもしれません。必要に応じて、Days Since Useクエリパラメータ を編集する。このテンプレートは、Maintain Wdata Parameters を使用して値を保持する。
変数
| 変数タイプ | 変数名称 | 変数目的 |
| チェーン変数 | チェーンリスト テーブルID | Wdata チェーンのデータを格納するテーブル。 |
| チェーン変数 | チェーン実行テーブルID | Wdata チェーン実行に関するデータを格納するためのテーブル。 |
| チェーン変数 | クエリパラメータ名称 | Days Since Useクエリで構成したEnvironmentsパラメータの名称。 |
| チェーン変数 | ステータスシート名称 | レポート・スプレッドシート内のステータス・シートの名称またはID |
| チェーン変数 | パラメータシート名称 | レポートスプレッドシート内のパラメータシートの名称またはID |
メモ: IDの検索については、WorkivaファイルおよびアイテムのID検索 を参照のこと。
ランタイム入力
| 入力タイプ | 名称 | 目的 |
| テキストフィールド | レポート・スプレッドシートID | レポート用スプレッドシートのIDを入力する。 |
メモ: IDの検索については、WorkivaファイルおよびアイテムのID検索 を参照のこと。
テンプレートの実行
- 実行 ボタンをクリックする。
- Run With Inputsボタンをクリックして実行
-
Chain Usage Tracker Spreadsheet ID をReporting Spreadsheet ID runtime inputフィールドに入力する。
- Start ボタンをクリックします。
- テンプレートが実行されると、チェーン使用状況トラッカー・スプレッドシートに移動し、プロセス追跡 シートをビューして、実行状況を監視する。
- テンプレートを完成させ、子シート「環境」のデータを表示
実行結果
チェーン使用状況トラッカー・スプレッドシートへの出力例です:
完成したチェーン:
トラブルシューティング
- サブチェーンUpdate Status、Load Data to Wdata、Maintain Wdata Parametersがすべて更新されていることを確認する
- 正しいIDが指定されていることを確認する。Workiva 内での ID の識別子については、Find IDs for Workiva files and itemsを参照してください。
- Chain User Tracker.cb およびChain User Tracker.tar.gz ファイルが正常にインポートされたことを確認する。Wdata ファイルのインポート およびWorkiva ファイルのインポート ヘルプ記事を参照
- Days Since Use クエリで、チェーンリストとチェーン実行テーブルのテーブルIDが正しいことを確認する。
- パラメータシートのDays Since Use の値が -1 以上であることを確認する。
- レポートスプレッドシートにチェーン環境シートが存在し、チェーン環境子シートの名称が正しいことを確認
- Environmentsシートの名称を変更した場合は、Days Since Useクエリを調整し、シートのカスタマイズ名称を使用してください。
- ステータスシートやパラメータシートの名称を変更し、チェーン変数でその名称を参照している場合は、そのカスタマイズ名がチェーン変数の値に反映されていることを確認してください。
- Days Since UseクエリのEnvironmentsパラメータの名称を変更した場合、クエリパラメータチェイン変数がパラメータのカスタマイズ名称を使用するように更新されていることを確認してください。
- Workiva Connector が選択した環境でコマンドを実行するために必要な権限を持っていることを確認する。