...
| 親オブジェクト | オブジェクト | 説明 |
|
| 最上位階層のオブジェクトであり、ドキュメント全体をカプセル化します。子タイプは、 |
|
| 独自の関数を定義し、その関数の定義に必要なデータフィールドをカプセル化します。子オブジェクトは、 |
|
| nameには、アプリケーション内で表示するカスタム関数の名前を定義します。これは各カスタム関数のプライマリ識別子のため、それぞれにユニークな名前を付けなくてはいけません。各関数には、ひとつの名前しか付けることはできません。 |
|
| argumentには、レポート作成時にカスタムSQLに挿入する引数（または、パラメーター）を定義します。argumentは、 |
|
| argumentのindexパラメーターは、関数のコンテキストで引数をユニークに特定するものであり、必ず正の整数値でなくてはいけません。indexは、カスタムSQL文内で定義された箇所に引数を挿入するために使用します。indexが「1」の場合、SQL文内のすべての「$1」を引数に置換します。 |
|
| argumentのnameパラメーターは、アプリケーションで表示する引数の名前です。 |
|
| argumentのdatatypeパラメーターには、引数のデータタイプを定義します。このパラメーターを指定すると、引数と互換性のあるカラム（列）や値のみ、入力することができます。データタイプは、以下のうちの、いずれかひとつを使用してください。
|
|
| SQLには、このカスタム関数のために生成される実際のデータベースSQL文を定義します。このフィールド内のSQLは、単一のカラム（列）として親SQL文に挿入されるため、完全なSELECT FROM WHEREの構文は必要ありませんが、単一カラム（列）構文との互換性が必要です。以下に、単一カラム（列）カスタム関数の、シンプルなCASE WHEN ELSE ENDの例を示します。このSQLには、引数を挿入するための変数を含めることができます。「$1」は、index 1の引数を割り当てられらたカラム（列）やデータ値で置換されます。 |
|
| aggregateパラメーターには、カスタム関数内で、どのカラムを（列）を集約するかを定義します。このパラメーターを指定すると、レポートSQL作成時に、これらのカラム（列）をGROUP BY節に配置しないよう、アプリケーションに伝えることができます。aggregateパラメーター値は、引数変数として使用することもでき、例えば、index 1の場合は「$1」を記述します。 |
|
| groupbyパラメーターには、アプリケーションがレポートSQLを作成する時に、どのカラム（列）をGROUP BY節に挿入すべきか定義します。group byパラメーター値は、引数変数として使用することもでき、例えば、index 1の場合は「$1」を記述します。 |
|
| これは、どのデータベースで関数を使用可能にするかを指定します。何も指定しない場合は、すべてのデータベースで表示することが可能になります。複数のデータベースで表示させるためには、データベースごとに、ひとつのオブジェクトを定義するようにしてください。例としては、SQLServer、PostgreSQL、OpenEdge、Progress、Oracle、DB2、Access、Notes、ODBC、HSQL、MySQLがあります。 |
|
| functionのreturnには、カスタム関数そのものが返す、データ型を定義します。データ型には、以下のうちの、いずれかのひとつを使用してください。
|
...