PROMPTEX parameter

Specifies values for parameter fields in a report. See also PROMPT# parameter.

There are two different methods for using this parameter.

Method 1

PROMPTEX-<promptname>[@<subrpt>]=<value>

<promptname> and <subrpt> are non-empty strings that represent names of a parameter field prompt and a subreport that are defined in the report.

<value> is a single or multivalued string.

For example:

• http://myServer/myVirtualDirectory/viewrpt.cwr?id=152&apstoken=A1B2&promptex-sample="hello"
• http://myServer/myVirtualDirectory/viewrpt.cwr?id=152&apstoken=A1B2&promptex-sample@mysubrpt="hello"

Note:    

• If an existing report is inserted as the subreport, then the subreport name includes the file extension. For example:

  user0@subreportname.rpt

  However, if the subreport was created inside the main report (with Insert Subreport and using the Report Expert to create the new report), then unless one is added in the Report Name text box in the Insert Subreport dialog box, the name of the subreport usually does not contain a file extension. For example:

  prompt0@subreport

• The left-hand side and right-hand side of a prompt expression are submitted as encoded strings. This allows for arbitrary prompt names and arbitrary string values. The encoding of the string values can be any character set. Java and ActiveX viewers use UTF8 encoding.

Remarks

The Promptex parameter is an enhanced version of an older Prompt# parameter. In the enhanced notation, quotation marks are used around parameter values to indicate string values. All parameter values are passed to the report as strings, and intended numeric values are translated from strings to numbers by the report.

Note:    A backslash \ acts as an escape, so it is substituted by the character that follows it. Quotation marks and backslashes need to be escaped as they are reserved URL characters.

For example:

promptex-sample="Welcome to the \"real\" world"

If the report contains more than one parameter field, multiple values can be passed to parameters.

For example:

promptex-sample="6","1","45"

The enhanced notation also allows for single and multiple range values.

For example:

promptex-sample=["5"-"7"],["1"-"23"],null

The following lists the types of bounded and unbounded intervals you can use.

Bounded interval	Unbounded intervals
["<value>"-"<value>"]	("<value>"-)
("<value>"-"<value>"]	["<value>"-)
["<value>"-"<value>")	(-"<value>")
("<value>"-"<value>")	(-"<value>"]

A square bracket indicates that the interval is closed at that end, and that the specified number is included in the range; a round bracket indicates that the interval is open at that end, and that the specified number is not included in the range.

For example:

• promptex-sample=("5"-"11")

  Specifies a range of all values between 5 and 11, not including 5 and 11 themselves.

• promptex-sample=["5"-"11")

  Specifies a range of all values between 5 and 11, including 5 but not 11.

• promptex-sample=(-"11")

  Specifies a range of all values up to, but not including, 11.

Method 2

PROMPTEX#=<value>

For example:

promptex0="CA"

Remarks

If the report contains more than one parameter field, multiple values can be passed to parameters by incrementing the PROMPT index value. For example:

promptex0="CA"&promptex1="1000"

Prompts can be specified in the URL in any order; for example, promptex1 can appear before promptex0. However, index numbers must match the order that the prompts appear in the report.

Note:    Reports that have the PROMPTEX# parameter applied do not have their pages shared. Caching will be by user.