〔はじめに〕
データディクショナリ チェーン テンプレートにより、ユーザーはワークスペース内の特定のテーブルに関するハイレベルな詳細をキャプチャし、スプレッドシートにエクスポートすることができる。ユーザーは、テーブルを検索するキーワードを指定し、エクスポート・スプレッドシートの名称を定義し、各テーブルのスキーマを格納するテーブルをワークスペースに作成することができる。
詳細については、Load Data to Wdata Process のドキュメントを参照してください。データディクショナリテンプレートを使用する前に、このドキュメントをレビューすることを推奨します 。
前提条件
このテンプレートは、Workiva アプリケーションに以下のオブジェクトが設定済みであることを前提としています：
- API グラント
- Workiva API を利用するには、ユーザーはワークスペース内でOAuth API Grant を確立する必要があります。OAuth Grantを管理するためのリーディングプラクティスについては、この記事を参照してください。
- ワークスペースでは、以下のコネクター を有効にして構成する必要があります：
メモ：変数値の中には、ユーザー名やパスワードのような機密情報を含むものもある。情報に敏感な変数には"暗号化 "オプション を使用し、スプレッドシートに適切な権限 を設定することをお勧めします。
- 変数の構成
- テンプレートのLoad Data to Wdata サブチェーン が期待通りに機能するためには、ワークスペース 変数タイトルwsv-WdataLoadWarningThreshold を作成しなければならなりません。
メモ： この変数のデフォルト値は50（50MBを表す）に設定するのがベストプラクティスだが、必要に応じて調整することもできる。
-
- さらに、データディクショナリチェーンを使用する前に、他の4つのワークスペース変数を作成しなければならない。
以下は、設定と母集団が必要な各変数の内訳です：
| 変数 | 値 | 説明 |
|---|---|---|
| wsv-WdataLoadWarningThreshold | 推奨: 50mb | チェーンがこのファイルサイズを超えるデータセットにフラグを立てる閾値を設定する。 |
| wsv-クライアントID | ユーザーのAPI Grantから派生したもの。 | API付与作成後に母集団を作成します。 |
| wsv-クライアント・シークレット | ユーザーのAPI Grantから派生したもの。 | API付与作成後に母集団を作成します。 |
| wsv-IAMBaseURL | https://api.app.wdesk.com/iam/v1 |
Workiva IAM API のベース URL。 メモ： ベース URL は、統合ユーザーの所在地に従属する。 |
| wsv-PlatformBaseURL | https://api.app.wdesk.com/platform/v1 |
Workiva Platform API のベース URL。 メモ： ベース URL は、統合ユーザーの所在地に従属する。 |
チェーンの構築
Data Dictionary | ALL | Primaryチェーン テンプレートは、テンプレート画面の Workiva Chains セクションにあります。
検索方法はこうだ：
- チェーンビルダーで、テンプレート タブに移動します。
- 上部のメニューからWorkiva チェーン を選択する。
- 右上の「Data Dictionary | ALL | Primary Chain Template」を検索し、テンプレートを開く。
データ・ディクショナリ | ALL | プライマリ・チェーン がワークスペースにデプロイされると、自動的に6つのサブチェーンが追加デプロイされる。
ユーザーは、7つのチェーンすべてが同じワークスペースに配置され、更新されていることを確認する必要があります：
- データディクショナリ｜ALL｜プライマリ
- データディクショナリ｜ドキュメントとサブセクションの作成｜スプレッドシートの作成
- データディクショナリ｜ドキュメントとサブセクションの作成｜シートの作成
- データディクショナリ｜テーブル作成
- Wdata｜プライマリチェーンにデータを読み込み中
- Wdataへのデータの読み込み｜データセットの置換
- Wdataへのデータの読み込み｜新規データセットの追加
テンプレートを見つけたら、セクションで作成した変数を使って、ワークスペース用に">構成します。
メモ： テンプレートからチェーンを作成する詳細な手順については、チェーンの作成と管理 の記事を参照のこと。
ランタイム入力
このプライマリチェーン（Data Dictionary | ALL | Primary ）を実行する際には、以下の実行時入力を入力するか、呼び出しチェーンに渡す必要がある：
| ランタイム入力 | 説明 | フィールドのタイプ | 必要ですか？ |
|---|---|---|---|
| スプレッドシート名 | テーブルスキーマを書き込むスプレッドシートの名称を指定する。 | テキスト | はい |
| 検索値 | この入力は、指定されたキーワードを含むテーブルを検索するために使用される。 | テキスト | はい |
| Wdataテーブル名称 | テンプレートの初回実行時に作成されるデータ辞書テーブルの名称を指定します。 | テキスト | はい |
Wdata テーブル
このチェーンを利用するには、ワークスペース内にデータディクショナリWdataテーブルが存在しなければならない。チェーンは、ユーザーが別のテーブル名を指定しない限り、"データディクショナリテーブル "という名称を使って自動的にこのテーブルを作成する。
データディクショナリー・テーブルの構築には、以下のテーブルスキーマが使用される：
| 列名 | 列の説明 | 列 ID | 列の型 |
|---|---|---|---|
| テーブル名 | なし | テーブル名 | SMS|SMS 送信 |
| 別名 | なし | 別名 | SMS|SMS 送信 |
| モード | なし | モード | SMS|SMS 送信 |
| 名称 | なし | 名称 | SMS|SMS 送信 |
| タイプ | なし | タイプ | SMS|SMS 送信 |
カスタマイズ調整 免責事項: ユーザーがデータをWdataテーブルにインポートする際に列ヘッダーが一致しない問題を経験した場合、データの準備や他のコマンドを活用してこれを修正することができます。ただし、ユーザーがこのテンプレートにカスタマイズ調整を追加する場合は、コピーを取ってから行うことをお勧めします。テンプレートに変更を加えると、再利用の妨げになる。これは、タグ構成 をテンプレートに適用する場合にも適用される。
トラブルシューティング
以下のステップは、チェーンテンプレートに関する問題のトラブルシューティングに使用できます：
チェーン実行エラー
- すべてのチェーンが更新されていることを確認します。
- OAuth2 認証情報 (
wsv-Client IDおよびwsv-Client Secret) が有効で最新であることを確認します。 - チェーンを実行するユーザーのワークスペース権限をチェックする。
データインポートエラー
- ソースファイルの列ヘッダーがWdataテーブルのスキーマと一致していることを確認する。
- データセットの置換操作では、ファイル名称がテーブル内の既存のデータセットと一致していることを確認してください。
- 新規データセットの追加操作では、ファイル名称がテーブル内で一意であることを確認してください。
複製テーブルまたはスプレッドシートの作成
-
Wdata テーブル名およびSpreadsheetNameの名称は、実行中一貫して使用すること。
モニター画面
- ユーザーは、モニター画面にナビゲーションすることで、エラーの原因を診断することができる。
- DCV_Chain Result変数は、最終結果に基づくチェーンのステータスをキャプチャする。エラーが発生した場合、モニター画面内のチェーンの出力テキストに失敗の理由が適用される。
ユーザーは、モニター画面を使って、ファイルが正常にインポートされたかどうかを判断することもできます。
ベストプラクティス
-
オリジナルテンプレートのカスタマイズを避ける:
調整が必要な場合はコピーを作成する。テンプレートの変更は、再利用の妨げになる可能性がある。 -
Tagging for Enhanced Context:
必要に応じて、タグデータセットにランタイム入力（Tag-KeyとTag-Value）を追加する。チェーンノードを更新して、これらの入力を渡す。 -
ファイルサイズ管理:
wsv-WdataLoadWarningThreshold変数を使用してデータセットサイズを監視する。警告が発生した場合は、大きなデータセットを分割することを検討してください。