アナリティクス ヘッダーおよびアナリティクス タグ

アナリティクス ヘッダーは、Analytics スクリプトの最初にコメント ブロックで囲まれた一連のタグです。 アナリティクス タブは、アナリティクス スクリプトの実行またはスケジュール前にユーザーが入力する入力パラメーターと出力パラメーターを指定します。

アナリティクス ヘッダーは、ロボット、AX Server 、または分析アプリ ウィンドウで実行するすべてのアナリティクス スクリプトで必要です。

アナリティクス ヘッダーの追加または変更

アナリティクス ヘッダーを追加または変更する最も簡単な方法は、アナリティクス ヘッダー デザイナーを使用することです。 デザイナーに備わる自動エラー チェックおよび埋め込まれているガイダンスを使用することで、作成するヘッダーが有効であり、かつ正確に動作するようにできます。 詳細については、アナリティクス ヘッダーを使った作業を参照してください。

また、アナリティクス ヘッダーを作成する別の方法として、必要な ANALYTIC タグを手動で入力するという方法もあります。 あるいは、手動入力とデザイナーを組み合わせて使用することもできます。

基本的なアナリティクス ヘッダーの要件

アナリティクス ヘッダーは、スクリプトの先頭行から始まるコメント ブロック内に定義する必要があります。 次を除き、タグは任意の順序でアナリティクス ヘッダーに配置できます。

  • ANALYTIC タグは先頭に配置する必要がある
  • FIELD タグは関連付けられた TABLE タグの直後に配置する必要がある

例

このアナリティクス ヘッダーは、スクリプトで使用するテーブルおよびフィールドと開始日パラメーターを特定します。

COMMENT 
//ANALYTIC Identify missing checks    
  このアナリティクス スクリプトは見つからないチェック番号を特定します。 
//TABLE v_table_payments 支払いテーブル  
  支払いを一覧表示していて小切手番号列が含まれるテーブルを選択します。 
//FIELD v_check_num CN Check Number 
  小切手番号が含まれているフィールドを選択します 
//PARAM v_start_date D OPTIONAL 開始日（任意） 
  分析の開始日を入力
END

タグ形式

ヘッダーの各タグは次の形式を使用します。

//タグ名 属性
  任意の説明テキスト

// タグ インジケーターは、スクリプト行でスペース以外の最初の文字でなければなりません。 タグ名は、タグ インジケーターの直後に、間にスペースも文字も入れずに続ける必要があります。

任意の説明テキストは、タグより後の次の行に入力する必要があります。 説明を複数行で指定することはできますが、行を飛ばすことはできません。 説明テキストをクライアント アプリケーションで表示する場合には、改行は保持されません。

タグ表記

コンポーネント 表記
タグ名

タグ名は大文字と小文字が区別されません。

Analytics の コマンド名と関数名とは異なり、タグ名は省略できません。
タグ属性 タグの属性を指定するときには、スペースを含め、任意で引用符で値を囲むことができます。
タグ説明 説明は省略可能です。 説明を指定する場合には複数行を指定できますが、クライアント アプリケーションでは改行が保持されません。

Analytics でのテスト入力値の指定

特殊割り当て演算子 := を使用し、定義が必要なアナリティクス タグのテスト値を指定できます。

  • FILE
  • TABLE
  • FIELD
  • PARAM

次の構文を使用して、Analytics でのアナリティクス スクリプトの実行とテストを行います。

//TABLE v_AnalysisTable "分類するテーブル" := "Trans_May"

Analytics でスクリプトを実行するときには、パラメーターは割り当てで指定された値を取得します。 アナリティクス スクリプトがクライアント アプリケーションで実行されるときには、テスト値が無視され、ユーザー定義入力パラメーターが使用されます。

割り当て演算子とその前のタグ構文の間にはスペースを残す必要があります。 割り当て値は、Analytics 全体で必要なデータ型に適切な修飾子を使用する必要があります。 詳細については、データ型を参照してください。

使用可能なアナリティクス タグの完全な一覧

タグ 説明
ANALYTIC

ACL スクリプトをロボット、AX Server または分析アプリ ウィンドウで実行可能なアナリティクス スクリプトとして指定します。
入力タグ
FILE

ロボットまたは AX Server で実行するアナリティクス スクリプトで使用する入力を提供する、Excel ファイルや区切り文字付きファイルなどの、Analytics ファイル以外のファイルを指定します。

  • ロボットのファイルはアナリティクス スクリプトと同じロボットの［入力/出力］タタブにある必要があります
  • このファイルは、アナリティクス スクリプトが配置される AX Server 内フォルダーの関連ファイル サブフォルダーにある必要があります。
TABLE

ユーザーがアナリティクス スクリプトの入力として選択する Analytics テーブルを定義します。

TABLE タグの後には、順次行に入力されたゼロ個以上の FIELD タグを続けることができます。
FIELD

ユーザーがアナリティクス スクリプトの入力として選択するフィールドを定義します。

このフィールドは、先行する TABLE タグで定義したテーブルに含まれます。 最初の FIELD タグは、TABLE タグの直後に続ける必要があります。その後続けて、追加の FIELD タグを連続した行に入力できます。
PARAM

アナリティクス スクリプトのための入力パラメーターを作成し、その入力値の要件を定義します。

入力パラメーターは、ユーザーがアナリティクス スクリプトを実行またはスケジュールする際に使用する実際の値を指定できるようにするプレースホルダーです。
PASSWORD

アナリティクス スクリプトのパスワード入力パラメーターを作成します。 パラメーターは、ACLScript コマンドで後から使用するための暗号化されたパスワードの格納場所を提供します。

ユーザーは、アナリティクス スクリプトをスケジュールまたは開始するときに、必要なパスワード値を指定するように要求されます。これにより、アナリティクス スクリプトを実行するときにユーザーの介入が不要になります。
出力タグ
DATA

アナリティクス スクリプトによって出力された Analytics テーブルを、デプロイメント環境のデータサブフォルダー（記憶位置）にコピーすることを指定します。

通常は、後続のアナリティクス スクリプトの入力テーブルとして利用できるよう、Analytics テーブルを格納します。
RESULT

エンド ユーザーからクライアント アプリケーションでアクセスできるようにするアナリティクス スクリプトの出力結果を指定します。

出力結果は、存在していても、自動的に利用可能にはなりません。
PUBLISH

アナリティクス スクリプトが処理を完了したときに、どの Analytics テーブルを AX Exception に公開するかを定義するメタデータを含んでいるファイルを指定します。