〔はじめに〕
Data Dictionary Chain テンプレートにより、ユーザーはワークスペース内の特定のテーブルに関するハイレベルな詳細を取得し、スプレッドシートにエクスポートすることができる。ユーザーは、テーブルを検索するキーワードを指定し、エクスポート・スプレッドシートの名前を定義し、各テーブルのスキーマを格納するテーブルをワークスペースに作成することができる。
詳細については、Load Data to Wdata Process のドキュメントを参照してください。データディクショナリテンプレートを使用する前に、このドキュメントを確認することが推奨されます 。
前提条件
このテンプレートは、Workiva アプリケーションに以下のオブジェクトが既に設定されていることを前提と しています：
- APIグラント
- Workiva API を活用するためには、ユーザーはワークスペース内でOAuth API Grant を確立する必要があります。OAuthグラントを管理するためのリーディングプラクティス この記事を参照してください。
- ワークスペースでは、次のコネクタ を有効にして構成する必要があります：
注：変数値の中には、ユーザー名やパスワードのような機密情報が含まれている場合がある。情報に敏感な変数には"暗号化" オプション を使用し、スプレッドシートに適切な権限 を設定することをお勧めします。
- 変数の設定
- テンプレートの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 | PrimaryChain テンプレートは、Templates 画面の Workiva Chains セクションにある。
探し方はこうだ：
- Chain Builder で、Templates タブを開きます。
- 上部のメニューからWorkiva Chains を選択する。
- 右上の「Data Dictionary | ALL | Primary Chain Template」を検索し、テンプレートを開く。
Data Dictionary | ALL | Primary chain がワークスペースにデプロイされると、自動的に6つのサブチェーンが追加デプロイされる。
ユーザーは、7つのチェーンすべてが同じワークスペースにデプロイされ、パブリッシュされていることを確認する必要があります：
- データ辞書｜ALL｜プライマリ
- データディクショナリ｜ドキュメントとサブセクションの作成｜スプレッドシートの作成
- データディクショナリ｜ドキュメントとサブセクションの作成｜シートの作成
- データ辞書｜テーブルの作成
- データをWdataにロード｜プライマリー・チェーン
- データをWdataにロードする｜データセットを置換する
- Wdataにデータをロードする｜新しいデータセットを追加する
テンプレートを見つけたら、 のセクションで作成した変数を使用して、ワークスペース用に を設定する。
注： テンプレートからチェーンを作成する詳細な手順については、チェーンの作成と管理 の記事を参照してください。
ランタイム入力
このプライマリ・チェイン（Data Dictionary | ALL | Primary ）を実行すると、以下のランタイム入力が入力されるか、呼び出しチェインに渡される必要がある：
| ランタイム入力 | 説明 | フィールドのタイプ | 必要ですか？ |
|---|---|---|---|
| スプレッドシート名 | テーブルスキーマを書き込むスプレッドシートの名前を指定する。 | テキスト | はい |
| 検索値 | この入力は、指定されたキーワードを含むテーブルを探すのに使われる。 | テキスト | はい |
| Wdataテーブル名 | テンプレートの初回実行時に作成されるデータ辞書テーブルの名前を指定します。 | テキスト | はい |
Wdata テーブル
このチェーンを利用するには、ワークスペース内にデータ・ディクショナリWdataテーブルが存在しなければならない。ユーザーが別のテーブル名を指定しない限り、チェーンは自動的にこのテーブルを作成し、"Data Dictionary Table "という命名規則を使用する。
データ・ディクショナリー・テーブルを構築するために、以下のテーブル・スキーマが使用される：
| 列名 | カラムの説明 | 列 ID | 列の型 |
|---|---|---|---|
| テーブル名 | なし | テーブル名 | SMS|SMS 送信 |
| 別名 | なし | 別名 | SMS|SMS 送信 |
| モード | なし | モード | SMS|SMS 送信 |
| 名称 | なし | 名称 | SMS|SMS 送信 |
| タイプ | なし | タイプ | SMS|SMS 送信 |
カスタマイズされた調整 免責事項: Wdataテーブルにデータをインポートする際に、カラムヘッダが一致しないという問題が発生した場合、ユーザーはデータプレパレーションやその他のコマンドを利用してこれを修正することができます。ただし、ユーザーがこのテンプレートにカスタマイズした調整を加える場合は、その前にコピーを作成することをお勧めします。テンプレートに変更を加えると、再利用の妨げになる。これは、タグ・コンフィギュレーション をテンプレートに適用する場合にも当てはまります。
トラブルシューティング
以下の手順は、チェーン・テンプレートのトラブルシューティングに使用できます：
チェーン実行エラー
- すべてのチェーンがパブリッシュされていることを確認する。
- OAuth2 認証情報 (
wsv-Client IDおよびwsv-Client Secret) が有効で、最新であることを確認します。 - チェインを実行するユーザーのワークスペース権限を確認する。
データインポートエラー
- ソース・ファイルのカラム・ヘッダーが Wdata テーブルのスキーマと一致していることを確認してください。
- Replace Datasetの操作では、ファイル名がテーブル内の既存のデータセットと一致していることを確認してください。
- 新しいデータセットを追加]操作では、ファイル名がテーブル内で一意であることを確認してください。
テーブルまたはスプレッドシートの重複作成
-
Wdata Table Name、SpreadsheetName、ラン間で一貫性のある名前を使用する。
モニター画面
- ユーザーは、モニター画面に移動することで、エラーの原因を診断することができる。
- DCV_Chain Result 変数は、最終結果に基づくチェーンのステータスをキャプチャする。エラーが発生した場合、モニター画面内のチェーンの出力テキストに失敗の理由が適用される。
また、モニター画面を使用して、ファイルが正常にインポートされたかどうかを判断することもできます。
ベストプラクティス
-
オリジナルテンプレートのカスタマイズを避ける:
調整が必要な場合はコピーを作成する。テンプレートに変更を加えると、再利用性が妨げられる可能性がある。 -
Tagging for Enhanced Context:
必要に応じて、タグデータセットに実行時入力（Tag-KeyとTag-Value）を追加する。チェーンノードを更新して、これらの入力を渡す。 -
ファイルサイズ管理:
wsv-WdataLoadWarningThreshold変数を使用してデータセットサイズを監視。警告が発生した場合は、大きなデータセットを分割することを検討する。