Custom Property Access Service

The Framework services manager provides a facility to access Custom Properties.

Custom property values are retrieved by using the avGetUserProperty method.

Method avGetUserProperty Parameters
Name Usage

AtLevel

Use this parameter to specify the level at which the custom property is defined. Allowable values are F (Framework), A (Application) or B (Business Object). The default value is F (Framework) level. 

WithName

Use this parameter to specify the name of the custom property. The special property value <name>.Count can be used to obtain a count of how many instances of the 

Instance

Use this parameter when a property has multiple values (i.e. instances) to specify which instance should be returned. The default value is 1.

AlphaValue

Use this parameter to specify the field or component into which any alphanumeric value that the property has should be returned. The custom property must be defined as type alphanumeric for this parameter to be used effectively.

NumericValue

Use this parameter to specify the field or component into which any numeric value that the property has should be returned. The custom property must be defined as type numeric for this parameter to be used effectively.

BooleanValue

Use this parameter to specify the field or component into which any Boolean value that the property has should be returned. The custom property must be defined as type Boolean parameter to be used effectively.

 

Examples of retrieving Custom Property valuesExample 1

Retrieve the current value of Framework level alphanumeric property named PRINTER:

Invoke Method(#avFrameworkManager.avGetUserProperty) Withname(PRINTER)  AlphaValue(#C_Printer)

 

Example 2

Retrieve the 3rd instance of an application level numeric property named COMPANYNUMBER:

Invoke Method(#avFrameworkManager.avGetUserProperty) AtLevel(A)

           Withname(COMPANYNUMBER)

           Instance(3)  NumericValue(#Company)

Example 3

Find out how many instances of a business object level property named STATE exist:

Invoke Method(#avFrameworkManager.avGetUserProperty) AtLevel(B)

           Withname(STATE.COUNT) NumericValue(#State_Tot)