ReportPortalUserGuide - Portrait Supportsupport.portraitsoftware.com/documentation/Portrait...

36
Report Portal User Guide Version 6.0 SP1

Transcript of ReportPortalUserGuide - Portrait Supportsupport.portraitsoftware.com/documentation/Portrait...

Page 1: ReportPortalUserGuide - Portrait Supportsupport.portraitsoftware.com/documentation/Portrait Dialogue/6.0/2... · Chapter2:Gettingstarted. IfyouhaveReportPortalopen,andopenanotherweblink(forexample,clickingalinkwithin

Report Portal User Guide

Version 6.0 SP1

Page 2: ReportPortalUserGuide - Portrait Supportsupport.portraitsoftware.com/documentation/Portrait Dialogue/6.0/2... · Chapter2:Gettingstarted. IfyouhaveReportPortalopen,andopenanotherweblink(forexample,clickingalinkwithin

© 2013 Pitney Bowes Software Inc. All rights reserved.

This document may contain confidential and proprietary information belonging to Pitney Bowes Inc. and/or itssubsidiaries and associated companies.

Portrait Software, the Portrait Software logo, Portrait, and Portrait Software’s Portrait brand are the trademarksof Portrait Software International Limited and may not be used or exploited in any way without the prior expresswritten authorization of Portrait Software International Limited.

Acknowledgement of trademarks

Other product names, company names, marks, logos and symbols referenced herein may be the trademarksor registered trademarks of their registered owners.

Portrait Software Support

If you need help with something that’s not covered by this documentation, try the Knowledge Base on our website. http://support.portraitsoftware.com and follow the links to your product.

You can also download other Portrait Software documentation from the site. If you don’t have a username andpassword—or you’ve forgotten them—please contact us through one of the channels below.

If you find a problem with the use, installation, or documentation of this product, please contact us using anyof the following methods:

Email:[email protected]

Phone

• USA/Canada 1-800-335-3860 (toll-free)• Rest of world +44 800 840 0001

When you report a problem, it helps if you can tell us:

• The name of the software application• The circumstances in which the problem arose• What error messages you saw (if any);• The version of the software that you were using.

Pitney Bowes Software Inc.

January 02, 2014

Page 3: ReportPortalUserGuide - Portrait Supportsupport.portraitsoftware.com/documentation/Portrait Dialogue/6.0/2... · Chapter2:Gettingstarted. IfyouhaveReportPortalopen,andopenanotherweblink(forexample,clickingalinkwithin

Contents

Chapter 1: Introduction..............................................................................................5Purpose................................................................................................................................6Intended audience...............................................................................................................6Related documentation.......................................................................................................6

Chapter 2: Getting started..........................................................................................7About the Report Portal......................................................................................................8Starting the Report Portal...................................................................................................8The start page......................................................................................................................9Navigating in the Report Portal..........................................................................................9

Chapter 3: Running reports.....................................................................................11Running reports.................................................................................................................12Viewing the generated report...........................................................................................12

Chapter 4: Archived reports.....................................................................................15Archiving reports...............................................................................................................16Viewing archived reports..................................................................................................16

Chapter 5: Viewing reports.......................................................................................19The Files tabbed page.......................................................................................................20The View tabbed page.......................................................................................................20The Details tabbed page...................................................................................................20

Chapter 6: Linking to reports...................................................................................21Linking to the Overview Page..........................................................................................22Linking to Run Report.......................................................................................................22

Page 4: ReportPortalUserGuide - Portrait Supportsupport.portraitsoftware.com/documentation/Portrait Dialogue/6.0/2... · Chapter2:Gettingstarted. IfyouhaveReportPortalopen,andopenanotherweblink(forexample,clickingalinkwithin

Linking to a report's archive............................................................................................24Linking to an archived report...........................................................................................24ISO Latin-1 Character Set.................................................................................................25Report Formats..................................................................................................................32Report View Actions..........................................................................................................32

Portrait Dialogue 6.0 SP14

Page 5: ReportPortalUserGuide - Portrait Supportsupport.portraitsoftware.com/documentation/Portrait Dialogue/6.0/2... · Chapter2:Gettingstarted. IfyouhaveReportPortalopen,andopenanotherweblink(forexample,clickingalinkwithin

1Introduction

In this section:

• Purpose . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .6• Intended audience . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .6• Related documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . .6

Page 6: ReportPortalUserGuide - Portrait Supportsupport.portraitsoftware.com/documentation/Portrait Dialogue/6.0/2... · Chapter2:Gettingstarted. IfyouhaveReportPortalopen,andopenanotherweblink(forexample,clickingalinkwithin

PurposeThis document describes how to use Portrait Dialogue's Report Portal, a web based Customer RelationshipManagement tool.

Intended audienceThis document is intended for people who will use the Report Portal to view, run and save report templates.

Related documentationMedia (zip/dvd) and locationDocument

Portrait Dialogue media in:\Documentation\<language_code>\

PD Visual Dialogue User Guide

Portrait Dialogue media in:\Documentation\<language_code>\

PD Customer View User Guide

Portrait Dialogue media in:\Documentation\<language_code>\

PD Telemarketing User Guide

Portrait Dialogue media in:\Documentation\<language_code>\

PD Web Portal User Guide

All documents are also available on Portrait Software's support website:http://support.portraitsoftware.com

Tip:

Portrait Dialogue 6.0 SP16

Purpose

Page 7: ReportPortalUserGuide - Portrait Supportsupport.portraitsoftware.com/documentation/Portrait Dialogue/6.0/2... · Chapter2:Gettingstarted. IfyouhaveReportPortalopen,andopenanotherweblink(forexample,clickingalinkwithin

2Getting started

In this section:

• About the Report Portal . . . . . . . . . . . . . . . . . . . . . . . . . . . .8• Starting the Report Portal . . . . . . . . . . . . . . . . . . . . . . . . . .8• The start page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .9• Navigating in the Report Portal . . . . . . . . . . . . . . . . . . . . . .9

Page 8: ReportPortalUserGuide - Portrait Supportsupport.portraitsoftware.com/documentation/Portrait Dialogue/6.0/2... · Chapter2:Gettingstarted. IfyouhaveReportPortalopen,andopenanotherweblink(forexample,clickingalinkwithin

About the Report PortalPortrait Dialogue's Report Portal is used by marketers to define, manage and carry out structuredcommunication processes with large numbers of customers, and is specifically designed to support theprinciples of one-to-one marketing.

The Report Portal provides you with an intuitive work environment for running report templates andviewing archived reports.

Starting the Report PortalReport Portal supports two login methods which are set up by your System Administrator:

• Normal login

When using Normal login, you manually enter your username and password. If successfully authorized,you are taken to the overview page.

• Windows login

When using Windows login, you do not have to enter your username and password. You areautomatically authorized and logged in to Report Portal using your Windows domain user credentials.

To use the Windows login option, you must have login rights to the Report Portal, and mustbe logged in to the corporate Windows domain. If not, you are taken to the normal login page.

Note:

When starting Report Portal from Visual Dialogue, you are automatically logged in with theuser credentials used for Visual Dialogue.

Note:

Advanced login

• Instance

When logging on to the Report Portal, the system can be set up to give access to different instances.To access this option, click on the Advanced button in the lower right corner. The window will expandand a drop down box will show available instances. Select the instance and continue.

• Cache

In order to speed up the performance in Report Portal, domain data is cached on the Web server. Thisdata cache has to be recovered when the System Administrator makes changes in the domain data.To access this option, click Advanced ->Clear Cache.

Portrait Dialogue 6.0 SP18

About the Report Portal

Page 9: ReportPortalUserGuide - Portrait Supportsupport.portraitsoftware.com/documentation/Portrait Dialogue/6.0/2... · Chapter2:Gettingstarted. IfyouhaveReportPortalopen,andopenanotherweblink(forexample,clickingalinkwithin

The start pageThe first window displayed when you start Report Portal is the Overview page.

The Overview page has the following:

• Recent viewed reports

This table lists the ten latest reports you have accessed in the report portal.

The table is sorted with the latest accessed reports at the top.

• Available reports

This table lists all available reports, organized in folders.

The number of reports in each folder is given in parentheses to the right of the folder name.

The reports available is dependent on your user rights (see Visual Dialogue - and Dialogue Admindocumentation).

Running reports

In order to run a report shown in either of the tables, click Run report.

See Running reports for details on running reports.

Viewing archived reports

To open a report's archive, click Archived versions. The number of reports archived for a given reportis given in parentheses to the right of the Archived versions.

See Viewing archived reports for details about viewing archived reports.

Navigating in the Report PortalThe Report Portal is a web-based application that runs in Microsoft Internet Explorer. When navigatingthe application, use the Report Portal's built-in navigation functionality and not the browsers Back andForward buttons.

Other navigation tips:

• When generating new reports, or accessing archived reports, you will automatically be taken to thecorrect pages.

• When working with a report template or an archived report, the left menu will automatically be updatedwith the necessary links.

• Use the Report Portal's back button to go back. This will load the page previously accessed.

9Report Portal User Guide

Chapter 2: Getting started

Page 10: ReportPortalUserGuide - Portrait Supportsupport.portraitsoftware.com/documentation/Portrait Dialogue/6.0/2... · Chapter2:Gettingstarted. IfyouhaveReportPortalopen,andopenanotherweblink(forexample,clickingalinkwithin

If you have Report Portal open, and open another web link (for example, clicking a link withinMS Outlook), the new link may open in the same window as Report Portal. To avoid this, changeyour settings in Windows Explorer or open a new explorer window before clicking on the link.

Note:

Portrait Dialogue 6.0 SP110

Navigating in the Report Portal

Page 11: ReportPortalUserGuide - Portrait Supportsupport.portraitsoftware.com/documentation/Portrait Dialogue/6.0/2... · Chapter2:Gettingstarted. IfyouhaveReportPortalopen,andopenanotherweblink(forexample,clickingalinkwithin

3Running reports

In this section:

• Running reports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .12• Viewing the generated report . . . . . . . . . . . . . . . . . . . . . .12

Page 12: ReportPortalUserGuide - Portrait Supportsupport.portraitsoftware.com/documentation/Portrait Dialogue/6.0/2... · Chapter2:Gettingstarted. IfyouhaveReportPortalopen,andopenanotherweblink(forexample,clickingalinkwithin

Running reportsThe reports available in Report Portal is dependent on your user rights (see Visual Dialogue- and DialogueAdmin documentation).

Running a report

In order to run a report in Report Portal, simply open the Overview page, browse to find the desiredreport and click Run report.

This will open the "Run report" page; This is where you set the report parameters and the report format.The page consists of the following:

• Template Details

This table lists all the template's details. Click Show detailed view in order to view all the reporttemplate's details.

• Report Parameters

This table lists all parameters defined for the report, if any.

• Report Format

This table lets you specify the report's format. The two most common formats are directly available,all other formats are listed in the "Other" dropdown-list.

The report's default format is selected by default.

The format can be changed after the report is generated.Note:

Generating the report / Viewing the result

Set the desired parameters and the report's format and click Run report to (run)generate the report;The report will then be generated and displayed on the View report page.

Viewing the generated reportAfter running a report, the result will be displayed on the View report page.

This page is organized with the following tabbed pages:

• Files

Lists all report files.

See The Files tabbed page for details.

• View

Displays the report files inline in your browser.

Portrait Dialogue 6.0 SP112

Running reports

Page 13: ReportPortalUserGuide - Portrait Supportsupport.portraitsoftware.com/documentation/Portrait Dialogue/6.0/2... · Chapter2:Gettingstarted. IfyouhaveReportPortalopen,andopenanotherweblink(forexample,clickingalinkwithin

See The View tabbed page for details.

• Details

Lists details about the report generated.

See The Details tabbed page for details.

• Archiving

This page provides functionality for archiving the generated report.

See the Archiving reports page for details.

Rerunning the report

In order to rerun the report, simply click the Rerun link in the left menu. This will load the Run reportpage, with all parameter values set.

This will unload the report generated. Archive the report first, if desired.Note:

Viewing the report's archive

In order to view the report's archive, simply click the Archive link on the left menu. This will load thereport's archive page, listing all archived version of the report.

This will unload the report generated. Archive the report first if desired.Note:

13Report Portal User Guide

Chapter 3: Running reports

Page 14: ReportPortalUserGuide - Portrait Supportsupport.portraitsoftware.com/documentation/Portrait Dialogue/6.0/2... · Chapter2:Gettingstarted. IfyouhaveReportPortalopen,andopenanotherweblink(forexample,clickingalinkwithin
Page 15: ReportPortalUserGuide - Portrait Supportsupport.portraitsoftware.com/documentation/Portrait Dialogue/6.0/2... · Chapter2:Gettingstarted. IfyouhaveReportPortalopen,andopenanotherweblink(forexample,clickingalinkwithin

4Archived reports

In this section:

• Archiving reports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .16• Viewing archived reports . . . . . . . . . . . . . . . . . . . . . . . . . .16

Page 16: ReportPortalUserGuide - Portrait Supportsupport.portraitsoftware.com/documentation/Portrait Dialogue/6.0/2... · Chapter2:Gettingstarted. IfyouhaveReportPortalopen,andopenanotherweblink(forexample,clickingalinkwithin

Archiving reportsReports generated in Report Portal can be saved to the report's archive.

To do this, run a report and click the Archiving tabbed page when viewing the generated report.

This tabbed page provides functionality for archiving the generated report.

To archive the generated report, enter a name for the archived report and click Archive report.

After the report is archived, a link to the archived report, and a link to the report's archive list are displayed.

Viewing archived reportsIn order to open a report's archive and display an archived report, follow these steps:

1. Open the Overview page.2. Find the report to which archive you want to view and click the Archive link.

This will display the report's archive page. This page consists of the Template Details table and theArchived report versions table (described below).

3. To open one of the archived reports in the list, click the report's name. This will display the archivedreport.

Template details

This table lists all the template's details. Click Show detailed view in order to view all the reporttemplate's details.

Archived report versions

This table lists all archived versions of the report. The table has the following columns:

• Name

The name of the archived report.

• Format

The format of the archived report.

• Date

The time and date the report was archived.

• Delete

Click the "delete icon" in order to delete the archived report. The action must be confirmed.

Clicking Show detailed view replaces the Date column with two new columns:

• Run start

Portrait Dialogue 6.0 SP116

Archiving reports

Page 17: ReportPortalUserGuide - Portrait Supportsupport.portraitsoftware.com/documentation/Portrait Dialogue/6.0/2... · Chapter2:Gettingstarted. IfyouhaveReportPortalopen,andopenanotherweblink(forexample,clickingalinkwithin

Shows the time and date the report started archiving.

This is the same field as the Date column in "normal view".

• Run finished

Shows the time and date the report finished archiving.

17Report Portal User Guide

Chapter 4: Archived reports

Page 18: ReportPortalUserGuide - Portrait Supportsupport.portraitsoftware.com/documentation/Portrait Dialogue/6.0/2... · Chapter2:Gettingstarted. IfyouhaveReportPortalopen,andopenanotherweblink(forexample,clickingalinkwithin
Page 19: ReportPortalUserGuide - Portrait Supportsupport.portraitsoftware.com/documentation/Portrait Dialogue/6.0/2... · Chapter2:Gettingstarted. IfyouhaveReportPortalopen,andopenanotherweblink(forexample,clickingalinkwithin

5Viewing reports

In this section:

• The Files tabbed page . . . . . . . . . . . . . . . . . . . . . . . . . . . .20• The View tabbed page . . . . . . . . . . . . . . . . . . . . . . . . . . . .20• The Details tabbed page . . . . . . . . . . . . . . . . . . . . . . . . . . .20

Page 20: ReportPortalUserGuide - Portrait Supportsupport.portraitsoftware.com/documentation/Portrait Dialogue/6.0/2... · Chapter2:Gettingstarted. IfyouhaveReportPortalopen,andopenanotherweblink(forexample,clickingalinkwithin

The Files tabbed pageThis tabbed page lists all the report files.

Opening files

To open one of the files, click the Open link. This will open the file in a new browser window.

The action performed to open this file depends on the report format and settings in your browser.

Saving files to disk

To save one of the report’s files to your workstation, simply click the Save link. This will display the Saveas dialog.

The View tabbed pageThis View tabbed page displays the report files inline in your browser.

The page is available only if the report format can be previewed inline in your browser.

Paging

If the report consists of multiple pages, use the navigation bar to navigate between the pages.

Zoom

In order to zoom the report page, simply enter the desired zoom percentage and press enter.

Print

To print the current report page, click the Print button. This will display the Print dialog.

Save page

If you want to save the displayed report page, click the Save button. This will display the "Save as"dialog.

The Details tabbed pageThis tabbed page lists the details and the parameters used when the report was generated.

Template Details

The template details are listed in the Template Details table.

Report Parameters

The parameters used when generating the report are listed in the Report Parameters table.

Portrait Dialogue 6.0 SP120

The Files tabbed page

Page 21: ReportPortalUserGuide - Portrait Supportsupport.portraitsoftware.com/documentation/Portrait Dialogue/6.0/2... · Chapter2:Gettingstarted. IfyouhaveReportPortalopen,andopenanotherweblink(forexample,clickingalinkwithin

6Linking to reports

In this section:

• Linking to the Overview Page . . . . . . . . . . . . . . . . . . . . . .22• Linking to Run Report . . . . . . . . . . . . . . . . . . . . . . . . . . . .22• Linking to a report's archive . . . . . . . . . . . . . . . . . . . . . . .24• Linking to an archived report . . . . . . . . . . . . . . . . . . . . . .24• ISO Latin-1 Character Set . . . . . . . . . . . . . . . . . . . . . . . . . .25• Report Formats . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .32• Report View Actions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .32

Page 22: ReportPortalUserGuide - Portrait Supportsupport.portraitsoftware.com/documentation/Portrait Dialogue/6.0/2... · Chapter2:Gettingstarted. IfyouhaveReportPortalopen,andopenanotherweblink(forexample,clickingalinkwithin

Linking to the Overview PageThe Overview page is Report Portal's default page. Linking directly to the web application will open theOverview page.

The URL link

The URL format described:http://<server>/MHReportal

You can also open the overview page in Report Portal and copy the URL from your web browser'saddress field.

Note:

Related information

The login page will be display if necessary.

Click here to view the World Wide Web Consortium's URL standard specification.

Linking to Run ReportIt is possible to link to the Report Portal and directly run a report, with or without parameters.

Linking without report parameters

When running a report without report parameters, the only URL-parameter required is the template id(the report's template id can be located in the Report templates browser in Visual Dialogue).

The URL format described:

• http://<server>/MHReportal/RunReport.aspx?TemplateID=[TEMPLATE-ID]

• The report's format index can be specified in the url in order to override the report's default format.The URL will then look this:http://<server>/MHReportal/RunReport.aspx?TemplateID=[TEMPLATE-ID]&FormatIndex=[FORMAT-INDEX]

• The action can be specified in the url in order to override the default action. The URL will then lookthis:http://<server>/MHReportal/RunReport.aspx?TemplateID=[TEMPLATE-ID]&Action=[ACTION]

See Report View Actions for an overview of the different report actions available.

URL parameters:

• The TemplateID parameter is required ([TEMPLATE-ID] in the URL must be replaced with the id ofthe report template).

• The FormatIndex and Action parameters are optional.

Portrait Dialogue 6.0 SP122

Linking to the Overview Page

Page 23: ReportPortalUserGuide - Portrait Supportsupport.portraitsoftware.com/documentation/Portrait Dialogue/6.0/2... · Chapter2:Gettingstarted. IfyouhaveReportPortalopen,andopenanotherweblink(forexample,clickingalinkwithin

Examples:

• http://<server>/MHReportal/RunReport.aspx?TemplateID=1030

• http://<server>/MHReportal/RunReport.aspx?TemplateID=1030&FormatIndex=6

• http://<server>/MHReportal/RunReport.aspx?TemplateID=1030&Action=Print

Linking with report parameters

When running a report with report parameters, the template id and the report parameters must besupplied.

When specifying report parameters in the URL, the parameter name and value (and optionally theparameter operator) must be given. If the report parameter operator is not specified, the default operatoris used.

The URL format described:http://<server>/MHReportal/RunReport.aspx?TemplateID=[TEMPLATE-ID]&class="- topic/p ">pname[1,2...]=[PARAMETER-NAME]&pvalue[1,2...]=[PARAMETER-VALUE]&poperator[1,2...]=[PARAMETER-OPERATOR]&FormatIndex=[FORMAT-INDEX]

• The TemplateID parameter is required (the [TEMPLATE-ID] in the URL must be replaced with theid of the report template).

• Specify the first report parameter like this:pname1=[PARAMETER-NAME]&pvalue1=[PARAMETER-VALUE]

Specify the second report parameter like this:pname2=[PARAMETER-NAME]&pvalue2=[PARAMETER-VALUE]

and so on..

• The FormatIndex parameter is optional ([FORMAT-INDEX] in the URL must be replaced with thedesired format-index).

Examples:

• http://<server>/MHReportal/RunReport.aspx?TemplateID=1030&FormatIndex=6

• http://<server>/MHReportal/RunReport.aspx?TemplateID=1030&pname1=CustomerID&

pvalue1=10003&poperator1=in

The URL may be copied or saved and used later. Note that opening the URL always willgenerate the report over.

Remarque :

All URL parameters must be url encoded - This implies that protected URL characters (like "=" and "&")must be converted into their respective hexadecimal character code as specified in the ISO Latin-1Character Set (ISO 8859-1).

Related information

The login page will be display if necessary.

23Report Portal User Guide

Chapter 6: Linking to reports

Page 24: ReportPortalUserGuide - Portrait Supportsupport.portraitsoftware.com/documentation/Portrait Dialogue/6.0/2... · Chapter2:Gettingstarted. IfyouhaveReportPortalopen,andopenanotherweblink(forexample,clickingalinkwithin

See Report Formats for an overview of the different report formats available.

See Report View Actions for an overview of the different report actions available.

Click here to view the World Wide Web Consortium's URL standard specification.

Linking to a report's archiveIt is possible to link directly to a report's archive list. This will open the Report Archive page in ReportPortal.

The URL format described:

• http://<server>/MHReportal/Reportal.aspx?Page=Archive&TemplateID=[ARCHIVE-ID]

• The TemplateID parameter is required (the [ARCHIVE-ID] in the URL must be replaced with thearchived report's id).

Example:

• http://<server>/MHReportal/Reportal.aspx?Page=Archive&TemplateID=1030

>You can also open Report Portal, open a report's archive and copy the URL from your webbrowser's address field.

Note:

Related information

The login page will be display if necessary. Click here to view the World Wide Web Consortium's URLstandard specification.

Linking to an archived reportIt is possible to link directly to an archived report. This will open the View archived report page in ReportPortal.

The URL link

The URL format described:

• http://<server>/MHReportal/Reportal.aspx?Page=ViewArchived&ArchiveID=[ARCHIVE-ID]

• The report's format index can be specified in the url in order to override the archived report's defaultformat. The URL will then look this:

http://<server>/MHReportal/Reportal.aspx?Page=ViewArchived&ArchiveID=[ARCHIVE-ID]&FormatIndex=[FORMAT-INDEX]

• The action can be specified in the url in order to override the default action. The URL will then lookthis:

Portrait Dialogue 6.0 SP124

Linking to a report's archive

Page 25: ReportPortalUserGuide - Portrait Supportsupport.portraitsoftware.com/documentation/Portrait Dialogue/6.0/2... · Chapter2:Gettingstarted. IfyouhaveReportPortalopen,andopenanotherweblink(forexample,clickingalinkwithin

http://<server>/MHReportal/RunReport.aspx?TemplateID=[TEMPLATE-ID]&Action=[ACTION]

URL parameters:

• The ArchiveID parameter is required (the [ARCHIVE-ID] in the URL must be replaced with the id ofthe archived report).

• The FormatIndex and Action parameters are optional.

Examples:

• http://<server>/MHReportal/Reportal.aspx?Page=ViewArchived&ArchiveID=1333

• http://<server>/MHReportal/Reportal.aspx?Page=ViewArchived&ArchiveID=1333&FormatIndex=7

• http://<server>/MHReportal/Reportal.aspx?Page=ViewArchived&ArchiveID=1333&FormatIndex=7&Action=print

You can also open Report Portal, display an archived report and copy the URL from your webbrowser's address field.

Note:

Related information

The login page will be display if necessary.

See Report Formats for an overview of the different report formats available.

See Report View Actions for an overview of the different report actions available.

Click here to view the World Wide Web Consortium's URL standard specification.

ISO Latin-1 Character SetThe following table contains the complete ISO Latin-1 character set, alias ISO-8859-1.

The table provides the decimal code, hexadecimal code, and a brief description for each character.

DescriptionHexadecimal codeDecimal codeCharacter

Horizontal tab99---

Line feedA10---

Carriage ReturnD13---

Space2032

Exclamation mark2133!

Quotation mark2234"

Number sign2335#

Dollar sign2436$

Percent sign2537%

25Report Portal User Guide

Chapter 6: Linking to reports

Page 26: ReportPortalUserGuide - Portrait Supportsupport.portraitsoftware.com/documentation/Portrait Dialogue/6.0/2... · Chapter2:Gettingstarted. IfyouhaveReportPortalopen,andopenanotherweblink(forexample,clickingalinkwithin

DescriptionHexadecimal codeDecimal codeCharacter

Ampersand2638&

Apostrophe2739'

Left parenthesis2840(

Right parenthesis2941)

Asterisk2A42*

Plus sign2B43+

Comma2C44,

Hyphen2D45-

Period (fullstop)2E46.

Solidus (slash)2F47/

Digit 030480

Digit 131491

Digit 232502

Digit 333513

Digit 434524

Digit 535535

Digit 636546

Digit 737557

Digit 838568

Digit 939579

Colon3A58:

Semicolon3B59;

Less than3C60<

Equals sign3D61=

Greater than3E62>

Question mark3F63?

Commercial at4064@

Capital A4165A

Capital B4266B

Capital C4367C

Capital D4468D

Portrait Dialogue 6.0 SP126

ISO Latin-1 Character Set

Page 27: ReportPortalUserGuide - Portrait Supportsupport.portraitsoftware.com/documentation/Portrait Dialogue/6.0/2... · Chapter2:Gettingstarted. IfyouhaveReportPortalopen,andopenanotherweblink(forexample,clickingalinkwithin

DescriptionHexadecimal codeDecimal codeCharacter

Capital E4569E

Capital F4670F

Capital G4771G

Capital H4872H

Capital I4973I

Capital J4A74J

Capital K4B75K

Capital L4C76L

Capital M4D77M

Capital N4E78N

Capital O4F79O

Capital P5080P

Capital Q5181Q

Capital R5282R

Capital S5383S

Capital T5484T

Capital U5585U

Capital V5686V

Capital W5787W

Capital X5888X

Capital Y5989Y

Capital Z5A90Z

Left square bracket5B91[

Reverse solidus (backslash)5C92\

Right square bracket5D93]

Caret5E94^

Horizontal bar (underscore)5F95_

Acute accent6096`

Small a6197a

Small b6298b

Small c6399c

27Report Portal User Guide

Chapter 6: Linking to reports

Page 28: ReportPortalUserGuide - Portrait Supportsupport.portraitsoftware.com/documentation/Portrait Dialogue/6.0/2... · Chapter2:Gettingstarted. IfyouhaveReportPortalopen,andopenanotherweblink(forexample,clickingalinkwithin

DescriptionHexadecimal codeDecimal codeCharacter

Small d64100d

Small e65101e

Small f66102f

Small g67103g

Small h68104h

Small i69105i

Small j6A106j

Small k6B107k

Small l6C108l

Small m6D109m

Small n6E110n

Small o6F111o

Small p70112p

Small q71113q

Small r72114r

Small s73115s

Small t74116t

Small u75117u

Small v76118v

Small w77119w

Small x78120x

Small y79121y

Small z7A122z

Left curly brace7B123{

Vertical bar7C124|

Right curly brace7D125}

Tilde7E126~

Nonbreaking spaceA0160

Inverted exclamationA1161¡

Cent signA2162¢

Pound sterlingA3163£

Portrait Dialogue 6.0 SP128

ISO Latin-1 Character Set

Page 29: ReportPortalUserGuide - Portrait Supportsupport.portraitsoftware.com/documentation/Portrait Dialogue/6.0/2... · Chapter2:Gettingstarted. IfyouhaveReportPortalopen,andopenanotherweblink(forexample,clickingalinkwithin

DescriptionHexadecimal codeDecimal codeCharacter

General currency signA4164¤

Yen signA5165¥

Broken vertical barA6166¦

Section signA7167§

Diæresis / UmlautA8168¨

CopyrightA9169©

Feminine ordinalAA170ª

Left angle quote, guillemet leftAB171«

Not signAC172¬

Soft hyphenAD173

Registered trademarkAE174®

Macron accentAF175¯

Degree signB0176°

Plus or minusB1177±

Superscript twoB2178²

Superscript threeB3179³

Acute accentB4180´

Micro signB5181µ

Paragraph signB6182¶

Middle dotB7183·

CedillaB8184¸

Superscript oneB9185¹

Masculine ordinalBA186º

Right angle quote, guillemet rightBB187»

Fraction one-fourthBC188¼

Fraction one-halfBD189½

Fraction three-fourthsBE190¾

Inverted question markBF191¿

Capital A, grave accentC0192À

Capital A, acute accentC1193Á

Capital A, circumflexC2194Â

29Report Portal User Guide

Chapter 6: Linking to reports

Page 30: ReportPortalUserGuide - Portrait Supportsupport.portraitsoftware.com/documentation/Portrait Dialogue/6.0/2... · Chapter2:Gettingstarted. IfyouhaveReportPortalopen,andopenanotherweblink(forexample,clickingalinkwithin

DescriptionHexadecimal codeDecimal codeCharacter

Capital A, tildeC3195Ã

Capital A, diæresis / umlautC4196Ä

Capital A, ringC5197Å

Capital AE ligatureC6198Æ

Capital C, cedillaC7199Ç

Capital E, grave accentC8200È

Capital E, acute accentC9201É

Capital E, circumflexCA202Ê

Capital E, diæresis / umlautCB203Ë

Capital I, grave accentCC204Ì

Capital I, acute accentCD205Í

Capital I, circumflexCE206Î

Capital I, diæresis / umlautCF207Ï

Capital Eth, IcelandicD0208Ð

Capital N, tildeD1209Ñ

Capital O, grave accentD2210Ò

Capital O, acute accentD3211Ó

Capital O, circumflexD4212Ô

Capital O, tildeD5213Õ

Capital O, diæresis / umlautD6214Ö

Multiply signD7215×

Capital O, slashD8216Ø

Capital U, grave accentD9217Ù

Capital U, acute accentDA218Ú

Capital U, circumflexDB219Û

Capital U, diæresis / umlautDC220Ü

Capital Y, acute accentDD221Ý

Capital Thorn, IcelandicDE222Þ

Small sharp s, German szDF223ß

Small a, grave accentE0224à

Small a, acute accentE1225á

Portrait Dialogue 6.0 SP130

ISO Latin-1 Character Set

Page 31: ReportPortalUserGuide - Portrait Supportsupport.portraitsoftware.com/documentation/Portrait Dialogue/6.0/2... · Chapter2:Gettingstarted. IfyouhaveReportPortalopen,andopenanotherweblink(forexample,clickingalinkwithin

DescriptionHexadecimal codeDecimal codeCharacter

Small a, circumflexE2226â

Small a, tildeE3227ã

Small a, diæresis / umlautE4228ä

Small a, ringE5229å

Small ae ligatureE6230æ

Small c, cedillaE7231ç

Small e, grave accentE8232è

Small e, acute accentE9233é

Small e, circumflexEA234ê

Small e, diæresis / umlautEB235ë

Small i, grave accentEC236ì

Small i, acute accentED237í

Small i, circumflexEE238î

Small i, diæresis / umlautEF239ï

Small eth, IcelandicF0240ð

Small n, tildeF1241ñ

Small o, grave accentF2242ò

Small o, acute accentF3243ó

Small o, circumflexF4244ô

Small o, tildeF5245õ

Small o, diæresis / umlautF6246ö

Division signF7247÷

Small o, slashF8248ø

Small u, grave accentF9249ù

Small u, acute accentFA250ú

Small u, circumflexFB251û

Small u, diæresis / umlautFC252ü

Small y, acute accentFD253ý

Small thorn, IcelandicFE254þ

Small y, diæresis / umlautFF255ÿ

31Report Portal User Guide

Chapter 6: Linking to reports

Page 32: ReportPortalUserGuide - Portrait Supportsupport.portraitsoftware.com/documentation/Portrait Dialogue/6.0/2... · Chapter2:Gettingstarted. IfyouhaveReportPortalopen,andopenanotherweblink(forexample,clickingalinkwithin

Report FormatsIntroduction

A number of formats are available to display reports. A Format Index is used to specify the formats whenworking with URLs to access the Report Portal and the Report Viewer web applications.

Report formats overview

The table below defines the different formats available.

Output filesDescriptionFormatIndex

One PDF file is generated.Adobe Acrobat PDF-files.0

One HTML file per page is generated. Pictures andcharts are returned as JPG files.

HTML - with page breaks1

One HTML file containing all pages is generated.Pictures and charts are returne as JPG files.

HTML - one page2

One XHTML file per page is generated. Pictures andcharts are returned as JPG files.

XHTML3

One RTF file is generated.Rich Text Format4

One Excel sheet is generated. Does not includegraphics.

Microsoft Excel - Single page5

One JPG file per page is generated.JPEG image format6

One GIF file per page is generated.GIF image format7

One BMP file per page is generated.BITMAP image format8

One WMF file per page is generated.Window Metafile9

One EMF file per page is generated.Enhanced Windows Metafile10

One Excel sheet per report page is generated. Includesgraphics (e.g. images). Graphs will be included asimages.

Microsoft Excel - Multi page11

Report View ActionsIntroduction

When a report is viewed using a URL, different view actions can be specified as URL parameters.

Report view actions overview

Portrait Dialogue 6.0 SP132

Report Formats

Page 33: ReportPortalUserGuide - Portrait Supportsupport.portraitsoftware.com/documentation/Portrait Dialogue/6.0/2... · Chapter2:Gettingstarted. IfyouhaveReportPortalopen,andopenanotherweblink(forexample,clickingalinkwithin

The table below defines the different view actions available.

DescriptionAction

The report file is opened in the Report Portal. This view action is suitable for all reportformats.

Portal

This is the default action. Thus if no action is specified, this action will be used.Note:

The report file is opened in the web browser. The default open behavior of the file typewill be used.

Open

If the report consists of multiple files (for example, HTML with page breaks),the first page will be opened by default.

Note:

The report file is downloaded and the user will be prompted by the browser to save itto a location.

Save

If the report consists of multiple files (e.g. HTML with page breaks), only thefirst page will be downloaded.

Note:

The report is displayed in the web browser with a navigation bar. This view action issuitable for reports consisting of multiple files (e.g. HTML with page breaks).

Browse

If the report is on a format which cannot be displayed inside an HTML page,view action Open will be used.

Note:

The report file is opened by the web browser and the window print dialog is opened.Print

This action will only work using HTML formats, otherwise the action Open willbe used.

Note:

The report file is opened by the web browser and the Window Print dialog is opened.After printing the report, the window is closed (needs user confirmation if page is notopened from another web page).

PrintClose

This action will only work using HTML formats, otherwise the action Open willbe used.

Note:

33Report Portal User Guide

Chapter 6: Linking to reports

Page 34: ReportPortalUserGuide - Portrait Supportsupport.portraitsoftware.com/documentation/Portrait Dialogue/6.0/2... · Chapter2:Gettingstarted. IfyouhaveReportPortalopen,andopenanotherweblink(forexample,clickingalinkwithin
Page 35: ReportPortalUserGuide - Portrait Supportsupport.portraitsoftware.com/documentation/Portrait Dialogue/6.0/2... · Chapter2:Gettingstarted. IfyouhaveReportPortalopen,andopenanotherweblink(forexample,clickingalinkwithin

Index

AAbout Report Portal 8Adobe Acrobat PDF-files 32Advanced login 8All URL 22Archive 9, 12, 16archived report 24Archived report 16, 24archived reports 16ArchiveID 24Archiving 16

CClicking 16copy 22, 24Copy 22, 24Customer Relationship Management 8Customer View 8

DDate 16Details 20Dialog Admin 9, 12Dropdown-list 12

EEMF file 32Enhanced Windows Metafile 32

FFiles tabbed page 20Format Index 32

Ggenerated report 12Generated report 12

HHTML 32

IInline 12, 20ISO Latin-1 Character Set 25

JJPEG 32JPG 32

Llink 22Linking 22, 24login 8Login 8

MMetafile 32Microsoft Excel 32Microsoft Internet Explorer 9MS Excel file 32

NNormal login 8

Page 36: ReportPortalUserGuide - Portrait Supportsupport.portraitsoftware.com/documentation/Portrait Dialogue/6.0/2... · Chapter2:Gettingstarted. IfyouhaveReportPortalopen,andopenanotherweblink(forexample,clickingalinkwithin

OOpen 20, 22opening 22Overview Page 22

PPARAMETER-NAME 22PARAMETER-VALUE 22PDF file 32Pname 22Pname1 22Pname2 22Poperator 22Print 20Print button 20Pvalue 22Pvalue1 22Pvalue2 22

Rreplaces 16Replaces 16Report Formats 12, 32Report Parameters 12, 20Report Portal 8, 9, 12, 16, 22, 24, 32Report Portal application 8Report Portal's 9Report Viewer 32report's archive 24Report's archive 24reports 12, 16Reports 12, 16Rerun 12Rich Text Format 32RTF file 32Run Report 22Running 9, 12

SSave 20Save button 20Show 12, 16Start page 9Starting 8System Administrator 8

TTabbed page 20Template Details 12, 16, 20TemplateID 22, 24types 8Types 8

UURL 22, 24, 32URL-parameter 22use 9Use 9Username 8

Vview 22, 24View 12, 16, 20, 22, 24Viewing 12, 16Visual Dialog 8, 9, 12

WWeb 8Windows Explorer 9Windows login 8WMF file 32World Wide Web Consortium's URL 22, 24

XXHTML 32

Portrait Dialogue 6.0 SP136