SAP Help Values Builder

SAP Help Values Builder

In this topic ...

Specifying Inputs
Related Topics ...

Lookup Table Builder
SAP View & Form Builder

This Builder provides access to the "Help Values" associated with the fields present in an SAP function. Help Values are a list of valid choices for a given function field. This Builder can be used to populate a Select input control from which a user can select an input to the SAP function.
Use this Builder to provide the equivalent of SAP F4 (Value) help in a portlet. The SAP Help Values Builder allows you to access help value information associated with the fields of an SAP function. This information is useful since it indicates to a user what valid inputs for a given field can be.
A benefit of using this Builder is the ease with which its output can be used to populate controls, such as a radio button group or a select list, with value help information.
This Builder can also be used to create a "lookup table" for use with the Select, Radio Button Group, Text., and Data Field Modifier Builders

Specifying Inputs

The SAP Help Values Builder takes the inputs described in the table below. For help on inputs common to many or all Builders such as those in the Properties and HTML Attributes input groups, see "Using the Builder Call Editor."

Input Name Description
Name Enter a name for this Builder call. The Designer displays this name in the Builder Call List.
In the case of this Builder, the name you enter here will also be the name of the SAP method used to fetch help values.
Function Call Name Enter the name of the SAP function being called and with which this help value information is associated.
Parameter Name Select the name of the SAP parameter for which you want help value information.
Field Name Select the name of the field for which you want help value information
Use Lookup Table When enabled, a Lookup Table is used to display help value information. We can use the Lookup Table to feed data to Select, Radio Button Group, Text, and Data Field Modifier Builders.
Remove Value Prefix From Text Enable this option to strip the Value portion of the pair from the Text portion.
Most SAP help values typically are value / text pairs. For example, a typical help value pair might look as follows:
VALUE    TEXT
JFK      JFK John F Kennedy Intl Airport, NY, NY, USA
SFO      San Francisco Intl Airport, San Francisco, CA, USA
When enabled, this check box would cause on the Text portion only to be returned. This might be useful if you want to populate a control with help text information.
Test Press this button to retrieve help value information and confirm that the correct information is being returned.
Not all fields have help values available
Test Results This text panel displays returned value help information and allows you to verify it is correct.
Advanced
Object Type This field is filled in automatically when you select a function. It displays the SAP object type represented by the called function
Method Name This field is filled in automatically when you select a function. It displays the name of the SAP method represented by the selected function.

Input Name	Description
Name	Enter a name for this Builder call. The Designer displays this name in the Builder Call List. In the case of this Builder, the name you enter here will also be the name of the SAP method used to fetch help values.
Function Call Name	Enter the name of the SAP function being called and with which this help value information is associated.
Parameter Name	Select the name of the SAP parameter for which you want help value information.
Field Name	Select the name of the field for which you want help value information
Use Lookup Table	When enabled, a Lookup Table is used to display help value information. We can use the Lookup Table to feed data to Select, Radio Button Group, Text, and Data Field Modifier Builders.
Remove Value Prefix From Text	Enable this option to strip the Value portion of the pair from the Text portion. Most SAP help values typically are value / text pairs. For example, a typical help value pair might look as follows: VALUE TEXT JFK JFK John F Kennedy Intl Airport, NY, NY, USA SFO San Francisco Intl Airport, San Francisco, CA, USA When enabled, this check box would cause on the Text portion only to be returned. This might be useful if you want to populate a control with help text information.
Test	Press this button to retrieve help value information and confirm that the correct information is being returned. Not all fields have help values available
Test Results	This text panel displays returned value help information and allows you to verify it is correct.
Advanced
Object Type	This field is filled in automatically when you select a function. It displays the SAP object type represented by the called function
Method Name	This field is filled in automatically when you select a function. It displays the name of the SAP method represented by the selected function.