Home >	Contents >

Alpha TOC   |    Annotated TOC

param

Defines a parameter in the given context.

Syntax

<param
       name="reference to parameter"
       type="list type"
       value="parameter value"
      [required="true|false"]
       key="true|false"
      [default="default value"]
       glue="true|false"
      [checksqlinject="replaces 'to'"]
      [namesg="displayed if missing parameter is required"]
      [translate="true|false"]
	/>

Attributes

Name	Type	Required?	Default value	Description
name	string	✓	No default value.	Used as a reference to the parameter.
type	list (string|sql| reportparametertable| request|rssum|rsavg| rsmin|rsmax|sqljoin)	✓	No default value.	Types sql and sqljoin require a ‹query› sub tag. The result set parameter (rssum, rsavg, rsmax, rsmin) can be used only as a sub tag of a sql tag.
value	string	@type=[rs*] true, else false.	Null	Initial value of the parameter.
required	boolean	Χ	False	When a required parameter is null and a sub tag of a report, then the report will not be displayed. When the parameter is null and a sub tag of a module, the module will be ignored.
key	boolean	@type=request true, else false.	No default value.	HTTP request key used for the parameter.
default	string	Χ	Null	Default value for the parameter if it is null.
glue	string	@type=sqljoin true, else false.	No default value.	Used to generate comma-separated lists.
checksqlinject	boolean	Χ	True	Replaces 'to'.
namsg	string	Χ	No Default value.	Message that is displayed when a required parameter is missing.
translate	boolean	Χ	False	If this attribute is set to true, the value will be translated.

Children

<restriction>

<paramprocessing>

<query> (@type=[sql|sqljoin]).

Parents

<filter>

<globalparams>

<module>

<paramprocessing>

<report>

<sql>

Example

<param type="request" name="dmode" key="dmode" required="true" default="days"
	<restriction type="listvalue">
		<restrictionvalue value="days"/>
		<restrictionvalue value="weeks"/>
		<restrictionvalue value="months"/>
	</restriction>
</param>

See Also

<restrictionvalue>

		Home >	Contents >
	Oracle WebCenter Sites 11gR1 | Analytics Tag Reference Copyright 2012 by Oracle Corporation All rights reserved.