PADomainUtils - グローバル

  • リリースバージョン: Xanadu
  • 更新日 2024年08月01日
  • 所要時間：8分

    • PADomainUtils API を使用すると、同じインスタンス上の異なるドメイン間でパフォーマンスアナリティクスレコードをコピーできます。

    サーバースクリプトでこの API を使用して、インジケーターやブレークダウン、ダッシュボードなどの パフォーマンスアナリティクス のレコードを別のドメインにコピーします。この API を使用すると、1 つのドメインに パフォーマンスアナリティクス レコードを作成し、そのレコードを任意の数の追加ドメインにコピーできます。

    注:
    この API では、レコードをグローバル ドメインにコピーすることはできません。
    警告:
    設定レコードを別のドメインに移動すると、スコアにアクセスできなくなります。
    PADomainUtils を使用するには、次の要件を満たす必要があります。
    • パフォーマンスアナリティクス を有効にする必要があります。
    • スクリプトを実行するユーザーには admin ロールが必要です。
    • インスタンスがドメインセパレーションを使用する必要があります。
    • グローバル ドメインからスクリプトを実行する必要があります。
    • レコードを移動またはコピーする場合は、ソース ドメインとターゲット ドメインが異なる必要があります。

    PADomainUtils - PADomainUtils()

    新しい PADomainUtils オブジェクトのインスタンスを作成して、グローバルドメインから パフォーマンスアナリティクス のレコードを移動またはコピーします。

    グローバルドメイン以外のドメインからレコードを移動またはコピーする際は、代わりに PADomainUtils(文字列 domainFrom) コンストラクターを使用します。

    表 : 1. パラメーター
    名前 タイプ 説明
    なし 
    // PADomainUtils initialized with the global domain
var globalUtils = new SNC.PADomainUtils();

    PADomainUtils - PADomainUtils(文字列 domainFrom)

    新しい PADomainUtils オブジェクトのインスタンスを作成して、指定したドメインから パフォーマンスアナリティクス のレコードを移動またはコピーします。

    グローバルドメインから移動またはコピーする際は、代わりに PADomainUtils() コンストラクターを使用します。

    表 : 2. パラメーター
    名前 タイプ 説明
    domainFrom 文字列 レコードのコピー元のドメイン 
    // c90d4b084a362312013398f051272c0d is the sys id of the ACME domain
var acmeUtils = new SNC.PADomainUtils('c90d4b084a362312013398f051272c0d');

    PADomainUtils - copy(文字列 runAs)

    パフォーマンスアナリティクス のレコードを別のドメインにコピーします。

    ダッシュボードまたはスケジュール設定済みジョブをコピーするには、「copyDashboard」および「copyJob」を参照してください。

    表 : 3. パラメーター
    名前 タイプ 説明
    runAs 文字列 レコードのコピー先のドメインのユーザー。
    表 : 4. 返される内容
    タイプ 説明
    なし 
    // copy all the Performance Analytics records from global to user's domain
var pa = new SNC.PADomainUtils();
pa.copy('09ff3d105f231000b12e3572f2b4775d');

    PADomainUtils - copyDashboard(文字列 dashboardId, 文字列 runAs)

    ダッシュボードを別のドメインにコピーします。

    表 : 5. パラメーター
    名前 タイプ 説明
    dashboardId 文字列 コピーするダッシュボードのSys_id。
    runAs 文字列 ダッシュボードのコピー先のドメインのユーザー。
    表 : 6. 返される内容
    タイプ 説明
    なし 
    //Copy Incident Management dashboard from global to user's domain
var pa = new SNC.PADomainUtils();
pa.copyDashboard('a64b7031d7201100b96d45a3ce610335','09ff3d105f231000b12e3572f2b4775d');

    PADomainUtils - copyJob(文字列 paJob, 文字列 runAs)

    パフォーマンスアナリティクスのスケジュール設定済みデータ収集ジョブ レコードを別のドメインにコピーします。

    表 : 7. パラメーター
    名前 タイプ 説明
    paJob 文字列 パフォーマンスアナリティクスのスケジュール設定済みデータ収集ジョブ [sysauto_pa] レコードの sys_id。
    runAs 文字列 ジョブのコピー先のドメインのユーザー。
    表 : 8. 返される内容
    タイプ 説明
    文字列 エラーが発生した場合はエラー メッセージが表示され、エラーがなければ空の文字列が返されます。 
    // No source domain needs to be set
var pa = new SNC.PADomainUtils();
// copy the '[PA Incident] Daily Data Collection job'
// set the 'run as' of the new record to be the 'acme.itil' user
// first argument is the sys_id of the sysauto_pa record
// the second is the sys_id of the acme.itil user record
pa.copyJob('82ba2023d7101100b96d45a3ce6103cd','797d14341f1310005a3637b8ec8b7010');

    PADomainUtils - isWriteable(文字列 table, 文字列 id)

    table と sys_id によって識別される特定のレコードに書き込むことができるかどうかを評価します。

    表 : 9. パラメーター
    名前 タイプ 説明
    table 文字列 pa_indicators などの、クエリーするレコードを含むテーブルの名前。
    ID 文字列 クエリするレコードの sys_id。
    表 : 10. 返される内容
    タイプ 説明
    ブーリアン 指定されたレコードに書き込めることを示します。レコードが現在のユーザーのドメイン内に存在する場合は true を返します。レコードが存在しないか、別のドメインにある場合は false を返します。 
    var pa = new SNC.PADomainUtils();
pa.isWriteable('pa_incidents','cd8125b5140012007665a83e633b028d');

    PADomainUtils - move(文字列 runAs)

    パフォーマンスアナリティクス のレコードを別のドメインに移動します。

    表 : 11. パラメーター
    名前 タイプ 説明
    runAs 文字列 レコードのコピー先のドメインのユーザー。
    表 : 12. 返される内容
    タイプ 説明
    なし 
    // move all the Performance Analytics records from the global to the customers domain
var pa = new SNC.PADomainUtils();
pa.move('774190f01f1310005a3637b8ec8b70ef')

    PADomainUtils - setFoundation(ブーリアン foundation)

    ハイブリッドドメイン構成の基盤レコードのみを移動またはコピーするには、このメソッドを使用します。

    レコードの一部のタイプを親ドメイン内で管理し、一部のタイプを子ドメイン内で管理することで、ハイブリッドアプローチを実施できます。通常、親ドメインには基盤レコードが入り、子ドメインにはウィジェットなどの上位レベルのレコードが入ります。基盤レコードとみなされるのは以下のタイプのレコードです。
    • バケットグループ
    • バケット
    • スクリプト
    • ブレークダウンソース
    • インジケーターソース
    • フィルター
    • ブレークダウン
    • 管理ソース
    • 手動ブレークダウン
    • ブレークダウンマッピング
    • ブレークダウンの関連付け
    他の パフォーマンスアナリティクス のレコード (ウィジェットやインジケーターなど) は、基盤レコードではありません。これらの追加レコードも移動またはコピーするには、このメソッドを false に設定します。
    表 : 13. パラメーター
    名前 タイプ 説明
    foundation ブーリアン この PADomainUtils オブジェクトで基盤レコードのみをコピーまたは移動する必要があるかどうかを示します。
    表 : 14. 返される内容
    タイプ 説明
    DomainUtils この関数を呼び出すオブジェクト。 
    var pa = new SNC.PADomainUtils().setFoundation(true);
pa.copy('bb6b58b01f1310005a3637b8ec8b70dd');

    PADomainUtils - setOverrides(ブール overrides)

    レコードをコピーして新しいレコードの sys_override 値を元の親レコードに設定する前に、このメソッドを使用します。

    このメソッドを使用すると、親ドメインのレコードを自動的に上書きできます。親レコードを上書きすることで、親レコードから子ドメインに影響を与えることはありません。レコードのコピー時にソースドメインがターゲットドメインの親でない場合は、sys_override 値を設定しても動作に影響はありません。レコードの移動時ではなく、レコードのコピー時にのみ上書きを指定できます。

    表 : 15. パラメーター
    名前 タイプ 説明
    overrides ブーリアン 子ドメインのコピーされたレコードが、親ドメインのソースレコードを上書きする必要があることを示します。この値のデフォルトは true です。
    表 : 16. 返される内容
    タイプ 説明
    DomainUtils この関数を呼び出すオブジェクト。 
    var pa = new SNC.PADomainUtils('c90d4b084a362312013398f051272c0d');
pa.setOverrides(false);
pa.copy('bb6b58b01f1310005a3637b8ec8b70dd');