A User Defined Field (UDF) is a custom field you create and add to the Transaction Details page. A UDF is any field related to your business that you want to pass to us from your internal Order Management System to help you analyze an order. Some examples of UDFs are coupon codes and affiliate ID numbers.
You can add up to 500 UDFs in the Agent Web Console (AWC), and then create rules around them. However, the more UDFs you have, the slower the performance of the AWC.
To create a UDF, do the following:
-
Sign in to the Agent Web Console (AWC).
-
Select the Fraud Control tab, and then select User Defined Fields.
-
Select Add UDF.
-
In the Add UDF field, enter the name of the UDF in the Label textbox. The label can be a maximum of 28 characters and the first character must be a letter.
-
Type a description in the Description field.
-
Select Number, Alphanumeric, Date, or Amount from the Type drop-down menu.
Note
UDFs intended for use in a VIP list must be alphanumeric.
-
Select Save UDF.
Once created, UDFs can only be deleted and cannot be edited.
-
Select
in the row of the UDF to be deleted.
-
Select Delete, and then select OK.
Once you have defined the UDF in the AWC, you can pass the data to us with an array called UDF as key-value pairs, where the label is the key and the data passed in is the value. You can create a maximum of 500 UDFs. The response time for evaluating transactions degrades as more UDFs are added. There are four data types available for user defined fields.
Note
Fields in the Rules Editor are limited to 16 characters when the format is a Number.
-
Sign in to the Agent Web Console (AWC).
-
Select Fraud Control , and then select Rules.
-
Select .
-
Under Rule Conditions, expand User Defined Fields to view the list of available fields.
The following are examples of how the various formats can be used in rules.
This UDF type is eligible for VIP List Management, as well as for tracking Persona Velocities within the Rules Engine. You can create separate VIP Lists for the values being passed in these UDFs. Additionally, you can track Persona Velocity for a specific value contained within the UDF.
|
Attribute |
Size |
Description |
Example |
|---|---|---|---|
|
UDF[ALPHA_NUMERIC_LABEL]=value |
1-255 |
Letters, numbers or both. |
UDF[COUPON]=BUY11 |
This UDF type is not eligible for VIP List options or for Velocity tracking, but it is available for use in the Rules Engine.
|
Attribute |
Size |
Description |
Example |
|---|---|---|---|
|
UDF[AMOUNT_LABEL]=value |
1-255 |
Integers only, no decimal points, signs or symbols. |
UDF[BALANCE]=1100 |
Note
UDF labels can be up to 28 characters in length and cannot begin with a number.
This UDF type is not eligible for VIP List options or for Velocity tracking, but it is available for use in the Rules Engine.
|
Attribute |
Size |
Description |
Example |
|---|---|---|---|
|
UDF[DATE_LABEL]=value |
1-19 |
Formatted as YYYY-MM-DD or YYYY-MM-DD HH:MI:SS |
UDF[FIRST_CONTACT] |
Note
To include an exact date, deselect the Relative date checkbox. The relative date ranges from -18,263 to 18,263.
This UDF type is not eligible for VIP List options or for Velocity tracking, but it is available for use in the Rules Engine.
Note
Fields in the Rules Editor are limited to 16 characters when the format is a Number.
|
Attribute |
Size |
Description |
Example |
|---|---|---|---|
|
UDF[NUMERIC_LABEL]=value |
1-255 |
Whole numbers and decimal points. |
UDF[FREQUENCY]=107.9 |
Note
The rules engine cannot distinguish between a UDF value of 0 and a Null value. For example, if no value was provided for the UDF. If there are scenarios where your integration might not pass us any value for a UDF then you should use caution when writing rules to evaluate if the UDF value equals 0.
Comments
0 comments
Article is closed for comments.