Difference between revisions of "QPR PowerPoint Reports"

From Mea Wiki
Jump to navigation Jump to search
Line 17: Line 17:
 
|| Default image format for QPR Web Service’s GetGraph operation. This setting is used if image format is not explicitly defined.
 
|| Default image format for QPR Web Service’s GetGraph operation. This setting is used if image format is not explicitly defined.
 
|}
 
|}
 +
 +
==== Attribute Tag (att) ====
 +
Attribute tag is used to show a property of an object. The attribute value is fetched by using QPR Web Service’s '''GetAttributeAsString''' method (more information: http://kb.qpr.com/qpr2017-1/index.html?getattributeasstring.htm). This tag uses '''QueryObjects''' instead, if there are multiple id's in the '''object''' attribute or if attribute '''followrelations''' used (more information below). If QueryObjects is used, '''separator''' and '''sortby''' attributes are applied.
 +
 +
{| class="wikitable"
 +
! Attribute
 +
!Description
 +
|- style="vertical-align:top;"
 +
|object (string)
 +
||A single object id or a comma separated list of object id's. If there is only one object, it is passed as a parameter '''objectId''' of '''GetAttributeAsString''' method. If there are no object id's at all, the tag result will be empty. (optional)
 +
|- style="vertical-align:top;"
 +
|attribute (string)
 +
||Attribute name to be shown. This is passed as a parameter '''attribute''' of '''GetAttributeAsString''' or '''QueryObjects''' method.
 +
|- style="vertical-align:top;"
 +
|options (string)
 +
||This is passed as a parameter '''options''' of '''GetAttributeAsString''' or '''QueryObjects''' operation. (optional)
 +
|- style="vertical-align:top;"
 +
|expression (exp. string)
 +
||An expression used to modify the returned attribute values, e.g. to make conversions etc. The attribute value is placed as an argument "value" to this expression (see the examples). (optional)
 +
|- style="vertical-align:top;"
 +
|followrelations (string)
 +
||Name of the relations 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)
 +
|- style="vertical-align:top;"
 +
|separator (string)
 +
||If multiple objects are defined, this property defined the character(s) separating the shown attributes of multiple objects. Empty values are not shown (i.e. no empties between separators). Default is a new line character. (optional)
 +
|- style="vertical-align:top;"
 +
|sortby (string)
 +
||Applied sorting if there are multiple objects returned. Default sorting is by attribute "name". (optional)
 +
|- style="vertical-align:top;"
 +
| visible (boolean)
 +
||Determines content visibility shown by the tag. (optional)
 +
|}
 +
 +
'''Examples'''
 +
<pre>
 +
<#attribute object=="[objectId]" attribute="name">
 +
<#attribute object=="[measureId]" attribute="measure.value(series=\"ACT\",period=\"1 / 2018\")" expression="[value] * 2.54">
 +
<#attribute object=="[measureId]" followrelations="childobjects,childobjects"attribute="measure.value(series=\"ACT\",period=\"1 / 2017\")" separator=", " sortby="name">
 +
</pre>
  
 
====Link Tag====
 
====Link Tag====
 
 
Link tag is used to add a hyperlink to a slide. If the link address is empty or someways invalid, no link is displayed. Note that the tag generates the hyperlink, so the report template should not contain a the desired hyperlink (only the tag in a textual form).
 
Link tag is used to add a hyperlink to a slide. If the link address is empty or someways invalid, no link is displayed. Note that the tag generates the hyperlink, so the report template should not contain a the desired hyperlink (only the tag in a textual form).
  

Revision as of 21:23, 21 March 2018

Note: This page contains documentation of functionality that hasn't been released yet.

Configuration

Following table contains QPR PowerPoint Reports’ parameters, which are configured in the web.config file of QPR Web Services Extensions.

Parameter name Description
reporttemplateparameter (optional) Defines the name of the parameter which passes the report template path. See chapter Working with Report Templates for configuring the report template path.
qprtemplateidparameter (optional) Parameter name which passes QPR’s Word report template object id.

This can be used when the report templates are stored in QPR Portal (i.e. QPR system objects) (see chapter Working with Report Templates). Instead of report template path, the Word report template object id can be passed as a parameter. The Word report template object id gets a priority over report template path.

defaultimageformat (optional) Default image format for QPR Web Service’s GetGraph operation. This setting is used if image format is not explicitly defined.

Attribute Tag (att)

Attribute tag is used to show a property of an object. The attribute value is fetched by using QPR Web Service’s GetAttributeAsString method (more information: http://kb.qpr.com/qpr2017-1/index.html?getattributeasstring.htm). This tag uses QueryObjects instead, if there are multiple id's in the object attribute or if attribute followrelations used (more information below). If QueryObjects is used, separator and sortby attributes are applied.

Attribute Description
object (string) A single object id or a comma separated list of object id's. If there is only one object, it is passed as a parameter objectId of GetAttributeAsString method. If there are no object id's at all, the tag result will be empty. (optional)
attribute (string) Attribute name to be shown. This is passed as a parameter attribute of GetAttributeAsString or QueryObjects method.
options (string) This is passed as a parameter options of GetAttributeAsString or QueryObjects operation. (optional)
expression (exp. string) An expression used to modify the returned attribute values, e.g. to make conversions etc. The attribute value is placed as an argument "value" to this expression (see the examples). (optional)
followrelations (string) Name of the relations 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)
separator (string) If multiple objects are defined, this property defined the character(s) separating the shown attributes of multiple objects. Empty values are not shown (i.e. no empties between separators). Default is a new line character. (optional)
sortby (string) Applied sorting if there are multiple objects returned. Default sorting is by attribute "name". (optional)
visible (boolean) Determines content visibility shown by the tag. (optional)

Examples

<#attribute object=="[objectId]" attribute="name">
<#attribute object=="[measureId]" attribute="measure.value(series=\"ACT\",period=\"1 / 2018\")" expression="[value] * 2.54">
<#attribute object=="[measureId]" followrelations="childobjects,childobjects"attribute="measure.value(series=\"ACT\",period=\"1 / 2017\")" separator=", " sortby="name">

Link Tag

Link tag is used to add a hyperlink to a slide. If the link address is empty or someways invalid, no link is displayed. Note that the tag generates the hyperlink, so the report template should not contain a the desired hyperlink (only the tag in a textual form).

Attribute Description
address (string) Url address (location) which hyperlink to pointing to.
text (string) Link’s displayed text.
screentip (string) Link’s screen tip. (optional)
target (string) Link’s target. (optional)
visible (boolean) Determines content visibility shown by the tag. (optional)

Example

<#link address=="getPortalUrl([diagramid], '', '')" text="Link to QPR Portal" target="_BLANK" screentip="Click here is go to QPR Portal">