Sunteți pe pagina 1din 186

(

(

.!

Content Server WebReport Design I v10.5 SP1

OPENTEXT™

www.opentext.com

Content Server WebReport Design I

v10.5 SP1

OpenText Content Server

OPENTEXT'"

Learning Services

The software described in this Workbook is furnished under a license agreement or non-disclosure agreement (the

"Agreement") with Open Text Corporation or one of its affiliates ("Open Text"). The software may be used or copied

only in accordance with the terms of the Agreement. The information contained in this Workbook is the valuable

property of Open Text and represents trade secrets of Open Text. No part of this Workbook may be copied, reproduced,

translated or transmitted in any form or by any means without the prior written consent of Open Text.

I

The information contained in this Workbook is subject to change without notice. If this Workbook is provided in both

printed and electronic form, the electronic form will govern in the event of any inconsistency. Open Text makes no representations or warranties concerning such information or the software described in this Workbook except as

expressly set forth in the Agreement.

Copyright © 2015 by Open Text Corporation

OpenText is a trademark or registered trademark of Open Text 5A andlor Open Text ULC. The list of trademarks is not

exhaustive of other trademarks, registered trademarks, product names, company names, brands and service names mentioned herein are property of Open Text SA or other respective owners. All rights reserved.

Revision History

Content ServerWebReport Design Iv10.5.x - First Edition: September 2014 Content ServerWebReport Design Iv10.5 SP1- Second Edition: Jul2015

Comments or suggestions about this manual can be sent to LearningContentDev@opentext.com.

Based on OpenText Content Server v10.s SP1 Developed by OpenText Learning Content Development and Learning Services

Course Name:

Content Server WebReport Design I

Course Number:

2-0117

Part Number:

2-0117-1051-00

Welcome

Welcome to the Content Server WebReport Design I course.

This course is intended to be an introduction to Content Server WebReports. WebReports provides a very rich set of capabilities which can be used in simple or very advanced ways. The aim of this course is to introduce some of the main features and how to use them. More advanced topics are dealt with in the WebReport Design II course.

The intended audience is people who wantto create WebReports or at least understand how they are created and what is possible. The course is suitable for power end-users, report developers and administrators.

By the end of this course, you will be able to:

• Create WebReports that Query users for parameters and display results in a custom format in the browser, Save report results as documents in Content Server or Deliver reports by email

• Configure a WebReport to run on a schedule

• Use Advanced Search to launch WebReports to provide custom search results

• Use saved Search Queries as a data source

• Use WebReporttags to Filter data, Control page content or Convert data like Node IDs or User IDs into names or other useful information

• Use sub-WebReports to combine results from multiple WebReports

Prerequisites:

• 3-0127 - Content Server Schema and Report Fundamentals, or equivalent experience

• 1-0101- Content Server Knowledge Fundamentals, or equivalent experience

• Familiarity with basic HTML

Thank you for participating in this course. Should you require anything further, please contact us at OpenText Learning Services.

Good luck and enjoy your learning experience.

OpenText Learning Services

Class Information:

For your reference during exercises, please record the following information per your instructor's directions:

Username:

 

_

Password:

 

_

Sample Docs folder location:

_

Text Conventions

This workbook uses the following conventions:

Monospace (courier) Monospaced text is used to represent sample code.
Monospace
(courier)
Monospaced text is used to represent sample code.

Italic

Bold

< >

Italics are used for Workshops and Exercises.

In instruction steps, indicates the action to be taken. In text it indicates emphasis.

Angle brackets « » represent an element of syntax you must substitute with a specific value.

This icon represents a lesson symbol where the student watches the instructor.

 

This icon represents a lesson symbol where the student follows along with the instructor.

This icon represents a lesson symbol where the student performs the exercise on their own.

This icon represents an optional (or advanced) exercise where the student performs the exercise on their own.

This icon represents a note that supplies additional information.

This icon represents a collection of Tips, Tricks, and Traps that is used at the

This icon represents a collection of Tips, Tricks, and Traps that is used at the end of a chapter.

This icon represents a caution that supplies warning information.

Table of Contents

1. Introduction to WebReports

 

Overview

1-1

Introducing WebReports

1-1

WebReport Architecture

1-2

WebReport Licensing

1-4

WebReport Administration

1-5

The Outdoor Gear Training Environment

1-6

Training Environment

1-6

Outdoor Gear

1-6

CS105Installation

 

1-6

Summary

1-7

Exercises

1-8

Login and Orientation to Outdoor Gear

1-8

Useful Settings for SAdmin and the WebReport Course Exercises

1-10

2.

WebReport Basics

Overview

2-1

Adding a WebReport

 

2-1

Changing the

Data Source

2-5

Changing the

Destination

2-9

Manual Export

2-13

Change

the Look of the Report Resuits With Reportviews

2-1S

Changing the Reportview

Using the Online Editor

2-16

Defauit Reportviews

2-23

Summary

2-24

Exercises

2-25

Create a WebReport

2-25

Changing the

WebReport Destination

2-26

Changing the

Reportview

2-28

Challenge Exercise

2-29

Editingthe Reportview Columns

2-29

3.

Scheduling WebReports

 

Overview

3-1

Scheduiing WebReports

3- 2

Administering WebReport Scheduiing

3-3

Troubleshooting a WebReport Schedule

3-5

Creating WebReport Schedules

3-5

Summary

3-8

Exercises

3-9

Change the WebReport Scheduling Agent Sleep Interval

3-9

Create a WebReport Schedule

3-9

4.

WebReport Tags

Overview

.4-1

AboutTags

4-1

Content Control Tags

4-2

Tag Example

4-3

Data Tags

.4-4

Examples of Useful Data Tags

4-4

Sub-Tags

.4-5

Tag Help

.4-6

Using WebReport Tags Outside the Reportview

4-7

Summary

4-7

Exercises

4-8

Apply Tags

4-8

5. WebReport Links and Constants

Overview

5-1

Including a Hyperlink

5-1

Constants Tab

5-3

Constant Fields

5-3

Constant Types

5-4

Using a Global Constant

5-5

Maintaining Constants

5-6

Using WebReports Constants in a Hyperlink

5-6

Summary

5-8

Exercises

5-9

Create a WebReport With Constants

5-9

Challenge Exercise

5-11

Document Name into Hyperlink

5-11

Document Name into Hyperlink

Challenge Exercise Solution

5-12

6. WebReport User Prompts and Parameters

Overview

6-1

Parameters Concepts

6-1

Parameters Tab

6-2

Parameter Fields

6-2

Extracting Parameters

6-3

Parameter Types

6-5

Custom Branding and Instructions

6-8

Parameter Descriptions

6-8

Data Source Parameters

6-10

LiveReport Data Source Parameters

6-10

Search Data Source Parameters

6-11

Custom Launch Screens

6-12

Summary

6-13

Exercises

6-14

Create

a Constant and Modify the Reportview to Display it

6-14

Create a Prompt Page

6-15

7.

Filtering WebReport Results

 

Overview

 

.7-1

Filter Tags

7-1

If-Else-Endif

7-2

Inciude If

7-2

Exit If

7-2

Inciude Range

7-3

Inciude Distinct

7-3

Logical Expressions

7-3

When to Use WebReports Filter Tags

7-4

Applications of Filter types

7-6

Performance Considerations

7-8

Summary

7-9

Exercises

7-10

Filtering

Results

Using

INCLUDEIF to Find Logins - Exercise Solution

7-12

Filtering

Results

Using INCLUDERANGE With

Start/End Parameters

7-13

Filtering Results Using INCLUDERANGE With Start/End Parameters - Exercise Solution

7-15

8.

Sub-WebReports

 

Overview

 

8-1

Introducing Sub-WebReports

8-1

Exporting and SUb-WebReports

8-4

Scenario

8-4

Solution

8-4

Syntax

8-5

Parameters

8-6

Considerations

:

8-7

Summary

8-7

Exercises

8-9

Create

a Mini

8-9

Create a Mini

Portal Portal- Exercise Solution

 

8-10

A.

WebRe port Help and Resources

 

Overview

 

A-l

Product Support. Knowledge Base and Help Resources

A-l

Product Home Page

A-l

Technical Support

A-l

Knowledge Center

A- 2

Documentation

A-3

Online Help

A-4

B.

SubTypes

Overview

B-l

Subtypes

 

B-l

Table B-1: Database SubTypes by Display Name

B-2

Table B-2:

B-8

Table

B-3:

User Interface SubTypes by Display Name SubTypes by Integer Value

B-l0

C.

Content Server and WebReport Licensing

Overview

C-l

Content Server Licensing

C-l

Unlicensed and Administrative Mode

C-l

Options

C-3

License Overview

C-4

License Management

C-6

System Fingerprint

C-7

Invalid System Fingerprint

C-8

License Report

C-8

WebReport Module Licensing and Functionality

C-l1

Module Not Licensed by Default

C-ll

XML Import

of WebReports

C-ll

Exception With Packaged Applications like Records Management

C-ll

Some Applications Like Report Pack Need Module Licensed

C-12

Upgrading From Previous Licensed WebReport Version

C-18

WebReports Licensing - Self-Certify

C-18

Summary

C-20

Exercises

C-21

Applya WebReport Module License File

C-21

D. Introduction to the WebReport Pack

Overview

D-l

WebReport Pack Overview

D-2

Pre-Configured Charts

D- 2

Report Access via Dashboard

D-3

Content Server Application Packaging Tool

D-3

Running Reports via the Launcher

D-4

E. Default Reportviews

Overview

E-l

OPENTEXT'M

Content Server WebReport Design I

Learning

Services

Student Attendance Form

Course Delivery Information

vl0.5 SPl

Training Date:

_

Instructor:

 

_

Location:

Student Information

Student Name:

 

_

Title:

 

_

Role (i.e., Management; User):

_

Industry (i.e., Legal, Manufacturing):

OpenText Partner:

0 Yes

0

No

Company Name:

_

Street Address:

Email:

 

_

Phone Number:

 

_

Signature:

_

,.

Chapter 1.

Introduction to WebReports

1. Introduction to WebReports

Objectives

On completion ofthis chapter, participants should be able to:

• Describe what a WebReport is and provide an overview of its architecture

• List several WebReport data sources and report destinations

Overview

This chapter provides an introduction to the Content Server WebReport Design I course.

Introducing WebReports

What is the WebReports module?

WebReports is an OpenText Content Server module that ships with the core product, but it must be licensed to make its functionality available to users.

It provides a powerful processing engine that allows Content Server data and content to be combined into output that can be consumed in a variety of different ways. This enables customers to create solutions ranging from simple tabular reports to complex multi-layer applications - without the need for custom programming or OScript customization.

Chapter 1.

Introduction to WebReports

The figure below illustrates an actual customer example using WebReports to format Content Server data which results in a geographical representation of their data.

Figure 1-1: Example of Graphical Output Generated From a WebReport

Example of Graphical Output Generated From a WebReport ~.'_lIon!lf MINe; 0 ::>~rege; 0 IrJiictjve; 0
~.'_lIon!lf MINe; 0 ::>~rege; 0 IrJiictjve; 0 ' Total: 0
~.'_lIon!lf
MINe;
0
::>~rege;
0
IrJiictjve;
0 '
Total:
0

WebReport Architecture

WebReports provides an "engine" that takes a source of data and processes it (manipulates, filters, sorts, converts, formats) into a readable report or user interface that can be output or delivered to varying destinations. These destinations allow content to be viewed

in a range of client applications, most commonly a browser but also

email, Excel, Word and other applications.

A WebReport has three main elements:

• Data Source: specifies from where we get the data

• Reportview: specifies how data should be processed and presented - this can be created using any text based format (HTML, CSV, RTF, XHTML, XML, Word, Spreadsheet, etc.)

Destination: specifies what to do with the final result

Chapter 1.

Introduction to WebReports

The diagram below illustrates how the WebReports architecture works in conjunction with a variety of different types of data sources and output destinations.

Figure 1-2: WebReport Architecture and Components

Sub WebRe ports PDF Conversion Web Reports AppHcvtiom Browser Databases Email File Systems Desktop
Sub WebRe ports
PDF Conversion
Web Reports
AppHcvtiom
Browser
Databases
Email
File Systems
Desktop

Chapter 1.

Introduction to WebReports

The table below lists a number of the WebReport data sources and destinations, similar to what was illustrated in the previous figure.

Table 1-1:

WebReport Sources and

Destinations

 

"

""n"""ft.

 

.

Content Server Query

Browser

Content Server File

Content Server (Document, Version)

Content Server Categories

Desktop

Externai File

 

Email

FTP

File on Server

External Applications

Workflow

Search Query Launch

Content Server Form

None

FTP

What use is a data source of "None"? Sometimes a WebReport is used to create a query screen or custom user interface that does not display data from a data source. Selecting "None" allows this.

WebReport licensing

WebReports that ship with Content Server (for example with the Records Management module), can be run, however, for administrators or report writers to create new WebReports, the module must be licensed. If the WebReports module has not been licensed, it will display the WebReports Administration tab appending the name with "Unlicensed" in parentheses.

The exercise in Appendix C: Licensing WebReports will apply a license to the WebReports module.

Chapter 1.

Introduction to WebReports

WebReport Administration

Flush Cache

Install Requests.js Library

Manage Category Data Source

Configuration

Manage Search Query

Integration

Manage Tags and Sub-Tags

Manage User / Group WR Triggers

Manage WebRe ports Conversion

Manage WebReports Schedules

Manage WebReports Scripting

I Manage WebReports Services

Manage WR Triggers

Miscellaneous WebRe ports Settings

WebRe ports Licensing

WebRe ports Node

Administration

WebRe ports Sub-tag Builder

A number ofthe WebReport Administration options will be discussed throughout this course, including:

Clear the cache of compiled Reportviews.

Provides an interface to install the Requests Library and associated files to the JavaScript library location.

Update maximum number of Categories and Attributes display parameters.

Manages the ability to invoke WebReports directly from the Advanced Search page.

Enable and disable tags and sub-tags.

Determine which Users and Groups can trigger WebReports.

Change the Sleep Interval for the Conversion Agent and set input and output directories to manage PDF conversion.

Change the Sleep Interval for the Schedule Agent and enable/disable or permanently delete individual schedules.

Enable or disable scripting of individual WebReports.

Enable/disable or restrict the WebReports services feature.

Determine which node types can trigger WebReports.

Configure miscellaneous WebReports settings.

Set or change the WebReports License Key and display licensing status.

Identify and update Reportviews using out-of-date syntax.

Used to test build and subtags that have been created in the subtags folder.

Chapter 1.

Introduction to WebReports

The Outdoor Gear Training Environment

Training Environment

This course will make use of a training environment based on a fictional company that markets and sells various outdoor and sporting gear.

Outdoor Gear

CS10S Installation

Here is a short overview of the company:

• Outdoor Gear sells tents, canoes, hiking boots, trail rations, bicycles, and other excellent outdoor equipment

• The company employs approximately 1,500 people globally in its headquarters, regional headquarters, local stores, and warehouse facilities

• Outdoor Gear uses Content Server to manage all kinds of work for its product selection and marketing, its departments such as Finance and Human Resources, and Field Support for its Sales team

• The Green Square is the parent company of Outdoor Gear

The C:\CS10S installation of Content Server consists of CS 10.5 + Update 2014-12 (aka Service Pack 1 or SP1) and includes the following core and optional installed modules:

• Core modules

WebDAV

elink

Email Services

Office Editor

WebReports

• Optional modules

Forms

Web Forms

Pulse/Social

Enterprise Connect

Chapter 1.

Introduction to WebReports

Summary

In summary, in this chapter we:

• Described what a WebReport is and provided an overview of its architecture

• Listed several WebReport data sources and report destinations

Chapter 1.

Introduction to WebReports

Exercises

Login and Orientation to Outdoor Gear

Overview

As a report writer or administrator, you will have the opportunity review and then use a number of WebReport features in Content Server version 10.5 SP1.

Your Instructor will provide you with directions or details concerning your login or username, password, and location of the Sample Docs folder location. There is space on the Welcome page to record the login information for your convenience during the course.

Typically, each student will have individual access to their own virtualized instance of the Outdoor Gear (ODG) system.

For most of the exercises in this course, where you need to have system administration privileges, you will be asked to log in using the Susan Adminvakova (sad min) account which has a password of letmein (lowercase, all one word).

If prompted for the password for the administration pages, it is opentext (lowercase, all one word).

Chapter 1.

Introduction to WebReports

1. Log in as sadmin (password = letmein).

2. Although you will be working in specific folders and other areas of the Content Server system, this may be a good opportunity to famil iarize yourself with the some of the folders found in the Enterprise Workspace, as illustrated below.

OPENTEXT ! CantE-ot Server

outdoor gea r r-tilriMU pProl«1 12n~1!: i!1i5W:O'S~;11 AM (l5vI.>-f\'i;1~!:'::
outdoor gea r
r-tilriMU pProl«1
12n~1!: i!1i5W:O'S~;11 AM
(l5vI.>-f\'i;1~!:':: ;}:Jjlt.':lfjilll~~~ M1
M~W«li(lU)
ql!~W~Qij:lStH;OSp;.1
~~'
~Rr~-m!ib.(¢l. (~)
~:?D!'l~)
~ _c
la H~
1)1{l1-nIUs O]:l9 f'I'-I
U='
H;'::~RJW~.lWl1lt~~>
1 St.!!J
l'r¢tt:
~"lUN1J.ll:-'l4-,*1
1-1.lu~Yi:iapJ
~
I-k>tt:
11 ~~.,s
mtl.lptl.il U:~.2:,/lF-l
r4!.L~ &
lliRe= OS1Z-1Il0UOO:oMA"-j
1»:IJffi¢o'Itt~tr}\
-
:B l:um
W~M.a.jlb~~J
21 J.:ma
Fcldu(12())
JJ.lm'.:I
OYUP.IU5 U:S2 P~I
Wf.u/;W111H·ll AA
wmJiDh Ut411lM
lv~~«t(~~) l
~rr>l!:~rljlJtat'\l'/
\'4d;F;oepQrt(~'i)
~I;cl-f
-
17fu.ms
09j;2"llOl~ 03:1Dm
Gn~s: O:3-f21/l01)11:-4JM
!'t~"
'iltllffiS: OJf21f10Ifl1;~J~
t3 I~
Q211lJ:2.li]'~U,51 ~H
J:!!~jdtS;lo.,.,pk.09W
~'OO yclyms (;&Vi .
m~
OJI2.lJ401j.H~41A,"':
!i
IIMl~
03/W2l)11 U-o~ M:!
OJI2.lJ401j.H~41A,"': !i IIMl~ 03/W2l)11 U-o~ M:! - - - I 3. Make sure you can log
OJI2.lJ401j.H~41A,"': !i IIMl~ 03/W2l)11 U-o~ M:! - - - I 3. Make sure you can log

---I

3.

Make sure you can log in and navigate withi n the Enterprise Workspace.

Chapter 1.

Introduction to WebReports

Useful Settings for SAdmin and the WebReport Course Exercises

1. For convenience, either create a bookmark in the IE browser, add a URL in Content Server or alternatively add an Additional Enterprise Menu (if you are familiar with this option) called Student 1 WRD I Exercises and link it to the Enterprise Workspace> Course Material> 2-0117 - WebReport Design I> WRD I Student Folders> Student 1 WRDI Exercises folder since you will be doing many of your activities in that folder). (Hint: the link should be in the following format:

?func=ll&objld=374847&objAction=browse&viewType=1)

OPENTExT I Content Server ,"", • •.• ~ '., ! ,
OPENTExT I Content Server
,"",
•.•
~
'.,
!
,
""VI""'"'~'''
Users $<. Groups
Transport Warehouse
student 1 WRD I Exerdse

2. If you added an Additional Enterprise menu entry, the Content Server service will need to be restarted.

3. From the Main menu, select Tools> Settings and then click the Color tab.

4. Update Row 2 from #FFFFFF (Le., white) to #EEEEEE (Le., light grey). You will be able to make use of these personal row settings later in the course with Reportviews.

~ My Color settings

C.un IC., "oM_j '.""".Hood,,! C_nH_ Row 1 Row 1 Row 1 Row 1 Row 2
C.un
IC.,
"oM_j
'.""".Hood,,! C_nH_
Row 1
Row
1
Row 1
Row 1
Row 2
Row 2
11.011'2
ROW2
Row 1
Row1
Ilowl
Row 1
Row 2
ll.ow2
Row 2
RO"'2

5. Remember to click the Update button at the bottom of the page.

Chapter 2.

WebReport Basics

2. WebReport Basics

Objectives

On completion of this chapter, partici pants should be able to:

• Create and configure a WebReport

• Choose an appropriate data source

• Save reports in Content Server and add report versions

• Make a simple change to the way a WebReport looks using Reportview

Overview

This chapter deals with WebReport basics such as creating and configuring a report along with choosing data sources and destinations. This chapter also provides an introduction to the Reportview.

Adding a WebReport

WebReports are added from the Add Item menu.

WebReport Object and Usage Privileges are unrestricted by default, so that means any user with the Add Item permission can create a WebReport in Content Server.

Item permission can create a WebReport in Content Server. Step Set 2-1: Adding a WebReport 1.

Step Set 2-1: Adding a WebReport

1. Log in with a system administration account.

2. Add a new Folder called WebReports to the Enterprise Workspace> Course Material> 2-0117 - WebReport Design Ifolder.

3. Click the WebReports folder link.

4. From the Add Item menu, select WebReport.

Chapter 2. WebReport Basics

The Add WebReport page is displayed.

Figure 2-1: Add WebReport

Add WebReport page is displayed. Figure 2-1: Add WebReport Add: WebReport Use a Default Reportview Name

Add: WebReport

Use a Default Reportview

2-1: Add WebReport Add: WebReport Use a Default Reportview Name Item Name. The Name can be

Name

Item Name. The Name can be up to 248 characters long.

Description

Item Description. An optional Description can also be entered.

5.

Enter a Name and an optional Description for the WebReport (e.g., Basic WebReport).

Data Source

The Data Source is an optional field which allows a report source to be selected.

Data source options and Go to Source Tab options are discussed in the next section.

6. Click the Browse Content Server button to select a Data Source. A pre-written data source can be selected from Enterprise> Course Material> 2-0117WebReport Design I > WRD I Templates (and Data Sources) folder.

7. Click the Select> link opposite the Basic Data Source (DTreeCore) for WebReport data source.

Chapter 2. WebRe port Basics

Reportview File

Reportviews are a set of pre-written templates that specify the presentation for the WebReport. The Reportview File is a required field.

The Use a Default Reportview list allows you to select from several pre-configured templates or the Browse button can be used to select a custom Reportview from your desktop.

The Reportview can be edited using the Edit Reportview function once the WebReport has been created.

8. Select the Reportview file called basic report from the Use a Default Reportview list.

Once a file has been selected, the file details are automatically inserted into the corresponding form field.

The basicJeport Reportview, as its name implies, is a basic report and returns just 5 columns of data with minimum formatting. This Reportview is mainly useful as a starting point for creating more elaborate reports.

Chapter 2.

WebRe port Basics

Figure 2-2: Adding a Basic WebReport

Add: WebReport

·Dl.taSOClrc:e~.·••·•·•.•·· IWebReports
·Dl.taSOClrc:e~.·••·•·•.•··
IWebReports
·Dl.taSOClrc:e~.·••·•·•.•·· IWebReports IBastC WebRe port This is a basic WebRepolt With DTreeQ)R

IBastC WebReport

This is a basic WebRepolt With

DTreeQ)R as a data source.

I lenterprise:courseMateriaJ:3-0117 - WebRe~

DTreeQ)R as a data source. I lenterprise:courseMateriaJ:3-0117 - WebRe~ Go To Source Tab 0 . ~

Go To Source Tab

0

.

~

Use a Default Reportview

DTreeQ)R as a data source. I lenterprise:courseMateriaJ:3-0117 - WebRe~ Go To Source Tab 0 . ~

9. Click the Add button.

10. Click the Basic WebReport link to run the report.

The WebReport runs and displays the result in the browser, as illustrated below:

Figure 2-3:

Basic WebReport Results in Browser

Run WebReport: Basic WebRepolt

Run WebReport: Basic WebRepolt OwnerID ParentIO DatalD Name OriginOwnerlD -332481 -1 332481 Transport

OwnerID ParentIO DatalD

Name

OriginOwnerlD

-332481 -1

332481 Transport Warehouse

0

-332431

332431

332482

Transport Boxes

0

-332481 332481

362466 OOG Warehouse Folder 0

-332481

362466

362576

000 Workbench

0

-332444

-1

332+14

Deleted Items

0

-286795

-1

286795

howard Home

0

-181744 -1

181744 rrdurmnt

0

-85636

-1

85636

c:slG Home

G

-81346·1

81346

studentlO

0

aQ3S7·1

80357

ysaito Home

0

aQ356·1

80356

hans Home

0

11. Click the Up Folder icon to return to the previous folder or Browse View page.

Chapter 2.

WebReport Basics

The browser is always assumed as the destination, but it can be changed.

Changing the Data Source

destination, but it can be changed. Changing the Data Source You will have the option of

You will have the option of selecting a data source when creating a new WebReport or you may select from a variety of data sources after the WebReport item is created.

Step Set2-2: Changing the WebReport Data Source

1. Add a new WebReport calling it Basic WebReport with CS Data Source; the Data Source can be left blank and select the Reportview file called basic report from the Use a Default Reportview list.

2. Click the Add button.

3. Click OK when prompted with 'You have not selected a data source Continue?'

4. From the WebReport Functions menu, select Properties> Source.

Figure 2-4: WebRe port Source Tab

The WebReport Source tab is displayed.

E~lerpri$~ > Coline Material' 3--0117· WtlbR2;pmt Oe~lg!1I" ~ W",bRH.)"nt~ t ~ Basic WebReport wtth
E~lerpri$~ > Coline Material' 3--0117· WtlbR2;pmt Oe~lg!1I" ~ W",bRH.)"nt~ t
~ Basic WebReport wtth CS Data Source
i_,~':~':~~i~_l~'~ "~." •.".I contffit5l1i(YtlfQ.uery@ Col\ttllt5~el'PiteO Qmt-MtS;jl:rv~Qt<:9[1.fI'O ExtuMlIAleO FTF'O &1:em~IAPp1ical;lollO 5-eaI.d,QlJeryUUlridlO
·."
Sefecta (onl~ot 'SeNer data .source: Ih;;lt I!; dyp",mk ,
nature.

5. Select Content Server Query.

i

_f

Chapter 2.

WebRe port Basics

The little blue callout icons offer in-page help and tips on the fields. Hoverthe mouse pointer overthe icon and the help appears. You'll see these on many of the WebReport interface pages.

Content Server Query

Objects in Content Server, each of which encapsulate a query of some kind, include:

Case

Channel

Compound Document

Discussion

Binder

Folder

Form

Form Template

LiveReport

Project

Saved Search

Task List

Task Group

Chapter 2.

WebReport Basics

Content Server File and External File

The File data sources allow you to select delimited files that will be parsed when the WebReport is run. The primary difference between these two data sources is the location of the data source file; either a document in the Content Server repository or an external file accessible from the Content Server application.

The options for Content Server File are illustrated below:

Figure 2-5: Options for Content Server Files as a Data Source

~ Basic WebRepott> '~ I: ~~"iIF6 r1 ~ I$",,-"'f;dv~""&l Ii]:,'I
~ Basic WebRepott> '~
I:
~~"iIF6 r1
~
I$",,-"'f;dv~""&l Ii]:,'I
I:············,· ·····,··"··:· ·.1

Content Server Category

The Category data source provides an easy interface to find all items in Content Server with the selected Categories applied. After selecting a Category, the user will define which Attributes are to be displayed in the report data.

The options for Content Server Category are illustrated below:

Figure 2-6: Options for a Category as a Data Source

~ Basic WebRepott • i

~ Basic WebRepott • i

for a Category as a Data Source ~ Basic WebRepott • i ~. VIew SQl CO(l!e.l'1t~eA"l!tQuerrO
~. VIew SQl
~.
VIew SQl

CO(l!e.l'1t~eA"l!tQuerrO e:.rlte1ltSef\W~O COlitefltSef\lerC~911ry@ Extematfll~O fWO

:j~~C#"""":·1~

Filter Results by User Permissions:

[;'l

Filter Results by User Permissions: [;'l Content Server WebReport Design I Page 2-7

Chapter 2.

WebRe port Basics

6. Select a data source of Content Server Category.

Figure 2-7: Basic WebReport Using the Product Spec Category

BasIc WebReport u I t.nlJ"'t I _~!:';':"'~!~' ; ';;'";;- _, _ ,

BasIc WebReport

u

BasIc WebReport u
I t.nlJ"'t I
I
t.nlJ"'t
I

_~!:';':"'~!~' ;

';;'";;-

_, _ ,

 

I Cc.nttAt5.frvtrQUl!'IY O

OlI'ltt,r\lServerRIe:O Co)t\uotStfVti"CilI~I)t)'@ fxttmelRl'eO FTPO

Ico,,,,,,t~'!':":"'lo"""""P'.fu<lSP"

,.• ~.~,'q eJ @ ~

• .fu<lSP" ,.• ~.~,'q eJ @ ~

0

Gr

El

0

0

0""01'

0

P'cel<Vd

o

Pmdurtlypt:

0

tWJnoTogy le\"e1 (pel't:«!niti:l)

 

I'2J ch.d.;A1I[J\ffl<!l.ckAll ~

 
 

V~i"'~:.~SQ;L~.•• :.F."il~ter:.Results by

User PeomlSslans:

fi1I

MaxImum Number of Results: ~' {Up To IOO}

7. Select a Category of Product Spec and choose the Green Attribute.

8. Click the Update button.

9. Run the updated report by clicking the Basic WebReport with CS Data Source link.

Figure 2-8:

Basic WebReport Results With Category Data Source

FTP

External Application

Run WebReport: Basic WebReport with CS Data SOurce

Basic WebReport lIIith CS Data Souroe

Ibl

OataJO PareotID SubType Name

Green

15956

15922

(l

Product 1st (pending)

0

15957

15956

144

cycle trainer.dO(

1

15961

15956

144

cydng commter.do<

0

15965

15956

144

hillilll1 boots,doc

1

15969

15956

144

oven.doc

(I

15973

15956

144

sleeplog bag.doc;

1

15977 159S(i

H4

tltertllClS.doc

1

10. Click the Up Folder icon.

Fi les are accessed via an FTP server. The configuration options are the same as for the Content Server File data source type with additional parameters to determine details of the FTP server.

Files are accessed via an external server such as a Web Server. The configuration options are the same as for the Content Server Fi Ie data source type with additional parameters to determine details of the external server.

Chapter 2.

WebReport Basics

The external server should either provide access to a file in the correct format, or to an appropriate server side script to invoke software necessary to return a file in the correct format.

Search Query Launch

None

Used to define WebReports that can be run from the Content Server Advanced Search page. Search Query Launch is discussed in the 2-0118 - Content Server WebReport Design II course.

When a WebReport is used to create a query screen or custom user interface which does not display data from a data source, None is selected as the data source.

The 2-0118 - Content Server WebReport Design II course provides more information regarding Data Sources.

Changing the Destination

n g i n g t h e D e s t i n a t

By default, WebReports display their output directly in the browser; however, the destination of report results can be changed. For example, you can store report results as a document in Content Server or send the results to colleagues via email.

Step Set 2-3: Changing the WebReport Destination

1. Copy the previous WebReport and call it Basic WebReport Stored to CS, saving it to the same WebReport folder.

2. Click the OK button to confirm the copy action.

3. From the WebReport Functions menu, select Properties> Destination.

Chapter 2.

WebReport Basics

The WebReport Destination tab is displayed.

Figure 2-9: WebReport Destination Tab

~ Bastc WebRepolt stored to cs -. '/ II················ ,".' - ,, -- , •
~
Bastc WebRepolt stored to cs -. '/
II················
,".'
-
,,
--
, •
"f"
\ "'"",,'
,.•
,.-
--
""
_ ""',
.
.
I·~~·~·
~,t.~~"~~_····
··
•.·
·
BIT f!ii
·'I. ero "'''
'.-.---------- --r:1b§J ~
I='?'!.<=<h
trn

Browser

The default option sends report results to the browser.

Content Server

Store report resu Its to Content Server.

4. From the Output Destination drop-down, choose Content Server.

Options for a Destination of Content Server are illustrated below:

Figure 2-10: Options for a Destination of Content Server

Enteqnm' (:Q1.I1!:'!l t1<Jtf:lial ' 3--0111-< Wl!bRt:Pilrt: r)t5ign.,. ~ WcilRJ!P'llls , ~ BasIc
Enteqnm' (:Q1.I1!:'!l t1<Jtf:lial ' 3--0111-< Wl!bRt:Pilrt: r)t5ign.,. ~ WcilRJ!P'llls ,
~ BasIc WebReport Stored to (S
'-'
;~~~E~;Ej "'-""'~=- ------"",,!iJ
~
~
~
~

Chapter 2.

WebReport Basics

5. Enter a Name for the report results (e.g., Basic WebReport Results for Product Spec Category).

6. Opposite the Create /n field, click Browse Content Server and select a location to store the report results (e.g., Enterprise Workspace> Course Material> 2-0117 WebReport Design / > WebReports folder).

Export Type and Add Version to

Additional options and settings are discussed below:

Selects whether the operation will either add a new Content Server node or alternatively add a new version to the specified document.

Append Results

Determines whether the report:

• Is added as a new version

• Appended to start of the existing document and added as a new version

• Appended to the end of the existing document and added as a new version

• Inserted between tags and added as a new version. (If you select this choice, newfields to specify the tags appear)

 

Export MIME Type

Determines the label for the type of document that will be created

and also the filename extension when downloaded (e.g

html,

.xml,

.csv, .xls etc." however, setting this option will not change the format of the actual file - that's controlled by the Reportview.

Use External Conversion Engine

Sends the report to a conversion engine to be converted to another format. For example, WebReports might create an HTML document, but then have it converted to PDF using a conversion engine such as Adlib Express'".

Adlib Express'" for PDF conversion is not part of WebReports and is an optional item. If installed, remember that the Administrator needs to perform some configuration in the WebReports Admin pages before this feature can be used.

7. Click the Update button at the bottom of the page.

Desktop

Store report results

to a file that is saved to the desktop.

Email

Send report results via email.

Chapter 2.

WebReport Basics

Options for a Destination of email are illustrated below:

Figure 2-11: Options for aDestination of Email

cot""ri,.· lIfebRo~Olt>; ~ Basic WebReport v u . • . . ' ." ~.~.~~!0'i i
cot""ri,.· lIfebRo~Olt>;
~
Basic WebReport v u
.
.
.
'
."
~.~.~~!0'i i
<.•• >•. oj Pltii.u . llii.1
··ii '-,------ ~
····
····.·.·i
••i".i
>
r-j
-----,
••
i" • ••
.•.•. I' .uu
Ct ~ ! ,~~(s.o~q ~
>
.
<
Luuu_
,------------, ~
ii
'.
1.··:r,,····rp<···<··'lt·Hl··tt!l'.··r<I'P"'
-----------'llii.1 "'·
~
r.:lto<li'"" u: hlm :;'L-
I
·.~.~~.~~~~_~~.I
EI
~
0
<
•••
••••
~
i<
Ii!l
~
.'
•.•.•.•.
Ii!l
~
•.
0
~
.
0
~

Email Address

There are 3 fields which provide different ways to specify the email addresses and may be fi lied out in any combination, so long as one address is specified:

• 1st Field: a list of email addresses

• 2nd Field: a Content Server user or group

• 3rd Field: a text file containing a receiver list

Email addresses are separated by either a semi-colon or comma, depending on the Content Server settings.

Server

Store the report results to a file that on a server, like a web server.

The little red flags opposite various fields indicate they can be populated with data from the report results. For example, specifying the recipients of the emailed report usi ng email addresses gathered in the report itself. This is done using WebReports tags in the fields which is discussed shortly.

Chapter 2.

WebReport Basics

Workflow

Attach the report results to an Initiated Workflow Map.

Options for a Destination of Workflow are illustrated below:

Figure 2-12: Options for a Destination of Workflow

~ Basic WebReport u t~ ,;"'tft~21 ~ r----------~ ------'---1 I
~ Basic WebReport
u
t~
,;"'tft~21
~
r----------~
------'---1
I ",C~"Cc.•••'.'~.•."'-
.----------~
OU.ln, °

Forms

Send report resu Its to a Content Server Web Form so that it populates form fields.

FTP

Send report results to an FTP server.

Manual Export

By changing the Destination settings for a WebReport, you change how the report behaves for everyone any time its run. If we just want to export the report once and not change the default behavior, the WebReport can be configured using its Functions menu> Export. The Content Server, Desktop, Email and Server export options can be run on a one-time basis using this method.

8. Run the Basic WebReport Stored to CS.

Chapter 2.

WebReport Basics

Content Server displays a message that WebReport data has been stored to the previously specified folder, as ill ustrated below:

Figure 2-13: Export of a Basic WebReportto Content Server Destination

Export WebReport: Basic WebReport stored to cs Exporting We:bRepore Basic WebReport Stored to cs We:bReport
Export WebReport: Basic WebReport stored to cs
Exporting We:bRepore Basic WebReport Stored to cs
We:bReport data has been sent to II new Content Server document called: Basic WebRepolt Results for Product Spec eateQOlY
Stored In container: WebRepo!ts
Enterplke'
Course Material ,
3-llU7, WehR
It Oesign, .• ,
Size
MOOified
fil
3l<B
07/07/20lot 12:54 PM
!}!lsi, W~bReportResul!s ro, Product SII'K Q!lM!!!Y".
')
~ !!ask. WebReoort Y ')
21<8
07/07/2014 12:36 P~l
~ §;!s!< WebRep0rt Stored W C$/
U
21<8
07/07/2014 12:53 P~I

9. Click the Continue button to navigate back to the previous page or alternatively click the WebReports container link to navigate to the folder where the report file was created.

10. Copy Basic WebReport Stored to CS and call it Basic WebReport with Versions in the WebReport folder.

11. From the WebReport Functions menu, select Properties> Destination.

12. Change the Export Type to Content Server Version.

13. Opposite the Add Version to field, click the Browse Content Server button and browse to the Basic WebReport Results for Product Spec Category node and click Select >.

14. Change Version Handling to Add Major Version.

15. Click the Update button at the bottom of the page.

16. Run the WebReport and click the Continue button to return to the WebReport folder.

Chapter 2.

WebReport Basics

17. Check that a new version of the Basic WebReport Results for Product Spec Category report has been added to Content Server, as illustrated in the figure below:

Figure 2-14: Version Added to Content Server as WebReport Destination

Enterprise ~ Course Material , ~117· WebRepolt Design

, WebReports '

 

Basic WebReport Results for Product Spec Category

 
Ale Name SIze Created Created By
Ale Name
SIze
Created
Created By

Vel'sion '0/

 

a

report; 201411710145a13 3384.htni

3 I<B

lIJ/lV/2G14 02:58 PM

Susan Adrrillvakovi!;

Default(Extemai Document Storage)

.1

reD9Ii

33ft! v

3

KB

07jiV/2014 02:54 PM

Susan Ad!!'illvaktwl

Default(E;xternal Docurrent storage)

Change the Look of the Report Results With Reportviews

Reportviews can change how a report's results are presented. You might want to include new data, or change the color scheme or include corporate branding. The Reportview contains everything to tell WebReports what data to include and how it should be presented.

The Reportview is a simple text document that functions as a template. It shows where report data should be inserted and describes how the document should look in between the data. For reports that will be displayed in the user's browser the Reportview will contain ordinary HTML (Hyper Text Mark-up Language) to describe how the report should look.

• The Reportview is divided into three sections: the Header, the Row Section and the Footer.

• The report output is constructed by repeating the Row Section once for every row of data returned by the data source. The Header is used once at the top and the Footer once at the bottom of the report.

• Data is inserted in the Row Section according to where special WebReports Data Tags are placed.

Chapter 2.

WebReport Basics

Figure 2-15: Example of a Reportview

<TABLE>'i

   

<TR>'i

 

<TDllLL_REPTAG_COLNllMEl . II </TD>'i

<TDllLL_REPTAG_COLNAME++'/I</TD>'i

 

Header1l

<TDllLL_REPTAG_COLNllME++'/I</TD>'i

 

<TDllLL_REPTAG_COLNAME++'/I</TD>'i

</TR>'i

   

_ Data·Tag~·"insert·

 

data'here"l1

<TR>'i <TD~lLL_REPTAG_l ~ <ITO>'!

   
 

<TD>(LL_REPTAG_Z'/I</TD>'i

<TDllLL_REPTAG_3'/1</TD>!

 

Row'Sectlon1!

<TDllLL_REPTAG_5'/1</TD>'i

 

</TR>!

 

[J,L

lliE1lllEPORT

ENDROW·/

I!

 

</TABLE>'!

 

}

Footer1l

In the above example, the Row Section is defined by the STARTROW and ENDROW tags. The <TABLE> and <TO> tags are standard HTML, and describe a table to be displayed in the document or web page.

There are two ways to edit Reportviews:

• Edit the file using an offline editor (e.g., Textpad) and add new versions of the Reportview

• Edit Reportview - online -- from the Functions menu

Changing the Reportview Using the Online Editor

The editor has a range offeatures to make working with Reportviews easier, including:

• Clicking any of the section labels such as Header Section toggles the size of the section

• Drag and drop tag selectors

• Textfunctions like Search, Redo and Undo

• Short cut to the WebReport tag reference

Chapter 2.

WebRe port Basics

Chapter 2. WebRe port Basics Figure 2-16: Basic WebReport Resu Its With Category Data Source Step

Figure 2-16:

Basic WebReport Resu Its With Category Data Source

Step Set 2·4: Changing the Reportview

1. From the Basic WebReport Functions menu, select Edit Reportview.

I OPENTExT I Export OJreO Add Reportview Version Download Reportview Edit Rej:lOrtview t v Fetch
I
OPENTExT I
Export
OJreO
Add Reportview Version
Download Reportview
Edit Rej:lOrtview
t
v
Fetch Reportview
Open Tag Guide
Rename
f··C::7<"·"r'~'.<~l.!.D''';5 .'.:?f0••.771 Add to Favorites
Copy
Make Generation
f.iake Shortcut

1 item

Move

Set Notification

Comments

Make News

Permissions

Reserve

Delete

Move Set Notification Comments Make News Permissions Reserve Delete

Chapter 2.

WebReport Basics

The Reportview editor page is displayed.

Figure 2-17: Reportview Editor

~ Basic WebReport' .~ R£l!<)\JE tIlE EOLLO'~ING tA~ BEE"(lJl£ EDItING IlllS Jl£POlUV!E:W •••
~
Basic WebReport' .~
R£l!<)\JE tIlE EOLLO'~ING tA~ BEE"(lJl£ EDItING IlllS
Jl£POlUV!E:W •••
H.
ThiSl
t-a9 hag Dillen
ad4.ecl. to
.""lOid er.ror.s bt.1n9 =-flpor1;.ed when the
da:t:6
.f¢\U~~
use-d ha.s
It is
le
9:~
t:h",n 5 c:~lumn3.
reqOl:tlm\ltnded that
thi3 'eAg' is xemo-ved
by U!l'triJ m=difying 'ehis: rap.o:r:t;vi.*,w 1;-(1 aS1Jiml:. we;m. -w.ith dlfi'tb\.1qg'inq
·/1
(W,-Il£Bll.EI1011.I_SllPPIlESSEAAOlU.OG
fl
<:!
Basic RapoJ:tl -
Created by C:ontf!n'C Stuver rieoReporea:
-->
~! -.
(U,_REP1MU'SAGE
II
>
til
!::Ix
t.
1;;he
I!tyle
f~.l" al'tE:rtUili'te
row
~olors u!3inq the
tJsrrtt'-P.tE" !Subt:4f;F
<.9tyla>
.1,ls$rll.o"l
(1:>a
k9roun~·
o~or: [LL_RSP!A<U.JSERIll VSEro!AAII:COLORS:IlOl/~ /1 i
<:nt CLi\SSoo" (LL
IGNmilun"> -
UPTAG 1l.0If!lUM ODDE'IElf:uurRo"l:"serll.o"Z
/I"
VALIGNm"CENrEll."
NOWRAP
-
dD>'''b.p; [LL_llEnAG_l /l</Ill>-
<lD>"'Q$]>1 [LL_REPIAG_2 /1<1l11>
<ID>'nb"l'i (LL_Jl£lnAG_3 /l<IlD>
<ID>'nb.I" [LL_UPIAG_4 Il-</TD>
"Tl»'nl>sp; (LL_RElnAG_5 1l<IID>

The editor breaks the Reportview into its three sections. The STARTROW and ENDROW tags are impl icit once text is entered in the Row Section or Footer and there is no need to type them in. If you ever need to share your Reportview with someone, use Download Reportview on the Functions menu rather than cut and paste from the editor.

Chapter 2.

WebRe port Basics

2. Scan through the three sections of the Reportview and familiarize yourself with the available function buttons.

3. Click the Header Section (grey panei) to expand the section.

Function Buttons

Add Version, Add Version & Continue, Reset and Cancel buttons are provided at the top and bottom of the page.

• Add Version causes the revised information to be submitted to Content Server as a new version, and returns the user to the previous screen

• Add Version & Continue also causes the revised information to be submitted to Content Server as a new version and then allows the user to continue to work on the Reportview

• The Reset button clears any changes made since the form was originally opened

• Cancel simply dismisses the form without saving a new version

Header Section

This section is used to provide any code that should be executed at the beginning of the WebReport. It is only output once, regardless of how many report rows are being read from the underlying data source. Any opening tags like <TABLE> should be in this section; however, it is not necessary to include <HTML> or <BODY> if the standard Content Server header is being included. The Content Server header is included by default unless the [LL_WEBREPORT_EXCLUDEHEADER /] tag is used.

Row Section

This section is used to define any code that should be applied to all data rows. Any tags that are used to refer to data source column data will only work in this section. It is important to note that anything in this section will be repeated for every row of the data source.

For example, if there are 10 rows of report data to be returned, everything in this section will appear 10 times in the output ofthe WebReport. The only exception to this is if conditional tags are used to exclude some data from the output.

Footer Section

This section is used to provide any code that should be executed at the end of the WebReport.lt is only output once regardless of how many report rows are being read from the underlying data source.

Chapter 2.

WebRe port Basics

4. Click the Tag Guide button to review the various Content Control Tags and Data Tags; the information is a valuable resource when editing Reportviews. You will be making use of Tags in Chapter 5, so just take a brief look at the available tag information at this point.

5. Close the browser window containing the Tag Guide when you are finished viewing it.

Figure 2-18: WebReport rag Syntax Reference

 

_• a~;syntaX I

 

"~_'.'2".,,_

,,,).

 

::

• ,,,, m>i ,",po'" I

,

,

content COntrol Tags

 

Sed:iOn

COntent COntrol Tag Name

 

Desoiptlon

H

 

F

!'Put

Used to comment the remainder oftha ine:.

   

"

I'l-'

o/J

used to denote a block comment whk:h coo span multiple lines.

?

 

" "

@[LL_WEBREPORLAPPEARBOTTOMOFF/J

ExckJdes any ApPearance HTML elements at the bottom, bottom left and bottom light.

"

 

@[LL_WEBREPOP:CAPPEARLEFfOFFf)

ExdJdes atr'I Appearance HTML elements to the left.

"

 

@[LL_WEBREPORCAP?EARRIGHTOFfIJ

Exmdes any Appearance HTML elements to the right.

"

 

@[LL_WESREPORT APPEARTOPHEADEROfflJ

ExdJdes any Appearance HTMl elements at: tile very top.

?

 

@[ll.WEBREPORT_APPEA.R.TOPOFFf]

Exdides any Appearance HTML elements at tiN top, top left and top right.

"

m

"

@[lL_WEBREPORT_CALLIJ

Cats a server side Oscrjlt function defined by ~WE6REPORT _STARTSCRtPT and ll_WEBREJlORCENOSCfUPT tags,

?

'"

4

Chapter 4 provides more details regarding the Content Control and Data Tags.

6. Click the Cancel button to return to the previous folder.

7. Run the Basic WebReport, so that we can visualize what the report output looks like with the existing unmodified Reportview.

Chapter 2.

WebRe port Basics

Figure 2-19:

Basic WebRe port Results Without a Modified Reportview

~t

~ Run WebReport: Basic WebReport

Basic WebReport .

OwnerlD ParentiD DataiD

Name

OriginOwnerID

-332461 -1

332461

Transport Warehouse

0

-332461

332461

332462

Transpurt Boxes

0

-332481

332461

362486

000 Warehouse Folder 0

-332481

362466

362576

000 Worl<bench

0

-332444

-1

332444

Deleted Ite

0

"266795

-1

266795

howard Horne

0

-161744 -1

161744 l11lurront

0

 

-1

65636

csl0 Home

0

-81346

-1

61346

studentl0

0

-80357

-1

80357

ysaito Home

0

-80356

-1

60356

hans Home

0

8. Modify the Reportview, using the Functions> Edit Reportview, so that the report node name and the up folder icon are not displayed in the header.

9. Also modify the Reportview so that it displays the ODG banner and information on when the report was generated and by whom (e.g., using available tags that we will learn more about in Chapter 4) and the sample code provided below:

Figure 2-20:

An Example of Header

Modifications for the Reportview

<p><img src="?fune=doe.Feteh&nodeid=379394" height="117"

width="638"></p>

Report results generated for: [ll_REPTAG_USERNAME I] on [ll_REPTAG_DATETIME/]

Or alternatively

<p><img src=" http://ioeal host/imglodg2013Iogo.gif" height="117" width="638"></p>

Report results generated for: [ll_REPTAG_USERNAME I] on [ll_REPTAG_DATETIME I]

10. Remove the 5 th column heading and displayed information also.

11. Save the Reportview modifications as a new version(s).

12. Run the Basic WebReport and verify your modifications were successful, as illustrated in the subsequent figure:

Chapter 2.

WebReport Basics

A

The Reportview's HTML img src references can either point to a Content Server node and be "fetched" or alternatively, they can be referenced from the local \support\ directory via the web server mapping (Le., \img\).

From the 1-0101- Content Server Knowledge Fundamentals course, users are taught that it is more efficient, performance-wise, to retrieve these graphics from the local support directory rather than from the database.

Figure 2-21: Basic WebReport Results With a Modified Reportview - Using a Banner Graphic and Tags

Run WebReport: Basic WebReport

Run WebReport: Basic WebReport

Report results generated fur. sadmin on Mon Jul 07 13:21:34 2014 outdoor gear

Report results generated fur. sadmin on Mon Jul 07 13:21:34 2014

outdoor gear

Report results generated fur. sadmin on Mon Jul 07 13:21:34 2014 outdoor gear

OwnerlD ParentID DataIO

Name

-390867 -1

390667 sadoMn

 

-332461

-1

332481

Transport Warehouse

-332481

332481

332482 Transport Boxes

 

-332481

332'181

362%6

OOG WareJIouse Folder OOG Workbench

-332481

362466

362576

-332444

·1

332444

Deleted Items

-286795

-1

286795

howard Home

-181744 -1

181744 mdumont

 

-85636

-1

85636

(s10 Home

13. Click the back browser button to return to the WebReports folder.

Chapter 2.

WebReport Basics

Default Reportviews

When adding a newWebReport to Content Server, the user is given the option of selecting a default Reportview.

Default Reportviews provide a variety of generic starting points

which can be used for developing a WebReport. Some

may be useful immediately but in other cases it will be necessary to edit them to meet specific requirements.

Reportviews

Once a WebReport has been created using a default Reportview, the user can either edit the Reportview online, or download the Reportviewfor editing on their desktop. These default Reportviews are provided when the WebReports module is installed; however, a Content Server administrator can modify them to provide a company look and feel.

Refer to the online help for more information regarding available Reportviews (i.e., ?func=help.index&keyword=LL.Webreport Webnode.create) or by referring to Appendix E.

Chapter 2.

WebRe port Basics

Summary

In summary, in this chapter we:

• Created and configured a basic WebReport

• Chose an appropriate data source

• Saved reports in Content Server and added a report version

• Made a simple change to the way a WebReport looks using Reportview

Chapter 2.

WebReport Basics

Exercises

Create a WebReport

Overview

Create a WebReport that lists data found in the KUAF (Users and Groups) table. Either create your own data source to do this or use the provided Data Source (KUAF) for WebReport Live Report. Then change the report destination from browser to Content Server to add report versions. Finally, using the Reportview, customize the look of the resulting report output making using of the provided tag.

1. If you choose to create the KUAF data source yourself, create it in Enterprise Workspace> Course Material> 2-0117 WebReport Design 1> WRD I Templates. The

LiveReport SQL query should be select

*

from

kuaf and the report format should

be set to autolivereport. Alternatively, skip to the next step and you can use a pre- written data source we have provided for you.

2. Create a basic WebReport calling it Basic Users and Groups WebReport in the Enterprise Workspace> Course Material> 2-0117 WebReport Design I > WRD I Student Folders> Student 1 WRD I Exercises folder. Hint: Use the previously create URL or Additional Enterprise Menu to make navigation to the folder easier.

3. Click the Browse Content Server button to select a Data Source. The pre-written data source, Data Source (KUAF) for WebReport, can be selected from Enterprise Workspace> Course Material> 2-0117 WebReport Design I > WRD I Template folder.

4. Select basicJeport from the Reportview drop-down.

Add: WebReport

18!1Sic Users and Groups WebReport basil: Ie ort Use a Default Reportvrew !Student 1WRO I
18!1Sic Users and Groups WebReport
basil: Ie
ort
Use a Default Reportvrew
!Student 1WRO I Exercises

5. Click the Add button to store the basic WebReport.

Chapter 2. WebReport Basics

6. Test the WebReport works by clicking the report link. Results should be similar to the following figure. Hint: Use the 'folder up' icon to return to the exercise folder.

~ Run WebReport: Basic Users and Groups WebReport

Basic Users and Groups WehReport

lD

OwnerlD Type

SpacelD Name

332458

1000

4

o

Queue fur Indexing ({298,{1000,17}})

332459

1000

4

o

Warehouse Manager ({S2S,1})

332460

1000

10

o

Warehousesystem

351264

1000

1

o

Warehouse Manager

371156

1000

4

o

UveReporl (299)

1000

1000

0

o

Admin

1002

1000

0

o

otadmln@>otds,admin

1001

1000

1

o

DefaultGroup

Changing the WebReport Destination

1. Copy the previously created WebReport to the same folder and call it Basic Users and Groups WebReport CS Version.

2. From the WebReport Functions menu, select Properties> Destination.

3. Change the Output Destination from Browser to Content Server.

4. The name of the report output should be called Basic Users and Groups from ODG.

5. Click the Browse Content Server button and select the Enterprise Workspace> Course Material> 2-0117 WebReport Design I > WRD I Student Folders> Student 1 WRDI Exercises folder.

Chapter 2.

WebRe port Basics

~ Basic Users and Groups WebReport 9

~ Basic Users and Groups WebReport

9

WebRe port Basics ~ Basic Users and Groups WebReport 9 i_(lo1~~I'~.~~'.': ~~ 1[~q.rll~nt_S~_rv~fI£]~
i_(lo1~~I'~.~~'.': ~~ 1[~q.rll~nt_S~_rv~fI£]~ C(lntflnt~lVefNod~@CQ~l.llltlt~rvl!rVelmI10 ~
i_(lo1~~I'~.~~'.':
~~
1[~q.rll~nt_S~_rv~fI£]~
C(lntflnt~lVefNod~@CQ~l.llltlt~rvl!rVelmI10 ~

6. Click the Update button at the bottom of the page.

7. Run the WebReport and confirm that it output report results to the exercise folder:

Export WebReport: Basic Users and Groups WebReport

Export WebReport: Basic Users and Groups WebReport . Exporting WebReport: Basic: Users and Groups WebReport WebReport

.

Exporting WebReport: Basic: Users and Groups WebReport

WebReport data has been sent to a new Content Server doc;urrent caDed: BaS¥; Users and GrollPs from oOG

stored in container: student 1 WRD J Exerdses

8. Now modify the WebReport again (as we did in Step 2), so that the Export Type is Content Server Version, the destination file is Basic Users and Groups from ODG, and the Version Handling is Add Major Version. Remember to click Update.

Chapter 2.

WebReport Basics

9. Run the WebReport and confirm that a new version of the Report output file has been added to Content Server.

Enltlrplise' Courne Material; 3-0117· WebReport Design,., ' WRD I 5wdent filldern , $wdent 1 WRD
Enltlrplise'
Courne Material; 3-0117· WebReport Design,., '
WRD I 5wdent filldern ,
$wdent 1 WRD ! Exe"""", ,
@J Basic Users and Groups from OOG 'Q
Version'""
k
report 201407071}SOl§. 2816.hlml· F
19 KB
07/07/201401:50 PM
sman Admlnvaf«>va
Defaurt(BdWlal Document Storage)
19 KB
07/07!20H 01:49 PM
SUMn A4minvakova
Defaurt(Bdernal Documelll Storage)

Changing the Reportview

1.

Alter the Reportview, for the Basic Users and Groups WebReport, using the online editor so that it has a new heading and a message in the footer. For example, you could modify the header using the following tag line:

Report results generated for: [LL_REPTAG_USERNAME /] on [LL_REPTAG_DATETIME

/]

2.

Download the Reportview to your desktop using Functions menu> Download Reportview. Make a change to your Reportview header and/or footer using either Notepad or TextPad. Hint: Use the Tag Guide as a reference and try using a number of the available tags for headers and footers.

3.

Add the modified Reportview as a new version to the WebReport.

4.

Test your Reportview modifications by running the WebReport.

5.

Take a look at Properties -> Versions page for your WebReport. You are looking at different versions of your Reportview and you can run different versions by clicking them.

Chapter 2.

WebRe port Basics

Challenge Exercise

Overview

This exercise provides a bit of a challenge and allows you to make further modifications to the Reportviews. You will need to know how HTML tables work forthis part of the exercise.

Editing the Reportview Columns

1. Copy the Basic Users and Groups WebReport and call it Basic Users and Groups WebReport without Space Column.

2. Edit the Reportview so that your report does not display the 'Space Column' heading or data. Ensure that you have the correct column headings too.

~ Run WebReport: Basic Users and Groups WebReport without Space Column

Bask: Users and Groups: WebRepott without space Column

&J

Report results generated for: sadrrin on Thu JuliO 15:23:52 2014

ID

OWl1erID Type

",ore

332458

1000

4

Queue for Indexing ({298,{1000,17}})

332459

1000

4

warehouse Manager({S25,1})

332460

1000

10

WarehouseSystem

351264

1000

;I.

warelmuse Manager

371156

1000

'I

LiveReport {299}

1000

1000

0

Admn

1002

1000

0

otadnln@otds.admn

1001

1000

1

DefaukGroup

Chapter 2.

WebReport Basics

Chapter 3.

Scheduling WebReparts

3. Scheduling WebReports

Objectives

On completion of this chapter, participants should be able to:

• Set a Schedule for a WebReport and avoid possible pitfalls

• Describe the Administration capabilities of Manage Scheduled Reports

Overview

In this chapter, we look at howto make WebReports run according to a schedule.

There are many reasons why scheduling WebReports can be practical, for example:

• Running large reports outside busy work times

• Storing results for later use by delivering popular reports as static documents

• Updating report files once per hour to avoid hitting the database with a report query every time a user accesses the information

• Provide specialized notification functions

Chapter 3. Scheduling WebReports

Scheduling WebReports

When we looked at the Destination tab earlier you may have noticed that some destinations had a Set Schedule check box. Selecting this check box reveals additional controls that allow a WebReport to be run automatically according to the parameters you specify.

Reports can be scheduled to run:

• Starting from a particular date and time

Repeated for either a fixed number of repetitions or forever

• In intervals from minutes up to years

Schedules for Report

Destinations

Only the following destinations permit scheduling:

Content Server

Email

Server

Workflow

Form

FTP

There are a few important subtleties to be aware of when scheduling a WebReport.

Multiple User Schedules but

Same Destination

Multiple users can set a schedule for the same WebReport, however, they must all use the same Destination settings.

For example, if Chris chooses export to Content Server and sets a schedule and then Peggy changes the export destination and sets her schedule, then Chris' reports will be exported to the new destination. Both Chris and Peggy's schedule will continue to run; the destination type and settings, based on the last user modification, will continue to run on each respective user's schedule interval and time settings.

Scheduled Report Runs Under User Account

Permissions

When a report runs on a schedule, it runs as if the user who set the schedule ran it.

Report results can - and often do vary - according to who runs the report. Results can vary according to a specific user's permissions. If you schedule a report and publish the results in a widely accessible location, make sure that the user scheduling the report has the appropriate level of permissions and privileges for public consumption, or that the report is written so sensitive information is not revealed.

Chapter 3.

Scheduling WebReports

Administering WebReport Scheduling

Scheduling WebReports Administering WebReport Scheduling Step Set 3-1: Administering WebReport Scheduling 1. Log

Step Set 3-1: Administering WebReport Scheduling

1. Log in with an administrative account.

2. Navigate to the Administration pages. If prompted for an Administrator password, enter it (i.e., opentext).

3. Click the WebReport Administration section.

The WebReports Administration page is displayed.

Figure 3-1: WebReportsAdministration and Manage WebReports Schedules

OPENTEx'r Content Server Show All s.mo., ~s.~-;;;:C.;nflguratlon ----T------------·------~---~---------------
OPENTEx'r
Content Server
Show All s.mo.,
~s.~-;;;:C.;nflguratlon ----T------------·------~---~---------------
-Oata~~;·Ad;lni;ka-ti~----·l
~::~~:::he:of tampiledreportviews,
. Sylllem Adminlatnliion
'In.lalI Roou••I.J.Ub!'l!l(
Modul.
Admln!• .,.,.!I.n
P"",id"" an !ntefh,o to Install tll. R'Quosls Ubrary .nd
o.t04
ftl
to t~eJ.vaS<rlpt library lo,atlon•
.~!!~.~!!-
.~
~_~~
ManBAA C:l1t.en01V pata Souretr CmlfiDuratiQn
_dota
Update mOldmum number 01 ",togori
and atmbut. dlsploy parameter••
Appeoranc
Admlnlalta1lon
Mana® Destination Me~ ryPfUI:
Bo.t Beta Adminiatrallon
CoUootionaAdm'nlatrll1i9n --
c.nfigu", wblch media type; can b. u,ed fo' WebRopot\$ output.
Manaoo Search Query tntoora tion
Conlent S"""',APPii;U~