| Set and Set Determinant Field Labels Guidelines | |
| Contents | |
| Description | |
|
| Overview | |
|
| Default Values | |
Set and set determinant fields should contain default values if at all possible. When a good default value is available, the set or set determinant field should be populated and any dependent fields should be rendered. Note that default values are generally not available in setup user interfaces (UIs). |
| Rules for Display | |
|
Hide the set concept from end users whenever possible. Set must not be surfaced in self-service or outward facing applications and should not be surfaced on any transactional page. Displaying set determinants, such as business unit or cost organization, instead of the sets themselves is acceptable. Sets should appear only to administrators and implementers. Showing the set concept on setup pages is acceptable and will often be required. Here is an examples of the UI with the set concept hidden, followed by an example where the set concept is available.
Set field labels should include the common name for the reference group (which represents a business object, such as a project type) that they are associated with and exclude the ID. The field label should take the form: <ObjectType> Set. For example, if a set identifies a set of payment terms, the field label should be Payment Terms Set not Set. Common Set: If a reference data value, such as a specific payment term, is assigned to the common set, it will appear in all sets. The code for the common set should appear in set assignment or reference data maintenance pages UIs as “common.” The name should be Common Set. The Description should display Value will be available in all sets. All Other Sets: Display the user-assigned code or name values as described in the Displaying Object Instance Identifiers guideline. |
| Create and Edit UIs | |
|
On a Create or Edit page, the Set (on setup pages) or Set Determinant (on transactional pages) field should appear after the object instance identifier fields (for example, Name, Code, Description). Identifiers should appear in the upper-left portion of the region. Set determinants should appear just below or to the right. Note that for effective-dated entities, Effective Start Date, Effective End Date, and Effective Sequence should appear at the top of the right-most column. Set Determinants should appear below instance identifiers or at the top of the second column in a three-column layout.
Any fields dependent upon Set or Set Determinant must appear below those fields. A field is dependent if its list of values is filtered or its rendering is altered based on the value of the master field. Fields dependent on Business Unit should be rendered only after the controlling Business Unit field is selected for pages that support the Select Business Unit feature. For pages that support the business unit defaulting feature, the Business Unit fields are rendered upon setting business unit context for the record. Changing the Business Unit field value before committing a record should clear out any business unit-specific fields. See the Guided Process Design Pattern when designing Create and Update UIs that include dependent fields. Set values are only editable in setup UIs. As stated previously, set should not appear on transactional pages. Set assignments for individual reference data values are editable, but editing a set assignment can affect multiple set determinant values, such as business units. Business units that previously had access to a given object instance (reference data object), such as a specific payment term, may no longer have access, while a new set of business units (associated with the new set) will gain access to it. You must display a warning message telling users that editing set assignments will impact multiple set determinant values, such as business units. Specify the determinant type in the message text. See the business unit example in figure 5.
Editing set assignments for individual reference groups can also affect multiple in-flight transactions. Warn users when they edit set assignments for reference groups on, for example, an Edit Business Unit: Set Assignments page.
Note that set is always a required field. When the child table design pattern is used, then at least one set must be assigned. In the case of an incomplete Create task flow (that is, the transaction was “saved for later”), the Set field should remain editable. If this is not possible, an error message must appear: "You must select a value for <ObjectName> Set before saving this transaction." Within the Create Business Unit UI, set assignments for reference groups are editable. Editing them can also affect multiple in-flight transactions. A warning message must appear when the set assignment for a reference group is changed. See figure 7.
|
| Search and Data Entry UIs | |
|
On transactional pages, set determinant fields should appear above (preferably) or to the left of the Reference Group fields that they filter. For example, if a set determinant will filter a list of payment terms, the set determinant field should be presented adjacent to (preferably above) a Payment Term Code or Name field. Setup UIs may include Set as a search criterion. In that case, follow the guidance previously outlined if any search field values depend on set. Data entry will be done on Create and Edit pages. Different organizations will implement sets differently. Whether or not users will have to select sets will vary based on implementation, role, and task. This section illustrates the Rules for Display for five common use cases. As in Create and Edit UIs, any fields dependent upon set or set determinant must appear below those fields. Case 1: User has access to only one set on the current page In the following cases, the set field should appear as read only. See figure 8.
Case 2: User has access to more than one set on the current pageWhen the user has access to more than one set, an LOV choice list or standard choice list appears on the page visually associated with any dependent fields. The set field should be labeled with the reference object that the set represents, not with the word "set." For example, if the user must select a set that represents a group of contracts, the field label should be Contract Set, not Set. See figure 9.
Note that labeling set fields <ObjectName> Set is recommended even if more than one set field appears on the page, and the user can select the same set from two or more of the set fields. See figure 10.
Case 3: The set determinant is on the page Set determinants, with many-to-one relationships to sets may appear on transactional pages. Oracle Fusion Applications supports at least five set determinant types, such as:
Because the set determinant has a one-to-one relationship to set, only the set determinant field should appear on the page. Do not display Set in read-write or read only mode on transactional pages. See figure 11. (Note that set, itself, can also be a set determinant type, but that case is indistinguishable from Case 3 from the user’s point of view.)
The set code and set name should appear as attributes of the set determinant in the list of values and its Search and Select dialog box. (See the List of Values guideline.) Note that, on transactional pages, set determinants are selected in the context of a single reference group so that a single set value can be associated with each set determinant value. In the Search and Select dialog box, the column headers will be Set Code and Set Name, rather than <ObjectType> Set because they will be derived from the View Object representing the list of determinant types, rather than something specific to the current page. See figure 12 and the Lists of Values section in this document.
Case 4: Users are implementers or administrators When a set appears in a Setup UI, the field label is Set. Implementers associate sets with business objects or reference data sets in Setup UIs, so the abstract term must be used. See figure 13.
Values appear as described previously, regardless of user type. In particular, the common set always appears with Code and Name “common” in both end user and administrator UIs. |
| Lists of Values | |
If the user (end user, implementer or administrator) is selecting a set from an LOV choice list , display the Set Code and Set Name attributes in the list. In the Search and Select dialog box, it's also recommended to display the set Description.
If the user is selecting a set determinant from a LOV, display the determinant type's code and name attributes in the list. In the Search and Select dialog box, also display Set Code and Set Name.
|
| View (Read-Only) UIs | |
Placement: When a Form Layout is used, follow the guidelines in the Create and Edit UI’s section. When data appeas in tables, order the columns as described in the Create and Edit UI’s section. That is, place the instance identifier attributes in the left-most columns and follow them with the set determinant. |
| Set Assignment UIs | |
Set Assignment UIs typically appear in Setup or Maintain Reference Data task flows. The only user types likely to use Set Assignment UIs are administrators and implementers. Therefore, fields and values appear as described for Search and Data Entry Case 5. Case 1: Each reference group value is assigned to only one set When each Reference Group value can be assigned to only one set, use a single select choice list. See the Select Choice Usage guideline and the List of Values Usage guideline. This UI is used with the Row Striping design pattern described in the SetID Solution Uptake Document. See figure 16.
Case 2: Each reference group value may be assigned to more than one set When each reference group can be assigned to many sets, there are a variety of options for displaying the sets to which each reference group value is assigned. Recommended UIs appear in figure 16.
Case 3: Reference group values may be assigned to the common set When reference group values are assigned to the common set so that they appear in all sets, users select Common in the set assignment UI. Common appears in the Set Code and Name fields. The text Value will be available in all sets appears in the Description field.
|
| Related Documentation | |
|
