Field Help for Page Customization

This page provides help for page customization.

Features

Function	Description
UI ID	Copy from the Reference Guide the UI ID for the page containing the element to customize. Find this value on the Class Reference page for the page to customize under UI Pages UI View UI ID . Example `masterdata.alert.ui.buyside.default` End of the example.
Parent Class	Select the parent class for the page customization. If a value is selected in this field, customization only applies if the parent of the customized object is the class specified.

Overrides

Function	Description
Field ID	Copy the Field ID for the page element to customize from the Reference Guide. Find this value on the Class Reference page for the page to customize under Page Fields UI View Field ID . Example `DISPLAY_NAME` End of the example.
Property	Select a property from the list of valid properties and values for fields and dividers.
Value	Select or enter a value for the property. Note If you enter text as a property value, you must create a localized resource and enter its Resource ID value in the Value field. For details, see Creating Localized Resources. End of the note.
Dimension on Parent	Check this box to indicate that the dimension used is an attribute of the top-most parent of the customized object.
Dimension Field	Enter the field name of the dimension attribute. You can set up an override to be applied only if a particular field has a specific value. This field indicates which field should be tested. It is the `FIELD_ID` as copied from the Reference Guide. Besides naming specific fields on a page, you may use a special token that automatically fills in the proper field information, including `<%USER_GROUP%>`, which is the default group that the user is currently a member of.
Dimension Field Type	Select the field type of the dimension attribute. The FieldType column in the Class Reference for the Page Field indicates the type for a dimension field.
Dimension Value	Select the value of the dimension field that must be set to apply this override. The Dimension Field Type determines the options that appear in this field.

Field Properties and Values

The properties and values for UI Fields (editable controls) are as follows

Property	Description	Possible Values
hidden	Allows an optional attribute to be removed from the UI	true
label	Allows the label for a field to be changed	a resource id
editable	Allows an optional field to be changed to read-only	false
position	Allows the fields on a page to be reordered. Position numbers are listed in the Reference Guide.	an integer
required	Allows an optional field to be made required	true
hide_label	Used to turn off the label for a field	true or false
pre_text	Used to add text just before a label	a resource id
post_text	Used to add text just after a label	a resource id
description	Used to add flyover text to a field	a resource id
checkbox_label	Define a label for the right side of a boolean field type	a resource id
hide_checkbox_label	Hide the right-side label for a boolean field	true or false
object_picker	Specify a query group /or initial query to execute for an object picker	<query-group-name>\|<query-name>

Divider Properties and Values

The properties and values for UI Dividers are as follows.

Property	Description	Possible Values
hidden	Allows a divider to be removed from the UI	true
label	Allows the label for a divider to be changed	a resource id
position	Allows the divider on a page to be re-ordered. Position numbers are listed in the Reference Guide.	an integer
hide_label	Used to turn off the label for a divider	true or false

Note Note

A resource ID is an ID from the localized string database in SAP E-Sourcing with the naming convention bundle$resource_id, for example cterm$cterm.display_name. If you want to display text without entering the string database, you can use the special bundle literal.

For example: literal$Display Name.

End of the note.

Collection Column Properties and Values

To customize the column heading for a collection list, use the name of the collection followed by the column ID with the naming convention <FIELD_ID>.<COLUMN_ID>.

Collection columns support the following configurable attributes.

Property	Description	Possible Values
label	Allows the label for a column to be changed	a resource id
description	Used to add flyover text to a collection column	a resource id

Object Picker Customization

Object Picker customization allows a change to the standard query group that is used when a picker window is launched for an object reference selection. It also allows a change to the initial query which is executed in the query group.

When considering a change to the query group, first examine the queries that are included in the standard query group that is provided. Can the customization goal be satisfied by adding a custom query to the standard query group, and making that custom query the default query to execute in the query group? If it is decided that a custom query group really is needed, then examine the filter parameters in the standard queries of the standard query group. Should some of these filter parameters be included in the queries in the custom query group?

To customize the Query Group name and/or Query name:

Select the Object Picker property from the drop-down list.
Enter the object reference Field ID. If the field is contained directly by the business object (BO), then the field name alone should be specified. If the field is in an editable cell of a collection list, then the field name should be qualified by the collection name.
Enter the Value in the pipe-delimited form: <query-group-name>|<query-name>
The internal name of the query group or query definition must be used.

Let’s say that a custom query group exists with the name of CUST-MySuppliers, and that a query definition within this group is named CUST-ApprovedSuppliers. If the default query definition in the query group is desired, then the Value would be: CUST-MySuppliers

If a non-default query in this query group is needed, then the Value could be: CUST-MySuppliers | CUST-ApprovedSuppliers

If the standard query group is sufficient, but a non-default query from that query group should be executed, then it is possible for only the query name to be provided: |CUST-SearchSuppliers Note that the query name must be preceded by the pipe character even when the query group name is not specified.

When a query group is specified, the class ID of the object reference field must match the Target Object Type of the query group.

Another UI element which can be customized is an Add button that launches an object picker window. Collection lists for subordinates typically have one or more Add buttons. Each Add button is associated with an object reference field in the subordinate BO. To customize such buttons, enter the subordinate object reference Field ID in the following format: .

<COLLECTION_NAME>< OBJECT_REFERENCE_FIELD_ID>/<_ADD_BUTTON_SEQUENCE_NUMBER>

For example, there are two Add buttons in the collection REPORTS and each of them is associated with the REPORT_REF attribute. To specify the query group and/or query name for the first button, enter the Field ID as REPORTS.REPORT_REF/1. The Value is entered in same format that is described above.

Note that the sequence number of the Add button must always be entered, even if no other Add buttons are associated with the same object reference field. The sequence number distinguishes the Add button from an editable object reference in the collection list itself.

Page Customization Properties and Values

The following table provides values for customizing the Page Customization UI.

Field ID	Property	Value	Action
DISPLAY_NAME	position	1	Name column is always in first position.
DISPLAY_NAME	label	cterms$cterm.display_name	Change the name of the field from Name to Display Name.
OVERRIDES	label	literal$Field Customizations	Change the name of the Overrides list to Field Customizations.
OVERRIDES.FIELD	label	literal$Field ID	Change the name of the FIELD column on a collection list.

Page Customization Field Values

Dimension Field Types	Usage
Boolean	Provides a yes or no response for the dimension value
Enumeration	Provides a choice from the Enumeration list. If this is selected, the Enumeration Type must also be supplied.
Object Reference	References an object type. If this is selected, the Class Name of the object must also be specified.
Value List	References a drop-down list of values. If this is selected, the Value List Type must also be specified.