User-Defined Function Definition Window

With this window, you can configure your own custom functions to be used in calculated field, filter and find expressions.

To display this window, select the Functions from the Table Design ribbon.

To display the properties of an existing function, select the function from the Functions selector.

 Options

Field

Description

Name

Use this field to specify a name for a new user-defined function (or to edit the name of an existing one).

Note: The name specified here will appear in the Functions list on the Formula tab of the Filter Definition dialog, the Formula tab of the Field Properties dialog for a Calculated Field, and the Find Expression Builder.

Comment

Use this drop-down to supply comments about the user-defined function. These comments may help to remind you (or other users of the model) of important facts about the user-defined function.   

Description

Use this field to provide a description of the user-defined function. This description will appear in the bottom box of the Formula tab when configuring a calculated field, filter or find expression.

Forms

Displays the return type and parameters for the form(s) of the function that you specify via the Edit Form dialog. To access this dialog you must click the Add button.

Return Type

Displays the return type (either character, numeric, or date/time) of the available form(s).  

Parameters

Displays the parameter(s) of the available form(s).

Add

Click to add a new form via the Edit Form dialog.

Edit

Click to edit the selected form via the Edit Form dialog.

Delete

Click to delete the selected form.

Categories:

 

Use the following check boxes to specify the categories in which the function will appear in the Functions list of the Formula tab. You may select multiple boxes.

  • String: Select to assign the function to the list of String functions.

  • Numeric: Select to assign the function to the list of Numeric functions.

  • Date: Select to assign the function to the list of Date functions.

  • Conversion: Select to assign the function to the list of Conversion functions.

  • Special: Select to assign the function to the list of Special functions.

  • Report: Select to assign the function to the list of Report functions.

Comment

 

Displays the Documentation Comment dialog, which you can use to supply comments about the user-defined function. These comments may help to remind you (or other users of the model) of important facts about the user-defined function.  

Manage External Functions

Displays the External Functions Library Dialog that allows you to add external models and their corresponding external functions.

 

 

 

 

© 2024 Altair Engineering Inc. All Rights Reserved.

Intellectual Property Rights Notice | Technical Support