IMPORT GRCRESULTS コマンド
HighBond のリザルト テーブルまたは解釈をインポートして、Analytics テーブルを作成します。
構文
IMPORT GRCRESULTS TO テーブル インポート ファイル名 PASSWORD 数値 FROM リザルトリソース パス <FIELD 名前 AS 表示名 <...n>>
パラメーター
名前 | 説明 | |||||||
---|---|---|---|---|---|---|---|---|
TO テーブル |
データをインポートする Analytics テーブルの名前。 メモ テーブルの名前は、64 文字までの英数字に制限されます。 名前にはアンダースコア文字(_)を使用できますが、他の特殊文字やスペースは使用できません。 名前の先頭を数字にすることはできません。 |
|||||||
インポートファイル名 |
作成する Analytics データ ファイルの名前。 インポートファイル名、.FIL ファイル拡張子を持つ引用符で囲まれた文字列として指定します。 例:"Invoices.FIL". デフォルトでは、データ ファイル(.FIL)は、Analytics プロジェクトが入っているフォルダーに保存されます。 既存の異なるフォルダーにデータ ファイルを保存するには、絶対または相対ファイル パスを指定します。
|
|||||||
PASSWORD 番号 |
使用するパスワード定義。 実際のパスワードを入力することを求めたり指定したりするのには、PASSWORD 番号の構文は使用しません。 パスワード定義とは、以前に PASSWORD コマンドか SET PASSWORD コマンドを使用して入力または設定されたパスワードのことです。 番号はパスワード定義の番号です。 たとえば、以前に 2 つのパスワードをスクリプトで設定したり入力したりしている場合には、PASSWORD 2 により、2 番目のパスワードを使用することを指定するなどします。 パスワードの入力または設定の詳細については、次を参照してください。 必須のパスワード値は、HighBond アクセス トークンです。 詳細については、パスワード定義の作成とパスワード値の指定を参照してください。 メモ PASSWORD は必要な場合と不要な場合があります。スクリプトを実行する環境によって異なります。
|
|||||||
FROM リザルトリソース パス |
インポートしているデータへのリザルト パス。 パスの形式は、インポートしているデータによって異なります。 パスの形式の詳細については、リザルト パスを参照してください。 メモ リザルト パスの形式は API によって提供され、変更されることがあります。 パスの正確な現在の構文を取得する最も簡単で信頼できる方法は、対象データの手動インポートを実行し、コマンド ログからパスをコピーすることです。 |
|||||||
FIELD 名前 AS 表示名 <...n> 省略可能 |
インポートするソース データの個別のフィールド。 名前を指定します。 FIELD を省略すると、すべてのフィールドがインポートされます。 名前名前は、リザルトのテーブルの物理フィールド名と正確に一致する必要があります。大文字小文字も区別されます。 物理フィールド名を表示するには、次のいずれかを実行します。
メモ リザルトの物理フィールド名は、テーブル ビューの列見出しに使用される表示名ではありません。 リザルト データをインポートおよびエクスポートするときのフィールド名の考慮事項を参照してください。 表示名表示名は、新しい Analytics テーブルのビューにおけるフィールドの表示名(代替列見出し)です。 各 FIELD 名の表示名を指定する必要があります. 表示名の値は引用符で囲まれた文字列。 列見出しを改行したい場合は、語句の間にセミコロン(;)を入れます。 Analytics の他のいくつかの IMPORT コマンドとは異なり、FIELD 名を表示名として使用する方法として、空の表示名を指定することはできません。 |
例
リザルトのテーブル内の指定したフィールドをインポートする
リザルトのテーブルから Analytics テーブル T and E exceptions に指定されたフィールドをインポートしています。
IMPORT GRCRESULTS TO T_and_E_exceptions "C:\Secondary Analysis\T_and_E_exceptions.fil" PASSWORD 1 FROM "results/api/orgs/11594/control_tests/185699/exceptions" FIELD "metadata.status" AS "Status" FIELD "EmpNo" AS "Employee Number" FIELD "DATE" AS "Date" FIELD "CARDNUM" AS "Card Number" FIELD "CODES" AS "MC Codes" FIELD "AMOUNT" AS "Amount" FIELD "DESCRIPTION" AS "Description"
リザルトのテーブル内のすべてのフィールドをインポートする
次の例では、リザルトのテーブルから Analytics テーブル T and E exceptions にすべてのフィールドをインポートしています。
IMPORT GRCRESULTS TO T_and_E_exceptions "C:\Secondary Analysis\T_and_E_exceptions.fil" PASSWORD 1 FROM "results/api/orgs/11594/control_tests/185699/exceptions"
リザルトの解釈内のデータをインポートする
次の例では、リザルトの解釈を Analytics テーブル T and E exceptions filtered にインポートしています。
IMPORT GRCRESULTS TO T_and_E_exceptions_filtered "C:\Secondary Analysis\T_and_E_exceptions_filtered.fil" FROM "results/api/orgs/11594/control_tests/185699/interpretations/22699/exceptions"
備考
メモ
このコマンドの動作の詳細については、Analytics のヘルプを参照してください。
並べ替え順やフィルターを保持する
リザルトからデータをインポートする場合、並べ替えやフィルターなどのデータ カスタマイズは、データのインポート方法に応じて、インポート後の Analytics テーブルでは保持されるか、破棄されます。
- テーブルのインポート データ カスタマイズが破棄されます。 省略するように選択したフィールドを除き、テーブルのすべてのデータがインポートされます。
- 解釈のインポート データ カスタマイズが保持されます。
リザルト パス
メモ
リザルト パスの形式は API によって提供され、変更されることがあります。 パスの正確な現在の構文を取得する最も簡単で信頼できる方法は、対象データの手動インポートを実行し、コマンド ログからパスをコピーすることです。
FROM パラメーターのリザルト パスは次の一般的な形式を使用します。
FROM "results <-地域コード>/api/orgs/<組織 ID>/control_tests/<統制テスト ID>/exceptions
例: FROM "results/api/orgs/11594/control_tests/4356/exceptions"
組織 ID は Launchpad にログインするときにブラウザーのアドレスバーに表示されます。 統制テスト ID および解釈 ID は、リザルトでテーブルを表示するときにアドレスバーに表示されます。
以下のテーブルは、リザルト パスのすべてのバリエーションを示します。
インポートするには | 次の形式のリザルト パスを使用します。 |
---|---|
統制テスト(テーブル)のデータ | FROM "results/api/orgs/11594/control_tests/4356/exceptions" |
統制テスト(テーブル)の監査証跡 | FROM "results/api/orgs/11594/control_tests/4356/audit_trail" |
統制テスト(テーブル)のコメント | FROM "results/api/orgs/11594/control_tests/4356/comments" |
解釈 | FROM "results/api/orgs/11594/control_tests/4356/interpretations/1192/exceptions" |
デフォルト地域(us)以外の HighBond 地域のデータ |
|
システムで生成された情報列
リザルトからデータをインポートするときには、次で示すシステムで生成された情報列を 1 つ以上インポートすることができます。
システムで生成された列は次のいずれかです。
- リザルトのテーブルの一部であり、個々のレコードに関連する処理情報を含んでいます。
- 追加情報 - コレクション名、テーブル名、またはレコード ID 番号
以下に示すように、システムで生成された列のフィールド名を正確に指定する必要があります。 Analytics のユーザー インターフェイスを使用して リザルトからインポートするときには、デフォルトの表示名が適用されます。 インポート処理のスクリプトを作成する場合は、表示名を自由に変更できます。
フィールド名 |
デフォルトの表示名 |
---|---|
metadata.priority |
優先度 |
metadata.status |
進捗状況 |
metadata.publish_date |
公開済み |
metadata.publisher |
公開者名 |
metadata.assignee |
割り当てられたユーザー |
metadata.group | グループ |
metadata.updated_at | 更新 |
metadata.closed_at | クローズ済み |
extras.collection | コレクション |
extras.results_table | 結果テーブル |
extras.record_id | レコード ID |
リザルト データをインポートおよびエクスポートするときのフィールド名の考慮事項
リザルトと Analytics 間でデータを往復する場合は、リザルト テーブルのすべてのフィールド名がより厳しい Analytics フィールド名要件を満たすことを確認する必要があります。 そうでない場合、Analytics とリザルト データが一致しないおそれがあります。
たとえば、リザルト フィールド名の特殊文字は、 Analytics にインポートされるときに自動的にアンダースコアに変換されます。これは、フィールド名がリザルトの元の名前と一致しないことを意味します。 後から Analytics データをリザルトの元のテーブルにエクスポートする場合は、フィールドが正しく一致しません。
往復するデータでこの問題を回避するには、CSV または Excel ファイルからリザルトにデータをアップロードする前に、以下の Analytics フィールド名要件を満たしていることを確認します。
- 特殊文字またはスペースがない
- 数字で始まらない
- 英数文字またはアンダースコア文字( _ )のみを含む
パスワード定義の作成とパスワード値の指定
PASSWORD コマンド
PASSWORD コマンドを使用して、HighBond に接続するための番号付けされたパスワード定義を作成した場合、パスワードの値が指定されていないと、スクリプトを接続しようとするときにパスワード プロンプトが表示されます。
詳細については、PASSWORD コマンドを参照してください。
SET PASSWORD コマンド
SET PASSWORD コマンドを使用して、 HighBond に接続するための番号付けされたパスワード定義を作成した場合、パスワードの値が指定されていれば、パスワード プロンプトは表示されません。これは、無人で実行するように設計されたスクリプトに適しています。
詳細については、SET PASSWORD コマンドを参照してください。
HighBond アクセス トークンを取得
どの方法を用いてパスワード定義を作成したかにかかわらず、パスワードには値として HighBond アクセス トークンを指定する必要があります。このトークンは Launchpad で生成できます。
注意
生成されるアクセス トークンは Launchpad へのサインインに使用するアカウントと一致します。 他のユーザーが使用するスクリプトを作成する場合は、そのスクリプト内に自身のアクセス トークンを指定することは不適切です。
- 次のいずれかを実行します。
- Analytics メイン メニューで[ツール>HighBond アクセス トークン]を選択します。
- スクリプト エディター内を右クリックし、[挿入 > HighBond トークン]を選択します。
[API アクセス トークンを管理します]ページがお使いのブラウザーで開きます。 まず Launchpad にサインインするように求められる場合があります。
- 次のいずれかを実行します。
- 既存のトークンを使用する[トークン]列で、使用する一部がマスクされたトークンをクリックし、HighBond アカウントのパスワードを入力します。 マスクされていないトークンが表示されます。
ヒント
新しいトークンを作成する理由がない場合は、既存のトークンを使用してください。 既存のトークンが機能しない場合は、新しいトークンを作成してください。
既存のトークンを使用すると、管理する必要があるトークン数が減ります。
- 新しいトークンを作成する[トークンを作成 > Analytics]をクリックし、お使いの HighBond アカウントのパスワードを入力します。
新しい Analytics トークンが作成されます。
メモ
Launchpad システム管理者である場合は、API トークンを作成することもできます。 目的に合った API トークンを予約する必要があります。これは、HighBond プラットフォームへのプログラム アクセスです。
- 既存のトークンを使用する[トークン]列で、使用する一部がマスクされたトークンをクリックし、HighBond アカウントのパスワードを入力します。 マスクされていないトークンが表示されます。
- [コピー ]をクリックしてトークンをコピーします。
ヒント
トークンが含まれているこのダイアログ ボックスは、そのトークンを貼り付けるまで閉じないでください。
- Analytics で、次のいずれかを実行します。
- トークンを[パスワードの確認]に貼り付ける
- スクリプトの SET PASSWORD コマンド構文内の適切な位置にトークンを貼り付ける
- Launchpad で、トークンが含まれているダイアログ ボックスを閉じます。
新しいトークンを作成した場合は、部分的にマスクされたバージョンのトークンが、トークンのリストに追加されます。
詳細については、アクセス トークンの作成と管理を参照してください。
インポート デバッグ機能
HighBond からのインポートには、簡易デバッグ機能があります。
インポートされたデータは、対象 Analytics プロジェクトを含むフォルダーの JSON 中間ファイルに一時的に格納されます。 Analytics プロジェクトを含むフォルダーでは、データが Analytics にインポートされた後に削除する代わりに、JSON ファイルを保持するテキスト ファイルを作成できます。
- JSON ファイルが存在する HighBond からのインポートが失敗し、JSON ファイルがコンピューターにある場合は、問題が HighBond 側ではなく、Analytics 側にあることがわかっています。
- JSON ファイルが存在しない HighBond からのインポートが失敗し、JSON ファイルがコンピューターにない場合は、問題が HighBond 側にあることがわかっています。
この情報はトラブルシューティングで役立ちます。
JSON 中間ファイルの保持を設定する
ターゲット Analytics プロジェクトを含むフォルダーで、_grc_import_debug.txt という名前の空のテキスト ファイルを作成します。
HighBond のリザルトまたはプロジェクトからインポートするときには、JSON 中間ファイルは results.json という名前で保持されます。 ファイルは後続の各 HighBond からのインポートするたびに上書きされます。
大きいテーブルのインポート
単一の IMPORT GRCRESULTS コマンドを使用して、多数のフィールドがあるテーブルは正常にインポートされない場合があります。 リザルト外で多数のフィールドを含む単一のテーブルを操作する必要がある場合は、次のいずれかの方法を使用します。
- テーブルの分割は、2 つ以上の IMPORT GRCRESULTS コマンドを使用して、フィールドのサブセットをインポートしてから、JOIN コマンドを使用して、Analytics の結果テーブルを結合します。
- テーブルをファイルにエクスポートは、CSV 形式にエクスポートを使用してから、IMPORT DELIMITED コマンドを使用して、Analytics に結果ファイルをインポートします。