QPR Word Reports - Revision history

Ollvihe at 22:12, 19 June 2024

2024-06-19T22:12:51Z

Ollvihe: /* Best Practices for Developing Reports */

2024-06-04T17:06:40Z

Best Practices for Developing Reports

Ollvihe at 10:31, 3 June 2024

2024-06-03T10:31:04Z

Ollvihe at 10:30, 3 June 2024

2024-06-03T10:30:25Z

Ollvihe: /* Introduction to QPR Word Reports */

2022-02-20T23:01:46Z

Introduction to QPR Word Reports

Ollvihe: /* Introduction to QPR Word Reports */

2022-02-20T21:42:26Z

Introduction to QPR Word Reports

Ollvihe: /* Configuration */

2022-02-20T21:35:47Z

Configuration

Ollvihe: /* Introduction to QPR Word Reports */

2022-02-20T21:35:21Z

Introduction to QPR Word Reports

Ollvihe at 21:29, 20 February 2022

2022-02-20T21:29:53Z

Ollvihe: /* Configuration */

2022-02-20T21:27:24Z

Configuration

@@ Line 16: / Line 16: @@
 * Templates contain tags, which instruct how the content is added to the report and how dynamic parts of the report are built.
 * Tags contain attributes, which offer additional information for the tag.
-* QPR Web Service is used through its operations. Operations used by QPR Word Reports are GetAttributeAsString, QueryObjects, GetGraph, GetBinaryData and GetPortalUrl. All QPR Web Service operations are documented under http://kb.qpr.com/qpr2017-1/index.html?functions.htm.
+* QPR Web Service is used through its operations. Operations used by QPR Word Reports are GetAttributeAsString, QueryObjects, GetGraph, GetBinaryData and GetPortalUrl. All QPR Web Service operations are documented under http://kb.qpr.com/qpr2023-1/index.html?functions.htm.
 * Subreport is a report that is called from another report (main report). The subreport is processed like any report and its contents are embedded in the main report. Main report may pass parameters to the subreport.
 * Loop is a list of QPR system objects (elements) returned by QPR Web Service’s QueryObjects operation. In a loop, a subreport is called for every looped object.
@@ Line 86: / Line 86: @@
 ===Attribute Tag (att)===
-This tag is used to get properties of QPR objects by using QPR Web Service’s '''GetAttributeAsString''' method (more information: http://kb.qpr.com/qpr2017-1/index.html?getattributeasstring.htm).
+This tag is used to get properties of QPR objects by using QPR Web Service’s '''GetAttributeAsString''' method (more information: http://kb.qpr.com/qpr2023-1/index.html?getattributeasstring.htm).
 This tag uses '''QueryObjects''' instead of GetAttributeAsString, 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
@@ Line 116: / Line 116: @@
 <pre>
 <#attribute object=="[objectId]" attribute="name">
-<#attribute object="[measureId]" attribute="measure.value(series=\"ACT\",period=\"1 / 2017\")" expression="[value] * 2.54">
+<#attribute object="[measureId]" attribute="measure.value(series=\"ACT\",period=\"1 / 2023\")" expression="[value] * 2.54">
-<#attribute object=="[measureId]" followrelations="childobjects,childobjects"attribute="measure.value(series=\"ACT\",period=\"1 / 2017\")" separator=", " sortby="name">
+<#attribute object=="[measureId]" followrelations="childobjects,childobjects"attribute="measure.value(series=\"ACT\",period=\"1 / 2023\")" separator=", " sortby="name">
 </pre>
@@ Line 243: / Line 243: @@
 ===Image Tag===
-This tag is used to show an image in the report. Images can be got using QPR Web Service’s '''GetGraph''' method, which can be used to get graphical content from QPR system, such as EA/PD diagrams, Metrics dashboards or measure graphs. For more information about GetGraph, see http://kb.qpr.com/qpr2017-1/index.html?ws_getgraph.htm.
+This tag is used to show an image in the report. Images can be got using QPR Web Service’s '''GetGraph''' method, which can be used to get graphical content from QPR system, such as EA/PD diagrams, Metrics dashboards or measure graphs. For more information about GetGraph, see http://kb.qpr.com/qpr2023-1/index.html?ws_getgraph.htm.
 When getting images using http, many kind of errors may be encountered, such as the image is not found, it’s not available, or user rights restrict. In case an image cannot be got, the report run still succeeds. If the reason for the error is not known, it’s possible to see the http error message by using the '''loggingmode'''. Note also the '''noimagemessage''' attribute which is used in case of these errors.
@@ Line 347: / Line 347: @@
 ===Loop Tag===
 This tag is for looping through content in following alternative ways:
-* Set of QPR elements defined by a QPR Web Service query (for more information of QueryObjects, see http://kb.qpr.com/qpr2017-1/index.html?queryobjects.htm).
+* Set of QPR elements defined by a QPR Web Service query (for more information of QueryObjects, see http://kb.qpr.com/qpr2023-1/index.html?queryobjects.htm).
 * List of strings (using attribute '''list'''). The list itself is a string where items are separated using defined character.

@@ Line 541: / Line 541: @@
 ==Best Practices for Developing Reports==
-* '''Use the QPR Web Services tester''': Most of the errors are related to QPR Web Services query or the expression language syntax. That’s why, before placing queries to QPR Word Reports templates, use the QPR Web Services tester to check that the query syntax is right.
+* '''Use QPR Web Services tester to create queries''': Usually the errors are related to QPR Web Services queries or the expression language syntax. That’s why, before placing queries to QPR Word Reports templates, use the QPR Web Services tester to check that the query syntax is right.
 * '''Use descriptive names for templates and variables''': Prefer names that describe content of report or variables.
-* '''Use subreports to reuse report parts''': If there are parts in a report that are structurally same, they can be put in a subreport and reused by calling the subreport with different parameters.
+*'''Prefer to run the logic in QPR Web Service''': When possible, write the logic to the QPR Web Service queries instead of report expressions because it offers performance advantages when round trips to Web Service are reduced.

@@ Line 110: / Line 110: @@
 | visible (boolean) || Determines content visibility shown by the tag. See [[QPR_Word_Reports#Setting Content Visibility|Setting Content Visibility]]. (optional)
 |- style="vertical-align:top;"
-| style (string) || Determines text style. See [[QPR_Word_Reports#Defining Styles|Defining Styles]]. (optional)
+| style (string) || Determines text style. See [[QPR_Word_Reports#Defining_Document_Styles|Defining Styles]]. (optional)
 |}
@@ Line 233: / Line 233: @@
 | visible (boolean) || Determines content visibility shown by the tag. See [[QPR_Word_Reports#Setting Content Visibility|Setting Content Visibility]]. (optional)
 |- style="vertical-align:top;"
-| style (string) || Determines text style. See [[QPR Reporting Add-on#Defining Styles|Defining Styles]]. (optional)
+| style (string) || Determines text style. See [[QPR_Word_Reports#Defining_Document_Styles|Defining Styles]]. (optional)
 |}
@@ Line 309: / Line 309: @@
 | visible (boolean) || Determines content visibility shown by the tag. See [[QPR_Word_Reports#Setting Content Visibility|Setting Content Visibility]]. (optional)
 |- style="vertical-align:top;"
-| style (string) || Determines text style. See [[QPR Reporting Add-on#Defining Styles|Defining Styles]]. (optional)
+| style (string) || Determines text style. See [[QPR_Word_Reports#Defining_Document_Styles|Defining Styles]]. (optional)
 |}
@@ Line 336: / Line 336: @@
 | visible (boolean) || Determines content visibility shown by the tag. See [[QPR_Word_Reports#Setting Content Visibility|Setting Content Visibility]]. (optional)
 |- style="vertical-align:top;"
-| style (string) || Determines text style. See [[QPR Reporting Add-on#Defining Styles|Defining Styles]]. (optional)
+| style (string) || Determines text style. See [[QPR_Word_Reports#Defining_Document_Styles|Defining Styles]]. (optional)
 |}

@@ Line 110: / Line 110: @@
 | visible (boolean) || Determines content visibility shown by the tag. See [[QPR_Word_Reports#Setting Content Visibility|Setting Content Visibility]]. (optional)
 |- style="vertical-align:top;"
-| style (string) || Determines text style. See [[QPR Reporting Add-on#Defining Styles|Defining Styles]]. (optional)
+| style (string) || Determines text style. See [[QPR_Word_Reports#Defining Styles|Defining Styles]]. (optional)
 |}

@@ Line 2: / Line 2: @@
 QPR Word Reports is a technology to generate Word (.docx) and pdf reports displaying content from QPR systems. QPR Word Reports works in IIS as a web application, and reports are accesses by a url address. Data for reports is fetched from QPR systems using QPR Web Service interfaces. QPR Word Reports generates Open XML documents, which can be opened in Microsoft Office or OpenOffice.
-Pdf reports are created by converting a generated Word documents into pdf, and thus templates for the pdf reports are same Word templates as for the Word reports. The pdf reports are very versatile and support practically all features that Word reports are able to show. By default, the created report is in the Word format, but when adding a parameter ''reportformat=pdf'', the report is generated as pdf.
+Pdf reports are created by converting a generated Word document into pdf. Templates for the pdf reports are same Word templates as for the Word reports. The pdf reports are very versatile and support practically all features that the Word reports are able to show. By default, the created report is in the Word format, and when adding a parameter ''reportformat=pdf'' to the request url, the report is generated as pdf.
 QPR Word Reports contains the following main features:
@@ Line 43: / Line 43: @@
 !Description
 |- style="vertical-align:top;"
-| reporttemplateparameter (optional) || Defines the name of the parameter which passes the report template path. See chapter [[##Working_With_Report_Templates|Working with Report Templates]] for configuring the report template path. The default value is '''report'''.
+| reporttemplateparameter (optional) || Defines name of the parameter which passes the report template path. See chapter [[##Working_With_Report_Templates|Working with Report Templates]] for configuring the report template path. The default parameter name is '''report'''.
 |- style="vertical-align:top;"
-| reportformatparameter (optional) ||Defines the name of the parameter which passes the asked report format QPR Word Reports. The default value is '''reportformat'''. The actual parameter can have values '''docx''' or '''pdf''' depending on which format is desired. Media type in the http response for the Word reports is ''application/vnd.openxmlformats-officedocument.wordprocessingml.document'' and for the pdf reports ''application/pdf''.
+| reportformatparameter (optional) ||Defines name of the parameter which passes the desired report format. The default parameter name is '''reportformat'''. The parameter can have values '''docx''' or '''pdf''' depending on which format is desired. Media type in the http response for Word reports is ''application/vnd.openxmlformats-officedocument.wordprocessingml.document'' and for pdf reports ''application/pdf''.
 |- style="vertical-align:top;"
-| qprtemplateidparameter (optional) || Defines the name of the parameter which passes QPR Word Reports template object id.  The default value is '''qprtemplateid'''. This is used when the report templates are stored in QPR Portal (i.e. QPR system objects) (see chapter [[#Working_With_Report_Templates|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.
+| qprtemplateidparameter (optional) || Defines name of the parameter which passes QPR Word Reports template object id.  The default parameter name is '''qprtemplateid'''. This is used when the report templates are stored in QPR Portal (i.e. QPR system objects) (see chapter [[#Working_With_Report_Templates|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.
 |- style="vertical-align:top;"
 | defaultimageformat (optional) || Default image format for QPR Web Service’s GetGraph operation. This setting is used if image format is not explicitly defined.

@@ Line 1: / Line 1: @@
 == Introduction to QPR Word Reports ==
-QPR Word Reports is a technology to generate Word reports displaying content from QPR systems. QPR Word Reports works in IIS as a web application, and reports are accesses by a url address. Data for reports is fetched from QPR systems using QPR Web Service interfaces. QPR Word Reports generates Open XML documents, which can be opened in Microsoft Office or OpenOffice.
+QPR Word Reports is a technology to generate Word (.docx) and pdf reports displaying content from QPR systems. QPR Word Reports works in IIS as a web application, and reports are accesses by a url address. Data for reports is fetched from QPR systems using QPR Web Service interfaces. QPR Word Reports generates Open XML documents, which can be opened in Microsoft Office or OpenOffice.
 QPR Word Reports contains the following main features:
@@ Line 24: / Line 26: @@
 Reports are accessed using a url address, which determines the report to be run and the url also passes all needed parameters to the report. The url depends on the server computer name and the path where QPR Word Reports is installed in IIS. Note that parameter names are case sensitive.
-Example url to get Word report:
+Example url to get a Word report:
 <pre>
 http(s)://SERVERNAME/QPRWebServicesExtensions/DynamicWordReports.ashx?report=reportname&parameter1=param1value&parameter2=param2value
 </pre>
-Example url to get pdf report:
+Example url to get a pdf report:
 <pre>
 http(s)://SERVERNAME/QPRWebServicesExtensions/DynamicWordReports.ashx?report=reportname&reportformat=pdf&parameter1=param1value&parameter2=param2value
@@ Line 43: / Line 45: @@
 | reporttemplateparameter (optional) || Defines the name of the parameter which passes the report template path. See chapter [[##Working_With_Report_Templates|Working with Report Templates]] for configuring the report template path. The default value is '''report'''.
 |- style="vertical-align:top;"
-| reportformatparameter (optional) ||Defines the name of the parameter which passes the asked report format QPR Word Reports. The default value is '''reportformat'''.
+| reportformatparameter (optional) ||Defines the name of the parameter which passes the asked report format QPR Word Reports. The default value is '''reportformat'''. The actual parameter can have values '''docx''' or '''pdf''' depending on which format is desired. Media type for the Word reports is ''application/vnd.openxmlformats-officedocument.wordprocessingml.document'' and for the pdf reports ''application/pdf''.
 |- style="vertical-align:top;"
 | qprtemplateidparameter (optional) || Defines the name of the parameter which passes QPR Word Reports template object id.  The default value is '''qprtemplateid'''. This is used when the report templates are stored in QPR Portal (i.e. QPR system objects) (see chapter [[#Working_With_Report_Templates|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.