Skip to main content

User Defined Fields

Creating User Defined Fields (UDF)​

In DPL Studio, User Defined Fields (UDFs) are key-value pairs used to store dynamic parameters that can be reused throughout a package.

UDF values can be used in:

  1. Standard Query filter conditions
  2. Advanced Query filters
  3. Transform functions
  4. SAP username and password fields

Importance of User Defined Fields​

One of the most important uses of UDFs is passing special parameters during command-line exports.

Example : Suppose a job is configured so that whenever a new record is inserted into a database table, export.exe should automatically run.

In this case:

  1. The primary key of the newly inserted record can be passed as a UDF parameter.
  2. The Standard Query can then use this parameter to filter and retrieve only the required record.

This makes automation and dynamic data processing easier and more efficient. When a package is transferred to another system, User Defined Fields must be redefined.

Adding User Defined Fields

Steps to Add a UDF

  1. Go to Settings → Configuration
  2. Select User Defined Fields
  3. Provide : Key, Value

The key-value pair will then be available throughout the package.

Using User Defined Fields in a Package​

Different areas of DPL Studio use different syntax formats for accessing UDF values.

1. Standard Relational / Advanced Query Syntax​

Use the following syntax : << %key% >> OR the longer format : << Expand('%key%') >>

2. Transform Function Syntax

Within transform functions, use the Expand function : Expand("%key%")

3. SAP Username / Password Syntax

For SAP credentials, use : %key%

This allows dynamic values such as usernames or passwords to be passed securely through User Defined Fields.