関数

ACLScript 関数は、範囲が狭い Analytics のカスタマイズされたルーチンです。特定のタスクまたは演算を実行し、値を返します。

たとえば、ALLTRIM( ) 関数はすべての先頭または末尾のスペースをフィールドのテキスト値から削除します。

関数のリスト

Analytics で使用可能な関数を網羅したリストを以下にアルファベット順またはカテゴリ別に整理して示します。

関数ドキュメントで使用される規則といくつかの一般的使用例の詳細も示されます。

アルファベット順の関数

関数 説明

ABS( )

数式の絶対値を返します。数の絶対値は符号のない数です。

AGE( )

指定した日付と指定した締切日の間の経過日数(年齢)、現在のオペレーティング システム日付、または任意の 2 つの日付間の経過日数を返します。

ALLTRIM( )

入力文字列から先頭と末尾のスペースを除去した文字列を返します。

ASCII( )

指定された文字の ASCII コードを返します。

AT( )

文字値における部分文字列の特定の出現の開始位置を示す数値を返します。

BETWEEN( )

指定された値が範囲内にあるかどうかを示す論理値を返します。

BINTOSTR( )

ZONED または EBCDIC 文字データから変換された Unicode 文字データを返します。"Binary to String" の省略形です。

BIT( )

現在のレコードにおける指定されたバイト位置のバイナリ表記を 8 文字の文字列として返します。

BLANKS( )

指定された数の空白スペースを含んでいる文字列を返します。

BYTE( )

現在のレコード内で指定されたバイト位置に格納されている文字を返します。

CDOW( )

指定された日付または日付時刻の曜日を返します。"Character Day of Week" の省略形です。

CHR( )

指定された ASCII コードに対応する文字を返します。

CLEAN( )

文字列内で、最初の無効な文字とそれ以降のすべての文字を空白に置き換えます。

CMOY( )

指定された日付または日付時刻の月の名前を返します。"Character Month of Year" の省略形です。

COS( )

ラジアン単位で表された角度のコサインを、小数点以下 15 桁の精度で返します。

CTOD( )

文字または数値の日付値を日付に変換します。また、文字または数値の日付時刻値から日付を抽出し、それを日付として返すこともできます。"Character to Date" の省略形です。

CTODT( )

文字または数値の日付時刻値を日付時刻に変換します。"Character to Datetime" の省略形です。

CTOT( )

文字または数値の時刻値を時刻に変換します。また、文字または数値の日付時刻値から時刻を抽出し、それを時刻として返すこともできます。"Character to Time" の省略形です。

CUMIPMT( )

期間の範囲中に貸付金に対して支払う累積利息を返します。

CUMPRINC( )

期間の範囲中に貸付金に対して支払う累積元金を返します。

DATE( )

指定された日付または日付時刻から日付を抽出し、それを文字データとして返します。また、現在のオペレーティング システム日付を返すこともできます。

DATETIME( )

日付時刻を文字列に変換します。また、現在のオペレーティング システムの日付時刻を返すこともできます。

DAY( )

指定された日付または日付時刻から日にちを抽出し、それを数値(1 ~ 31)として返します。

DBYTE( )

レコード内の指定されたバイト位置にある Unicode 文字を返します。

DEC( )

指定された小数点以下の桁数で値または数式の結果を返します。

DHEX( )

Unicode 文字列を 16 進数の文字列に変換します。

DICECOEFFICIENT( )

2 つの指定された文字列のダイス係数を返します。これは、2 つの文字列間の類似度を測定したものです。

DIGIT( )

指定された位置にある Packed データ型のバイトから、上位または下位の数字を返します。

DOW( )

指定された日付または日付時刻の曜日を表す数値(1 ~ 7)を返します。"Day of Week" の省略形です。

DTOU( )

Analytics 日付値を指定された言語およびロケール書式の Unicode 文字列に変換します。"Date to Unicode" の省略形です。

EBCDIC( )

EBCDIC 文字エンコードに変換された文字列を返します。

EFFECTIVE( )

貸付金に適用される実効年利率を返します。

EOMONTH( )

指定された日付から起算して、指定された月数だけ前または後の月の末日の日付を返します。

EXCLUDE( )

指定した文字を除外する文字列を返します。

EXP( )

数式の指数値(底 10)を指定された小数点以下の桁数で返します。

FILESIZE( )

指定されたファイルのサイズをバイト数で返します。ファイルが存在しない場合は -1 を返します。

FIND( )

指定された文字列が、特定のフィールド中またはレコード全体のどこかに存在するかどうか示す論理値を返します。

FINDMULTI( )

指定された 1 つまたは複数の文字列が、特定のフィールド中、またはレコード全体のどこかに存在するかどうか示す論理値を返します。

FREQUENCY( )

連続する先頭の正の数値桁について、ベンフォードの法則で期待される頻度を小数点以下 8 桁で返します。

FTYPE( )

フィールドまたは変数のデータ カテゴリや、Analytics プロジェクト項目の種類を識別する文字を返します。

FVANNUITY( )

一定の利率を使って計算した一連の預金額の将来価値を返します。将来価値は、毎月の預金額と複利利息の合計です。

FVLUMPSUM( )

一定の利率を使って計算した現在の総額の将来価値を返します。

FVSCHEDULE( )

一連の利率を使って計算した現在の総額の将来価値を返します。

GETOPTIONS( )

指定された Analytics オプションの現在の設定([オプション]ダイアログ ボックスの設定)を返します。

GOMONTH( )

指定された日付から、指定された月数前または月数後の日付を返します。

HASH( )

入力値に基づいてソルト付き暗号化ハッシュ値を返します。

HEX( )

ASCII 文字列を 16 進数の文字列に変換します。

HOUR( )

指定された時刻または日付時刻から時間を抽出し、それを 24 時間制の数値として返します。

HTOU( )

16 進数の文字列を Unicode 文字列に変換します。"Hexadecimal to Unicode" の省略形です。

INCLUDE( )

指定した文字のみを含む文字列を返します。

INSERT( )

元の文字列の指定のバイト位置に、指定した文字列が挿入された内容が返されます。

INT( )

数式またはフィールド値の整数値を返します。

IPMT( )

単一の期間で貸付金に対して支払われた利息を返します。

ISBLANK( )

入力値が空白かどうか示す論理値を返します。

ISDEFINED( )

指定されたフィールドが定義されている場合は T(true)、そうでない場合は F(false)を返します。

ISFUZZYDUP( )

文字列が、比較文字列のあいまい重複であるかどうかを示す論理値を返します。

LAST( )

文字列の末尾から指定された数の文字を返します。

LEADING( )

指定された数の先頭桁を含んでいる文字列を返します。

LEADINGZEROS( )

文字列または数値の先頭にゼロを追加します。

LENGTH( )

文字列に含まれている文字数を返します。

LEVDIST( )

指定された 2 つの文字列間のレーベンシュタイン距離を返します。これは、2 つの文字列がどの程度異なっているかを測る数値です。

LOG( )

数式またはフィールド値の対数(底 10)を、指定された小数点以下の桁数で返します。

LOWER( )

アルファベット文字を小文字に変換した文字列を返します。

LTRIM( )

入力文字列から先頭のスペースを除去した文字列を返します。

MAP( )

文字列が、ワイルドカード文字やリテラル文字を含んでいる指定された書式文字列と一致するかどうかを示す論理値を返します。

MASK( )

2 つの文字列の最初の各バイトに対してビットごとの AND 演算を実行します。

MATCH( )

指定された値が比較対象の値のうちのどれかと一致するかどうかを示す論理値を返します。

MAXIMUM( )

一連の数値中の最大値、または一連の日付時刻値中の最も新しい値を返します。

MINIMUM( )

一連の数値中の最小値、または一連の日付時刻値中の最も古い値を返します。

MINUTE( )

指定された時刻または日付時刻から分数を抽出し、それを数値として返します。

MOD( )

2 つの数値を除算して余りを返します。

MONTH( )

指定された日付または日付時刻から月を抽出し、それを数値(1 ~ 12)として返します。

NOMINAL( )

貸付金の名目年利率を返します。

NORMDIST( )

正規分布データ セットのランダム変数が指定した値以下になるか、指定した値とまったく同じになる確率を返します。

NORMSINV( )

標準正規分布で指定された確率に関連付けられた z スコアを返します。z スコアは、標準正規分布の平均を基準にした、値の標準偏差数です。

NOW( )

現在のオペレーティング システム時刻を日付時刻データ型で返します。

NPER( )

貸付金を完済するのに必要な期間の数値を返します。

OCCURS( )

部分文字列が指定された文字値内に現れる回数を数えて返します。

OFFSET( )

指定されたバイト数によって補正された開始位置からフィールドの値を返します。

OMIT( )

指定した 1 つ以上の部分文字列が削除された文字列を返します。

PACKED( )

パック データ型に変換された数値データを返します。

PI( )

円周率 π の値を、小数点以下 15 桁で返します。

PMT( )

貸付金を完済するのに必要な定期払込金額(元金 + 利息)を返します。

PPMT( )

単一の期間で貸付金に対して支払われた元金を返します。

PROPER( )

各単語の最初の文字を大文字に、残りの文字を小文字に設定した文字列を返します。

PROPERTIES( )

指定された Analytics プロジェクト項目のプロパティ情報を返します。

PVANNUITY( )

一定の利率を使って計算した一連の将来価値の現在価値を返します。現在価値は現在の総額です。

PVLUMPSUM( )

一定の利率を使って計算する特定の将来総額を生成するのに必要な現在価値を返します。現在価値は現在の総額です。

PYDATE( )

外部の Python スクリプトの関数によって計算された日付値を返します。Python によるデータ処理は Analytics の外部で行われます。

PYDATETIME( )

外部の Python スクリプトの関数によって計算された日付時刻値を返します。Python によるデータ処理は Analytics の外部で行われます。

PYLOGICAL( )

外部の Python スクリプトの関数によって計算された論理値を返します。Python によるデータ処理は Analytics の外部で行われます。

PYNUMERIC( )

外部の Python スクリプトの関数によって計算された数値を返します。Python によるデータ処理は Analytics の外部で行われます。

PYSTRING( )

外部の Python スクリプトの関数によって計算された文字値を返します。Python によるデータ処理は Analytics の外部で行われます。

PYTIME( )

外部の Python スクリプトの関数によって計算された時刻値を返します。Python によるデータ処理は Analytics の外部で行われます。

RAND( )

指定した境界内にあるランダム数を返します。

RATE( )

期間ごとの利率を返します。

RDATE( )

R の関数またはスクリプトによって計算された日付値を返します。R によるデータ処理は Analytics の外部で行われます。

RDATETIME( )

R の関数またはスクリプトによって計算された日付時刻値を返します。R によるデータ処理は Analytics の外部で行われます。

RECLEN( )

現在のレコードの長さを返します。

RECNO( )

現在のレコード番号を返します。

RECOFFSET( )

現在のレコードを基準にして、指定された n 番目にあるレコードのフィールド値を返します。

REGEXFIND( )

正規表現で指定されたパターンが文字列内に現れるかどうかを示す論理値を返します。

REGEXREPLACE( )

正規表現と一致する文字列のすべてのインスタンスを新しい文字列で置き換えます。

REMOVE( )

指定した文字のみを含む文字列を返します。

REPEAT( )

指定された回数だけ部分文字列を繰り返す文字列を返します。

REPLACE( )

指定された文字列のすべてのインスタンスを新しい文字列で置き換えます。

REVERSE( )

文字の順番を逆にした文字列を返します。

RJUSTIFY( )

文字列の末尾の空白をすべて先頭に移動させ、指定された文字列と同じ長さの右寄せした文字列を返します。

RLOGICAL( )

R の関数またはスクリプトによって計算された論理値を返します。R によるデータ処理は Analytics の外部で行われます。

RNUMERIC( )

R の関数またはスクリプトによって計算された数値を返します。R によるデータ処理は Analytics の外部で行われます。

ROOT( )

数式の平方根を返します。

ROUND( )

数値を丸めた整数を返します。

RSTRING( )

R の関数またはスクリプトによって計算された文字列の値を返します。R によるデータ処理は Analytics の外部で行われます。

RTIME( )

R の関数またはスクリプトによって計算された時刻値を返します。R によるデータ処理は Analytics の外部で行われます。

SECOND( )

指定された時刻または日付時刻から秒数を抽出し、それを数値として返します。

SHIFT( )

入力値の最初の文字のビットを左または右に移動させた 1 文字の文字列を返します。

SIN( )

ラジアン単位で表された角度のサインを、小数点以下 15 桁の精度で返します。

SORTWORDS( )

連続する順序で並べ替えられた個別の単語を含む文字列を返します。

SOUNDEX( )

ほかの文字列との発音の比較に使用できる、指定された文字列の soundex コードを返します。

SOUNDSLIKE( )

文字列が比較文字列と発音学的に一致しているかどうかを示す論理値を返します。

SPLIT( )

文字列のうちの指定された部分を返します。

STOD( )

シリアル日付、つまり、整数で表される日付を日付値に変換します。"Serial to Date" の省略形です。

STODT( )

シリアル日付時刻、つまり、整数部分と 24 時間の小数部分で表される日付時刻を日付時刻値に変換します。"Serial to Datetime" の省略形です。

STOT( )

シリアル時刻、つまり、24 時間を 1 として、24 時間が小数部分で表される時刻を時刻値に変換します。"Serial to Time" の省略形です。

STRING( )

数値を文字列に変換します。

SUBSTR( )

文字列のうちの指定された部分文字列を返します。

TAN( )

ラジアン単位で表された角度のタンジェントを、小数点以下 15 桁の精度で返します。

TEST( )

指定された文字列がレコード内の特定のバイト位置に現れるかどうか示す論理値を返します。

TIME( )

指定された時刻または日付時刻から時刻を抽出し、それを文字データとして返します。また、現在のオペレーティング システムの時刻を返すこともできます。

TODAY( )

現在のオペレーティング システム日付を日付時刻データ型で返します。

TRANSFORM( )

指定された文字列内の双方向テキストの表示方向を逆にします。

TRIM( )

入力文字列から末尾のスペースを除去した文字列を返します。

UNSIGNED( )

符号なしデータ型に変換された数値データを返します。

UPPER( )

アルファベット文字を大文字に変換した文字列を返します。

UTOD( )

書式設定された日付が含まれる Unicode 文字列を Analytics 日付値に変換します。"Unicode to Date" の省略形です。

VALUE( )

文字列を数値に変換します。

VERIFY( )

物理データ フィールドのデータが有効かどうか示す論理値を返します。

WORKDAY( )

2 つの日付の間の就業(稼働)日数を返します。

YEAR( )

指定された日付または日付時刻から年を抽出し、それを YYYY 書式の数値として返します。

ZONED( )

数値データを文字データに変換し、出力の先頭にゼロを追加します。

ZSTAT( )

標準 Z 統計量を返します。

検索、置換

関数 説明

AT( )

文字値における部分文字列の特定の出現の開始位置を示す数値を返します。

BETWEEN( )

指定された値が範囲内にあるかどうかを示す論理値を返します。

CLEAN( )

文字列内で、最初の無効な文字とそれ以降のすべての文字を空白に置き換えます。

FIND( )

指定された文字列が、特定のフィールド中またはレコード全体のどこかに存在するかどうか示す論理値を返します。

FINDMULTI( )

指定された 1 つまたは複数の文字列が、特定のフィールド中、またはレコード全体のどこかに存在するかどうか示す論理値を返します。

ISBLANK( )

入力値が空白かどうか示す論理値を返します。

MAP( )

文字列が、ワイルドカード文字やリテラル文字を含んでいる指定された書式文字列と一致するかどうかを示す論理値を返します。

MATCH( )

指定された値が比較対象の値のうちのどれかと一致するかどうかを示す論理値を返します。

OCCURS( )

部分文字列が指定された文字値内に現れる回数を数えて返します。

REGEXFIND( )

正規表現で指定されたパターンが文字列内に現れるかどうかを示す論理値を返します。

REGEXREPLACE( )

正規表現と一致する文字列のすべてのインスタンスを新しい文字列で置き換えます。

REPLACE( )

指定された文字列のすべてのインスタンスを新しい文字列で置き換えます。

TEST( )

指定された文字列がレコード内の特定のバイト位置に現れるかどうか示す論理値を返します。

比較

関数 説明

DICECOEFFICIENT( )

2 つの指定された文字列のダイス係数を返します。これは、2 つの文字列間の類似度を測定したものです。

ISFUZZYDUP( )

文字列が、比較文字列のあいまい重複であるかどうかを示す論理値を返します。

LEVDIST( )

指定された 2 つの文字列間のレーベンシュタイン距離を返します。これは、2 つの文字列がどの程度異なっているかを測る数値です。

SOUNDEX( )

ほかの文字列との発音の比較に使用できる、指定された文字列の soundex コードを返します。

SOUNDSLIKE( )

文字列が比較文字列と発音学的に一致しているかどうかを示す論理値を返します。

変換

関数 説明

BINTOSTR( )

ZONED または EBCDIC 文字データから変換された Unicode 文字データを返します。"Binary to String" の省略形です。

CTOD( )

文字または数値の日付値を日付に変換します。また、文字または数値の日付時刻値から日付を抽出し、それを日付として返すこともできます。"Character to Date" の省略形です。

CTODT( )

文字または数値の日付時刻値を日付時刻に変換します。"Character to Datetime" の省略形です。

CTOT( )

文字または数値の時刻値を時刻に変換します。また、文字または数値の日付時刻値から時刻を抽出し、それを時刻として返すこともできます。"Character to Time" の省略形です。

DATE( )

指定された日付または日付時刻から日付を抽出し、それを文字データとして返します。また、現在のオペレーティング システム日付を返すこともできます。

DATETIME( )

日付時刻を文字列に変換します。また、現在のオペレーティング システムの日付時刻を返すこともできます。

DTOU( )

Analytics 日付値を指定された言語およびロケール書式の Unicode 文字列に変換します。"Date to Unicode" の省略形です。

EBCDIC( )

EBCDIC 文字エンコードに変換された文字列を返します。

HASH( )

入力値に基づいてソルト付き暗号化ハッシュ値を返します。

LEADINGZEROS( )

文字列または数値の先頭にゼロを追加します。

PACKED( )

パック データ型に変換された数値データを返します。

STOD( )

シリアル日付、つまり、整数で表される日付を日付値に変換します。"Serial to Date" の省略形です。

STODT( )

シリアル日付時刻、つまり、整数部分と 24 時間の小数部分で表される日付時刻を日付時刻値に変換します。"Serial to Datetime" の省略形です。

STOT( )

シリアル時刻、つまり、24 時間を 1 として、24 時間が小数部分で表される時刻を時刻値に変換します。"Serial to Time" の省略形です。

STRING( )

数値を文字列に変換します。

TIME( )

指定された時刻または日付時刻から時刻を抽出し、それを文字データとして返します。また、現在のオペレーティング システムの時刻を返すこともできます。

UNSIGNED( )

符号なしデータ型に変換された数値データを返します。

UTOD( )

書式設定された日付が含まれる Unicode 文字列を Analytics 日付値に変換します。"Unicode to Date" の省略形です。

VALUE( )

文字列を数値に変換します。

ZONED( )

数値データを文字データに変換し、出力の先頭にゼロを追加します。

テキスト

関数 説明

ALLTRIM( )

入力文字列から先頭と末尾のスペースを除去した文字列を返します。

BINTOSTR( )

ZONED または EBCDIC 文字データから変換された Unicode 文字データを返します。"Binary to String" の省略形です。

BLANKS( )

指定された数の空白スペースを含んでいる文字列を返します。

DATETIME( )

日付時刻を文字列に変換します。また、現在のオペレーティング システムの日付時刻を返すこともできます。

DTOU( )

Analytics 日付値を指定された言語およびロケール書式の Unicode 文字列に変換します。"Date to Unicode" の省略形です。

EBCDIC( )

EBCDIC 文字エンコードに変換された文字列を返します。

EXCLUDE( )

指定した文字を除外する文字列を返します。

INCLUDE( )

指定した文字のみを含む文字列を返します。

INSERT( )

元の文字列の指定のバイト位置に、指定した文字列が挿入された内容が返されます。

LAST( )

文字列の末尾から指定された数の文字を返します。

LEADINGZEROS( )

文字列または数値の先頭にゼロを追加します。

LENGTH( )

文字列に含まれている文字数を返します。

LOWER( )

アルファベット文字を小文字に変換した文字列を返します。

LTRIM( )

入力文字列から先頭のスペースを除去した文字列を返します。

OMIT( )

指定した 1 つ以上の部分文字列が削除された文字列を返します。

PROPER( )

各単語の最初の文字を大文字に、残りの文字を小文字に設定した文字列を返します。

REMOVE( )

指定した文字のみを含む文字列を返します。

REPEAT( )

指定された回数だけ部分文字列を繰り返す文字列を返します。

REVERSE( )

文字の順番を逆にした文字列を返します。

RJUSTIFY( )

文字列の末尾の空白をすべて先頭に移動させ、指定された文字列と同じ長さの右寄せした文字列を返します。

SORTWORDS( )

連続する順序で並べ替えられた個別の単語を含む文字列を返します。

SPLIT( )

文字列のうちの指定された部分を返します。

STRING( )

数値を文字列に変換します。

SUBSTR( )

文字列のうちの指定された部分文字列を返します。

TRANSFORM( )

指定された文字列内の双方向テキストの表示方向を逆にします。

TRIM( )

入力文字列から末尾のスペースを除去した文字列を返します。

UPPER( )

アルファベット文字を大文字に変換した文字列を返します。

ZONED( )

数値データを文字データに変換し、出力の先頭にゼロを追加します。

数学

関数 説明

ABS( )

数式の絶対値を返します。数の絶対値は符号のない数です。

COS( )

ラジアン単位で表された角度のコサインを、小数点以下 15 桁の精度で返します。

DEC( )

指定された小数点以下の桁数で値または数式の結果を返します。

EXP( )

数式の指数値(底 10)を指定された小数点以下の桁数で返します。

FREQUENCY( )

連続する先頭の正の数値桁について、ベンフォードの法則で期待される頻度を小数点以下 8 桁で返します。

INT( )

数式またはフィールド値の整数値を返します。

LEADING( )

指定された数の先頭桁を含んでいる文字列を返します。

LOG( )

数式またはフィールド値の対数(底 10)を、指定された小数点以下の桁数で返します。

MAXIMUM( )

一連の数値中の最大値、または一連の日付時刻値中の最も新しい値を返します。

MINIMUM( )

一連の数値中の最小値、または一連の日付時刻値中の最も古い値を返します。

MOD( )

2 つの数値を除算して余りを返します。

NORMDIST( )

正規分布データ セットのランダム変数が指定した値以下になるか、指定した値とまったく同じになる確率を返します。

NORMSINV( )

標準正規分布で指定された確率に関連付けられた z スコアを返します。z スコアは、標準正規分布の平均を基準にした、値の標準偏差数です。

PI( )

円周率 π の値を、小数点以下 15 桁で返します。

RAND( )

指定した境界内にあるランダム数を返します。

ROOT( )

数式の平方根を返します。

ROUND( )

数値を丸めた整数を返します。

SIN( )

ラジアン単位で表された角度のサインを、小数点以下 15 桁の精度で返します。

TAN( )

ラジアン単位で表された角度のタンジェントを、小数点以下 15 桁の精度で返します。

VALUE( )

文字列を数値に変換します。

ZONED( )

数値データを文字データに変換し、出力の先頭にゼロを追加します。

ZSTAT( )

標準 Z 統計量を返します。

日付/時刻

関数 説明

AGE( )

指定した日付と指定した締切日の間の経過日数(年齢)、現在のオペレーティング システム日付、または任意の 2 つの日付間の経過日数を返します。

CDOW( )

指定された日付または日付時刻の曜日を返します。"Character Day of Week" の省略形です。

CMOY( )

指定された日付または日付時刻の月の名前を返します。"Character Month of Year" の省略形です。

CTOD( )

文字または数値の日付値を日付に変換します。また、文字または数値の日付時刻値から日付を抽出し、それを日付として返すこともできます。"Character to Date" の省略形です。

CTODT( )

文字または数値の日付時刻値を日付時刻に変換します。"Character to Datetime" の省略形です。

CTOT( )

文字または数値の時刻値を時刻に変換します。また、文字または数値の日付時刻値から時刻を抽出し、それを時刻として返すこともできます。"Character to Time" の省略形です。

DATE( )

指定された日付または日付時刻から日付を抽出し、それを文字データとして返します。また、現在のオペレーティング システム日付を返すこともできます。

DATETIME( )

日付時刻を文字列に変換します。また、現在のオペレーティング システムの日付時刻を返すこともできます。

DAY( )

指定された日付または日付時刻から日にちを抽出し、それを数値(1 ~ 31)として返します。

DOW( )

指定された日付または日付時刻の曜日を表す数値(1 ~ 7)を返します。"Day of Week" の省略形です。

EOMONTH( )

指定された日付から起算して、指定された月数だけ前または後の月の末日の日付を返します。

GOMONTH( )

指定された日付から、指定された月数前または月数後の日付を返します。

HOUR( )

指定された時刻または日付時刻から時間を抽出し、それを 24 時間制の数値として返します。

MAXIMUM( )

一連の数値中の最大値、または一連の日付時刻値中の最も新しい値を返します。

MINIMUM( )

一連の数値中の最小値、または一連の日付時刻値中の最も古い値を返します。

MINUTE( )

指定された時刻または日付時刻から分数を抽出し、それを数値として返します。

MONTH( )

指定された日付または日付時刻から月を抽出し、それを数値(1 ~ 12)として返します。

NOW( )

現在のオペレーティング システム時刻を日付時刻データ型で返します。

SECOND( )

指定された時刻または日付時刻から秒数を抽出し、それを数値として返します。

STOD( )

シリアル日付、つまり、整数で表される日付を日付値に変換します。"Serial to Date" の省略形です。

STODT( )

シリアル日付時刻、つまり、整数部分と 24 時間の小数部分で表される日付時刻を日付時刻値に変換します。"Serial to Datetime" の省略形です。

STOT( )

シリアル時刻、つまり、24 時間を 1 として、24 時間が小数部分で表される時刻を時刻値に変換します。"Serial to Time" の省略形です。

TIME( )

指定された時刻または日付時刻から時刻を抽出し、それを文字データとして返します。また、現在のオペレーティング システムの時刻を返すこともできます。

TODAY( )

現在のオペレーティング システム日付を日付時刻データ型で返します。

UTOD( )

書式設定された日付が含まれる Unicode 文字列を Analytics 日付値に変換します。"Unicode to Date" の省略形です。

WORKDAY( )

2 つの日付の間の就業(稼働)日数を返します。

YEAR( )

指定された日付または日付時刻から年を抽出し、それを YYYY 書式の数値として返します。

財務

関数 説明

CUMIPMT( )

期間の範囲中に貸付金に対して支払う累積利息を返します。

CUMPRINC( )

期間の範囲中に貸付金に対して支払う累積元金を返します。

EFFECTIVE( )

貸付金に適用される実効年利率を返します。

FVANNUITY( )

一定の利率を使って計算した一連の預金額の将来価値を返します。将来価値は、毎月の預金額と複利利息の合計です。

FVLUMPSUM( )

一定の利率を使って計算した現在の総額の将来価値を返します。

FVSCHEDULE( )

一連の利率を使って計算した現在の総額の将来価値を返します。

IPMT( )

単一の期間で貸付金に対して支払われた利息を返します。

NOMINAL( )

貸付金の名目年利率を返します。

NPER( )

貸付金を完済するのに必要な期間の数値を返します。

PMT( )

貸付金を完済するのに必要な定期払込金額(元金 + 利息)を返します。

PPMT( )

単一の期間で貸付金に対して支払われた元金を返します。

PVANNUITY( )

一定の利率を使って計算した一連の将来価値の現在価値を返します。現在価値は現在の総額です。

PVLUMPSUM( )

一定の利率を使って計算する特定の将来総額を生成するのに必要な現在価値を返します。現在価値は現在の総額です。

RATE( )

期間ごとの利率を返します。

フィールドとレコード

関数 説明

FTYPE( )

フィールドまたは変数のデータ カテゴリや、Analytics プロジェクト項目の種類を識別する文字を返します。

HASH( )

入力値に基づいてソルト付き暗号化ハッシュ値を返します。

ISDEFINED( )

指定されたフィールドが定義されている場合は T(true)、そうでない場合は F(false)を返します。

OFFSET( )

指定されたバイト数によって補正された開始位置からフィールドの値を返します。

RECLEN( )

現在のレコードの長さを返します。

RECNO( )

現在のレコード番号を返します。

RECOFFSET( )

現在のレコードを基準にして、指定された n 番目にあるレコードのフィールド値を返します。

VERIFY( )

物理データ フィールドのデータが有効かどうか示す論理値を返します。

テーブル、ファイル、およびプロジェクト

関数 説明

FILESIZE( )

指定されたファイルのサイズをバイト数で返します。ファイルが存在しない場合は -1 を返します。

FTYPE( )

フィールドまたは変数のデータ カテゴリや、Analytics プロジェクト項目の種類を識別する文字を返します。

GETOPTIONS( )

指定された Analytics オプションの現在の設定([オプション]ダイアログ ボックスの設定)を返します。

PROPERTIES( )

指定された Analytics プロジェクト項目のプロパティ情報を返します。

変数テスト

関数 説明

FTYPE( )

フィールドまたは変数のデータ カテゴリや、Analytics プロジェクト項目の種類を識別する文字を返します。

ISDEFINED( )

指定されたフィールドが定義されている場合は T(true)、そうでない場合は F(false)を返します。

Python

関数 説明
PYDATE( )

外部の Python スクリプトの関数によって計算された日付値を返します。Python によるデータ処理は Analytics の外部で行われます。

PYDATETIME( )

外部の Python スクリプトの関数によって計算された日付時刻値を返します。Python によるデータ処理は Analytics の外部で行われます。

PYLOGICAL( )

外部の Python スクリプトの関数によって計算された論理値を返します。Python によるデータ処理は Analytics の外部で行われます。

PYNUMERIC( )

外部の Python スクリプトの関数によって計算された数値を返します。Python によるデータ処理は Analytics の外部で行われます。

PYSTRING( )

外部の Python スクリプトの関数によって計算された文字値を返します。Python によるデータ処理は Analytics の外部で行われます。

PYTIME( )

外部の Python スクリプトの関数によって計算された時刻値を返します。Python によるデータ処理は Analytics の外部で行われます。

R

関数 説明
RDATE( )

R の関数またはスクリプトによって計算された日付値を返します。R によるデータ処理は Analytics の外部で行われます。

RDATETIME( )

R の関数またはスクリプトによって計算された日付時刻値を返します。R によるデータ処理は Analytics の外部で行われます。

RLOGICAL( )

R の関数またはスクリプトによって計算された論理値を返します。R によるデータ処理は Analytics の外部で行われます。

RNUMERIC( )

R の関数またはスクリプトによって計算された数値を返します。R によるデータ処理は Analytics の外部で行われます。

RSTRING( )

R の関数またはスクリプトによって計算された文字列の値を返します。R によるデータ処理は Analytics の外部で行われます。

RTIME( )

R の関数またはスクリプトによって計算された時刻値を返します。R によるデータ処理は Analytics の外部で行われます。

ビット エンコードと文字エンコード

関数 説明

ASCII( )

指定された文字の ASCII コードを返します。

BIT( )

現在のレコードにおける指定されたバイト位置のバイナリ表記を 8 文字の文字列として返します。

BYTE( )

現在のレコード内で指定されたバイト位置に格納されている文字を返します。

CHR( )

指定された ASCII コードに対応する文字を返します。

DBYTE( )

レコード内の指定されたバイト位置にある Unicode 文字を返します。

DHEX( )

Unicode 文字列を 16 進数の文字列に変換します。

DIGIT( )

指定された位置にある Packed データ型のバイトから、上位または下位の数字を返します。

HEX( )

ASCII 文字列を 16 進数の文字列に変換します。

HTOU( )

16 進数の文字列を Unicode 文字列に変換します。"Hexadecimal to Unicode" の省略形です。

MASK( )

2 つの文字列の最初の各バイトに対してビットごとの AND 演算を実行します。

SHIFT( )

入力値の最初の文字のビットを左または右に移動させた 1 文字の文字列を返します。

関数構文規則

表記

説明

かっこ ( )
  • 関数への入力値は、かっこで囲む必要があります。

    ALLTRIM(業者名)
  • 開くかっこは関数名の直後に置き、間にスペースを入れません。

    ALLTRIM(業者名)

    間違った例:

    ALLTRIM (業者名)
  • 入力値を指定しない場合でも、かっこを使用する必要があります。

    RECNO( )
区切り文字
  • 関数への複数の入力値は、区切り文字で区切る必要があります。

    SUBSTRING(<製品 ID>,5,12)
  • 有効な区切り文字は、空白スペース、カンマ、セミコロンです。

    オプション]ダイアログ ボックスの[数値]タブの[リストの区切り文字]では、カンマまたはセミコロンの区切り文字を指定する必要があります。

ヒント

読みやすくするために、空白スペースと、カンマまたはセミコロンのどちらかを両方とも使用することもできます。

SUBSTRING(<製品 ID>, 5, 12)
修飾子あり
  • リテラル文字値の前後には、一重引用符または二重引用符が必要です。

    EXCLUDE(<製品 ID>, "#-")
  • リテラル日付時刻値の前後にはバッククォートが必要です。

    AGE(期日, `20141231`)
  • 数値には修飾子は使用しません。

    ABS(-7.2)
  • 論理値(T/F)には修飾子は使用しません。

    LEVDIST(業者名, 業者名_2, F)
  • フィールド名には修飾子は使用しません。

    ALLTRIM(業者名)
リテラル日付時刻書式
  • リテラル日付値は YYYYMMDD または YYMMDD 書式で入力する必要があります。
    • `20141231`
    • `141231`
  • リテラル時刻値は、前に T または t を付けたうえで hhmmss または hhmm 書式で入力する必要があります。
    • `t235959`
    • `20141231 235959`

関数名の省略

注意

ACL は、演算フィールド、式、スクリプトの関数名を省略せず、各名前の完全なバージョンを使用することをお勧めします。

省略により、演算フィールド、式、スクリプトが読み取りにくく、理解が困難になります。完全な関数名なしでは、オンライン ヘルプでの関数の検索が難しくなります。

Analytics プロジェクトまたは Analytics スクリプトが、省略に精通していない人によって修正または継承される場合、特に省略(短縮)が問題になります。

演算フィールド、式、スクリプトの関数を指定するときには、名前を省略できます。関数名から十分な先頭文字を含め、すべての Analytics 関数で関数を一意に特定する必要があります。

例:

  • MAXMAXIMUM 関数を一意に特定し、有効な略語にします。
  • MA は MAXIMUM 関数を一意に特定しないため、エラー メッセージを生成します。

関数が一意に特定される場合は、必要に応じて略語を短くすることができます。

たとえば、次のすべての略語はALLTRIM 関数で有効です。

  • ALLTR
  • ALLT
  • ALL
  • AL

メモ

略語が短くなると、他のユーザーが認識することが難しくなります。

関数ドキュメントで使用される規則

表記

使用目的

大文字

ACLScript 関数の名前です。

メモ

Analytics のどのドキュメントでも、関数名は大文字で記載されていますが、これはあくまでも書式設定の表記規則上、そう記載されているにすぎません。Analytics 自体では、関数を大文字で入力する必要はありません。

斜体

ユーザーが指定する関数パラメーター。

|

(縦棒)

山かっこまたは波かっこで囲まれた構文項目の選択肢を区切ります。項目のうち 1 つだけを使用できます。

< >

(山かっこ)

オプションの構文項目。山かっこを入力しないでください。

{ }

(波かっこ)

必須の構文項目。波かっこを入力しないでください。

<,...n>

前の項目が n 回繰り返されることを示します。出現はカンマによって区切られます。

関数ドキュメントで使用されるデータ型用語

次の用語は、関数パラメーター引数のデータ型を特定し、値を返すために使用されます。

用語

次のものを使用できます。

文字 文字リテラルや、Analytics の文字(C)カテゴリに属するフィールド名、式、または変数。
数値 数値や、Analytics 数値(N)データ カテゴリに属するフィールド名、式、または変数。
日付時刻 日付時刻リテラルや、Analytics の日付時刻(D)カテゴリに属するフィールド名、式、または変数。
論理 論理値や、Analytics の論理(L)カテゴリに属するフィールド名、式、または変数。
フィールド 任意の Analytics データ カテゴリに属するフィールドの名前。