1. Administrator's Guide
  2. Rule Functions
  3. UD1...3

UD1...3

Gets the text stored in the UserDefined1...3 attribute for the current member or for a specified member. This function can be used in these types of rules:

  • Calculation

  • Translation

  • Consolidation

  • Allocation

Syntax

HS.<Object>.UD1...3(strElement)
HS.<Object>.UD1...3("")
HS.Custom(Dimension).UD1(Member)

Note:

Use a blank string ( "" ) to apply this function to the current member.

Table 11-53 Syntax for UD1...3 Functions

Parameter Description

<Object>

One of these object keywords:

  • Account

  • Entity

  • Parent

  • Scenario

  • Custom1...4

  • Custom

Element

Depending on the object selected, name of a valid member of one of these dimensions:

  • Account

  • Entity

  • Parent

  • Scenario

  • Custom1...4

  • Custom

Return Value

A string that contains the user-defined text stored for the member.

Example

In this example, if the user-defined text for the UD1 account is History, then statements between the If...Then and End If statements are executed.

If HS.Account.UD1(strAccount) = "History" Then
  ...
End If
If HS.Custom("Product").UD1("P3000-Phones") = "History" Then
...
End If