Report & Query Settings

This section of behavior settings deals with the Report and Query settings. The available settings are:

Layout & Display menu - Report and Query Settings Typical Value Description
ABBREVIATED_HOME_PAGE NO A value of NO will display the sign on message and up to three user-defined reports on the Home Page. A value of YES will only display the sign on message
ALLOWED_ATTACH_ SEARCH_FILE_EXT application/pdf,application/msword, application/vnd.ms-excel,text/csv,text/html, text/plain,text/rtf The allowed attachment files of the types in this list to be searched for keywords, when the user checks the "Search Attachments?" box. If the file in the list to be searched does not have one of these extensions, it is skipped. This is used to skip searching of files such as image files, to speed the search process
ALLOW_SEARCH_ DEACTIVATED_USERS YES The behavior setting controls whether you will allow users to include deactivated users when querying and the setting of USER_LIST_DISPLAY is set to POPUP. If the value is YES, then an additional option appears in the popup search screen. This option allows you to enable querying for deactivated users. Users can search for deactivated users when USER_LIST_DISPLAY is NO in the same manner as searching for other deactivated values
ALLOW_SEARCH_TEXT_UDFS YES When this setting is YES, then performing a keyword search will include the searching of UDF's with a display type of Text. This may have a performance impact on the speed of searches. Valid values are YES and NO
ALLOW_UNLIMITED_SEARCH YES Allow or disallow unlimited rows to be returned on queries when searching. Valid values are YES and NO. In large databases, the system administrator typically wants to stop users running reports that consume a large amount of resources. This is used in conjunction with LIMIT_QUERY_ROWS
AUTO_FILTER_QUERY_FIELDS NO This setting causes a list of the Business Areas and Projects to appear within report editors that display one or more field lists.  The user can select a Business Area and/or a Project from the list, and the field lists will be filtered to only display the fields which are available within the selected Business Area / Project
DEFAULT_SORT_ORDER ID:DESC The default sort order for reports
DISPLAY_ALL_FIELDS YES When this value is set to YES, all fields to which the user has read permission will be generated into the all the query field lists from which a user can select for column reports, at all levels, for hierarchy reports. If the value is set to NO, then only the fields that exist in the edit screen of the Business Area and Project defined for the hierarchy level will be displayed. This keeps the number of fields displayed to a minimum, and most probably displays all the fields in which a user will have an interest in using as filters
DRILLDOWN_ATTRIBUTE ID Data dictionary entry name for search criterion. Typically, this is the ID of the issue, but it may become ALT_ID or another field according to how your system is configured
DUPLICATED_FIELD_TEXT      " This setting defines the text value that is used to substitute for duplicated row values in a hierarchical report. The valid entries for this setting are any HTML-safe text value.
EXCEL_CELL_CHAR_LIMIT 31000 This specifies the number of characters exported to a single Excel cell. If the length of the text in a log area field exceeds this number, it will be truncated. Excel supports a maximum of 32,000 characters in a single cell, therefore this number must be less. Only log area fields can exceed this limit of Excel.
EXCEL_PRESERVE_
LEADING_ZEROS
NO EXCEL_PRESERVE_LEADING_ZEROS allows the spreadsheet to retain leading zeroes output. For example, if the setting is NO, then when 0001234 is output, the Excel cell will display 1234. If the setting is YES, then the Excel cell will display text as 0001234.
FILL_IN_REPEATING_RECORDS YES In text and Microsoft Excel reports, this determines whether to pad parent data in repeating rows with blanks. If NO is selected then the parent data will be repeated for each repeating row child values. Values are YES and NO
FULL_TEXT_SEARCH_COLUMNS ITEM.SHORT_DESCR ITEM_TEXT.TEXT ATTACHMENT.FILE_DESC ATTACHMENT.FILE_NAME ITEM_UDF.VALUE ATTACHMENT_ CONTENT.CONTENT_BLOB This is a comma-delimited list of the database columns that will be indexed and used to perform high speed keyword searches for users. If a column is in this list, and there is no suitable index for that column in the underlying database, search queries using standard SQL will be used when the user searches that column. There is typically no need for the administrator to modify the list in the value of this behavior setting as all the columns used to store text within issues are on the list.
GRANULAR_REPORT_DEFINITIONS NO By default, the report editors allow the end user to output all the report definitions with a single mouse click.  When this setting has a value of YES, then the end user can elect to output any combination of the Report Definition, Report Filters and Custom Filters, though individual checkboxes.
HIGHLIGHT_LAST_CHANGE_USER YES If set to YES, the LAST_CHANGE_USER field will always be highlighted on email notifications and history report. Valid values are YES and NO
HISTORY_DISPLAY ABBREVIATED, SIDE_BY_SIDE, LAYOUT This setting allows the administrator to set which methods for the presentation of history are available to the end user. You may set one, two or three of the values ABBREVIATED, SIDE_BY_SIDE and LAYOUT, separated by commas. For each of these values, a button will appear on the menubar of the history screen, and the user can switch between the alternatives. The first value in the list is the default value when the user first enters history for an issue
INSERT_REPORT_HEADERS YES This setting controls whether header and footer information is inserted into reports with a destination of Microsoft Excel or Text. Values may be either YES or NO. Note that headers and footers are always generated for reports output to the browser and Microsoft Word.
ITEM_TABLE_CARDINALITY   The optimal order for indexed queries.
KEYWORD_SEARCH_
FIELD_SECURITY
NO Determines whether field security is checked on keyword search for text fields. Use YES to check, NO to skip
LIMIT_GROUP_BY_ITERATIONS 40 This setting will limit the number of iterations produced by an Group By Container Report. The report will stop running after the limit has been reached. The last row of the table of contents will show an error message informing the user that the limit has been reached. The default is 40.
LIMIT_HOMEPAGE_QUERY_ROWS 20 Maximum number of rows that will be returned by any column report from homepage. This is used in conjunction with ALLOW_UNLIMITED_SEARCH to provide the limit of rows returned by a query.
LIMIT_MASS_UPDATE_BATCH_SIZE 100 This is the number of issues that mass update processes in memory at one time. The higher the number, the faster the processing occurs, but more memory is consumed. If you encounter out-of-memory errors when running mass updates, you should reduce the number from the default of 100
LIMIT_QUERY_ROWS 10000 Maximum number of rows that will be returned by any search query. This is used in conjunction with ALLOW_UNLIMITED_SEARCH to provide a limit to the number of rows returned by a query. Note that a user whose current role is ADMIN, bypasses this check
LIMIT_SUMMARY_QUERY_ROWS 1000 Maximum number of rows that will be returned by a summary report. This is an exception to LIMIT_QUERY_ROWS which is the limiter for most other report types
LIMIT_WORD_DETAILED_RECORDS 10000 The maximum number of detailed records on a MS Word report. Use this if you encounter the bug in Microsoft Word (pre-2007) where it freezes when downloading or loading large HTML reports. This is an exception to LIMIT_QUERY_ROWS which is the limiter for most other report types
LIMIT_WORD_RECORDS 25000 The maximum number of records returned from a search to a MS Word report. This is used to limit the amount of HTML data being sent to Word (pre-2007), if you encounter the bug where Word freezes when loading a large amount of HTML data. This is an exception to LIMIT_QUERY_ROWS which is the limiter for most other report types
MASS_DELETE_TEMPLATE VIEW_BUTTON, ID, AREA, PROJECT, SHORT_DESCR This provides a list of the fields displayed on the review screens when the user clicks the Mass Delete button from Quicklists and Column reports
MAX_CELLS_ON_TASKBOARD 500 The maximum number of cells that will be rendered when producing a Taskboard report. Browsers may run out of resources and consequently hang, on client computers if you attempt to render a huge taskboard with too many cells. This setting provides the means to set sensible limits on the size of taskboards
MAX_DRAG_NUM_PROMPT 5 This is the maximum number of issues which may be dragged and then dropped onto a report, before a warning is provided to the end user, indicating how many issues are being moved, and asking them to confirm that it is OK to proceed. The update proceeds without any warning to the user when the number of issues being dropped is equal to or less than this number
MAX_PDF_COLS 12,15 This sets the maximum number of columns that a user can place on a report being outputted to PDF. This setting has two comma separated values. The first value is the number of columns when generating portrait output, and the second indicates the number of columns when generating landscape output.
MAX_REPORT_FIELD_HEIGHT_
PIXELS
0 This setting controls the maximum height, in pixels, of values of Text Area, HTML Area, Log Area and Print Text fields when output to reports.  When the unconstrained height of an individual field value on a report is greater than the value of this setting, the height is constrained to the value of the setting, and buttons are placed beneath the value to allow the user to see the entire contents, and to reduce the height back to the initial value.  A value of 0 implies there is no limit on the height and the entire contents of the field are always displayed.

As a guide, a row of characters is approxiately 25 pixels high.  This varies however, depending on the text size of the user.

Also, for reference, characters are approximately 12 pixels wide, but as font characters have different widths, some are narrower, and some are wider.

MENUBAR_SEARCH_TARGET_WIN main When you drill down to an issue from the navigation bar, a value of MAIN will place the results in the main window alongside the navigation bar. A value of __BLANK will open a new window for the display
MINIMUM_SEARCH_FIELDS 0, 0 This setting is used to force a user to select a number of filters before their queries will be executed. If you specify a single number, then this specifies the number of filters in addition to the KEYWORD filter that must be provided. If you provide two numbers, separated by a comma, then the first number specifies the number of filters in addition to the KEYWORD filter that must be provided and the second number specifies the number of filters that must be provided when no KEYWORD filter is provided. The default is 0,0. For large databases, a setting of 2 or 3 for each number typically provides sufficient control, to ensure that only a small section of the database is searched at one time, and that users do not attempt to download millions of records or perform complex queries across millions of records.
MS_OFFICE_CHARSET UTF-16LE The default character set for reports sent to Microsoft Office Products. The default value is UTF-16LE, which is the appropriate value for English language versions, and most foreign language versions of MS Office
MULTIPLE_VALUE_REPORTING RELEASE Must be RELEASE, MODULE or NONE - Note this is not on the GUI and is set to RELEASE as this is the only valid option at this time
QL_REPORT_LAYOUT_ AREA_PROJECT   This setting defines the business area and project to be used when creating a Quicklist report. If defined, the value of QL_REPORT_LAYOUT_AREA_PROJECT has two comma-separated values - Area_Title, Project_Title, where Area_Title and Project_Title must exist. These values are used to select the layout for the Quicklistif the business area and project can not be resolved uniquely in the search filters for the Quicklist report. This happens if there are no business area/project filters selected and more than one exist, or there is more than one business area and project pair combinations selected. If QL_REPORT_LAYOUT_AREA_PROJECT is not defined, the current business area and project for the current user is used to select the layout.
QUERY_TIMEOUT_SECONDS 0 The maximum number of seconds that any SQL query is allowed to run in the database before it is aborted. This prevents any one query from taking all the database resources, and in the worst case, stops a query that may never end. A value of 0 allows a query to run to completion, regardless of how long it may take
QUICKFIND_MAX_HITS 20000 This setting provides a limit to the number of results returned with a Quickfind query..  It is possible to generate extremely large (and somewhat unusable) result sets, especially when using wildcards in queries, and this setting provides a throttle.
RECORDS_PER_PAGE 20, 100, 500 The number of records per display page that a user can select on reports. These values will populate the list box on the Search / Report screens. If ALLOWED_UNLIMITED_SEARCH is YES, then Unlimited is also appended to the list of values
RECURRENCE_ISSUES RECURRENCE_ISSUES This value is used by ExtraView to relate issues together by the recurrence generator in the calendar report. It is highly suggested you do not edit this field. Editing this field after a recurrence has been generated will result in the loss of that recurrence
REPORT_AUTO_REFRESH YES This setting controls whether report results are auto-refreshed after a user drills down into an issue and updates it.  The report results are updated following the update if the value of this setting is YES.  In addition, each user can override the default value of this setting in their personal report options
REPORT_DTL_ITEM_DATA_LAYOUT NO When this is set to YES Detailed Reports will be rendered with the layout for the each issue’s area and project and the current user’s role. If this is set to NO, the layout used will be that of the user’s current area and project, and their current role
REPORT_FILTER_BY_ CURRENT_ROLE NO When this is set to YES, the user will only see reports on the Query / Report page that are valid for their current role. Typically this means they will see their personal reports, shared reports and reports that are visible to their current role. If this is set to NO, then they will also see reports that are valid for other roles that they are eligible to see.
REPORT_IN_NEW_WINDOW NO If set to NO the Quicklist and Detailed Report will be opened in the main ExtraView window. If set to YES, the Quicklist and Detailed Report will be opened in a new window.
REPORT_LABELS_POSITION TOP Position of the labels on reports, relative to the data. Valid values are LEFT and TOP. When the value of LEFT is set, the detailed report uses the layout defined for the purpose. If you set the value to TOP, then the detailed report will be displayed in a single column, with the labels to the left and the values presented top to bottom. The order of fields is taken from the detailed report layout, from left to right, top to bottom.
REPORT_REL_ISSUES_EXCEL_TEXT NO When this behavior setting is set to YES, reports that are output to Microsoft Excel or to text, will include the RELATED_ISSUE_DISPLAY layout for related issues to the records being output. When this is set to NO, related issues will be suppressed on Microsoft Excel and text output. Note that browser output and Microsoft Word output will always contain the RELATED_ISSUE_DISPLAY for related issues if it has been defined.
REPORT_SUPPRESS_BLANK_LINES YES If YES, the detailed report will suppress any row where the data values are all null. Valid values are YES and NO. This is used to shorten the length of reports that may contain a significant amount of blank cells.  Note that if any field or files on the detailed report layout span more than a single row, and if the value is YES, then the setting is ignored
REPORT_TABLE_WIDTH 100% This setting controls the width of displayed information and tables on all the query screens and the home page report widths. The most common setting is to use 100% as the value, but the setting can be an absolute number of pixels for the width of objects on most screens presented to end users
REPORT_WITH_FIXED_WIDTH_FONT NO When this is set to YES, fields with a display type of "text area" and "log area" will display their contents with the FIXED_WIDTH_FONT. When this field is set to NO, these fields will display their contents using the DEFAULT_FONT. Note that this setting also applies to the display of log area fields on the edit screen.
RESTRICT_ROLE_BASED_REPORTS   Any report created for * All Roles * is visible to everyone that means RESTRICT_ROLE_BASED_REPORTS behavior setting is ignored if a report is created for All Roles. If the setting of RESTRICT_ROLE_BASED_REPORTS is left blank, all users will see all reports that match the role(s) they may adopt, if the role has been given access to role-based reports. If the setting of RESTRICT_ROLE_BASED_REPORTS is set to COMPANY_NAME, users will see all reports that match the role(s) they have, and that have been created by a user with the same company name as their user account, if the role has been given access to role-based reports. If the setting of RESTRICT_ROLE_BASED_REPORTS is set to COMPANY_NAME_OR_ADMIN, users will see all reports that match the role(s) they have, and that have been created by a user with the same company name as their user account or that were created by the ADMIN user, if the role has been given access to role-based reports. This setting does not affect reports saved for shared reports - all shared reports are available to all users, if their role has permission to that type of shared report via the security permission keys.
RID_PAGING_DEFAULTS 0,0 This behavior setting determines whether the results returned within a related issue display are paged, with Next and Previous buttons to move between pages.  The page size and the minimum number of rows where related issue displays are rendered in pages are separated by commas. A page size of 0 is unlimited, resulting in no paging.
THUMBNAIL_THROTTLE 50,1000,1000 This setting is comprised of three numbers separated by commas that determine how thumbnail images are rendered on detailed reports and edit screens.  The first number is the minimum number of attachments before the throttle is applied. A value of 0 disables throttling. The second, optional, number is the interval in milliseconds between rendering of thumbnails.  The third, optional, number is the delay in milliseconds before the first thumbnail on the page is rendered.