Runtime Parameter Elements - Reporting Dashboards - Foundation 24.1 - Foundation 24.1 - Ready - OnBase - external

Reporting Dashboards

Platform
OnBase
Product
Reporting Dashboards
Release
Foundation 24.1
License

Runtime parameters are added to the Web Viewer URL preceded by an ampersand (&) and in the following pattern, with each element separated by a hyphen (-):

&dpID-ParameterID-ParameterNumber-BinaryOperator-LogicalOperator=Value

The following table describes each element of a runtime parameter.

Parameter

Description

dpID

The data provider ID number, where ID is replaced with the ID number of your data provider (the number must be appended after dp). For example, dp106. This element is required.

The data provider ID number is in the upper right corner of the General tab of the properties window for the data provider.

ParameterID

The runtime parameter ID. This element is required.

The runtime parameter ID is displayed on the Runtime Parameters tab of the properties window for the data provider in the ID column.

ParameterNumber

The sequential number of the parameter in the URL, used to create a unique instance when two or more parameters with the same parameterID are used in the same URL. This element is only required if two or more parameters with the same parameterID are used in the same URL.

For example:

&dp106-statenum-1-eq=oh&dp106-statenum-2-OR-eq=pa

BinaryOperator

The binary operator that describes the relationship between this parameter and the previous parameter. This element is optional and must be either AND or OR.

LogicalOperator

The logical operator used to evaluate the value of the parameter. This element is required and must be eq, gt, gte, lt, lte, neq, in, or nin where:

  • eq is equivalent to =(equal to)

  • gt is equivalent to >(greater than)

  • gte is equivalent to >=(greater than or equal to)

  • lt is equivalent to <(less than)

  • lte is equivalent to <=(less than or equal to)

  • neq is equivalent to <>(not equal to)

  • in indicates that the parameter is contained in the value

  • nin indicates that the parameter is not contained in the value

Note:

If the parameter does not allow the logical operator to be changed at runtime, this setting is ignored.

Value

The value of the parameter, equivalent to what would be entered by a user in the user interface. This element is required.

If the parameter requires a currency value, it must be formatted as a decimal value without any commas. For example, $1,000.00 must be added to the URL as 1000.00:

&dp106-cost-gt=1000.00

If the parameter requires a date-time range for the value, it must be formatted as type:begin:end.

Note:

See the following table for the possible values of type, begin, and end(see Value Parameter Elements).