1024 views

Description

The option to change the highlighting of a specific field as displayed on a calendar report can be a useful feature of calendar reports.  Usually, this capability will probably not be necessary, however, in a few cases, administrators of the platform may prefer to change the selection of fields which appear in this selection list on the system.  The method to do this is not necessarily intuitive and can sometimes lead to confusion on the best way to accomplish these changes.  This article will thus describe the process as well as the steps that might be used to modify the values as found in that list.

Instructions

The administrator may have the need to remove, add, or modify the specific field highlighting options that appear in the Highlight based on the selection menu at the bottom of the calendar report. 

In order to understand the process to add fields to this list, it helps to understand how this list is actually populated as displayed on the report.  The actual fields which will be displayed in the "Highlight based on" selection field on a report are thus dynamically generated for that list when the report is displayed based on corresponding records found in the Styles table (sys_ui_style).  In the case of reports on tables which are extended from the task table, this will be either the Style records associated directly to the table on which the calendar report is based or on the root table "task".  This determination is directly dependent on the setting of a specific system property on the instance which will determine if these fields should be selected from the task table or the child table.

Thus, for any reports which are reporting on a table which is extended from the task table hierarchy, we should first consider the value of the system property glide.ui.report.extend_calendar_choices.  If this system property is set to a value of true on an instance the system will use Style records defined for the specific child table which is the source of the table as well as any Style records configured for the root table, task.  However, if the value of this system property is set to false, the list will only include fields for Style records which are specified for the root table of the hierarchy, in this case, task.  In addition, for a value of true for the system property, if there are Style records specified at the child table level as well as the task table level the style specified for the child table will override any Style records specified at the task table level.  The default value for this system property in a new out-of-box instance is true, which is also the value if the property is missing from the instance.

To check the value of this property, perform the following steps:

Log in to the instance with an account having admin rights to the instance.

Once logged into the instance, in the Filter navigator text field type sys_properties.list and press the Enter key.

In the list of System Property records that appears, locate the System Property with the name glide.ui.report.extend_calendar_choices and click the name of the property in the list to open that property for editing/viewing.

Note the setting for the Value field in the system property record that opens.  If this value is set to "true", as mentioned above, the list will be populated with fields for which a Style has been defined for the report table data source itself as well as the root task table.  If instead, the Value field for the system property is set to "false", the field list in the report will use the list of fields for which a Style has been defined on the task table only.

Change the Value field of this property as appropriate.

Extended Calendar Choices System Property

If the value of the system property was changed, click the Update button on the record.

 

After modifying the appropriate System Property as necessary, the next step is to verify the specific fields that currently will appear in the "Highlight based on" selection list included within a calendar type report.

The fields listed in this selection will be directly associated with records as found in the Styles table of the instance.  As mentioned above, if the glide.ui.report.extend_calendar_choices system property is set to a value of true, the list will include fields for which a Style record is defined on either the root "task" table as well as any Style records specified for the child of the task table on which the calendar report is based.  However, if the glide.ui.report.extend_calendar_choices system property is set to a value of false, the list will only include fields from the root table, task, which have a Style record defined.  If multiple records are defined for the same field from a table, the system will only include that field name one time in the list of fields.  For example, if the instance contained the following Style records defined on the task table:

Example Style records associated to the task table

Each of the fields found one or more times in the list would be included one time in the Highlight based on field list.

The Highlight based on field list

It should also be noted that, while the system will include any field for which a Style table record is found on the instance, the actual style applied to the field on the report will only be applied for changes to the background color of that field (background-color).  Style records that define the application of a style other than this background color will still have the corresponding field listed in the list, but selecting that field will not cause the specified style to be applied to the field on the report.  Similarly, if a field found in the Highlight based on list is not actually displayed and visible on the Calendar report, the field will still appear in the list (as long as it has a corresponding Style record for the field and table), but selecting that field from the list will not cause any visible change to that field on the calendar report.  See KB Article KB0750293 which describes how the system determines what fields to actually included in the displayed Calendar report.

Thus, if one or more additional fields are to be added to this Highlight based on field list, a new corresponding Style record should be added to the Style table.  This new Style record should be defined on the appropriate Table as well as the Field name which should be included in the list.  The Value field should be a Value for which, if the field equates, will cause the Style described for this Style to be applied.  If this field is left blank, the Style will be applied to this field for all records.  The Style field should contain the CSS formatted style that should actually be applied to the field.  It should be remembered, that only background-color styles will actually be applied to that field as displayed on a calendar report.  This new Style record should then be Submitted to add the new record to the instance.

Custom Field Style record

Once a Field Style record has been added to the instance, that field should then appear in the list of selectable fields in a Calendar report based on the appropriate table.

 

As a Calendar report is first opened, it will have the None option selected which will result in all fields displayed with the default grey background (and no particular style from the Styles table applied to any of the field labels).  Selecting a specific field name from the Highlight based on the selection list will then apply the background color style, as appropriate for each Style record specified for that field as found in the Styles table.  This background color will be applied to the entire row corresponding to that record as displayed on the Calendar report.  For any displayed data record in the Calendar report for which no Style can be found that fulfills the criteria, the row will be displayed with no highlighting at all (empty white background).  Note that even if the field itself is not actually displayed on the report if any records are found which fulfill the criteria as specified in the Value of the Style record, that Style will thus be applied to the entire displayed row for any corresponding records which fulfill the Value criteria for the Style record.

Styles applied to the Change calendar report

Additional Information

For instructions on how to configure the report to determine the specific fields that will be displayed in the labels in the calendar report, see the following article:

Configure the specific fields for display in a calendar report

To review a KB article for an issue in which the fields specifically configured to appear in the Highlight based on are not displaying in the list, see the following Knowledge Base article:

Fields configured in the Highlight based on selection field for a calendar report are not appearing in the list

Article Information

Last Updated:2020-01-29 05:43:15
Published:2020-01-13