Show TOC

Function documentationQuery Definition: URL Parameters Affecting Query Display Locate this document in the navigation structure

 

URL parameters can be provided in various locations to change the display of query results, usually to override settings in the query definition. These locations include:

  • The URL Parameters field of the report item in the master category, if the report is to be launched from the Analysis page

  • The URL Parameters field of the Workbench channel parameter definition object, for a report channel

  • The Parameters field of a document report configuration

  • A query definition column using SQL to compose a URL to be used as a link to another report

For the report item in the master category and for the document report configuration, the URL parameters are entered as a string value. For example:

&querysuppresstable=FCI-MyQueryDefinition&myotherparam=42

Note Note

Both of the parameters start with an ampersand (&).

End of the note.

For the report channel definition, the URL parameters are also entered as a string value, but the string value must be identified with a Parameter ID of multiquery.urlparams. A sample string value might be:

querySuppressTable=FCI-MyQueryDefinition&myotherparams=42

Note Note

The string does not start with an ampersand, but an ampersand separates additional parameter name=value pairs.

End of the note.

Most of the URL parameters cited below affect chart display.

URL Parameters

chartInvert={ true | <internal-query-name>[,...]}

This parameter enables horizontal bars for a bar or stacking bar chart, rather than the default vertical orientation. The chart expands vertically as more bars or bar clusters are added to the data.

In the case of chartInvert=true, all bar charts in the report will be inverted (made horizontal). Specific charts in a report can be inverted by providing the list of internal query names that contain those charts. The chartInvert parameter has no effect on charts of other types (pie and line).

querySuppressTable={ true |<internal-query-name>[,...]}

This parameter suppresses one or more tables in the report. If the value is true, all the tables in a report are suppressed.

Specific tables can be suppressed by providing the list of internal query names associated with those tables.

querySuppressChart={ true |<internal-query-name>[,...]}

This parameter is used to suppress one or more charts in a report. It is not likely to be used, but is available for completeness.

chartLegendPos={ EAST | SOUTH | NONE } [,<internal-query-name>[ ,...]][: ...]}

The following are examples of this parameter:

  • All charts in the report have the legend positioned on the bottom:

    chartLegendPos=SOUTH

  • One query has a chart in the EAST and two other queries have no legend:

    chartLegendPos=EAST,FCI-GreatStuff:NONE,FCI-Other1,FCI-Other2

Use the following rules for this parameter:

  • If multiple positions must be specified, separate them with a colon (:).

  • If all queries' charts use the same position, do not specify query names.

    chartType={ BAR | PIE | LINE },<internal-query-name>}

A query may have more than one chart definition, each having a different type. The default type to use in the type in the first chart definition in the collection. If a query identified by<internal-query-name> has a chart defined for the specified type that will be used.

This parameter was designed to be generated by a drop-down list of available chart types in the report UI. Since it was not designed for direct report developer use, it does not support multiple queries or allow the query name to be omitted. However, it is available if it is necessary to change the default chart type of one query in the report.

reportFormatDirectives

The URL parameter reportFormatDirectives can be added to any report entry in the Analysis page, to any report document configuration, or any link composed in query results that launches a report. Each directive would be in the value of this parameter, separated by a comma. The formatting directives are as follows:

  • suppressTableGrid: Do not show vertical or horizontal borders for columns and rows

  • suppressTableColumnHeaders: Do not show table column headers

  • suppressTableQueryDisplayName: Do not show query display name above table

  • suppressTableToolbar: Do not show block w/ Find controls and export control for table

The directives can be used independently or together. The following example suppresses the controls that appear above the table data in a report:

&reportFormatDirectives=suppressTableGrid,suppressTableColumnHeaders,suppressTableToolbar