ユーザー定義関数の作成
[新しいアセット]ページでユーザー定義関数を作成します。作成したユーザー定義関数は、組織内のすべてのユーザーがそれぞれの権限に基づいて使用できます。
1[新規] > [コンポーネント] > [ユーザー定義関数]をクリックし、[作成]をクリックします。
2関数名、場所、戻り型などの全般プロパティを設定します。
3必要に応じて、関数の引数を作成します。
引数を作成する際は、各引数の名前、データ型、および説明を設定します。
4関数式を作成します。
5関数を検証して保存します。
ユーザー定義関数の全般プロパティ
ユーザー定義関数を作成する際は、関数名や戻り型などの全般プロパティを定義する必要があります。全般プロパティは、[全般]タブで定義します。
以下の表に、プロパティを示します。
プロパティ | 説明 |
---|
名前 | 関数の名前。組織内で一意である必要があります。 先頭は文字にする必要があります。文字、数字、および次の特殊文字を使用できます。 _ @ $ # 名前100文字を超えない範囲で指定する必要があります。また、空白文字は使用できません。 |
場所 | ユーザー定義関数の場所。ユーザー定義関数を保存するフォルダを参照するか、デフォルトの場所を使用します。 デフォルトの場所は直近で保存されたアセットの場所です。 |
説明 | ユーザー定義関数の説明。 説明は、トランスフォーメーション式、フィールド式、または他のユーザー定義関数で関数を選択したときに式エディタに表示されます。 |
戻り型 | 関数から返される値のデータ型。バイナリ、日付、数値、または文字列のいずれかです。 |
ユーザ定義関数の引数
ユーザー定義関数を作成する際は、関数に渡す値を定義する引数を含めることができます。引数は[引数]タブで作成します。最大10個の引数を作成できます。
引数を作成するには、[追加]をクリックして次の情報を入力します。
プロパティ | 説明 |
---|
名前 | 引数の名前。関数内で一意であることが必要です。 名前は英字で始める必要があり、英字、数字、およびアンダースコア(_)を含めることができます。100文字を超えない範囲で指定する必要があります。また、空白文字は使用できません。 |
タイプ | 引数のデータ型。バイナリ、日付、数値、または文字列のいずれかです。 |
説明 | 引数の説明。 説明は、引数を選択するときに、[式]タブの引数と関数の領域に表示されます。トランスフォーメーションまたはフィールド式で関数を使用するときに、式エディタにも表示されます。 |
引数は、[引数]タブに表示される順で関数に渡されます。順序を変更するには、変更する引数を選択して[上に移動]または[下に移動]をクリックします。
引数を削除するには、引数を含む行で[削除]をクリックします。
ユーザ定義関数の式
関数を定義する式は[式]タブで作成します。関数式には、定数、演算子、組み込み関数、その他のユーザー定義関数を含めることができます。関数内に関数をネストすることで複雑な式を作成できます。
式を作成するには、式エディタで式を入力します。作成する式は、トランスフォーメーションまたはフィールド式と同じガイドラインに従い、同じ構文を使用する必要があります。式の作成の詳細については、「タスク」を参照してください。
式には、引数、組み込み関数、他のユーザー定義関数を追加できます。これらは、式エディタの引数と関数の領域で選択して[追加]をクリックすることで行えます。または、Ctrl+スペースキーを押すと、推奨される引数と関数のリストがインラインで表示されます。式を手動で入力することも可能です。
式に循環参照を含めることはできません。例えば、ユーザー定義関数Function_Aの式に、Function_Aを含めることはできません。また、ユーザー定義関数Function_Aがユーザー定義関数Function_Bを呼び出す場合、Function_Bの式からFunction_Aを呼び出すことはできません。
式を検証するには、[検証]をクリックします。データ統合で式が検証されます。その式を使用するユーザー定義関数と式は検証されません。