IMPORT GRCRESULTS コマンド

Diligent One のリザルト テーブルまたは解釈をインポートして、Analytics テーブルを作成します。

構文

IMPORT GRCRESULTS TO テーブル インポートファイル名 PASSWORD番号 FROM リザルトリソースパス <FIELD 名前 AS 表示名 <...n>> <CHARMAX 最大フィールド長>

パラメーター

名前 説明
TO テーブル

データをインポートする Analytics テーブルの名前。

メモ

テーブルの名前は、64 文字までの英数字に制限されます。名前にはアンダースコア文字(_)を使用できますが、他の特殊文字やスペースは使用できません。名前の先頭を数字にすることはできません。

インポートファイル名

作成する Analytics データ ファイルの名前。

インポートファイル名、.FIL ファイル拡張子を持つ引用符で囲まれた文字列として指定します。例:"Invoices.FIL".

デフォルトでは、データ ファイル(.FIL)は、Analytics プロジェクトが入っているフォルダーに保存されます。

既存の異なるフォルダーにデータ ファイルを保存するには、絶対または相対ファイル パスを指定します。

  • "C:\data\Invoices.FIL"
  • "data\Invoices.FIL"
PASSWORD 番号

使用するパスワード定義。

実際のパスワードを入力することを求めたり指定したりするのには、PASSWORD 番号の構文は使用しません。パスワード定義とは、以前に PASSWORD コマンドか SET PASSWORD コマンドを使用して入力または設定されたパスワードのことです。

番号はパスワード定義の番号です。たとえば、以前に 2 つのパスワードをスクリプトで設定したり入力したりしている場合、またはアナリティクス スクリプトをスケジュールしている場合、PASSWORD 2 により、2 番目のパスワードを使用することを指定します。

パスワードの入力または設定の詳細については、次を参照してください。

必須のパスワード値は、HighBond アクセストークンです。詳細については、パスワード定義の作成とパスワード値の指定を参照してください。

PASSWORD 番号は必要な場合と不要な場合があります。スクリプトを実行する環境によって異なります。 

スクリプトが実行される環境 PASSWORD 番号要件
Analytics

(オンライン アクティベーション)

PASSWORD 番号は不要です。

Windows レジストリに保管されている現在のユーザーの HighBond アクセストークンが自動的に使用されます

Analytics

(オフライン アクティベーション)

PASSWORD 番号は必要です。

ロボット

FROM リザルトリソース パス

インポートしているデータへのリザルト パス。

パスの形式は、インポートしているデータによって異なります。パスの形式の詳細については、リザルトパスを参照してください。

メモ

リザルトパスの形式は API によって提供され、変更されることがあります。パスの正確な現在の構文を取得する最も簡単で信頼できる方法は、対象データの手動インポートを実行し、コマンドログからパスをコピーすることです。

FIELD 名前 AS 表示名 <...n>

省略可能

インポートするソース データの個別のフィールド。名前を指定します。

FIELD を省略すると、すべてのフィールドがインポートされます。

名前

名前は、リザルトのテーブルの物理フィールド名と正確に一致する必要があります。大文字小文字も区別されます。物理フィールド名を表示するには、次のいずれかを実行します。

  • リザルトで、テーブル ビューの列見出しをクリックします。[フィールド名]の後に物理フィールド名が表示されます。
  • Analytics では、リザルトのテーブルをインポートするときに、フィールドを選択できるダイアログ ボックスの表示名の後にかっこ付きで物理フィールド名が表示されます。

メモ

リザルトの物理フィールド名は、テーブルビューResultsの列見出しに使用される表示名ではありません。

リザルト データをインポートおよびエクスポートするときのフィールド名の考慮事項を参照してください。

表示名

表示名は、新しい Analytics テーブルのビューにおけるフィールドの表示名(代替列見出し)です。各 FIELD の表示名を指定する必要があります.表示名の値は引用符で囲まれた文字列。

列見出しを改行したい場合は、語句の間にセミコロン (;) を入れます。

Analytics の他のいくつかの IMPORT コマンドとは異なり、FIELD 名を表示名として使用する方法として、空の表示名を指定することはできません。

CHARMAX 最大フィールド長

省略可能

リザルトテーブルまたは解釈内の文字データから発生する Analytics テーブルの任意のフィールドの文字の最大長。

リザルトテーブルまたは解釈内の最大フィールド長を超えるデータは、Analytics にインポートすると切り捨てられます。

フィールドを切り詰める機能では、時折出現する長い値が原因で、インポート処理でサポートされるレコード全体の長さを超えることがなくなります。

  • 32,767 文字(非 Unicode Analytics)

  • 16,383 文字(Unicode Analytics)

リザルトのテーブル内の指定したフィールドをインポートする

リザルトのテーブルから 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 にすべてのフィールドをインポートしています。CHARMAX パラメーターを使用してフィールド長を制限します。

IMPORT GRCRESULTS TO T_and_E_exceptions "C:\Secondary Analysis\T_and_E_exceptions.fil" PASSWORD1 FROM "results/api/orgs/11594/control_tests/185699/exceptions" CHARMAX 200

結果として得られた Analytics テーブルでは、リザルト内の文字データから発生するすべてのフィールドは、指定した 200 文字長に制限されます。制限を超えるフィールド値は 200 文字に切り詰められます。

リザルトの解釈内のデータをインポートする

次の例では、リザルトの解釈を Analytics テーブル T and 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"

備考

このコマンドの動作の詳細については、Diligent One リザルトのデータをインポートするを参照してください。

並べ替え順やフィルターを保持する

リザルトからデータをインポートする場合、並べ替えやフィルターなどのデータ カスタマイズは、データのインポート方法に応じて、インポート後の Analytics テーブルでは保持されるか、破棄されます。

  • テーブルのインポート データカスタマイズが破棄されます。省略するように選択したフィールドを除き、テーブルのすべてのデータがインポートされます。
  • 解釈のインポート データカスタマイズが保持されます。

リザルトパス

メモ

リザルトパスの形式は API によって提供され、変更されることがあります。パスの正確な現在の構文を取得する最も簡単で信頼できる方法は、対象データの手動インポートを実行し、コマンドログからパスをコピーすることです。

FROMResults パラメーターのリザルトパスは次の一般的な形式を使用します。

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) 以外の Diligent One 地域のデータ
  • アフリカ(南アフリカ)
    FROM "results-af/api/orgs/11594/control_tests/4356/exceptions"
  • アジア太平洋(オーストラリア)
    FROM "results-au/api/orgs/11594/control_tests/4356/exceptions"
  • アジア太平洋(シンガポール)
    FROM "results-ap/api/orgs/11594/control_tests/4356/exceptions"
  • アジア太平洋(東京)
    FROM "results-jp/api/orgs/11594/control_tests/4356/exceptions"
  • 欧州(ドイツ)
    FROM "results-eu/api/orgs/11594/control_tests/4356/exceptions"
  • 北米(カナダ)
    FROM "results-ca/api/orgs/11594/control_tests/4356/exceptions"
  • 南米(ブラジル)
    FROM "results-sa/api/orgs/11594/control_tests/4356/exceptions"

システムで生成された情報列

リザルトからデータをインポートするときには、次で示すシステムで生成された情報列を 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 フィールド名要件を満たしていることを確認します。

  • 特殊文字またはスペースがない
  • 数字で始まらない
  • 英数文字またはアンダースコア文字( _ )のみを含む

パスワード定義の作成とパスワード値の指定

ロボットで Diligent One リザルトテーブルまたは解釈をインポートするスクリプトを実行する場合、IMPORT GRCRESULTS コマンドとともにパスワード定義を含める必要があります。オフラインアクティベーションを使用する場合、同じ要件が Analytics で実行されるスクリプトに適用されます。

どの方法を用いてパスワード定義を作成したかにかかわらず、パスワードには値として HighBond アクセストークンを指定する必要があります。このトークンは Launchpad で生成できます。詳細については、HighBond アクセストークンを取得を参照してください。

パスワード定義方法

方法 説明

PASSWORD アナリティクス タグ

(ロボットで実行するスクリプト用)

PASSWORD アナリティクスタグを使用して、Diligent One に接続するための番号付けされたパスワード定義を作成した場合、スクリプトでパスワードの値が指定されません。ロボットでスクリプトを実行するタスクを作成すると、タスクデザイナーの入力フィールドで実際のパスワードを指定できます。

詳細については、PASSWORD アナリティクスタグを参照してください。

PASSWORD コマンド

(Analytics で実行するスクリプトでは、オフラインアクティベーション)

PASSWORD コマンドを使用して、Diligent One に接続するための番号付けされたパスワード定義を作成した場合、スクリプトでパスワードの値が指定されません。スクリプトで接続しようとすると、パスワードプロンプトが表示されます。

詳細については、PASSWORD コマンドを参照してください。

SET PASSWORD コマンド

(Analytics で実行するスクリプトでは、オフラインアクティベーション)

SET PASSWORD コマンドを使用して、Diligent One に接続するための番号付けされたパスワード定義を作成した場合、スクリプトでパスワードの値が指定されるため、パスワードプロンプトは表示されません。この方法は自動実行用に作成されたスクリプトに適していますが、スクリプトに実際のパスワードがクリアテキストで表示されるため、この状況には適していません。

詳細については、SET PASSWORD コマンドを参照してください。

HighBond アクセストークンを取得

注意

生成されるアクセストークンは Diligent One にサインインするために使用されるアカウントと一致します。他のユーザーが使用するスクリプトを作成する場合は、そのスクリプト内に自身のアクセストークンを指定することは不適切です。

アクセストークンはアカウントパスワードと同じように保護してください。

新しいアクセストークンを作成する理由がない場合は、既存のトークンを使用してください。既存のトークンが機能しない場合は、新しいトークンを作成してください。既存のトークンを使用すると、管理する必要があるトークン数が減ります。

  1. 次のいずれかを実行します。

    • Analytics メインメニューで[ツール] > [HighBond アクセストークン]を選択します。HighBond Access Token

    • スクリプト エディター内を右クリックし、[挿入 > HighBond トークン]を選択します。HighBond Token

    API トークンを管理]ページがお使いのブラウザーで開きます。最初に Diligent One にサインインすることを求められる場合があります。

    Analytics からの[API トークンを管理]ページへのアクセスが便利です。Diligent One にサインインし、Analytics を使用せずにユーザープロファイルからこのページにアクセスすることもできます。

  2. 次のいずれかを実行します。

    • 既存のトークンを使用する

      1. トークン]列で、使用するトークンをクリックします。

      2. Diligent One アカウントのパスワードを入力し、[確認Diligent One]をクリックします。

        マスクされていないトークンが表示されます。

      3. コピー ]をクリックしてトークンをコピーします。

        ヒント

        トークンが含まれているこのダイアログボックスは、そのトークンを貼り付けるまで閉じないでください。

    • 新しいトークンを作成する

      1. トークンを追加] > [Analytics]をクリックします。

      2. 新しい Analytics トークン]サイド パネルで、次の情報を指定します。

        フィールドまたはオプション 説明
        説明

        次のような有用な情報を提供する説明を入力します。

        • トークンの目的
        • トークンの使用場所 - 例えば、Analyticsスクリプトの名前と場所、ロボットのタスクの名前と場所など。
        トークンの有効期限
        • 有効 指定した日数後にトークンの有効期限が切れます
        • 無効 トークンの有効期限はありません

        メモ

        あなたの組織には、トークンを一定期間後に失効させるセキュリティポリシーがあるかもしれません。有効期限付きのトークンを作成することは良い習慣です。Diligent One では、有効期限の前に自動でメール通知が送られます。

        有効期限が切れるまでの日数 トークンの有効期限が切れるまでの日数を指定します (1~365)。
        パスワード Diligent One アカウントのパスワードを入力します。
      3. トークンを生成]をクリックします。

      4. コピー ]をクリックしてトークンをコピーします。

        ヒント

        トークンが含まれているこのサイド パネルは、トークンを貼り付けるまで閉じないでください。

  3. 使用しているパスワード定義方法に応じて次のいずれかを実行します。

    • PASSWORDアナリティクスタグACLロボットのタスクデザイナーで、コピーしたトークンをパスワーACL robotドパラメーターフィールドに貼り付けます。

    • PASSWORD コマンドAnalytics で、コピーしたトークンを、スクリプト実行中に表示されるパスワードの確認に貼り付けます。

    • SET PASSWORD コマンドAnalytics で、スクリプトの SET PASSWORD コマンド構文内の適切な位置にコピーしたトークンを貼り付けます。

  4. Launchpad で、トークンが含まれているダイアログボックスまたはサイド パネルを閉じます。

    新しいトークンを作成した場合は、部分的にマスクされたバージョンのトークンが、トークンのリストに追加されます。

    詳細については、HighBond アクセストークンの作成と管理を参照してください。HighBond access tokens

インポートデバッグ機能

Diligent One からのインポートには、簡易デバッグ機能があります。

インポートされたデータは、対象 Analytics プロジェクトを含むフォルダーの JSON 中間ファイルに一時的に格納されます。Analytics プロジェクトを含むフォルダーでは、データが Analytics にインポートされた後に削除する代わりに、JSON ファイルを保持するテキストファイルを作成できます。

  • JSON ファイルが存在する Diligent One からのインポートが失敗しDiligent One、JSON ファイルがコンピューターにある場合は、問題が Diligent One 側ではなく、Analytics 側にあることがわかっています。AnalyticsDiligent One
  • JSON ファイルが存在しない Diligent One からのインポートが失敗し、JSDiligent OneON ファイルがコンピューターにない場合は、問題が Diligent One 側にあることがわかっています。Diligent One

この情報はトラブルシューティングで役立ちます。

JSON 中間ファイルの保持を設定する

ターゲット Analytics プロジェクトを含むフォルダーで、_grc_import_debug.txt Analyticsという名前の空のテキスト ファイルを作成します。

Diligent One のリザルトまたはプロジェクトからインポートするときには、JSON 中間ファイルは results.json という名前で保持されます。ファイルは後続の各 Diligent One からのインポートするたびに上書きされます。

大きいテーブルのインポート

単一の IMPORT GRCRESULTS コマンドを使用して、多数のフィールドがあるテーブルは正常にインポートされない場合があります。リザルト外で多数のフィールドを含む単一のテーブルを操作する必要がある場合は、次のいずれかの方法を使用します。

  • テーブルの分割は、2 つ以上の IMPORT GRCRESULTS コマンドを使用して、フィールドのサブセットをインポートしてから、JOIN コマンドを使用して、Analytics の結果テーブルを結合します。
  • テーブルをファイルにエクスポートは、CSV 形式にエクスポートを使用してから、IMPORT DELIMITED コマンドを使用して、Analytics に結果ファイルをインポートします。