QPR Web Views - Revision history

Ollvihe at 15:56, 1 December 2018

2018-12-01T15:56:30Z

Ollvihe: /* Template Tag */

2018-08-28T06:58:50Z

Template Tag

Ollvihe: /* Loop Tag */

2018-08-28T06:58:37Z

Loop Tag

Ollvihe: /* Working with Templates */

2018-03-23T15:05:35Z

Working with Templates

Ollvihe: /* Attribute Tag (att) */

2018-03-23T15:03:50Z

Attribute Tag (att)

Ollvihe: /* Expression Tag (exp) */

2018-03-23T15:02:30Z

Expression Tag (exp)

Ollvihe: /* Parameter Tag (par) */

2018-03-23T15:01:39Z

Parameter Tag (par)

Ollvihe: /* Template Tag */

2018-03-23T15:01:13Z

Template Tag

Ollvihe: /* Templatesettings Tag */

2018-03-23T15:00:03Z

Templatesettings Tag

Ollvihe: /* Setting Content Visibility */

2018-03-23T14:59:25Z

Setting Content Visibility

@@ Line 104: / Line 104: @@
 |- style="vertical-align:top;"
 |visible (boolean)
-||Determines content visibility shown by the tag. See [[Reporting Add-on#Setting Content Visibility|Setting Content Visibility]]. (optional)
+||Determines content visibility shown by the tag. See [[QPR Reporting Add-on#Setting Content Visibility|Setting Content Visibility]]. (optional)
 |}
@@ Line 160: / Line 160: @@
 | footertemplatedata (byte array) || Alternative to footer template. Contains the used footer template as a byte array. (optional)
 |- style="vertical-align:top;"
-| visible (boolean) || Determines content visibility shown by the tag. See [[Reporting Add-on#Setting Content Visibility|Setting Content Visibility]]. (optional)
+| visible (boolean) || Determines content visibility shown by the tag. See [[QPR Reporting Add-on#Setting Content Visibility|Setting Content Visibility]]. (optional)
 |- style="vertical-align:top;"
 | (all other attributes) || All other attributes are passed to the looped template as parameters. Note that all the above mentioned attributes are not passed as parameters, because they have a special meaning in the Dataset tag. (optional)
@@ Line 178: / Line 178: @@
 |- style="vertical-align:top;"
 |visible (boolean)
-||Determines content visibility shown by the tag. See [[Reporting Add-on#Setting Content Visibility|Setting Content Visibility]]. (optional)
+||Determines content visibility shown by the tag. See [[QPR Reporting Add-on#Setting Content Visibility|Setting Content Visibility]]. (optional)
 |}
@@ Line 208: / Line 208: @@
 | tplexpression || Expression defining the template. Alternative to tpl or templatedata. (optional)
 |- style="vertical-align:top;"
-| templatedata || Looped template file as a byte array. See available function from [[Reporting Add-on#Binary Data Functions|Binary Data Functions]]. (optional)
+| templatedata || Looped template file as a byte array. See available function from [[QPR Reporting Add-on#Binary Data Functions|Binary Data Functions]]. (optional)
 |- style="vertical-align:top;"
 | query || This is passed as a parameter '''query''' of '''QueryObjects''' method.
@@ Line 234: / Line 234: @@
 | list || List of items as an array that is looped through instead of a QPR Web Service query. When this attribute is used, no QPR Web Service query is made, and thus the following attributes are ignored: query, criteria, sortby attributes, and options. (optional)
 |- style="vertical-align:top;"
-| visible || Determines content visibility shown by the tag. See [[Reporting Add-on#Setting Content Visibility|Setting Content Visibility]]. (optional)
+| visible || Determines content visibility shown by the tag. See [[QPR Reporting Add-on#Setting Content Visibility|Setting Content Visibility]]. (optional)
 |- style="vertical-align:top;"
 | (all other attributes) || All other attributes are passed to the looped template as parameters. Note that all the above mentioned attributes are not passed as parameters, because they have a special meaning in the Loop tag. (optional)
@@ Line 299: / Line 299: @@
 |- style="vertical-align:top;"
 |templatedata (byte array)
-||Looped template file as a byte array. See available functions in expression language documentation in [[Reporting Add-on#QPR Web Services Extensions Expression Language|QPR Web Services Extensions Expression Language]]. (optional)
+||Looped template file as a byte array. See available functions in expression language documentation in [[QPR Reporting Add-on#QPR Web Services Extensions Expression Language|QPR Web Services Extensions Expression Language]]. (optional)
 |- style="vertical-align:top;"
 |passallparameters (boolean)
@@ Line 305: / Line 305: @@
 |- style="vertical-align:top;"
 | visible (boolean)
-||Determines content visibility shown by the tag. See [[Reporting Add-on#Setting Content Visibility|Setting Content Visibility]]. (optional)
+||Determines content visibility shown by the tag. See [[QPR Reporting Add-on#Setting Content Visibility|Setting Content Visibility]]. (optional)
 |- style="vertical-align:top;"
 |(all other attributes)
@@ Line 342: / Line 342: @@
 * calculated using an expression, such as '''visible=="[typename]='Activity'"'''.
-See [[Reporting Add-on#QPR Web Services Extensions Expression Language|QPR Web Services Extensions Expression Language]] for available functions and more information of the expression language.
+See [[QPR Reporting Add-on#QPR Web Services Extensions Expression Language|QPR Web Services Extensions Expression Language]] for available functions and more information of the expression language.
 When writing tags, character escaping is required. There are three levels of escaping, explained by the following table.

@@ Line 296: / Line 296: @@
 |- style="vertical-align:top;"
 |tpl (string)
-||Template name (without file type extension in file system templates). For more information see [[Reporting Add-on#Working with Templates|Working with Templates]]. (optional)
+||Template name (without file type extension in file system templates). For more information see [[#Working with Templates|Working with Templates]]. (optional)
 |- style="vertical-align:top;"
 |templatedata (byte array)

@@ Line 204: / Line 204: @@
 !Description
 |- style="vertical-align:top;"
-| tpl || Template name for the looped content (without the file type extension in file system templates). For more information see [[Reporting Add-on#Working with Templates|Working with Templates]]. (optional)
+| tpl || Template name for the looped content (without the file type extension in file system templates). For more information see [[#Working with Templates|Working with Templates]]. (optional)
 |- style="vertical-align:top;"
 | tplexpression || Expression defining the template. Alternative to tpl or templatedata. (optional)

@@ Line 37: / Line 37: @@
 |}
-==Working with Templates==
+== Working with Templates ==
+QPR Web Views is based on text templates files. When a web view is called, a template is taken as a basis, and all tags in the template are processed. Templates are stored in the server disk. Template files have extension '''tpl'''. The result content fetched using http have in http response header '''Content-Type: text/html; charset=utf-8.'''
 Templates may be organized in folders. Folders inside folders are also supported. Template root location is determined by configuration setting '''templatephysicalpath'''.
 There are two ways to reference templates:
-* '''absolute''': Absolute paths start with / and they contain the full path to the template starting from the templates root. Example: '''/folderName1/folderName2/templateName.
+When a web view processing fails, an html page showing an error message is displayed. The error message a likely to reveal, in which template and tag the error occurred.
 ==Template Tags==

@@ Line 88: / Line 88: @@
 ! Description
 |- style="vertical-align:top;"
-| object || Object id or list of object id’s separated by comma (,). If this contains only one id, it is passed as a parameter '''objectId''' of '''GetAttributeAsString''' method. If this attribute is not provided or is empty, the tag will be evaluated to empty. (optional)
+|object (string)
 |- style="vertical-align:top;"
-| attribute || This is passed as parameter '''attribute''' of '''GetAttributeAsString''' or '''QueryObjects''' method.
+|attribute (string)
 |- style="vertical-align:top;"
-| options ||  This is passed as parameter options of '''GetAttributeAsString''' or '''QueryObjects''' method. (optional)
+|options (string)
 |- style="vertical-align:top;"
-| expression || An expression where the result is placed as an argument "value" (see the examples). (optional)
+|expression (expression string)
 |- style="vertical-align:top;"
-| followrelations  || Name of the relation attributes to follow to get another object or a set of other objects. If there are multiple subsequent relations to follow, the relations are separated by comma (,) (see the examples). (optional)
+|followrelations (string)
 |- style="vertical-align:top;"
-| separator || Character(s) separating list of attributes of different objects. Empty values are not shown (i.e. no empties between separators). Default is a new line (<nowiki><br /></nowiki>). (optional)
+|separator (string)
 |- style="vertical-align:top;"
-| sortby || Sorting if there are multiple objects returned. Default sorting is by name. (optional)
+|sortby (string)
 |- style="vertical-align:top;"
-| visible || Determines content visibility shown by the tag. See [[Reporting Add-on#Setting Content Visibility|Setting Content Visibility]]. (optional)
+|visible (boolean)
 |}

@@ Line 250: / Line 250: @@
 !Description
 |- style="vertical-align:top;"
-| inputname || Name of the parameter (url parameter name or a parameter name passed to template)
+|inputname (string)
 |- style="vertical-align:top;"
-| outputname || Parameter name used in the template. Makes it possible to use a parameter with different name than the input name. If output value is not defined, output value is same as input value. (optional)
+|outputname (string)
 |- style="vertical-align:top;"
-| defaultvalue || The default value is used when a parameter value is not passed to the template. If no default value is defined and no parameter value is passed, an error occurs. (optional)
+|defaultvalue (object)
 |}

@@ Line 275: / Line 275: @@
 | contenttype (string) || Http response’s Content-Type header when QPR Web Views data is requested. This setting only have an effect in the top level template. Default value is '''text/html'''. E.g. '''application/xml''' can be used for xml data. Available values: http://www.freeformatter.com/mime-types-list.html. (optional)
 |- style="vertical-align:top;"
-| contentdisposition || Alternative values are "attachment" and "inline". This is the http response’s content disposition’s disposition type. Default value is attachment. For more information: https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Disposition. (optional)
+| contentdisposition (string)
 |- style="vertical-align:top;"
 | filename (string) || Filename is used with the contentdisposition attribute defined above. More information: https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Disposition. (optional)

@@ Line 355: / Line 355: @@
 If an expression tag returns a datetime value, it is implicitly converted to string if it’s shown in the web view. Templatesettings tag’s dateformat parameter is used for this.
-==Setting Content Visibility==
+== Setting Content Visibility ==
+Most tags support parameter '''visible,''' which is used to hide the content the tag is about to add. Available values are '''true''' (shown) or '''false''' (hidden). Also the ''visible'' parameter can be defined using expressions. Visible tag is optional, and by default its value is true (i.e. the tag is shown).
 When a tag is set to hidden, its expressions are not evaluated nor is related QPR data fetched. The tag may thus contains errors, which don’t emerge if the tag is hidden.
 ==Calling QPR Web Service from JavaScript==