スクリプトの作成と編集
スクリプトの作成にはいくつかのオプションがあります:
- スクリプト エディタ スクリプト エディタ ウィンドウのスクリプト構文を入力する
- コマンド ログ コマンド ログからスクリプト構文をコピーして貼り付ける
- スクリプト レコーダー 実行時にコマンドの構文を記録する
- 構文キャプチャ コマンドを実行せずユーザー インターフェイスで選択する場合にコマンドの構文を挿入する
- テーブル履歴 出力テーブル履歴からスクリプトの構文をコピーする
これらのオプションは組み合わせで利用できます。たとえば、コマンドログから構文をコピーして、スクリプト エディター ウィンドウに直接構文を追加してスクリプトを開始することができます。
Analytics 内の既存のスクリプトを編集するには、スクリプト エディターを使用する必要があります。
また、選択したテキスト エディターを使用して、Analytics スクリプトに構文をコピーして貼り付けることもできます。
コード補完
スクリプト エディターでスクリプト構文を入力する際、Analytics によってさまざまな種類のコード補完が実行されます。コード補完により、構文の入力が簡素化されるだけでなく、ACLScript のコマンド、関数、キーワード、パラメーターの有効な形式も提示されます。
-
コマンド、関数、キーワードの自動補完 自動補完機能により、入力した文字に基づいて、ACLScript のコマンド、関数、キーワードの選択リストが順次更新されます。リストから項目を選択すると、構文項目が自動的に補完されます。
-
関数パラメーターのポップアップ ヘルプ 有効な関数名の後に開き括弧を入力すると、ポップアップ ヘルプが表示され、関数が返す出力のデータ型と、関数パラメーターに必要な形式が示されます。
-
ペアの構文項目の自動閉じ 以下のペアになっている構文項目のいずれかの開き記号を入力すると、閉じ記号が自動的に入力されます。
-
二重引用符 ""
-
単一引用符 ''
-
逆引用符 ``
-
括弧 ()
-
コマンド、関数、キーワードのオートコンプリートをオフにするには、[オプション]ダイアログ ボックスの[インターフェイス]タブ([ツール] > [オプション])で[スクリプトのオートコンプリートを無効にする]を選択します。
関数パラメーターのポップアップ、および一般的な構文項目の自動閉じを無効にすることはできません。
ScriptHub からスクリプトやスニペットをインポートする
スクリプトを作成するための別のオプションは、ScriptHubのコンテンツを利用することです。ScriptHub は、Diligent の社員と Diligent ユーザー コミュニティによって開発された Analytics スクリプト項目の Web ライブラリです。サブスクリプションの一部として、ScriptHub のコンテンツをダウンロードおよび使用できます。
詳細については、ScriptHub からのインポートを参照してください。
スクリプト エディター でスクリプトを作成または編集する
必要な ACLScript 構文を直接スクリプトエディターに入力するか、あるいは既存のスクリプトに対してはその他の方法のいずれかを使用することで、スクリプトを作成または編集することができます。
メモ
スクリプトを作成または編集する場合、ACLスクリプトの各コマンドは必ず別々の行に入力してください。
スクリプトの作成または編集
- スクリプト エディターでスクリプトを開くには、次の手順のいずれかを実行します。
- スクリプトを新規作成するには、[ファイル > 新規作成 > スクリプト]を選択します。
スクリプトは名前新しいスクリプトで作成されます。名前を右クリックし、[名前の変更]をクリックすると、スクリプトの名前を変更します。
メモ
スクリプトの名前は、64 文字までの英数字に制限されます。名前にはアンダースコア文字(_)を使用できますが、他の特殊文字やスペースは使用できません。名前の先頭を数字にすることはできません。
- 既存のスクリプトを開くには、ナビゲーターの[総覧]タブでそのスクリプトをダブルクリックします。
- スクリプトを新規作成するには、[ファイル > 新規作成 > スクリプト]を選択します。
- スクリプト エディターで、ACLScript 構文を追加、変更、または削除します。
ヒント
一般的な操作には以下のショートカットキーを使用できます:
- Ctrl+Z キーを押すと、1 段階以上の操作を元に戻します。
- Ctrl+Y キーを押すと、1 段階以上の操作をやり直します。
- Ctrl+S キーを押すと、開いているスクリプトも含め、Analytics プロジェクトを保存します。
- (オプション) スクリプト内の適切な場所にカーソルを置き、次のいずれかの手順を実行して、1 つまたは複数の特定の項目を挿入します:
項目 手順 プロジェクト項目名
(テーブル、スクリプト、ビュー、ワークスペース、またはインデックス)
- 挿入を右クリックして、[プロジェクト項目]をクリックします。
- [項目の種類]ドロップダウンリストから、項目の種類を選択します。
- 1 つ以上の項目名を選択し、[OK]をクリックします。
フィールド名 - スクリプト エディターのツール バーで、[フィールドの挿入
]をクリックします。 - 1 つ以上のフィールド名を選択して[OK]をクリックします。
式 - スクリプト エディターのツール バーで、[式の挿入
]をクリックします。 - 式を作成して[OK]をクリックします。
ダイアログ ボックス - スクリプト エディターのツール バーで、[ダイアログの新規作成
]をクリックします。 - カスタム ダイアログ ボックスを作成し、[閉じる]、[OK]の順にクリックします。
詳細については、カスタム ダイアログ ボックスの作成を参照してください。
日付/時刻 - 挿入 > 日付時刻 を右クリックします。
- 日付、日付時刻、または時刻を入力または選択して[OK]をクリックします。
Diligent Oneトークン 詳細については、Diligent One アクセス トークンを取得するを参照してください。
- [ファイル > プロジェクトを上書き保存]の順にクリックします。
- 確認ダイアログ ボックスで、[はい]をクリックします。
繰り返し使われる用語や構文項目を強調表示する
テーブル、フィールド、変数、キーワードの名前など、スクリプト全体で繰り返し使用される用語を強調表示できます。また、括弧、引用符などの繰り返される構文項目も強調表示できます。
特定の用語や構文項目のすべての出現箇所を強調表示する機能は、スクリプトの開発とデバッグに役立ちます。
-
用語 特定の用語の複数インスタンスを強調表示するには、スクリプト内の任意の場所でその用語の 1 つのインスタンスをダブルクリックします。
-
語句 特定の語句の複数インスタンスを強調表示するには、スクリプト内の任意の場所でその語句の 1 つのインスタンスを選択します。
メモ
強調表示する動作は、必ずしも期待どおりに機能しないこともあります。たとえば、変数名を囲んでいる百分率記号 % を選択しても、変数のその他のインスタンスが強調表示されない場合があります。スクリプト全体で一貫した強調表示を行うには、変数名をダブルクリックしてください。
対応する括弧を強調表示する
入れ子になったパラメーターを含む関数など、式内の対応する括弧を強調表示できます。複雑な式で対応する開き括弧と閉じ括弧を強調表示する機能は、コーディングの効率を高め、括弧の不一致によるバグの発生リスクを軽減します。
対応する括弧を強調表示するには、スクリプト内の 1 つの括弧の直前または直後にカーソルを置きます。開き括弧と閉じ括弧の両方が強調表示されます。対応する括弧が強調表示されない場合、いずれかの括弧が欠落していることが分かります。
ダイアログ ボックスを使用してコマンド構文を編集する
スクリプト内のコマンドを手作業で編集するのではなく、関連するダイアログ ボックスを使用して編集することができます。
メモ
この方法は、ダイアログ ボックスを持つコマンドに対してのみ使用できます。
- スクリプトで既存の ACL スクリプト コマンドを選択します。
- スクリプト エディターのツール バーで、[コマンドの編集
]をクリックします。ダイアログボックスが表示されます。
- ダイアログボックスでコマンド パラメータに必要な変更を行い、[OK]をクリックします。
スクリプト構文が更新されます。
2 つのスクリプトを横並びで開く
スクリプトエディターで 2 つのスクリプトを横並びで開くことができ、スクリプト構文を簡単に比較したり、相互にコピーしたりすることができます。
-
ナビゲーターの[総覧]タブで、横並びに開く 2 つのスクリプトを選択します。
Ctrl を押しながらクリックして隣接していない 2 つのスクリプトを選択するか、Shift を押しながらクリックして隣接しているスクリプトを選択します。
-
選択したスクリプトのいずれかを右クリックし、[並べて編集]を選択します。
2 つのスクリプトが横並びモードで表示されます。
-
いずれかのスクリプトの本文をクリックすると、スクリプト間を移動できます。
スクリプトエディターでデフォルトの背景色を使用している場合、現在アクティブなスクリプトの背景がより明るく表示されます。
-
片方または両方のスクリプトの変更を保存するには、以下のいずれかを実行します。
-
Ctrl+S を押し、表示される確認ダイアログ ボックスで[はい]をクリックします。
- Analytics ツールバーで、[開いているプロジェクトを上書き保存]
をクリックし、表示される確認ダイアログ ボックスで[はい]をクリックします。
-
-
横並びモードを終了するには、スクリプト タブの閉じるアイコン
をクリックします。2 つのスクリプトが別々のスクリプト エディター タブで表示されます。
スクリプトをテストする
スクリプトをテストするために実行またはステップ実行してみる場合は、スクリプト エディター ツールバーにある[実行]
または[ステップ]
をクリックします。
メモ
スクリプトを実行またはステップ実行している場合は、開いているすべてのスクリプトが自動的に保存されます。
コマンド ログからスクリプトを作成する
ナビゲーターの[ログ]タブにあるログ エントリを、スクリプトを新規作成するための出発点として、または既存のスクリプトに追加するためにコピーすることができます。Analytics で以前に実行された各コマンドの構文は個別のログ エントリに記録されます。
次のタイプのログ エントリを選択し、新しい、または既存のスクリプトにコピーします。
- 個別のエントリ
- テーブルに関連付けられた一連のエントリ
- セッションまたは期間に関連付けられたエントリのより大きいグループ
- ナビゲーターで[ログ]タブをクリックしてログを表示します。
- スクリプトに含めるログ エントリまたはエントリのグループを選択します。
ツリービュー内の上位レベルの項目を選択すると、サブエントリも自動的に選択されます。
- 次のうちの 1 つを行います:
新しいスクリプトを作成する - ログタブで右クリックして[選択項目の保存 > スクリプト]を選択します。
- [スクリプトを別名で保存]ダイアログ ボックスで、新しいスクリプトの名前を入力して[OK]をクリックします。
メモ
スクリプトの名前は、64 文字までの英数字に制限されます。名前にはアンダースコア文字(_)を使用できますが、他の特殊文字やスペースは使用できません。名前の先頭を数字にすることはできません。
新しいスクリプトがナビゲーターの[概要]タブに追加されます。スクリプトはアクティブな Analytics テーブルを含むフォルダー、またはテーブルが開いていない場合はルート プロジェクトに保存されます。
既存のスクリプトに構文をコピーする - [ログ]タブで右クリックして[コピー]を選択します。
- 既存のスクリプトがまだ開いていない場合は、そのスクリプトを開きます。
- スクリプト エディターで、コピーした構文を挿入する位置にカーソルを置きます。
- [貼り付け]を右クリックし、選択します。
スクリプト レコーダーを使用してスクリプトを作成する
Analytics スクリプト レコーダーでは、Analytics ユーザーインターフェイスでテーブルに対して行った操作やコマンドを記録することによって、スクリプトを作成できます。スクリプト レコーダーを使用してスクリプトを作成する利点は、使用する ACLScript コマンドに対して構文を入力することや構文の知識が必要ないという点です。
スクリプト レコーダー が記録するのはコマンドだけです。原則として、コマンド ログに表示されるコマンドはスクリプト レコーダーに記録できます。
ヒント
スクリプト レコーダーは ACLScript を学ぶための有用なツールでもあります。スクリプト レコーダー を使用して、実行した一連の分析手順をスクリプトに記録しておけば、そのスクリプトを見ることで、実行した分析を再現するために必要な一連のコマンドおよび構文を確認することができます。
- Analytics のメインメニューから、[ツール > スクリプト レコーダーをオンに設定]を選択します。
スクリプト レコーダーアイコン
がオンであることを示すため、ステータス バーにはスクリプト レコーダーアイコンが表示され、メニュー項目の左側にはチェック ボックスが表示されます。 - レコードの分析や処理を実行します。
Analyticsは処理した各コマンドを新しいスクリプトに記録します。
- データに対する解析または処理が終了したら、再度、[ツール > スクリプト レコーダーをオンに設定する]を選択してスクリプト レコーダーをオフにします。
Analyticsスクリプトを保存するよう指示されます。
- スクリプトの内容が特定しやすい名前をテキスト ボックスに入力して、[OK]をクリックします。
メモ
スクリプトの名前は、64 文字までの英数字に制限されます。名前にはアンダースコア文字(_)を使用できますが、他の特殊文字やスペースは使用できません。名前の先頭を数字にすることはできません。
構文のキャプチャを使用してスクリプトを作成する
構文のキャプチャを使用すると、Analytics メニューとダイアログボックスを使用して、Analytics スクリプト構文をスクリプトに自動的に挿入できます。
- 作業したいスクリプトを開きます。
- (オプション) 作業したいテーブルを開きます。
ヒント
テーブルを開く前に構文のキャプチャを開始すると、構文のキャプチャ中にコマンドが実際に実行されないため、[表示]タブではテーブルが物理的に開きません。ガイダンスのために開いたテーブル無しで後続のコマンドを視覚化するのは難しいかもしれません。
- スクリプト エディターのツールバーで、 [構文のキャプチャを開始する] をクリックします
。 - レコードの分析や処理を実行します。
関連する構文が自動的にスクリプトに挿入されます。コマンド自体は実行されません。
- [構文のキャプチャを終了]
をクリックして、スクリプトへのコマンド構文の挿入を停止します。
テーブル履歴からスクリプトを作成する
Analytics 出力または結果または結果テーブルに関連付けられた履歴に基づいてスクリプトを作成できます。
たとえば、Analytics プロジェクトに月次棚卸テーブルを追加し、関連する部署と項目を新しいテーブルに抽出する場合は、作成した最初の出力テーブルに関連付けられたテーブル履歴に基づいてこのプロセスをスクリプト化できます。
Analytics では、Analytics コマンドの実行結果の出力として作成されたテーブルごとに、そのテーブルの作成に使用したコマンドの記録を保持しています。これには、元の ACL テーブルと出力テーブル間に存在した中間テーブルを作成したコマンドも含まれます。後続の出力テーブルの作成を自動化するために使用できる新しいスクリプトにこのテーブル履歴をコピーできます。
-
スクリプトで自動化するプロセスの結果である出力テーブルを開きます。
-
[ツール > テーブル履歴からのスクリプト作成]を選択します。
[デフォルト_ビュー](Default_View)がアクティブな場合、新しいスクリプトを実行するときに上書きされないようにするため、Analytics ではビューの名前を変更するよう促します。
-
ビューの名前の変更を促された場合は、[名前の変更]をクリックして新しい名前を入力し、[OK]をクリックします。
-
[スクリプトを別名で保存]ダイアログ ボックスで、新しいスクリプトの名前を入力して[OK]をクリックします。
メモ
スクリプトの名前は、64 文字までの英数字に制限されます。名前にはアンダースコア文字(_)を使用できますが、他の特殊文字やスペースは使用できません。名前の先頭を数字にすることはできません。
-
(オプション) スクリプトの動作を調整する場合は、新しいスクリプトを開いて編集します。
たとえば、元のテーブルを上書きする代わりに、別の名前のテーブルに結果を出力できます。
Diligent One アクセス トークンを取得する
注意
生成されるアクセストークンは Diligent One にサインインするために使用されるアカウントと一致します。他のユーザーが使用するスクリプトを作成する場合は、そのスクリプト内に自身のアクセストークンを指定することは不適切です。
アクセストークンはアカウントパスワードと同じように保護してください。
新しいアクセストークンを作成する理由がない場合は、既存のトークンを使用してください。既存のトークンが機能しない場合は、新しいトークンを作成してください。既存のトークンを使用すると、管理する必要があるトークン数が減ります。
-
次のいずれかを実行します。
-
Analytics メインメニューで[ツール] > [Diligent One アクセス トークン]の順に選択します。
-
スクリプト エディター内を右クリックし、[挿入] > [Diligent One トークン]の順に選択します。
[API トークンを管理]ページがお使いのブラウザーで開きます。最初に Diligent One にサインインすることを求められる場合があります。
Analytics からの[API トークンを管理]ページへのアクセスが便利です。Diligent One にサインインし、Analytics を使用せずにユーザープロファイルからこのページにアクセスすることもできます。
-
-
次のいずれかを実行します。
-
既存のトークンを使用する
-
[トークン]列で、使用するトークンをクリックします。
-
Diligent One アカウントのパスワードを入力し、[確認Diligent One]をクリックします。
マスクされていないトークンが表示されます。
-
[コピー ]をクリックしてトークンをコピーします。
ヒント
トークンが含まれているこのダイアログボックスは、そのトークンを貼り付けるまで閉じないでください。
-
-
新しいトークンを作成する
-
[トークンを追加] > [Analytics]をクリックします。
-
[新しい Analytics トークン]サイド パネルで、次の情報を指定します。
フィールドまたはオプション 説明 説明 次のような有用な情報を提供する説明を入力します。
- トークンの目的
- トークンの使用場所 - 例えば、Analytics スクリプトの名前と場所、ロボットのタスクの名前と場所など。
トークンの有効期限 - 有効 指定した日数後にトークンの有効期限が切れます
- 無効 トークンの有効期限はありません
メモ
あなたの組織には、トークンを一定期間後に失効させるセキュリティポリシーがあるかもしれません。有効期限付きのトークンを作成することは良い習慣です。Diligent One では、有効期限の前に自動でメール通知が送られます。
有効期限が切れるまでの日数 トークンの有効期限が切れるまでの日数を指定します (1~365)。 パスワード Diligent One アカウントのパスワードを入力します。 -
[トークンを生成]をクリックします。
-
[コピー ]をクリックしてトークンをコピーします。
ヒント
トークンが含まれているこのサイド パネルは、トークンを貼り付けるまで閉じないでください。
-
-
-
使用しているパスワード定義方法に応じて次のいずれかを実行します。
-
PASSWORDアナリティクスタグACLロボットのタスクデザイナーで、コピーしたトークンをパスワーACL robotドパラメーターフィールドに貼り付けます。
-
PASSWORD コマンドAnalytics で、コピーしたトークンを、スクリプト実行中に表示されるパスワードの確認に貼り付けます。
-
SET PASSWORD コマンドAnalytics で、スクリプトの SET PASSWORD コマンド構文内の適切な位置にコピーしたトークンを貼り付けます。
-
-
Launchpad で、トークンが含まれているダイアログボックスまたはサイド パネルを閉じます。
新しいトークンを作成した場合は、部分的にマスクされたバージョンのトークンが、トークンのリストに追加されます。
詳細については、Diligent One アクセス トークンの作成と管理を参照してください。