SAMPLE_GRIDDING_SCHEME_HDR_FIELD

STRING, comprising a scheme table column or DTO attribute name, of String type data, in the format:

recordTypeAlias.TABLE_COLUMN_NAME/attributeName

or

TABLE_COLUMN_NAME/attributeName

This preference sets the field displayed in the scheme column header when Applying Sample Gridding for a job or job scheme.

The recordTypeAlias is the table/DTO name alias: JS for job scheme, SCH for scheme, and SC for scheme version.

The table column or DTO attribute names (either can be used, as long as they contain string-type data) are case-sensitive. The target field is not found if case is not matched. Therefore, table column names must be upper-cased to work, and DTO attribute names must be as they appear when the cursor hovers over a screen field where the Show attribute tooltips setting is enabled, or in screen personalisation for the DTO service.

Note: Where table column or DTO attribute names are taken from SCH or SC, then they are taken from the org-scope (not the enabled-scope), or the lab-scope.

The column heading is set using the following rules:

  1. Where any of the following situations exist, then the scheme's Name is used as a default:
    • The preference is not defined
    • The preference's value is inactive
    • The preference's value is empty
    • The preference's value does not contain a recognisable column/attribute name within JS, SCH or SC, matching on case, for example: REPORT_description, or XXX.xxx
    • The preference's value contains a valid record type alias but does not contain a recognisable column/attribute name within that table, for example: JS.xxx, SC.exportName, or JS.POSSIBLE_DATE
    • The column/attribute does not hold a string-type data
  2. Where the preference's value does not contain a record type alias but contains a column/attribute name within JS, SCH or SC, or the preference's value contains a table type alias that does not match JS, SCH or SC but contains a column/attribute name within JS, SCH or SC, then the first occurrence of the field within JS, SCH and SC, in that order, is used. For example:
    • name --> SCH.name
    • reportName --> JS.reportName
    • priceCode --> JS.priceCode when the price code is populated, otherwise S.code
    • exportName --> SCH.exportName
    • XXX.name --> SCH.name
    • XXX.reportName --> JS.reportName
    • XXX.exportName --> SCH.exportName
    • SV.name --> SCH.name
    • SV.reportName --> JS.reportName
    • SV.exportName --> SCH.exportName
  3. Where the preference's value contains a record type alias matching JS, SCH or SC, and contains a column/attribute name within that record type, then it is used. For example:
    • JS.reportName --> JS.reportName
    • JS.priceCode --> JS.priceCode; SC.code when JS.priceCode is empty
    • SCH.name --> SCH.name
    • SCH.reportName --> SCH.reportName
    • SCH.priceCode --> SCH.priceCode
    • SCH.exportName --> SCH.exportName
    • SC.name --> SC.name
    • SC.reportName --> SC.repName

The maximum length should be about 10 characters as a greater length than this causes the headings to consume the entire screen, preventing scrolling and making the grid unusable. Custom attributes are not supported for the sample grid.

Typically the preference is not set at role or user level.

Related Processes