Content Server WebReport Design I PDF

(
.!
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, I
translated or transmitted in any form or by any means without the prior written consent of Open Text.
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 I v10.5.x - First Edition: September 2014

Content ServerWebReport Design I v10.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
Page ii Content Server WebRe port Design I

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: _
Content Server WebRe port Design I Page iii

Text Conventions
This workbook uses the following conventions:
Monospace (courier) Monospaced text is used to represent sample code.
Italic Italics are used for Workshops and Exercises.
Bold 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 end of a chapter.
This icon represents a caution that supplies warning information.
Pageiv Content Server WebReport Design I

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
Content Server WebRe port Design I Page v

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
Page vi Content Server WebReport Design I

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 Portal 8-9
Create a Mini Portal- Exercise Solution 8-10
A. WebReport 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: User Interface SubTypes by Display Name B-8
Table B-3: SubTypes by Integer Value B-l0
Content Server WebRe port Design I Page vii

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
Page viii Content Server WebReport Design I

OPENTEXT'M Content Server WebReport Design I
Learning Services
vl0.5 SPl
Student Attendance Form
Course Delivery Information
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.
Content Server WebRe port Design I Page 1-1

Chapter 1. I ntroduction 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
~.'_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
Page 1-2 Content Server WebReport Design I

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
Content Server WebReport Design 1 Page 1-3

The table below lists a number of the WebReport data sources and
destinations, similar to what was illustrated in the previous figure.
.. " ""n"""ft.
.
Content Server Query Browser
Content Server File Content Server (Document, Version)
Content Server Categories Desktop

Table 1-1:
WebReport Sources and Externai File Email
Destinations
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.

WebReport Administration A number ofthe WebReport Administration options will be

discussed throughout this course, including:
Flush Cache Clear the cache of compiled Reportviews.
Install Requests.js Library Provides an interface to install the Requests Library and associated
files to the JavaScript library location.
Manage Category Data Source Update maximum number of Categories and Attributes display
Configuration parameters.
Manage Search Query Manages the ability to invoke WebReports directly from the Advanced
Integration Search page.
Manage Tags and Sub-Tags Enable and disable tags and sub-tags.
Manage User / Group WR Determine which Users and Groups can trigger WebReports.
Triggers
Manage WebRe ports Conversion Change the Sleep Interval for the Conversion Agent and set input and
output directories to manage PDF conversion.
Manage WebRe ports Schedules Change the Sleep Interval for the Schedule Agent and enable/disable
or permanently delete individual schedules.
Manage WebRe ports Scripting Enable or disable scripting of individual WebReports.
I Manage WebReports Services Enable/disable or restrict the WebReports services feature.
Manage WR Triggers Determine which node types can trigger WebReports.
Miscellaneous WebRe ports Configure miscellaneous WebReports settings.

Settings
WebRe ports Licensing Set or change the WebReports License Key and display licensing
status.
WebRe ports Node Identify and update Reportviews using out-of-date syntax.
Administration
WebRe ports Sub-tag Builder Used to test build and subtags that have been created in the subtags
folder.
Content Server WebReport Design I Page 1-5

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 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
CS10S Installation 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

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

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).

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

m~ ~'OO yclyms (;&Vi . OJI2.lJ401j.H~41A,"':
!i IIMl~ 03/W2l)11 U-o~ M:!
---I 3. Make sure you can log in and navigate withi n the Enterprise Workspace.

Chapter 1. I ntroduction 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

.....
•....•.• ~ '., .......! , .... ,"",
""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 Row 2 11.011'2 ROW 2
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.
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 I folder.
3. Click the WebReports folder link.
4. From the Add Item menu, select WebReport.

The Add WebReport page is displayed.
Figure 2-1: Add WebReport
Add: WebReport
Use a Default Reportview
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.

Figure 2-2: Adding a Basic WebReport
Add: WebRe port

IBastC WebRe port
This is a basic WebRepolt With

DTreeQ)R as a data source.
...·Dl.taSOClrc:e~.· ••·•·•. · I lenterprise:courseMateriaJ:3-0117 - WebRe~ Go To Source Tab 0
. ~ Use a Default Reportview
IWebReports
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:
Run WebReport: Basic WebRepolt
OwnerID ParentIO
DatalD Name OriginOwnerlD
-332481 -1 332481 Transport Warehouse 0
Figure 2-3: -332431 332431 332482 Transport Boxes 0
Basic WebReport Results in -332481 332481 362466 OOG Warehouse Folder 0
Browser -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.

The browser is always assumed as the destination, but it

can be changed.
Changing the Data Source 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.
The WebReport Source tab is displayed.
Figure 2-4: WebRe port Source Tab
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

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:
• Binder
• Case
• Channel
• Compound Document
• Discussion
• Folder
• Form
• Form Template
• LiveReport
• Project
• Saved Search
• Task List
• Task Group

Content Server File and External The File data sources allow you to select delimited files that will be
File 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
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
CO(l!e.l'1t~eA"l!tQuerrO e:.rlte1ltSef\W~O COlitefltSef\lerC~911ry@ Extematfll~O fWO

:j~~C#"""":·1 ~
~. VIew SQl Filter Results by User Permissions: [;'l

6. Select a data source of Content Server Category.
Figure 2-7: Basic WebReport Using the Product Spec Category
~ BasIc WebReport u
_~!:';':"'~!~' ; 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 @ ~
.............................. I
t.nlJ"'t..........""~,.'\" I 0 Gr... El 0 l"~",i' 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 ~
';;'";;- _, _,__,~"';J-:= . 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.
Run WebReport: Basic WebReport with CS Data SOurce

Basic WebReport lIIith CS Data Souroe Ibl
Figure 2-8: OataJO PareotID SubType Name Green
15956 15922 (l Product 1st (pending) 0
Basic WebReport Results With
15957 15956 144 cycle trainer.dO( 1
Category Data Source 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.
FTP 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.
External Application 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.

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 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.
None 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 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.

The WebReport Destination tab is displayed.
Figure 2-9: WebReport Destination Tab
~ Bastc WebRepolt stored to cs -. '/
II················ ," .' - ,, -- , •.................... "f" \ "'"",,'

..,.•....,.-
..-- "" _ ""',
... . .. . _. ..
I·~~·~·.~,t.~~"~~_· · ·.·.•.·.· ·'I.ero"''' BIT f!ii

b§J ~
' . - . - - - - - - - - - -.--r:1
..................... 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 WebReport Stored to (S .. '-'
;~~~E~;Ej "'-""'~=-
.. - - - - - - " " , , ! i J
~
~
~
~

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).
Additional options and settings are discussed below:
Export Type and Add Version to 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.

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 oj Pltii.u . l i .1
<.•• >
•.
............. ··ii '-,- - - - - - ~
. . . . . · · . .· · .·.·i ..> ••i".i r.-._
j ....._
_ .- - - - - ,
• • . i " . •. .• .•.•. I' .uu Ct ~ ! ,~~(s.o~q ~

...>.. .... <
Luuu_
,------------, ~
1.··:r,,····rp<···<··'lt·Hl··tt!l'.··r<I'P"'..•. ii '. ....""u:

r.:lto<li' :;'L-
hlm ... "'· ~
-----------'llii.1
....
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.

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----------~
I ",C~"Cc .•••'.'~ .•."'- ------'---1
.----------~
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.

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 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 !}!lsi, W~bReport Resul!s ro, Product SII'K Q!lM!!!Y". ') 3l<B 07/07/20lot 12:54 PM
~ !!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.
16. Run the WebReport and click the Continue button to return to the
WebReport folder.
Page 2-14 Content Server WebRe port Design I

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
Vel'sion '0/ Ale Name SIze Created Created By
a report; 201411710145a13 3384.htni 3 I<B lIJ/lV/2G14 02:58 PM Susan Adrrillvakovi!; Default(Extemai Document Storage)
.1 reD9Ii 20H071lU4~4 33ft! v 3 KB 07jiV/2014 02:54 PM Susan Ad!!'illvaktwl Default(E;xternal Docurrent storage)
PurgeallV4!rs~~sexcept~ll'l~~~Jlt:j. rc--lf~iJla\ie~~~J
Change the Look of the Reportviews can change how a report's results are presented. You
Report Results With might want to include new data, or change the color scheme or
Reportviews 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.

Figure 2-15: Example of a Reportview
<TABLE>'i
<TR>'i
... <TDllLL_REPTAG_COLNllMEl . II </TD>'i
... <TD~lLL_REPTAG_COLNllME++'/I</TD>'i
... <TDllLL_REPTAG_COLNAME++'/I</TD>'i Header1l
... <TDllLL_REPTAG_COLNllME++'/I</TD>'i
... <TDllLL_REPTAG_COLNAME++'/I</TD>'i
_ Data·Tag~·"insert·
</TR>'i
[J,L..JlEB~RT...:STARTRO'iI·/]'I data'here"l1
<TR>'i
... <TD~lLL_REPTAG_l ~ <ITO>'!
... <TD>(LL_REPTAG_Z'/I</TD>'i
... <TDllLL_REPTAG_3'/1</TD>! Row'Sectlon1!
... <TD~lLL_REPTAG_4'/1</TD>'i
... <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 The editor has a range offeatures to make working with
Using the Online Editor 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

Step Set 2·4: Changing the Reportview

1. From the Basic WebReport Functions menu, select Edit Reportview.
I
I
OPENTExT Export
OJreO
Add Reportview Version
Download Reportview
Edit Rej:lOrtview
v t
Fetch Reportview
Open Tag Guide
Rename
f··C::7<"·"r'~'.<~l.!.D''';5 .'.:?f0••. 771 Add to Favorites
Figure 2-16:
Copy
Basic WebReport Resu Its With
Make Generation
Category Data Source
f.iake Shortcut
Move
1 item
Set Notification
Comments
Make News
Permissions
Reserve
Delete

The Reportview editor page is displayed.
Figure 2-17: Reportview Editor
~ Basic WebReport' .~
H . R£l!<)\JE tIlE EOLLO'~ING tA~ BEE"(lJl£ EDItING IlllS Jl£POlUV!E:W •••
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 le..9:~ t:h",n 5 c:~lumn3. It is 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 UPTAG 1l.0If!lUM ODDE'IElf:uurRo"l:"serll.o"Z /I" VALIGNm"CENrEll." NOWRAP

IGNmilun"> - -
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.

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.

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-' U· _.. 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. ? ••
m
@[ll.WEBREPORT_APPEA.R.TOPOFFf] Exdides any Appearance HTML elements at tiN top, top left and top right.
" "
? 4
@[lL_WEBREPORT_CALLIJ Cats aserver side Oscrjlt function defined by ~WE6REPORT _STARTSCRtPT and ll_WEBREJlORCENOSCfUPT
tags, '"
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.

~t
~ Run WebReport: Basic WebReport
Basic WebReport .
OwnerlD ParentiD DataiD Name OriginOwnerID

-332461 -1 332461 Transport Warehouse 0
Figure 2-19: -332461 332461 332462 Transpurt Boxes 0
Basic WebRe port Results Without -332481 332461 362486 000 Warehouse Folder 0
a Modified Reportview -332481 362466 362576 000 Worl<bench 0
-332444 -1 332444 Deleted Ite.... 0
"266795 -1 266795 howard Horne 0
-161744 -1 161744 l11lurront 0
~636 -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:
<p><img src="?fune=doe.Feteh&nodeid=379394" height="117"

width="638"></p>
Report results generated for: [ll_REPTAG_USERNAME I] on
Figure 2-20: [ll_REPTAG_DATETIME/]
An Example of Header Or alternatively
Modifications for the Reportview
<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 5th 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:

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\).
A 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
outdoor gear
Report results generated fur. sadmin on Mon Jul 07 13:21:34 2014
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
-332481 362466 362576 OOG Workbench
-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.

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 Reportviews
may be useful immediately but in other cases it will be necessary to
edit them to meet specific requirements.
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.

Summary
• 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

Exercises
Create a WebRe port
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 Exercises
5. Click the Add button to store the basic WebReport.

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 WebRe port 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.

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

7. Run the WebReport and confirm that it output report results to the exercise folder:
Export WebReport: Basic Users and Groups 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.

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 ! 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.

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 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 Only the following destinations permit scheduling:

Destinations
• 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 Multiple users can set a schedule for the same WebReport,
Same Destination 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 When a report runs on a schedule, it runs as if the user who set the
User Account schedule ran it.
Permissions 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.

Administering WebReport Scheduling
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------------·------~---~---------------
-Oata~~;·Ad;lni;ka-ti~----·l ~::~~:::he: of tampiled reportviews,

. Sylllem Adminlatnliion ' I n . l a l I 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~e J.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 c.nfigu", wblch media type; can b. u,ed fo' WebRopot\$ output.
CoUootionaAdm'nlatrll1i9n - - Manaoo Search Query tntoora..tion
Conlent APPii;U~
S"""', Manages the abUlly 10 if\VOke WebReport< dJ,ertly 110m the ••a,<h set".n.
Adm~nj8ltation
Mtmpoe Tags and Stlb...Tags
Ol,ocl<>,y SeJ'Vtt:u Inteoration Enable and d".bl. tags and .ub·L>g,.
Admlni'lrall<in
•• ~ •• w ~_ _ ~ ~ n._n.
Documenl tindel_to Mnrlime U.er I Group WR TriooMS,
Admlnl.tnltlon Determin. wbi<b U,e", and "",up, <an trigger WebReports.
eUnk Admtniafratlon
....---.,...--1 nvers",n Agent and ,et Input ..d output dl,e<torles to manage PtlF <o..."lon.
Em_il setVices AdminIstration
Enlerpri•• Conne<;\
Mmlnl.tnlUon Enabl~d".bl. or perman""lly delete IndMdual «bodules.
_._------~---~
Item Templafu AdmInistration

LlvoReporuAdmlnl.t,ation
_':'.."!~:!il. OU!Il,U.!. Admin'l1",tI,,;;= Monage WebReports SeNfce-"
Notification Admlnlalnltlon
-------~_._~.~~.,----
Enab!eld,..ble 0' ",$!lid the WebR.ports ,ern<.. f.aw",.
RecomrMndor Admlni.tratlon Maoage WR Trimrers
Searcb Admmi.atration Determine wblch nod. types <an trigger WcllReports.
Pul•• Admlnlltrall<i. _._ _ Miscelhmwus WebReporU Setthlg9
.!!~!: P"''Ild~.t:~~~~.!._. _ Configure ml,ceJlane<los W.bReports ,ettlng,•
Users and Groups Administration Webnenort~ l.l~ftnllhlg
W.,"~ou" Admlni.tratlon S.t or ,hang. tho Web Reports Ucan.e Key and dl,play licensing ,taw,.
WebRgDorU kode Admfnistrnf!on
1denll'" and update repol1vi""'s ",Ing out-ol-date .<yom.
~
W"bOAV AlIInlniitrat'on U.ed to le<t build and SUb-tags th.l bave be.n created In t~e .ubtag. folder.
Webl'". Cote..e, Conflou",t1on
WebR_lImn AdIllinl.lration
.!'~~'W Adm!~lltnltlon ~j
I
=:::.:----_._----
Prospeelora AdmlnlBllaUon
-j

Chapter 3. Scheduling WebRe ports
4. Click the Manage WebReports Schedules link.
The Manage WebReports Schedules page is displayed.
5. Change the Sleep interval from 300 to 60 and click the Save Agent
Changes button.
Figure 3-2: Manage WebReports Schedules Page
Manage WebReports Schedules
Spedfy the: sIeep i:ll.teN'al for the WebRe:pom; schedufing .agent in secon4$. This Is- thft amount. 4f ome: the- agMt Will mit btiQre running ag.ain. For petformlnce ft:aSOJiSI the v0'5roe ~Iltered must be grtater than 59,
Onoo lite change< .re _ , • reslllrt of lIte..mas Is ""IuiNd.
~liOQAgentSI_Inte""'b I~
n~~~cl:~q
- -s."""-In,tance.
Th.... are .. W.bl\epoftt ,theduJ.. ill In thIS CO<ltent
---
Sleep Interval The Sleep Interval setting is entered in seconds, and must be at
least 60 seconds or more. After submitting the form, a restart of
Content Server is required so that the agents are adjusted with the
new values.
If any agent's Sleep Interval is less than 300 seconds, or 5 minutes,

the Destination tab of that WebReport Properties page will change
with an additional option to manually enter the Minutes value for
the scheduled report. This allows for more granular control of how
often the WebReport will run.
By default, the WebReports scheduling agent is configured to run

every 5 minutes, or 300 seconds. In some instances, it might be
desirable to execute a WebReport in shorter increments than 5
minutes.
Content Server Agents need to be enabled, in the [loader]

section of the opentextini file; however, Notifications do
not have to be enabled.

Scheduled reports, if any schedules exist, are listed in a tabular

format, once for each user that scheduled it along with its
corresponding information:
• The Enabled check box can be cleared to temporarily turn off
the schedule and it can be restored by selecting the box again.
• Run Times shows how many more runs remain. Forever
appears if this applies.
• A schedule can be permanently deleted by selecting the Delete
Schedule check box and clicking the Apply button.
Troubleshooting a Troubleshooting Scheduling Problems:

WebReport Schedule
• Log in as the user that has set the schedule. Run the WebReport
manually to check that it runs ok. If it does not run manually, it
won't on a schedule either.
• Check that the user has appropriate permissions, for example
the ability to Add Item to destination folder in Content Server.
• Check that agents are enabled.
• Turn on agent logging then check the agent logs to see whether
or not the WebReport agent reported a problem.
Creating WebReport Schedules

Step Set 3·2: Creating a WebReport Schedule
1. Navigate to the Enterprise Workspace> Course Material> 2-0117
WebReport Design I > WebReports folder.
2. From the Basic WebReport with Versions WebReport Functions
menu, choose Properties> Destination.

The Destination tab is displayed.
Figure 3-3: Report Destination of Content Server Versions
~ BasIc WebReport with VersIons ~ '-'
3. Click Set Schedule.
The Schedule section is displayed.
4. Configure the schedule so that the report is run 3 times every 3

minutes.
Figure 3-4: WebReport Scheduling
I"»~»:'::':,,·,>·~c,::··:,:~·~<:>,,-~·:·>·>:·>:·'C:,:·"'::":':',:,,;.,,!
107/07/2014 j [ill , 121111: 1~8~1 f'PBlm;,~j)j' ~
o Forever rr--- Times . .
o 5 Minute Increments @ Enter Minutes (0-59)
!31.. .. : Minutes [iiJi1I Hours 1?1m Days fG"""J Weeks . .

Chapter 3. Schedu ling WebReports
5. Click the Update button.
The option to Enter Minutes is greyed out and not available

unless the Sleep Interval (discussed in the previous section)
is less than 300 seconds.
6. Visit the Manage WebReports Schedules page. The newly created

report schedule will be listed-and enabled-as illustrated below.
Refresh the page (e.g., F5) about 10 minutes after the report
schedule was created; the Run times will reduce from 3 to O.
Figure 3-5: Scheduled Report is Listing on the Manage WebReports Schedules Page
Specify th~ :'jl~ lntetvai for the WebRepd$ Sth~uling agent 10 $!f(Qnds:". this i.'i the aPWtJn't iJftlm"llhe ;agen'twfii wait bfIfoCi;! fUl)(1llttJ aga~n. For pwoml"nce ~~asons,lhl3 v~ue-I!tlh!t-ed must be greater than-59-.
Once the (:~JJ§i!S am salledJ it ~rt tif tlle:serv~is fil!qul.red.
sdJ""uUn\lAglmfSfuop in/:,;m,I, I~
!s",",~Ci.i~liA~!I·
7. Check that [3] new versions of the report have been added to
Content Server.

The Scheduled WebReport has added the three most recent

versions of the report output; note the 3 minute interval between
creation times.
Figure 3-6: The Report Results Versions Tab Illustrates Report Version Being Added
Enterprise' Olurse ~latefia! ' 34>117· WebRepOlt ~i9!l ... ' WebRe poTts '
iJ Basic WebRe port Results fur Product Spec Category . ~. u
fileName SiZe Slllf1lge Provider
r!lAArt 201407(17143<\52 391§.html 3KB 07/07/2014 02:34 PM StfS;ln Adminya!Sllvii Default(Elltf!rnal Coroment SlQfaqe)
1 fepqrt 2Ql1!m!7t431S2 3!!1Ji,h!mI" 31(5 07/07/201402:31 PM ~n (ldmmyako¥;!l Defauft(Exlernlll Document storage)
~ moort 2014!Vll71429S1 391!i,blml . 3KB 07/07/21l14 02:29 PM swan AdmJ!lva!Sllvil Default(Elltf!mal Doroment Storage)
~ rAA!lrt 20140EUm43 28l§.btrr.}, 3KB (17/07/201401;35 PM fu\San Admln'¥llkm1Jl Default(Exterfllli Ollcumellt storage)
3K6 07{07/201112:S4 PM fred Bassett Oefault{Elltf!mal Document Storage)
Summary

• Set a schedule for a WebReport and avoid possible pitfalls
• Described the Administration capabilities of Manage Scheduled
Reports

Exercises
Overview
Administer the sleep interval and then create a Schedule for the previous Basic Users and Groups
WebReport and store it to Content Server 4 times at 4 minute intervals.
Change the WebReport Scheduling Agent Sleep Interval
If you did not perform Step Set 3-1, complete the following steps to change the Sleep interval value,
otherwise skip ahead to the next exercise.
2. Navigate to the Administration pages. If prompted for an Administrator password, enter
it (Le., opentext).
3. Click the WebReport Administration section followed by clicking the Manage
WebReports Schedule link.
4. Change the Sleep interval from 300 to 60 and click the Save Agent Changes button.
Create a WebReport Schedule
1. Copy the previously created Basic Users and Groups WebReport CS Version and call it
Basic Users and Groups WebReport - Scheduled.
2. From the WebReport Functions menu, choose Properties> Destination.
3. Click Set Schedule.
4. Configure the schedule so that the report is run 4 times every 4 minutes.
5. Confirmthat the WebReport is scheduled to run 4 times at 4 minute intervals by

navigating to the Manage WebReport Schedules page.
A
I

.5~ ~ JI~p Intel'VlIl rot lbe WtbbD~ $d'I~lin'\l "gtnt Iii $WJM!. This Is 1M Affifiuni of ijme ~ bg.et\t lmll wait bd'me !lll'\.i'll.nllJO/Iln. for ptt'fOHMIl«: rUSOrlSt th~ vahle- oente«:d murt b.e Qfoe~ Ol~f\ 51.
Oo~ttt. dlitnpef ..... ~ a ratartoltht ~loQtlIi l$felt"ired.
~1I.. Ajl<.rltSr...,.u_ 1160i

'''~'~~~'J /~H
~~~~~J~ __ __
,~~.~ ~_. ~ __ ~"~~ ~, -':' EIl_bled'- ~~~~-~-N~Rull __'-'r Roo~~~,.~~ .~_ -l
n~~~
SlJutlAdiNrwl!~RVf! 9.W<llimalidGI04.JpsWab!l.e:c9~ ',' ~ 01j07/2Ul4.02H1PM ~i_~q 4 4~litl$ OH~l,l:ro (lOoliys: oW~eb 0 I
Sll@n AdmlrrGkga ~ WAAR!1lort wih Y~I*M 0 Q7/rm~OH QL:31 PM ~;~,~H 0 3 Hrns 0 HilUf' 0 O~ Q W . 0
6. After allowing enough time (e.g., 15 minutes), visit the Versions tab for the Basic Users
and Groups from ODG report and confirm that the Scheduled WebReport has added the
4 most recent versions.
Ale !IaJne SiZe created Cl"eaW:IIly Storage Provider

---_._---
li r<P\lrt 22119Z971456S1 3916,blml .~ 19 K6 07!91f~014 02~S~ I'M $u"o I\dnl1!'!V~OO Oefau1t(External Dowment 510'llge)
li 'Willt 4!!14979ZHS2S3 3';l16,hlml 19 J(B 07/97[1.01'f O~:S2 pt.I SU.,. AdmirwaOO Dtfuult(Ext<!(niil DOQlmenl SW"'lle)
1 ,#oort ;w140707144853 391!i.frtml v 19 KB OlN7!2014 02:43 PM Susan AdmrnvaMv4: ~ault(Extern.1 cotumen! Sro.-age)
;l, report 20149107144553 391Uffinl 19 J(B OZ/07!W14 02:45 PM Sunn Admhwak<m1 Ol:fault(E>.tern~ Dowment Sll>rage)
.? 'OMit 20!tl!lNl13S016 2816.btml v 19 J(B 07/07/2014 01,50 PM Susan Admlnvakoya D!!faoll(Extamal Datum""t 5loolge)
191«1 D7/07{2014 01:49 PM Susan Adm1nvakova Deflruil(ecterrtal (lowmenl Slorage)

Chapter 4. WebReport Tags
4. WebReport Tags
Objectives
• Describe how tags determine what the report contains and how it is structured
• Describe the different types of tags and their purpose
• Look up the tags they need
Overview
This chapter introduces the concept of tags and explores the

different kinds of tags, and how they are used.
About Tags
At the heart of WebReports is the tag system. Tags, placed in the
Reportview, let the report designer show where data needs to
appear, control what Content Server page elements are displayed,
sort and filter data, perform look-ups to convert numeric IDs into
names and much more.
The majority of tags are quite simple to use, but there are many of
them. To make life a little easier all the tags are fully documented in
the WebReports on-line help.
There are three main types of tags:
Content Control Tags Content Control Tags deal with the content of the report, for
example whether to include the Content Server header and footer,
or whether to include a section of the Reportview based on the
result of a logical condition.
The following are examples of Content Control Tags:

[LL_WEBREPORT_EXCLUDEHEADER/l
[LL_WEBREPORTJF 11
[LL_WEBREPORTJNCLUDEIF 11

Chapter 4. WebRe port Tags
Data Tags Data Tags show where data from the data source should be
inserted, or where other contextual data should go, such as the
name of user running the report.
The following are examples of Data Tags:

[LL_REPTAG_1I]
[LL_REPTAG=Datald /1
[LL_REPTAG_DATETIME /1
Sub-Tags Sub-Tags format or manipulate data returned by a Data Tag. For

example, converting a user ID into the user's name.
The following is an examples of a Sub-Tag:

[LL_REPTAG_USERID USERINFO:FULLNAME /]
These three types of tags are hierarchical in that Sub-Tags

are always used within Data Tags, and Data Tags can be
used within any Content Control Tags that allow
parameters.
Content Control Tags
Let's have a look at a couple of useful Content Control Tags. The

following is an excerpt from the WebReports User Guide:
Exclude Footer [LL_WEBREPORT_EXCLUDEFOOTER /1

Excludes the standard Content Server footer from the output. This tag
can be used in the Header section.
Exclude Header [LL_WEBREPORT_EXCLUDEHEADER/J

Excludes the standard Content Server header from the output. This tag
can be used in the Header section.
Exclude HTML [LL_WEBREPORT_EXCLUDEHTMl/l

Excludes all the HTML, JavaScript and Style definitions that Content
Server uses to wrap any given page. This can be used to good effect
when exporting, e.g. XML or CSV as the Content Server page wrapping
is no longer relevant. When this option is used, all other EXCLUDE tags
will be ignored as they are not relevant unless in the context of a
Content Server page. This tag can be used in the Header section.

Chapter 4, WebReport Tags
If Condition [LL_WEBREPORTJF (expression) Il

[LL_WEBREPORT_ELSE Il (optional) [LL_WEBREPORT_ENDIF Il
(expression) Format:
"parm A" <operator> "parmB"
If a condition is met, include the contents in the output. Anything
between the IF and ENDIFtags will only be included if the specified
condition evaluates to true, If an ELSE clause is included then
everything between the ELSE tag and the ENDIF tag are included if the
specified condition evaluates to false, This tag differs from the
INCLUDEIF tag in that this structure allows selected parts of the row
to be conditionally included or excluded, This tag can be used
anywhere in the Reportview, This tag can be used in each section,
Tag Example [LL_WEBREPORT_EXCLUDEFOOTER Il

[LL_WEBREPORTJF "[LL_REPTAG_&WantMenu UPPER Il" ==
"TRUE" Il
[II include the function menu
[LL_REPTAG_MYID LLURL:FUNCTIONMENU Il
<BR>
[LL_WEBREPORT_ENDIF I]
<BR>
[LL_WEBREPORT_STARTROW Il
When the WebReport runs, there is no Content Server footer

displayed. The [LL_REPTAG_&WantMenu UPPER/] returns either
TRUE or FALSE depending on the &WantMenu parameter passed
to the WebReportwhen it runs, If TRUE then a Functions menu for
the WebReport itself is displayed in the header of the WebReport
output.

Data Tags
There are two distinct types of Data Tags.
Data Source Tags Data Source Tags are used only in the Row Section to determine where
data source data should be inserted. They work by specifying which
column of data from the source should be used to supply the data for
the tag. Either the column name or number may be specified.
For example:
[LL_REPTAG_2/1
[LL_REPTAG=Datald /1
Contextual Data Tags Contextual Data Tags can be used anywhere in the Reportview and
provide a way to output parameters, variables and constants or
static information such as user's ID, URLs, current date.
For example:
[LL_REPTAG_DATE /1
[LL_REPTAG_USERID /1
[LL_REPTAG_&inputVal/l
[LL_REPTAG_%emaiiAddr /1
Examples of Useful Data Here are some more examples of useful Data Tags:
Tags
o [LL_REPTAG_DATETIME /J - inserts the server date and time
when the WebReport was run.
o [LL_REPTAG_ROWNUM /J - inserts the current row number in
data.
o [LL_REPTAG_NEXTURLll- inserts the URL to go to when the
WebReport is dismissed - usually the previous page. Handy for
a "Back" or "Finish" type button in the report.
o [LL_REPTAG_MYID /J - inserts the node ID of the WebReport
itself.

Sub-Tags
Sub-Tags are so named because they only appear inside the body of
a Data Tag. Sub-Tags let you format, manipulate or transform data
returned by a Data Tag into something else. Sometimes they actto
store or trigger some other feature using the data instead of
formatting it.
Sub-Tags often take parameters, and these are separated from each
other and the Sub-Tag by a coion (:).
Some examples:
• [LL_REPTAG~Status UPPER/] - converts the data into
uppercase.
• [LL_REPTAG_DATETIME DATE:LONG I] - the date Sub-Tag
offers a plethora of options for formatting a date and time. This
example causes the standard "long" date format specified in the
Content Server Admin pages to be used.
• [LL_REPTAG~status DECODE:O:False:1:True:Unknown 1]-
DECODE offers an If, Then, Else function (like in Oracle SQL). In
this example: If 0, then return "False. If 1, then return "True".
Otherwise return "Unknown".
• [LL_REPTAG~Datald NODEINFO:CREATEDATE 1]- takes a
Data ID (Node ID) and converts it into some useful information
about the node. In this example the date the node was created.
• [LL_REPTAG~Userld USERINFO:MAILADDRESS/]- takes a
User ID and converts it into something useful. In this case the
user's email address.
You can combine Sub-Tags so thatthe output of one feeds

the other. Specify them one after the other, separated by
spaces. Processing works from left to right.
[LL_REPTAG~Userld USERINFO:FIRSTNAME UPPER 11
This takes the user ID, gets the users first name and
converts it to uppercase.

Tag Help
The sections to follow look at other tags in more detail. However,

we can't cover every tag in this course as there are simply too many.
Fortunately, WebReports has a comprehensive on-line help

reference to tags plus articles with examples and explanations. In
addition there is printable reference documentation on the
Knowledge Centre.
• You can open the Tag Reference directly from the online editor
• Alternatively find WebReports help via the Content Server End
User online help menu
The following figure illustrates the following:

• The right side shows which sections support each tag
• Double-click on a row for detailed info
• Drag-and-drop tag into editors using icon on left
• Search using "Filter" field
Figure 4-1: Tag Help
~ ~ .1, •........"urowse
,,,J "" 'IWMM'
,,~C ~"""'.
Content Contmllags Section

Content COntrol Tag Name Descrfptlon H
• F
I'iJ [If used to comment the rllmahder of the line.

- '" '"
I'iJ U" ... "j)
@[L,"-WEBREPORr_APPEAR60TTOMOFFj]
used to denote a block comment whiCh tan span mutllle k\es.
Exck!des;my Appearance HUlL elements at the hottom, bottom left and bottom riqht.
'"
-
'" • •
~
@[LL_WEBREPORr..APPEARlEFTOFf(] Extkldes ilfIY Appearance HTf·tL elements to the left.

'" • •
,••
@ [lL..WEBREPORLAPIlEARRlGHTOFf tJ ExckJdes any Appearance HTML elements to the light.
ffiJ [LL_WEBREPORT.J\PPEARTOPHEAOEROFF f) ExdJdes any AppearanCe HTML elements at the very toP. '" • •
@[lL...WEBREPQRU\PPEAP'TOPOFfIl Excudes illlY Appearance HTML elements at the top, top left and top riqht. •••
@[ll_WEBREPORU."ALLIl calls it SIltVer side Oocrttt function defined by Ll_WEaREPORT_STARTSCRlPT Mil ll._WEeREPORT_ENOSClUPT
tags. '" " "

Using WebReport Tags Outside the Reportview
Tags are mainly used in the Reportview. But a subset of Data Tags
and SUb-Tags can also be used in some ofthe fields we've already
met in the WebReports interface. You can spot the fields that
support tag replacement as they are identified with a red flag icon.
One common application for this is to construct an email receiver

list inside a variable tag and then use it to determine who to email
the report to in the Destination page.
Examples of Tags You Can Use • Static Data Tags (e.g. LL_REPTAG_DATE)
Outside of a Reportview
• Parameter Tags (LL_REPTAG_&)
• ConstantTags (LL_REPTAG_$)
• Variable Tags (LL_REPTAG_%)
• SUb-Tags (inside a valid Data Tag)
Examples ofTags You Cannot The following tags cannot be used outside of a Report view, since
Use Outside of a Reportview neither of them have any meaning outside of that environment:
• Data source Data Tags

• Content Control Tags
Summary

• Learned how tags determine what the report contains and how
itis structured
• Described the different types of tags and their purpose
• Learned how to look up the tags you need
Content Server WebReport Design I Page4-7

Exercises
Apply Tags
Overview
This exercise provides you with an opportunity to practice using various tags, including the CAT Sub-
Tag.
1. Create a new WebReport in the WRD I Student Folder, called WebReport Using
Customer Feedback Category and use a basicJeport format.
2. The data source you need to seiect is List Documents with a Customer Feedback
Category Data Source and it can be found in the WRD I Templates (and Data Sources)
folder.
3. Run the report to verify that it lists several documents:
~ Run WebRepolt: WebRepolt Using Customer Feedback category

webReport Using Cusblme, feedback Category v
QwneriD ParenllD DataiD Name OriginOwner!D

-2000 11572 11581 Ergoboot Customer complaints ,umma'Y.doc 0
-2000 11590 l1S91 1.1ntro.doc 0
-2000 11590 11595 2. Ergoboots description.doc 0
-2000 IlS90 11599 3. Marketing Plan.doc 0
-2000 11572 11613 Ginetie·. feedback.doc 0
-2000 11590 11606 4. Sales Forecasts.doc 0
-2000 IlSn 11620 loe'. feedback.doc 0
-2000 11572 11624 Router spikes question.rtf 0
-2000 11585 11586 Customer Feedbock for Product X.pdf 0
-2000 11572 11573 Complaint Infonnation 0
4. Edit the Reportview and delete the [LL_WEBREPORT_SUPPRESSERRORLOG I] tag 50

any errors while working on your Reportview get reported. Hint: Click the Header
Section grey area to expand the size of the editing window.
S. Edit the Reportview so the WebReport displays the document names in column 1
([LL_REPTAG~Name III and the date it was created in column 2
([LL_REPTAG~CreateDate Il - or use the NODEINFO Sub-Tag to get the creation date).
6. Click the Add Version button to save your Reportview modifications, before testing the
report.
7. Run the report and check you get what you expected. Remember - changing the data
tags in the row section will not automatically change the column headings.
8. Update the header of your WebReport so the headings are correct for the data in the
columns (i.e., <TD>Name</TD> and <TD>Created Date</TD».

9. Look up the DATE Sub-Tag in the on-line help. Format the date to a standard format of
your choice using the DATE Sub-Tag.
10. Look up the CAT Sub-Tag in the on-line help. Change the 3rd column to report the
Datald for the document and use the CAT Sub-Tag to display the Type of Customer
attribute instead of the Datald. It should look like this:
<TD> ILL_REPTAG=DataID CAT:"CustomerFeedback":"Type of
Customer":DISPLAY /]</TD> The syntax is CAT:<catname>:<attname>:DISPLAY.
When there are spaces in the Category and/or Attribute names, they need to be placed
inside double quotes. In the example we have placed "CustomerFeedback" in quotes for
consistency even though they are not needed.
11. Use the following figure to assist in establishing the appropriate columns and Attribute
names.
Content Server Catel1Qrles t Customer SeMee Categori... ,
~ CustomerFeedback '
12. Using the syntax example in step 10 and the list of attributes in step 11, edit your
WebReport to display the following attributes in separate columns. Use the USERINFO
Sub-Tag to convert user IDs into real names and format the date.
f
t
'I
Run WebReport: WebReport Using Customer Feedback category

WebReport Using Customet Feedback Category v [hJ
Name create Date Type Qf Customer Customer Name Feedba,k ~ledia language
Ergoboot Customer Complaints summary.doc feb 23 2002 web Camlog Customer Eunice Tyson Phone CaU English
t. Intro.doc Feb 23 2002
2. Efgllboots descrlption.doc Feb 23 2002 Store Visitor Alice lund letter English
3. !'larkeling Plan.doc Feb 23 2002 Web Catal09 Customer fred lntext' E-man Spanish
Ginette's feedback.doc Od 2S 2.000 Web catal09 Customer Glnelte Phone Call French
4. Sales forecasts.doc Mar 01 2001
Joe's feedbad<.doc Od 25 ;WOO Reseller Joe Sapp E-mail
Router spikes Question.rtf Aug 12 1999 Web Catalog Customer Andy Barrie Phone Call
Customer Feedback for Product x.pdf Nov 16 2000
Complaint Infotmatiol1 oct 26 2000 Store Visitor Helga Higgenbotham Phone CaU


Chapter 5. WebReport Links and Constants
"1 5. WebReport Links and Constants
Objectives
• Include links or icons for other Content Server items or interfaces

• Describe how to use Constants to do this more effectively
• Understand Constant Types and Uses in a WebReport
Overview
One of the great things about WebReports is that it allows you to

create reports that are tightly linked into the rest of Content
Server. It is easy to include hyperlinks to any other object or page in
Content Server.
['
Including a Hyperlink
To make a link you use something like this:

<A HREF="...put the URL address here...">Writewhat should
appear here</A>
This code will produce a link looking something like this in the
browser:
Write what should appear here
For static links (i.e., not based on report data) there is nothing to
prevent you from grabbing the URL address of the object you want
to link to (e.g., right-click a link to it, select Copy or Shortcut) and
then pasting it into the HREF value. But, WebReports provides a
better way, which you can use to make links from report data.
All you need to create a link to another Content Server item is its
Node ID or Data ID. Even if the item is moved or hidden, the Node
ID remains valid forthe entire life of the item. So, a link builtfrom
this will always pointto the correct item.

For example:
[II insert link to item
<A HREF="[LL_REPTAG=Datald LLURL:DEFAULTLiNK I]
&nexturl=[LL_REPTAG_MYURL ESCAPEURL
1]">[LL_REPTAG=Datald NODEINFO:NAME 1]<1A>
[II insert function menu and 'up a level' icons
[Ll....REPTAG=Datald LLURL:FUNCTIONMENU I]
[LL_REPTAG=Datald LLURL:UPALEVELI]
The code above does not include some of the HTML

formatting like alternating row colors. Look at the
"browseJlexible_cs10" Reportview template to see how
that is done.
Used in a Row Section, this code produces a URL link.
Figure 5-1: Example of a WebReport With URL Links
~ Run WebReport: WebReport Using customer Feedback category

WebReport Using Customer Feedbaclc Category
Name Create Date Type of Customer Customer Name Feedback Media Language
Eraoboot customer Conp!ai!l!:s sullmlry.doc Feb 23 2002 Web catalog Customer Eunice Tyson Phone Cal Englsh
t. IntrO.doc Feb 23 2002
2. Erooboots docaiption.doc Feb 23 2002 Store VIsitor Alee lund letter English
3. Marketing !'!an.doc Feb 23 2002 Web Catalog Customer Fred IAtext E-rmi Spanish
GIIlette's feedbadc.doc oct 25 2000 Web catalog Customer Glnelte Phooecal French
,. Sales Forecasts'doc Mar 012001
Joe'sfeedbaclcdoc Oct252000 Reseler JoeSopp E-mill English
Router ...... ow><!jnn.rtf Aug 12 1999 Web Catalog Customer Andy Barrie Phone Cal Englsh
Customer Feedb;!ck for Product X.Ddf Nov 16 2000
Conp!aintl!!hmration oct 26 2000 Store VIsitor I!eIga Higgenbotham Pbone caB English

Chapter 5. WebReport Lin ks and Constants
Selecting a link runs the default action for that type of item:
~ Router spikes questlon,rtf
Figure 5-2:
Clicking Report Link Run Default
OutdoorGear Customer SelVlce
Action - Open From: Jack Fom [2934S2@joLcom]
Sent: Friday, April 24, 199810:41 AM
To: Made Undsay (E-mail)
Subject: Whatln tarnation. ,_
.. are the "rou1er spikes" you ad'lal\ise on your web pago? They look like a cross between SI
and a garden weasel.
Jack Ford
<
Review the LLURL tag in the online help to see all the
actions and icons available.
Constants Tab
Constant Fields The Constants Tab provides you with the ability to define constant
values that may be used in the report output. Best practices
involves using constants to replace any hard-coded Data IDs or
User IDs to make your work more portable; you may also use
constants for any string values that may be subject to change
periodically.
Constants are referenced in the ReportView with

[LL_REPTAG_$constantname /] syntax.
Constant Name The constant name is used in the ReportView with the
[LL_REPTAG_$constantname /] syntax to reference the constant
and display the constant value. The constant name should contain
no spaces and no special characters.
Constant Value This is the value that wi II be displayed when a constant is

referenced in the ReportView.
Constant Type This field defines the data type of the constant.
Constant Description Enter a purpose of the constant and where it is being used within
the ReportView.

Chapter 5. WebRe port Links and Constants
Constant Types WebReports supports several different types of constants which

can be selectively implemented depending on specific reporting
needs.
String The String type is a good general purpose constant that is used
when the constant value is alpha-numeric. Use this constant for any
stringvalue for common text strings that may require discretionary
change during development, including report titles, custom
instruction or error messages, etc.
Figure 5-3: String Constant
I; WebReport with Constants ?
Using the RptTitle tag in the Reportview will display the string
value: "Outdoor Gear, A GreenSquare Company".
Content Server Object The Content Server Object type allows you to select an item in
Content Server and the Data ID of that item becomes the constant
value. The Data ID value may be used for referencing Sub-
WebReports or the constant may be combined with a Sub-Tag to
display information about the selected item.
Figure 5-4: Content Server Object Constant
~ WebReport With Constants

Chapter 5. WebReport Lin ks and Constants
Using the [LL_REPTAG_$PolicYDiscussion NODEI NFO:NAME /]

tag in the Reportview will display the name of the selected Content
Server Object.
Content Server User/Group The Content Server User/Group type allows for the selection of a
user or group and the ID of the user or group becomes the constant
value. Combining the Constant Tag with a Sub-Tag would allow us
to retrieve more information about the selected user.
Figure 5-5: Content Server User or Group Constant
~ webReport wIth Constants '.' v
Using the [LL_REPTAG_$librarians U5ERINFO:NAME /] tag in the

ReportView will display the name of the selected User or Group.
Using a Global Constant

If you have a group of WebReports that will share the same
constants, you may use the Global Constant option at the top of the
page to select the WebReport that contains all of the shared
constants. This provides a more efficient application because any
changes needed to the constants will be made in one location only.
~ WebReport with Constants v •.;
Figure 5-6:
Global Constant Selection Field in a
WebReport

Ch apter 5, WebReport Links and Constants
8. Edit the ReportView and paste the fa I/owing text into the Header
Section:
<A HREF="[LL_REPTAG_$DriltDown_WR LLURL:DEFAULTLINK
/}&nexturl=[LL_REPTAG_MYURL ESCAPEURL
/}">[LL_REPTAG_$DriltDown_ WR NODEINFO:NAME /1</A>
[LL_REPTAG_$DriltDown_ WR LLURL:FUNCTIONMENU /J
The above tag loads the constant - the Content Server's Customer
Service folder location - into the Reportview. In this way, you can
use a placeholder for the constant in the report tag code.
9. Click the Add Version button.
Using similar HREF tags as the previous section, we have created

links to the selected item using our constant as the NodelD
reference.
10. Run the WebRe port.
You will see a simple example of a hyperlinked item.
Run WebReport: WebReport with Hypet1ink

Figure 5·8:
WebReport Results With a WebReport with Hyperlink v ~
Hyperlink
Summary
• Included Jinks or icons for other Content Server items or
interfaces
• Described how to use Constants to do this more effectively
• Learned about Constant Types and Uses in a WebReport

Exercises
Create a WebReport With Constants
Overview
Create a pair of WebReports: one with a Constant Report Title and another using a Global Constant
to list all Outdoor Gear user accounts that have system administration privilege rights.
1. Create a new WebReport called ODG Global Constant WebRe port, with the Go To
Source Tab selected, and using the basicJeport Reportview.
2. On the Constants tab, create a new String type Constant with the Constant Name
ODGReportTitle. Enter Outdoor Gear, A GreenSquare Company in the Constant Value
and Constant Description fields.
3. Click the Update button to save the report.
4. Create a new WebReport called ODG Users with SA Privilege, using the ODG Users
;
I•
with System Administration Privilege data source ( Enterprise Workspace> Course
Material> 2-0117WebReport Design I> WRD I Templates (and Data Sources) folder)
and the basicJeport Reportview.
5. Edit the Constants setting (of the ODG Users with SA Privilege WebReport) and
Browse to the previously created ODG Global Constant WebReport. Remember to
click the Update button to save the report.
6. Edit the ReportView and add a tag (i.e., [LL_REPTAG_$ODGReportTitle III to display
your ODGReportTitle Constant at the top of the WebReport.
7. Click the Add Version button to save your changes.
8. Add any necessary formatting, like blank rows (e.g., < BR» and additional columns to the
Reportview to accommodate output of all of the data source columns (Hint: 6 columns).
9. Run the WebReport and verify is displays the report title constant:
~ Run WebReport: OOG Users with SA Privilege

outdoor Gear, A GreenSquare COlTl'any
OOG Users wiI:h SA Privilege
Login First Name Last Name OserID Department Emli Address

Adllin Fred Bassett 1000 11674 adllin@thegreensquare,com
eUnk 200113 21111112
otadllin@otds.adllin 1002 1001
sadllin Susan Adnimlakova 17670 11674 sadllin@thegreensquare,com
Warehouse System 332460 1001


Challenge Exercise
Document Name into Hyperlink
Overview
Using the WebReport you created in the previous chapter, try turning the document name into a
hyperlink that opens the document.
1. Use the LLURL sub-tag; the "browse" default Reportview shows exactly how to do it.
2. Test the resulting report, for example using Router spikes question.rtf, by clicking the
hyperlink and having the document open in the browser.
~ Run WebReport: WebReport Using Customer Feedback Category

WebReport Using Customer Feedback Category
Name Create Date Type of CustOtDi:!r Customer Name feedback Media language
Eraoboot ClJSt9frer C1WJ)laintssul1m.uv,doc Feb 23 2002 web Catalog Customer eunice Tyson Phone call English
1. tntro.dpc Feb 23 2002
2. Eraoooots description.dQc Feb Z3 2002 Store Visitor Alee Lund letter English
3. Madcetioo Plan.dot: Feb 23 2002 Web Catalog CIlstOlrer Fred lntext E-... d Spanish
Pooneea.
4. *
Ginette} feedback.doc
Forecasts.doc
Joe's feedback.do-c
Oct 2S 2000 Web Catalog CUstorrer Gnette
Mar 012001
Oct 25 2000 Reseler Joe Sapp E-... d
French
English
Bouler spikes guestiop,rtf Aug 121999 Web Catalog Customer Andy BarrIe Phone cal English
Custorrer Feedback for Prgduct X.pdf Nov 162000
Cormlalnt Information Oct 26 2000 Store VIsllllr Helga HIggenbotham Phone cal English

Document Name into Hyperlink - Challenge Exercise Solution
1. The solution is to replace the first name column's tag ([LL_REPTAG=Name I]l, in the
Row Section, with the following tag:
<A HREF="[LL_REPTAG=Datald LLURL:DEFAULTLINK I]
&nexturl=[LL_REPTAG_MYURL ESCAPEURL Il">[LL_REPTAG=Datald
NODEINFO:NAME 1]<1A>
2. Once the editing is complete, the entire Row Section should contain the following HTML
code:
<TR CLASS="[LL_REPTAG_ROWNUM ODDEVEN:userRowl:userRow2 1]"
VALlGN="CENTER" NOWRAP ALlGN="LEFT">
<TD>
<A HREF="[LL_REPTAG=Datald LLURL:DEFAULTLiNK/] &nexturl=[LL_REPTAG_MYURL
ESCAPEURL Il">[LL_REPTAG=Datald NODEINFO:NAME 1]<1A>
</TD>
<TD> [LL_REPTAG=CreateDate DATE:"%b %d %y" Il</TD>
<TD> [LL_REPTAG=DATAID CAT:"CustomerFeedback":"Type of
Customer":DISPLAY I]</TD>
<TD> [Ll..REPTAG=DATAID CAT:"CustomerFeedback":"Customer
Name":DISPLAY I]</TD>
<TD> [LL_REPTAG=DATAID CAT:"CustomerFeedback":"Feedback
media":DISPLAY Il</TD>
<TD> [Ll..REPTAG=DATAID CAT:"CustomerFeedback":"Language":DISPLAY
I]</TD>
</TR>

Chapter 6. WebReport User Prompts and Parameters
6. WebReport User Prompts and Parameters
\I Objectives
• Understand the different types of input parameters

• Know when and how to use WebReport parameters as well as data source parameters (and
understand the difference between them)
• Use input parameters in a LiveReport and in a saved search query data source
• Build a user prompt screen using WebReports point and click design interface
• Build a simple custom prompt screen using a "launcher" WebReport
Overview
The most useful reports provide flexibility by allowing users to

specify different values for parameters so the report delivers
different information, or presents it in a different way, according to
the needs ofthe user. This is also important when building
applications, where one part of the application needs to pass
information to another part. This section deals with how to use
parameters and how to prompt users to provide values for them.
Parameters Concepts
First a quick review of how requests and parameters work in

Content Server:
• When you click any link on a Content Server page in your
browser a request is sent to Content Server.
• The request, encapsulated in a URL, contains parameters which
start with '&' character (e.g., &ObjAction=browse). You can see
these in the status bar and address bar ofthe browser. This tells
Content Server what the user wants (some requests are also
generated using a form "post"; however, the principles of name
value parameter is still the same).
• If a request is for a WebReport to run, then the WebReport has
access to all the parameters that were passed in the URL.
• LiveReport and Search Query data sources can also access
special parameters of the form &inputlabeIX, where X is a
number. These are often used to filter or sort data at the data
source.

Chapter 6. WebRe port User Prompts and Parameters
WebReports makes it easy to use these parameters. Parameter

values can be accessed in the Reportview using the
[LL_REPTAG_&<parm_name> /1 tag.
In addition WebReports provides a sophisticated point and click

user input screen designer.
Figure 6-1: Parameter Collection and Report Execution
objAction=R...nReport&lnputLabeI1 =2000&lnputLabel2=2001 &dlr=up•••
I InputLabel1
I -+ WebReport
-+
-+ -+
ILL,..REPTAG_&inputLabelt l]
inputLabel2
I I
I
dir
I
-+ -+
Parameters Tab
Parameter Fields The Parameters tab provides two main functions. Firstly, it provides
the ability to set defaults for parameters used in the Reportview so
that they can have a defined value (besides a blank string) even if
the specified parameter does not exist in the URL used to run the
WebReport. Secondly, the Parameters tab provides options to
setup an automatic prompt screen. The fields used for each
parameter are as follows:
Parameter Name This is the name of the parameter as it will appear in the U RL once
the user has selected their values and selected Run on the
prompting page. The parameter name must not contain spaces or
other characters which cannot be passed in a URL. The end user will
be largely unaware of this value.
Display Text This is the text that the user will be prompted with. It differs from
the parameter name in that it can be more descriptive and can
contain spaces.
Prompt This check box determines whether the user will see the prompt or
not. If the user is not prompted for a particular parameter the
default value will be used.

Mandatory This check box determines whether a parameter is mandatory or

not. If a parameter is mandatory the user will not be able to go
beyond the prompt screen without selecting a value for the
parameter (unless the parameter has a default value). Mandatory
parameters can be identified on the prompt screen by the (t, icon
next to the prompt text.
Prompt Order This field determines the order in which the parameters will appear
on the prompt screen. The values can be alphanumeric.
Type This field will determine the type of parameter the user is prompted
for. This can be String, ObjectlD, User, Number, Object, Date or
Custom.
Default Value This is the value that will be used if the user doesn't select a value
on the prompt screen. The value will appear pre-populated on the
prompt screen. The value will be used by WebReports that are
running on a schedule.
Description The description is a free text field which allows the WebReport
developer two options. They can put comments in itto remind them
and other developers about an implementation detail. The second
option is to tick the Show Descriptions check box atthe top of the
parameters page - this will cause all the descriptions to appear on
the prompt screen where they can be used to provide the end user
with instructions. This field can contain HTML tags.
Extracting Parameters The WebReports Parameters tab allows users to automatically

extract parameters from both the Reportview and the data source.
To perform this action the extraction icon () must be selected from
the top right corner of the parameters tab.
For example, the figure that follows shows a WebReport based on a

Live Report data source of List Modified Documents in the Date
Range, where the Live Report use a starting date and an ending date
provided from user input.

Figure 6-2: Extracting Parameters
~ WebReport for Extracting parameters " y
~ WebReport for Extracting Parameters '.' y
IE'] 0 r
Clicking the Extracting Parameter icon will auto-extract the

LiveReport user input parameters to the WebReport Parameters
tab.
The extraction icon will only appear if one or more parameters is

not defined on the tab, and one or more of following circumstances
is true:
• There is a LiveReport data source with parameters defined
• There is a search data source with parameters in the query (%x)
• There are parameter tags in the Reportview of the form
[LL_REPTAG_&. /]
The browse Jlexible_cs 10 Reportview contains Parameter

Tags. Extract these and populate them with default values
to change the default sort order.

Parameter Types WebReports supports severa I different types of parameters which

can be selectively implemented depending on specific reporting
needs.
Figure 6-3: Parameter Types
~ WebReport With Parameters f)
0 ~
IGoid. lS<lodA Product Um Go<l [;'I 0 r

ltN°De"" I.s~!~~ ~ o.a.t~ fO,~':H'!,.fT~~: 0 0 I3J
lu.., Ico.tact, G<4r5;>«!'li'it ~ 0 f4

IN"n~" IEtlltl VbUrft.',I~~1t thJrrb~ 0 0 r
String The string type is a good general purpose parameter and is often
used when the end user needs to enter free text in a filter field. The
text is passed to the parameter replacem,ent tag~xactlyas it is
entered on the prompt screen. ',: j"i'::c" '
ObjectlD The Objectl D parameter allows the report developer to build

flexible object selection prompts. This is similar to the LiveReport
parameter types Nodel D, Container and Project but offers
considerably more flexibility by allowing the creator to restrict
which types of object the end user will be able to select at the
prompt screen. The default is that the user can select any object
type but the developer can change this in the multi-value select
input.

Even though an ObjectlD parameter appears to select a path to the

object, it is the actual id of the object which is passed tothe report.
This means when you use a tag to reference the parameter above
e.g. [LL_REPTAG_&parmname f], this will be replaced with the
objectlD. To retrieve the latter the developer would need to use
[LL_REPTAG_&parmname NODEINFO:PATH fl.
When using a multi-value select statement you can select a

range of items by holding the shift button while selecting a
value with the mouse. Another method is to use the Ctrl
button in the same way; this has the effect of allowing
multiple individual selections.
User The user parameter provides a prompt where the end user can
select a Content Server user or group. When the developer creates
the report he can configure it so that the end user can select either
only a user, only a group, or a user or group. Either one of these may
be selected for the default value.
The user parameter type allows for the selection of a user or group
but it is not the user name (or group name) which is passed it the
report, it is the id of the user or group. This means the
[LL_REPTAG_&parmname f] would be replaced by the user ID
rather than the user's name. If we wanted to retrieve her name we
could use USERINFO e.g. [LL_REPTAG_&parmname
USERINFO:NAMEf].
Number The Number input type works similar to the string type. The key
difference is when the user enters a value it is validated before the
report runs to check that it is an actual number.
Object The object input type allows users to select from the available list of
object sub types within Content Server. If custom modules are
installed and create new object types, these will be reflected
automatically within the select statement.

Date The date input type offers considerable flexibility. The developer is
able to decide whether the user is prompted with or without the
time, whether the default prompt is current date or whether the
user is prompted with a blank date field.
If a blank date is required, Use Current must not be selected and

each of the individual fields must be set to blank.
Date parameters can be compared inside the Reportview with

dates from the database or the WebReports DATE and DATETIME
tags. As an example:
[LL_WEBRE PORTJNCLUDEIF "[LL_REPTAG=MYCOl/l" >=
"[LL_REPTAG_&parmname /l" /1
In this example each row with column name MYCOL will be

included in the output if the date in that column is greater than or
equal to the date provided by the parameter.
Live Report parameters don't natively support the time

(only the date) but if you use WebReports you can pass the
time to a LiveReport data source and filter on it.
Custom If the custom parameter type is selected the report developer can
create custom prompts by directly inserting HTML from either a
Content Server Document or another Content Server WebReport.
The benefit of this capability isyou can build dynamic filters that
have their values populated at run time.
Another example of using a custom parameter in a WebReport is

where a report can be executed, and its results inserted into the
parameter prompt page.

Custom Branding and At the top left hand side of the Parameters tab the report developer
Instructions has the option to browse for a Prompt File. This allows a Content
Server object to be selected and its contents inserted at the top of
the parameters prompt page. The object selected can either be a
HTML document or another WebReport. In the case of a HTM L
document its contents are static but if a WebReport is used it can
dynamically retrieve information and the prompt screen
manipulated depending on who is running the report and their
permissions etc.
Example of an image being inserted by an HTML prompt file is

illustrated in the following figure:
Figure 6-4: Example of an HTML Prompt File Used With WebReport Parameters
~ WebReport Parameters: WebReport with Parameters
outdoor gear
Parameter Descriptions At the top right hand side of the Parameters tab, you have the
option to turn on (or off) Parameter Descriptions. Parameter
descriptions are useful because they can be used to provide
instructions or additional information on a parameter-by-
parameter basis to end users. If the end user does not need these
they can be turned off and the developer can use the fields for
design notes or leave them blank.

The following figure illustrates the design of the WebReport with

Show Descriptions turned on.
Figure 6-5: An Example of a WebReportWith Parameters and Show Descriptions
~ WebReport with Pal<lmet€rs & show Descriptions "
lSI
P~;a.rn:t.,.r...;~ i1
h",,,GiJrl--------,
~Vllf'~rMF~i!
Ap~~f~ll(~ f",jlikr
[2) 0 A ~t~Il(l:. VlOIle> ~{" fiMf.I
I~~~. ... _.... I~~~d. ~ ~!~J~~.I£i_~,f!~~, ~ 0
IU~~t ICq~I_~~ ~.~r5~ 0 0
IrftltrlltT I~o~~~/Jllr F~'·~II,:,tNrrne 0 0
And when the report is run, the descriptions appear to the far left of
the parameter fields.
Figure 6-6: An Example of a WebReport With Parameters and Show Descriptions
~ WebReport Parameters: WebReport with Parameters & Show Descrlptlons
outdoor gear
EIIter part of the PrQdUd ~ame in this field.
iil~l 'C!~.f I Browse QurKnawledye 6il<e and •• lect. Product ther yulde to help you.
[jJ ,112@JII~~@IAM@J ;C(~.d Enter the nat" for a product's UVeD<!n».
0... ig...il Select a Us.r to {ontad far expert .WK. On an Outdoor G1!ar product.
EIIter yoorlavo,le nunil.,.

Data Source Parameters

Data source parameters are a special type of parameter that can be
used in the Reportview but, more importantly, are passed
transparently to the data source where they often act as sort or
filter criteria.
Data source parameters can be used in both Live Report and Search
data sources. If a WebReport is using a data source that expects a
parameter, by default, the user will be prompted for it at run time.
If, however, a WebReport is running on a schedule the user has no
opportunity to enter the parameter at run time. In this scenario a
parameter default can be defined on the WebReports parameters
tab. The parameters tab can also be used to override the prompt
behavior for data source parameters. As an example, one data
source parameter might have a default value and not prompt the
end user whilst another might be set to prompt and force the user
to enter a value before allowing the report to run.
Live Report Data Source LiveReport input parameters are of the form %x in the SQL and
Parameters inputLabelx in the calling URL where x is a number.
An example - and reminder from the Schema and Report

Fundamentals course - of a Live Report using a string parameter, is
illustrated below:
Figure 6-7: LiveReport With Parameter as a Data Source
• LiveReport With Parameter as Data Source ' u

Chapter 6. Web Report User Prompts and Parameters
When the user initially runs the LiveReport above they will be
prompted to enter a string. Once prompting has occurred %1 in the
SQL statement will be replaced by the value entered by the user on
the prompt screen. This is passed to the LiveReport in the URL in
the form &inputLabel1=<value>.
If a WebReports uses this as a data source the mechanism will be

the same but the parameter will also be available in the Reportview
via tags. In this case all instances of [LL_REPTAG_&inputLabeI1 /] in
the Reportview wou Id be replaced by the user text.
~ WebReport Parameters: WebReport with Input Parameter from LR
Figure 6-8: • WebRepolt with Input Parameter from LR

Resulting WebReport With Input lbJ
Parameter
AI Item; with a Name Beginning with: vae
OwnerID ParentJO DataID Name otigi!lOvmerID

·2000 11015 11764 VacatiQns.ooc 0
·2000 11423 11424 VacatiQn request 0
-:WOO 15543 15605 Vacatilln_Po!icy, doc 0
~2000 15622 15678 vacatillrn;.ooc 0
-2000 201764 201831 vacatkms.doc 0
-20(1) 355977 355978 Vacatilln search Query (1) 0
Search Data Source Search data source parameters are similar to LiveReport
Parameters parameters in that they are of the form %x in the LQL (Content
Server Query Language) and &inputLabelx in the calling URL. The
main difference is that the standard search capability doesn't
support parameters so you cannot run saved searches on their own
if they expect one or more %x parameters.
To use a parameter in a search data source simply enter %x at the

point in the LQL where you want the parameter replacement to
occur.
Figure 6-9:
A WebReport Parameter in a look For: IAll Words l~H Modifier: I <None> ~ Within: ,-IA_II_-,lv"""JI@
Search Data Source "%1"

To find the unique identifier for a given attribute go to:

Administration pages> Search Administration> Open The System
Object Volume> Enterprise Data Source> Enterprise Search
Manager and from the Functions menu> Properties> Regions.
The 3-0125 - Configuring and Customizing Content Server

Search course deals with the System Object Volume and
the search Regions in greater detail.
Custom Launch Screens
Even with the flexibility of the WebReports Parameters tab, it is not

always possible to create the exact look and feel you want for a
prompting screen.
In such cases, you can create a custom launch page (either with an
HTML document, or a WebReport) which collects the user's
filter/display values then passes them to a second WebReport that
uses them to control the output.
Figure 6-10: Custom Launch Screens
, ,
Parameter Collection Results

This method is very flexible and it is widely used on many larger

reporting tasks. First a launcher WebReport is created (often with
no data source). The launcher WebReport does the job of coliecting
user inputs such as fiiter criteria.
If desired, Sub-WebReports (more on these later) can be used to

provide pop-up selectors in the launch page with dynamic values
drawn from database tables. When the user has finished making
choices the Main WebReport is calied passing in all the parameters
that were collected.
The Main WebReport (and its LiveReport/data source) uses the

parameters to filter and control the output delivered to the user.
By using a Launcher WebReport to coliect parameters,

filters can be builtfrom many different data sources e.g.
Forms, Search, Live Reports, external sites.
Summary

• Learned about the different types of input parameters
• Know when and how to use WebReport parameters as weli as
data source parameters (and understand the difference
between them)
• Used input parameters in a LiveReport and in a saved search
query data source
• Built a user prompt screen usingWebReports point and click
design interface
• Built a simple custom prompt screen using a "launcher"
WebReport

Exercises
Create a Constant and Modify the Reportview to Display it
Overview
Create a string constant as the report title or name and then modify the Reportview to include it as
part of the output it generates.
1. Copy the WebReport Using Customer Feedback Category report to the same folder as in
the Chapter 5 exercises, but rename it to Customer Feedback Category with Parameters.
2. From the Functions menu select Properties> Constants and create a new String type
Constant with the name ReportTitle. Enter data for the Constant Value and Constant
Description fields.
~ customer Feedback Category with Parameters .. tl
IO-_nst~t~, ~~~.,.¥
IR'POttWo
3. Edit the ReportView and add a tag to display your ReportTitle Constant at the top of the
report.
4. Run the report and verify the report title is displayed.
5. On the Constants tab, change the Constant Value and run the report again.

Create a Prompt Page
Overview
Create a prompt page and the parameter is used by the data source.
1. Create a newWebReport using the Parameters Prompt Page Data Source in the WRD I
Templates (and Data Sources) folder and call it WebReport with Prompt Page. Also use the
browseJlexible_cs10 format.
2. From the Functions menu select Properties> Parameters and extract the parameters from
the data source. Click the Apply button to save the ReportView changes.
~ WebRepoIt with Prompt page -~ {)
0 0 n l,stnl~_j9[
0 0 n I.S_tm~ _ lsal
0 0 n, 1.Sl;r'i\l. _ ',,iJI
3. Notice how the SORT and DIRECTION came from the browse_flexible_cs10 view, but the
inputLabel1 ca,e from the LiveReport Data Source we used in the first step.
4. Set a default value for the date field of 1st January 2006 and set the display text to
Documents From; make the parameter mandatory and set it to prompt the user. Also enter
a description and set the check box so that descriptions appear on the prompt page.
J
Content Server WebReport Design I Page 6-1S
5. Create a new HTM L document in Content Server and add some simple branding to it. Hint: If
you are unfamiliar with HTML, you can make use of the provided odgbanner.html file that
displays the company's banner graphic (odg2013IogLgif).
outdoor gear
6. From the Functions menu select Properties> Parameters. Click the Browse button opposite
the Prompt File field and select the [odgbanner.html] HTML fi Ie created in the previous step.
WebReport with Prompt Page v 19
,- --_. __ .. _-_ .. - -,- " . .... ".", -_ __ ,., -, .. ,."",.-'_--_"'_--_'_'_'_-----_'_,-".,_"'- - - ' .. '-.'
".• PioInptf'ile: IEnter~rise:course~ateriaI:3-oU7iI:·~·'IRi~~if ~
7. Click the Apply button to save your ReportView changes.

8. Run the report; it should result in a prompt page similar to the figure below:
~ WebReport Parameters: WebReport With Prompt Page
outdoor gear
~~~I';~';~:c.lgn~M~I~11l~J _.,..""'....
ILW"',j.i....il··~··f

9. Click the Run Report button with the default date; the report results should look like the
following:
~ Run WebReport: WebReport with Prompt Page
Type: Harre ,,,. MmJlI1ed

o §) Exdted and Fris:* Feet Product fine 30 Kll 08/31{.1010 11:23 AM
o d!l I'l"'" Rekase Alin 30Kl\ 08/31{2010 11;16 AM
o @ !!iring Meeting Minutes 4562 ISl'1l 10/06/2010 02:OZ PM
o @] tli}wai cQnfetenq; exPWes,xk 16l<1j 10/05/201012:17 PM
o @ Pr~duct Devela..",.! Eslimates fY 2911,.1< HKll 1010S/~01O 12,18 PM
o @ Eli•• os.Reoort.xl\ 17l'll 10/OS/2010 12:17 PM

o @) B:penseRepol't.xk " 17!<1l 10/05/2010 1~,17 PH
o ® Tlbet{;Qnfere:rgext!~.xls 17Kll 1OI0S/~010 12;17 PM
o @) Appe"d~ c.d.< 19l'll 10/17/2010 O~;U PN
o @ 1'lOSlaQe Body 2K1l 10/17/~010 09'2lI PM
o ® "'IOtra.doc 1~ Kll to/17/2010 %,28 PI1

o @) Ml!Wge Bo!ly lJ<1l 10117/2010 \)9;:11 PM
o Ij[j APoend" A,doc v 19 KII 10/17/2010 0~'33 PH
o @ proM 5laW"" E>la""leh:!> L7Kll 03{16/l0H 02;39 PM
o @ Quartery Re""It.~ 2Zlill 10{17/2010 11,3< PM
o ® Qualterly R?"Qlt,;h>< 22rn 1l{16jZ010 01'03 pt.1
o I\[l 9u,Mry I\eMrt.doc 22Kll 1l{26jZOlO 01,03 pr~
o I[J gu.rtewllilR<!rt,d<l, '0';" 22lill 1l{Z6/2010

o ® Qoarte'y ReMit,"'" 22YlJ
o lID Ou.rterlv B.o.rt.~oc , "f ~ 0, ' I' '. ' ; ' 221Ql U/26/2010 01'03 PM
o @~~ 22K6 tlf46/2010 01:03 PM
o @ Q,'"rtmt Repprt,do{ 21K6 11/16/2010 01:03 P~1

o ® 9u.rter!y R••ott.et% 42 KB U{20/1010 01,03 PM
o @ QMarWIy Re""rt,o!A< 11/26/2,010 01'03 pt.!

U{26j2010 01'01 PM
Show llic-T:J CiJ 2 3 4 5 jdl

*
ft\":r(S
[·25 of .boyt 208 ~~"" 1 of .baot 9 p.W'"
10. Run the report again, but change the date to 01 Jan 2012. Observe how the number of
reported documents is far less (e.g., less than 50).
11. If you run the report again, but use the Clear button to use a blank date, what happens? Hint:
remember that the date was a mandatory field.
Content Server WebReport Design 1 Page 6-17


Chapter 7. Filtering WebReport Results
7. Filtering WebReport Results
Objectives
• Identify appropriate applications of WebReport filter tags

• Use appropriate fiiter tags to restrict the volume of results returned
Overview
This chapter discusses WebReport filter tags and their syntax. We
will aiso look at a comparison of various filter options.
Filter Tags
Although WebReport tags provide the ability to insert data into
other language sources, there are a few tags that provide simple
scripting type functions. This is primarily limited to the ability to set
conditions that will allow parts of the output to be controlled. This
means that what the user ultimately sees can be made dependent
on conditions such as:
• A particular data field matching a value
• Data fields being less than or greater than a value
• User criteria (such as group membership or permissions level)
compared to a predefined level
• The row number being greater than or less than predefined
values
I•
) • A particuiar field being unique within the result set
These filter tags come under the general category of Content

Control tags which means they all start with [LL_WEBREPORTJ.
These tags do not directly insert data into the output, but instead
affect the appearance of the output.
Filter tags can provide a very powerfu i alternative and or

complement to the filtering provided by data sources such as
LiveReports.

The following describes the main filter tags:
If-Else-Endif This is equivalent to most if - else type constructs used in scripting

languages. This tag can be used to hide or reveal specific parts of
the Reportview based on any data returned by any WebReport tag.
The else clause is optional.
You cannot nest IF tags, however, you can use logical

expressions to achieve the same result.
This tag can be used in the Header, Footer, or Row Sections of a

Reportview. They can be used multiple times in each section, but
they cannot be nested.
Examples of these tags include:

[Ll..WEBREPORTJF (expression) II
ILL_WEBREPORT_ELSE II *
[Ll..WEBREPORT_ENDIF II
Include If This tag is used to specify one or more conditions to determine

whether a row should be included in the output or not. It affects the
entire row section and will affect the [LL_REPTAG_ROWNUM II tag
which always reflects the actual row number after any rows have
been deleted by the INCLUDEIF condition(s).
This tag can only be used in the row section of a Reportview.
An example of this tag is:

ILLWEBREPORTJNCLUDEIF (expression) II
Exit If This tag is used to specify one or more conditions where no further
rows in the result set will be included.

[LL_WEBREPORT_EXITIF (expression) II

Include Range This tag is used to allow a specific range of rows to be included in
the output. It does not use any logical condition but supports from 1
to 3 optional parameters that can be used to determine which rows
are used.
Optional parameters are:

STARTROW:x
ENDROW:x
MAXROWS:X

[LL_WEBREPORTJNCLUDERANGE (row indices) I] *
Include Distinct This tag is used to limit the number of rows so that only rows with a
unique value for the specified column are included.

[LL_WEBREPORTJNCLUDEDISTINCT (distinct value) I] *
For some simple situations, the DECODE Sub-Tag can be

used to vary output text rather than using the IF/ENDIF
tag. The DECODE Sub-Tag allows different outputs based
on the results of the tag being used with the DECODE.
Logical Expressions For the IF, INCLUDEIF and EXITIF tags a logical expression is
required. The evaluation of this logical expression to a value of
either TRUE or FALSE determines whether the tag includes or
excludes data. In most cases, these logical expressions allow
comparison of fields from the data set with either constant values
or values specifically passed to the WebReport when it is run.
The section in the online help under Using WebRe ports >
WebReports Advanced Information> Logical Expressions
has some detailed explanations on forming logical
expressions but the key points are listed below.

A logical expression is made up of one or more clauses in the form:

lI<value>" <operator> "<value>JI
The operator can be one of the following:

==, !=, <>, <=, >=, <, >, IN, NOTIN, CHILDOF, NOTCHILDOF.
One or more logical clauses can be combined, using one of the key
words: AND, OR, &&, II (AND isthesame as &&, OR is the same as
II). Expressions are evaluated from left to right. Bracketing is not
supported, so you need to place your conditions in the correct
order.
Each value can either be another WebReport tag or an actual value:

...INCLUDEIF "[LL_REPTAG=DATAID PERMCHECK:SEE fl" ==
"TRUE" fl
A logical expression with multiple clauses would look something

like this example:
IF "[LL_REPTAG_&namefl" IN "[LL_REPTAG=NAMEfJ" OR
"[LL_REPTAG_&showall fl" == "FALSE" fJ
When to Use WebReports When building applications with WebReports there are a variety of
Filter Tags ways that the data can be filtered. Some common approaches are
data source filtering, WebReport filtering and client side filtering.
Data Source Filtering If the data source supports filtering (e.g. LiveReport using SQL or
Search using search criteria or LQLl then it is possible to pass
parameters to the data source that are then used to add clauses to
the query in order to limit the data being returned.
This approach is often the first choice as it reduces the amount of

data being processed at the source, prior to any processing on the
server or in the client. In general the less data that gets passed from
the source to the eventual target (usually client software) the
better.
• Can only be used for LiveReport or search based data sources

• Where large amounts of data may be returned, some filtering
should be included at the data source to reduce the amount of
data being processed in Content Server and ultimately the
client program
• If server or client performance is an issue, more processing on

the database is desirable. Conversely, if the database is a
bottleneck for performance, this might suggest that some
filtering should be done through the WebReports code

WebReport Filtering The tags described in this section and or the WebReports scripting
feature can be used to restrict the volume of output that is
ultimately delivered to a destination.
WebReport fiitering can be used:

• Where data sources do not have a query language associated
with them or do not allow filter clauses to be generated (e.g.,
Forms)
• Where a database cannot be used and it is not desirable to
allow all data to be sent to a client program (either due to
performance or due to security concerns)
• Where the data source is restricted for editing (e.g., the
WebReport author is not allowed to edit the Live Report and
therefore cannot add any filters to the query)
• Where performance on the database is an issue (and processing
in the client is not desirable). It is also possible to create a
dedicated Content Server that is only used for WebReports
processing. In these cases the impact of report processing on
other Content Server functions can be minimized
• Where the syntax required to achieve database filtering may be
overly complex or some of the WebReport sub-tag
functionality can be leveraged to reduce query complexity
• Where it is necessary to restrict parts of the data output at a
more granular level (instead of removing an entire row). The IF
tag can be used to change aspects of the presentation and or
specific columns of data
Client Side Filtering The most common means of performing client side filtering is with
JavaScript. JavaScript can be included in the client that evaluates
conditions prior to displaying page components. Alternatively
JavaScript could be used to dynamically build an array (limited by
fiiter conditions) or to dynamically hide or reveal components.
There are other types of client scripting methods but for HTML
being read in a browser JavaScript is the most common.

Client side filtering (such as JavaScript code) can be used:

• Where it is desirable to change the data presentation without
repeatedly requesting new data from Content Server
• Where the volume of data being worked on is relatively low
• Where it is not necessary to maintain an up-to-date snapshot of
data (i.e. we get the data once when the application loads and
then hide or reveal information as necessary)
• Where the data being hidden is not sensitive (as it is possible to
see the hidden data by viewingthe JavaScript source)
Applications of Filter types Each filter tag has particular strengths and applications. Some
common usages are as follows:
IF/ELSE/ENDIF This tag is actually made up of three separate tags that allow parts
of the report to be bracketed. Any source in the bracket becomes
conditional on the outcome of the logical expression specified in the
IF tag. These tags are not normally used to restrict rows of output
as the INCLUDEIF tagor EXITIF tags are much more suited tothis
task (and are more efficient). The IF tags are most useful when
there are portions of the output either in the Header Section, Row
Section or Footer Section that may vary according to data
conditions. A common application of this tag is to make certain
parts of the output dependent on the user's permission level or
their membership in a group.
For example:
[LL_WEBREPORTJF "[LL_REPTAG_$DID PERMCHECK:EDIT II"
== "TRUE" 11
<INPUTTYPE=SUBMITVALUE=EDIT>
[LL_WEBREPORT_ELSE 11
<INPUTTYPE=SUBMITVALUE=EDITDISABLED>
[LL_WEBREPORT_ENDIF 11
Another example of usage is where certain parts of the output are

only revealed if a particular parameter is passed. For example:
[LL_WEBREPORTJF "[LL_REPTAG_&show UPPER 1]" == "TRUE"
II
<DIV>This text is displayed if &show=true is in the URL</DIV>
[LL_WEBREPORT_ENDIF II

The IF tag can also be used within the Row Section to allow optional
columns where certain users might see a column and others might
not. For example, something like this might be used in the row
section:
[ll_WEBREPORT-'F "[ll_REPTAG_$AdminGroup
USERINGROUP Il" == "TRUE" I]
<td> [ll_REPTAG=CreateDate I] <ltd>
[ll_WEBREPORT_ENDI F I]
INCLUDEIF This tag is used to control which rows are included or not included
in the output. If the logical expression fails (returns FALSE) then the
entire row is excluded and the row number is not incremented. This
tag is the most commonly used for filtering out rows based on
specified conditions, equivalent to SQl WHERE clause.
For example:
[ll_WEBREPORT-' NClUDEIF "[ll_REPTAG=STATUS 1]" ==
"ACTIVE" Il
The logical expression can be built into multiple clauses if required.
It is also possible to use multiple INClUDEIF tags.
Often the INClUDEIF will be used to compare a data tagto a

passed parameter. For example, the above example would more
likely look like this:
[ll_WEBREPORT-,NClUDEI F "[ll_REPTAG=STATUS Il" ==
"[ll_REPTAG_&findstatus I]" Il
EXITIF This tag is similar to INClUDEIF but is used to specify a condition

under which no further rows will be included. Cases for this tag
tend to be specialized but it is well suited to situations where it is
necessary to set a maximum number of rows.
For example:
[ll_WEBREPORT_EXITIF
"[ll_REPTAG_ROWNUM Il" >= " [ll_REPTAG_$max Il" Il
INCLUDERANGE This tag allows control of which rows (and how many of them) are
returned. This is particularly useful for pagination applications.
While there are other ways to implement pagination, this tag is
most useful when the INClUDEIF tag is being used to filter rows as
the INClUDEIF tag will affect how many rows exist in the data set.
The tag help for INClUDERANGE explains this in some depth.
Content Server WebReport Design I Page7-7

As an example of usage, if a URL parameter called start at is used to

specify the first row to include, and a constant called max specifies
how many rows to include, the syntax would look like this:
[LL_WEBREPORTJNCLUDERANGE
STARTROW:[LL_REPTAG_&startat fl
MAXROWS:[LL_REPTAG_$max I] fl
INCLUDEDISTINCT This tag makes it easy to return a list of unique values from a data
source where duplicate values may be found. Specifically, if you
were creating a select list based on a table and you didn't want any
duplicates in the list, this tag could be used in a Sub-WebReport to
return an appropriate list.
For example, if the data source returned a "title" column and we

only wanted to show unique titles, the syntax would be:
[LL_WEBREPORTJ NCLUDEDISTINCT "[LL_REPTAG=title fl" fl
DECODE sub-tag In some situations using the DECODE sub-tag is more efficient than
IFfENDIF.ln a commonly used example, if we wantto change an
HTML row color based on whether a row number is odd or even, we
could use this syntax:
<TR CLASS="[LL_REPTAG_ROWNUM ODDEVEN
DECODE:ODD:browsel:EVEN:browse2 fl">
In this example, the ROWNUM tag returns the row number (after
filtering and sorting has occurred). The ODD EVEN Sub-Tag
converts this number to either the word ODD or the word EVEN
accordingly. The DECODE then substitutes the word browsel
instead of the word ODD or the word browse2 instead of the word
EVEN. The alternative to this approach might be an IFfELSE tag
with a check to see if ROWNUM was odd or even. Using DECODE
here is more efficient and generally tidier.
Performance In the preceding sections, some references were made to possible

Considerations performance considerations when using WebReports filter tags.
It is important to be aware that as more filter tags are added to a

Reportview, performance will necessarily be affected negatively as
the amount of processing required goes up. For this reason
sometimes alternatives (such as doing some filtering in the client)
may be desirable.

Chapter 7. Filtering WebRe port Results
In some cases it is preferable to perform filtering using WebReports

as the processing overhead is confined to Content Server which, if
necessary, can be dedicated to reporting functions. Even without a
dedicated Content Server many customers have load balanced
Content Server servers which means that any heavy processing is
less likely to impact all other users. The merit of this depends on
how the database is performing and whether more complex queries
have an impact on database performance.
When it is necessary to exclude or include an entire row, always use

the INCLUDEIF rather than the IF/ENDIF as the INCLUDEIF has
some performance benefits over the IF/ENDIF.
When using the IF/ENDIFtryto use the ELSE tag rather than using
two IF tags. (Prior to WebReports 4.0 there was no ELSE clause so
customers may want to consider updating old Reportviews where it
was necessary to use IF twice for certain problems).
If possible, try to use multiple clauses in logical expressions rather

than multiple INCLUDEIF statements.
Wherever it is possible to use the DECODE sub-tag to solve a

conditional problem, this should be used instead of IF/ENDIF.
Summary

• Identified appropriate applications of WebReport filter tags
• Used appropriate filter tags to restrict the volume of results
returned

Exercises
Overview
In the first exercise, you will use Includelfto Find logins.
In the second exercise, you will use start/end parameters.
Filtering Results Using INCLUDEIF to Find Logins
1. Create a basic WebReport calling it WebReport to Find Login in the Enterprise

Workspace> Course Material> 2-0117 WebReport Design I > WRD I Student Folders>
Student 1 WRDI Exercises folder.
source, Oata Source (KUAF) for WebReport, can be selected from Enterprise
Workspace> Course Material> 2-0117 WebReport Design I > WRD I Template folder.
3. Select basicJeport from the Reportview and click the Add button to store the basic
WebReport.
4. Use the Parameters tab to setup a single mandatory prompt of type string with display
text that says Enter Name and a parameter name of name.
~ WebReport to Find Login' "
5. Remember to save your work by clicking the Update button.

6. Begin by editing the WebReport Reportview to remove the SpacelD column. You will
also want to only output User 10, Owner ID and Name columns and column Headings.
<TR>
<TO>ID</TO>
<TD>OwnerIO</TD>
<TD>Name</TD>
</TR>

7. Next, apply a filter to only return results that correspond to Users (Le., Type =0). Hint:
Add a Constant (e.g., OnlyUsers) as String Type with a value of 0 and use this Constant
as part of an IF statement.
~ WebReport to And LogIn' u
I
i~
1.cw:~n~ nil~_, ~ & . Constam Vilkl?1 ill
ilo'~\h<lS
I
8. Add an appropriate INCLUDEIF tag syntax to restrict the result set so that only items
that exactly match a specified [login] name are included.
Hint: You will need to compare the name column with whatever value was passed from
the prompt; also, you should see the parameter tag in a pop-up list at the top of the edit
screen which you can drag-and-drop into the Reportview.
9. Run the WebReport and test that it only returns the result corresponding to the
entered name:
~ WebReport Parameters: WebReport to And Login

...--,....--,---------, Report results wiI on~ be an exact
rretch h> entered name.
: WebReport to Find Login

v~
ID OwnerlD Name
35152 1000 studentl

Filtering Results Using INCLUDEIF to Find Logins - Exercise Solution
The following code represents one possible solution to filter the User and Group results so that only
Users with an exact match to the entered input are displayed on the report.
[LL_WEBREPORTJNCLUDEIF "[LL_REPTAG=Name fl" == "[LL_REPTAG_&name fl" I]

[LL_WEBREPORTJF "[LL_REPTAG=Type f]" == "[LL_REPTAG_$OnlyUsers fl" I]
<TR CLASS="[LL_REPTAG_ROWNUM ODDEVEN:userRow1:userRow2 fl" VALlGN="CENTER"
NOWRAP ALlGN="LEFT">
<TD> [Ll.-REPTAG=ID f]</TD>
<TD> [LL_REPTAG=OwnerID I]</TD>
<TD> [LL_REPTAG=Name fl</TD>
[LL_WEBREPORT_ENDIF I]
</TR>

Filtering Results Using INCLUDERANGE With Start/End Parameters
1. Create a WebReport calling it WebReport with StartwEnd Parameters in the Enterprise

Workspace> Course Material> 2-0117 WebReport Design I> WRD I Student Folders>
Student 1 WRDI Exercises folder.
source, Data Source (KUAF) for WebReport, can be selected from Enterprise
Workspace> Course Material> 2-0117 WebReport Design I> WRD I Template folder.
3. Select basic]eport from the Reportview and click the Add button to store the basic
WebReport.
4. Use the Parameters tab to setup two numeric prompts:
• Parameter name::;: Start, Display Text::;: Enter Start Row")
• Parameter name = End, DisplayText::;: Enter End Row")
~ WebReport with Stai't"End Parameters ···1
5. Remember to save your work by clicking the Update button.

6. EdittheWebReportReportviewandaddanlNCLUDERANGEtag.
7. Also use the STARTROW and ENDROW tags to use the correctly passed parameters
values to filter the report results.

8. Test the WebReport with different values used for the prompts (Hint: Try a start value
of 23 and end value of 53).
~ Run WebReport: WebReport with Start-End Parameters

WebReport with start-End Paramet"", " IbJ
ID OwnerID Type Name
10801 1000 1 Rnance
H021 1000 1 Product Marketing
10802 1000 1 Accollllting
11022 1000 1 students
10803 1000 0 cho
10804 1000 0 !d>rownlng
108116 10806 1080S Coordinators
10807 10806 10805 MeriJers
10800 10806 10805 Guests
15685 1000 0 ralba
15687 1080 0 wbates
15688 1000 0 kmanager
15698 1000 1 Purchasmg
17780 17780 17779 Coollf"mators
17781 17780 17779 MelTbefs
17782 17780 17779 Guests
17891 1000 0 rtdullllnt
20859 1000 1 OutdoorGear
28882 1000 1 elink
28883 1000 0 ellnk
35152 1000 0 student1
35153 1000 0 student2
43072 1000 1 Customer Service
43623 1000 1 External Users
43073 1000 1 Librarians
43074 1000 1 Malroom
43624 1000 1 Managers
43625 1000 1 Publications
43626 1000 1 WFGl
43627 1000 1 WFG3
43075 1080 1 WFG7

Chapter 7. Filtering WebRe port Results
Filtering Results Using INCLUDERANGE With Start/End Parameters - Exercise Solution
The following code represents one possible solution to filter the User and Group results so that only
Users with an exact match to the entered input are displayed on the report.
[LL_WEBREPORTJNCLUDERANGE STARTROW:[LL_REPTAG_&Start fl
ENDROW:[LL_REPTAG_&End fl J]
<TR CLASS="[LL_REPTAG_ROWNUM ODDEVEN:userRowl:userRow2 fl" VALlGN="CENTER"
NOWRAP ALlGN="LEFT">
<TD> [LL_REPTAG=1D fl</TD>
<TD> [LL_REPTAG=OwnerID fl</TD>
<TD> [LL_REPTAG=Type fl</TD>
<TD> [LL_REPTAG=Name fl</TD>
</TR>
Content Server WebReport Design I Page 7-1S


Chapter 8. Sub-WebReports
8. Sub-WebReports
Objectives
• Use sub-WebReports to combine other WebReports

• Use sub-WebReports to export data to multiple destinations
Overview
What if you want to combine data from multiple sources? Or build

up a report by plugging together other pre-existing WebReports?
Sub-WebRe ports let you do this and a lot more.
Introducing Sub-WebReports
sub-WebReports allow the report developer to break down

reporting problems into discrete parts which work together to
create a single report or application from the end users perspective.

An example of a WebReport using Sub- Reports is illustrated below.
Figure 8-1: Sub-WebReports in Use
PopUlar Knowledge Center items "

!Jp.dlltad Daily ",. "" "
" " ,
P"pular O"cuments Locahon Latest Documents Locati""

® UveHl1!.::.),tildl..du_MafriX,xts 'ti) UVf"Ilt1k EGM .. Federa-tert rke-f'.f SeN'frf 4, 'I ,0 User GI.il!ffl
1ld UVfl-Hrr.k [0,1- Em5rprlS"" SErv~r 9.7,j} R~ltJEl.s.e NIJ1~ [§ Soori~ January PaWh Ra1~~.t.(lr.gz
1'kl Apj.illr:~tl[}~: Hole - Javit lUll: n-aylE!.# S.a'lijJg~ Time (V-i'<f ) Updated .. I~ rm'Vi~n:rl~jYI$ January Palth. Rel~....'$J;i.~~'
ri.l Rf:~age thlies - U ... elinlc 95.0 S-PI ~ LirlolD; J-cHl.ll&ry Piitch ReleaseJIW,gz:
m Ll'1l:;UrlR £itl.(irprlst1 Server.9 Ei,ll Rdft;l.S6 HQtes [~ HP-UX JMUl'If){ Patch fl.elense.-tar 112'
rg Ullelinl!: fx.p!Q~er 4.8.0 F.1e~~,;:e- Nfites ~ 5c"Jris January P£1tc-h P.elE:"flseJ8Lgz
l±I U'.,teHn.iI FCf..l- tnlerplise Senl'er 9.7.0- Qllllotl H",.lp f~r .". ~ NTNlinQp.ws January P<9rch ~tt;llsfr.zip
tzj U\fellrl,~ F[Jtmw~~e S~rver Up~de l~taltatmn GU~1~ [[iiJ LJntlx JiHmary P'ltcl1. ii€le3~e lar.gz
161 U\lelJf'!]:: 9.5.0 Admin OoHfle He'P ~ HP-UX JaouMy Patch Release: tar.g::
U:1 UJlelJtlk Erierp.r5~ ServEr fir~·-TjlTI€< Inslallal1oJ1: Gtl.me- [@1 SoorisJanuary Palch R~je;'J511,tar_gz
Popular Oiscu9sion Threads U::H~ation lalest Dlseu..;,," Pools Loc8tion

~ Load: Batl:lI~drtlJr Vo/hal 1;:; lnfl Be5f P~Hce1 !tJ BWJ In W~kl mooule
Ofggli'lst Folders- k1 Uveri[l~
fr;iJ ItJ !1.tit pos'sJble In upload a. picture rftoo poHc;.';5o brol-cftll
~ U~'!lRI1~o-rt for f.r:6:;mrved ~-<:~ ill a f{;W:o-r'Sl.ltJ-!t;tlder ~ UrrJfaroOll ":i-n-gtfl. of GomplE:<x.j)I.HHy-Strltl.g1JI SearchAf-'1
~ Pmbl,Htls w~h. llfliCI}t}E} cli~nH;t~r:;;. in pUf tila~ ~ G.5tPil-'ije:i::I fl"cmmnJ;;
~ lo~koo te>lt Dbjed ItJ TlliH\R5:, r~ g:i'Ea fhal ~ lry_
lp l C311'b bfD-WSe uhfeds is Site Admj[l-isirutQf Objt;;:c.t r.ll1naa;er lP Wnere-'~ tny hgr; gone I'
~ R~P~C!lU~Hl flnfEl./l:ed with errors;. (t}il.fJectiotls not 2-witchmt: {t:J RE SE1WFFOml ~Yfjtax?
~ 'lm;tatfnns 111 pdf~dexlnq (Cl:ln\'erilng'} mqanfing \'!l'ral(H\ and ~ Ward i1o-c CtHrurtw after webDAV {'(lit
1.&3 HI}'qu-est fJJf inftlfTnaHIlfio . abotll uslleg F(lrltl Oata in SelircllES- rtJ Re How Lo lJ5e o-bjEl"ct !.Uoups Ih~ best ,Nay
~ aJ1.g jh \,\ij~i madlJ~! ftJ Re COfltent paHcy I;iHjl "Jrt~ S~e 1,~al'lag~r 9.7
In this example, one WebReport is acting as a master report and

calling four individual Sub-WebReports. Each of the four Sub-
WebReports has its own Live Report data source, which is designed
to bring back results in the most efficient way possible.
The master report has no data source of its own, it simply acts as a
mechanism to call the Sub-WebReports and deliver the results.
Each of the Sub-WebReports are set to run to the browser and the
master report is set to export to a document, the end result is a
single HTML document containing the combined results of four
sub-WebReports. The master report runs, refreshing the document,
on a dai Iy schedule. This approach minimizes load on the system as
the report executes once per day and the end users simply access a
document (which is much less costly than running four
LiveReport/WebReports for every user that visits the page).
Page 8-2 Content Server WebReport Design J

Diagrammatically, this arrangement is illustrated in the figure

below:
Figure 8-2: Diagrammatic Representation of Document Dashboard WebReports Configuration

Exporting and Sub-WebReports
As seen in the previous example, Sub-WebReports can be used to

pull information into a single report and export it as single report.
An alternative is to set up the sub-WebReports to perform
individual export actions themselves. This is probably best
described with a WebReport / sub-WebReport 'case study' or
scenario.
Scenario You want to be able to send an email to each person within a given
Content Server Project that has an overdue task.
Solution First break the problem into manageable pieces. We know the
following is needed:
• A main LiveReport to retrieve a list of users
• A main WebRe port to call a sub-WebReport. We need this
because we want to send individual emails by calling one sub-
WebReport once for each user
• A sub-WebReport to trigger the email for the given user
• A LiveReport to return additional information (via SQL) about
the user
If you want to email everybody with the same message you

could build a To list with WebReport variables and not
bother with sub-WebReports.

Below is a diagrammatic representation of how a sub-WebReport

might be used to trigger multiple emails. The same principle can be
used when triggering workflows or performing other bulk actions.
Figure 8-3: Diagrammatic Representation of Sub-WebReports and Email
..
..
..
A WebReport can call a sub-WebReport an unlimited
number of times.
Even if a WebReport is being used as a sub-WebReport it
can still be executed as a stand-alone WebReport.
Syntax Sub-WebReports are invoked by tags in a parent WebReport. The

sub-WebReports tag is classed as a content control tag meaning it
has the prefix LL_WEBREPORT. Here's an example.
[LL_WEBREPORT_SUBWEBREPORT NODEID:1234 /]
Where 1234 is the id of the sub-WebReport you wish to trigger.
Although using a hard coded node ID for the sub-WebReport is

perfectly valid a better way to do it would be as follows:
[LL_WEBREPORT_SUBWEBREPORT
NODEID:[LL_REPTAG_$SWR /] /]

Chapter 8. Sub-WebReparts
Here the node 10 of the sub-WebReport is provided by a constant

called SWR. This is defined on the constants tab as a Content
Server object type. As we have seen before, the benefits to this are:
• Constants are easier to manage because you have a single point
where all references to other Content Server objects are
defined
• It makes your reports more portable as WebReports has an
intelligent XML export/import process that allows objects to
maintain relationships between Content Server systems
Parameters Sub-WebReports can be passed parameters in two ways:

• Explicitly via the arguments list specified in the calling
WebReport
• Via inheritance; sub-WebReports have access to the
parameters of their parent and grandparent etc.
The previous example would require the sub-WebReport to be

called in the rowsedion and for the user 10 to be explicitly passed
to the sub-WebReport. Here's how the syntax would look:
[LL_WEBREPORT_SUBWEBREPORT
NODEID:[LL_REPTAG_$SWR f]
PARM:inputLabeI1:[LL_REPTAG=USERID f] I]
First the PARM directive must be used then the name of the
parameter you wish to pass then the value of that parameter. In this
example, the parameter we're passing is called inputLabel1 and its
value will be whatever is in the USERIO column for the current row
of the WebReport.
Multiple parameters can be specified by using multiple PARM

directives. The order in which the parameters are specified is not
important and there is no upper limit on the number that can be
passed.
If the sub-WebReport is using a Live Report data source it will have

access to parameters in the format inputLabelx. This means you can
use %x in your SQL statement just the same as a regular LiveReport.
If you want to access the parameter in the sub-WebReport you
access it just like any other parameter (e.g.,
[LL_REPTAG_&inputLabelx fl).

Considerations If you are running a WebReport that has a thousand rows returned
and that in turn is cailing a sub-WebReport which is doing
something like an export to Workflow, consider the performance
implications. The impact of this type of operation will depend on the
individual system. Is it capable of running 1,000 reports and
launching 1,000 Workflows at peak hours?
The WebReport stack depth is limited to 5 by default;

however, this value can be overridden in the opentext.ini
file using the parameter MaxNestedSubWebReports.
Summary

• Use sub-WebReports to combine other WebReports
• Use sub-WebReports to export data to multiple destinations


Exercises
Create a Mini Portal
Overview
Create a small or mini portal using a master WebReport and a pair of sub-WebRe ports.
1. Use the basic reportview to create two WebReports.

a. The first WebReport called Portal 25 Largest, uses the 25 Largest Documents
LiveReport (Hint: it is located in the Live Report Volume) as a data source.
b. The Second WebReport, called Portal Most Versions, uses the Documents With
The Most Versions LiveReport as a data source.
c. Use the INCLUDERANGE tag to limit the results in each of these reports to 10.
2. Create a Master WebReport, called Portal Master WebReport, using no data source
and a blank Reportview format that calls both of the WebReports created in the
previous step so that the results appear side by side; make sure you use WebReports
constants to reference each of the sub-WebReports.
The resulting [master] report should look like the following:
~ Run WebReport: Portal Master WebReport
Portal 25 largest ' [:kJ Portal Most Versions l.kl

Owner!O ParentlO OataID Name OrfginDwnerID DataID Name SubType GlF PerrriD
·,'lOUD 354115 374458 Sall"4'!eOOtS,zip I} 397691 Qd\lbanner.htni 144 ??
~2070 14216 74217 razmLWAV 0 404226 Bask Users and GroupsfromODG 144? ?
-2070 74216 74217 razwL WAV 0 iWM-24 Bask Users and GroupsfromODG 144 ??
-2000 35'1122 354135 Custormfel'ls.Zip I} 407668 Baslc:WehRllp<lrt; Result$ for Product Spec Category144 7'?
-2000 40'1U33 404038 Output 2 I} 404213 BaskWe:bRell0rt Results for Product Sp..,;: Category 144 ??
·2000 404G33 4M035 Output 0 15555 Filmly_leave.doc 144 1?
-200f} 15609 15610 hamet.xrrl 0 I 11404 jobs, doc 144 ?-,
~2llj)O 15609 15614 othella,xrrl 0 '115583 observ«UioJidiIYs,doc 144 ??
-2000 354112 354141 enterpnse-anlmgif I) 15874 NewProdurt,doc 144 1?
-2000 1S445 15446 ISO Character Set~.htm I) 101785 Ho&l!ay,ooc 144 ??

Create a Mini Portal - Exercise Solution
The Row Section of the sub-reports should contain the following information to limit the number of
returned results to 10 rows.
[LL_WEBREPORTJNCLUDERANGE MAXROWS: 10 /1
The Header Section of the Master Report should contain the following information (and necessary
HTML structure), to display both sub-reports side-by-side.
<table width="100%" border="3" cellspacing="3" cellpadding="3">

<tr>
<td >[LL_WEBREPORT_SUBWEBREPORT NODEID:[LL_REPTAG_$PortaI25Largest /1 /]</td>
<td >[LL_WEBREPORT_SUBWEBREPORT NODEI D:[LL_REPTAG_$PortaIMostVersions /] /l</td>
</tr>
</table>

Appendix A. WebReport Help and Resources
A. WebReport Help and Resources
Objectives
On completion of this appendix, participants should be able to:
• Describe the online hel p and Knowledge Center resources that are available for WebReports
Overview
This appendix identifies several resources you should be aware of

that can be very useful when working with WebReports.
Product Support, Knowledge Base and Help Resources
Product Home Page The Resonate home page is available from the following URL:
http://www.resonatekt.com
FigureA-1:
Resonate Home Page
Technical Support Technica I and customer support is available from your regional
OpenText support call centers.
Content Server WebReport Design I Page A-1

The following URLs provide initial support and contact information:

• http://www.resonatekt.com/supporLhtml
• http://www.opentext.com/who-we-are/contact-us
• http://www.opentexLcom/support
OPENTEXT '""On It''''''''· c<

WrlATWEDO WWOWE AAf.: VlOEO-!; c~~ CO./'l!MlJNITY (\.iP,t>ORT ~~~D
~~~o-'-.%.~, ","".~ ~ ,. ,,"'I
How can we help? Cort\tltt Support

liZl 'f>~y.:itlPP':l(t
Whethllr you're looking for self-help resources, strategiesto optimize
your systems, or expert assistancE!, we're here for you every step ofthe ~GXS S~1'P"ft.
way. ~ CMtad..SupfiQ'1
CUUOM£IlJl!!'ltVlcItUOO1C
FigureA-2:
OpenText Support
Pram(er Anytime
Anywhoro
Ow Wp"QHIIe"lItJ"" Ptl'l~~ ilndf/l'~YlilrMrl'l" IdtJo~for,<e;.tom".~ I'r''''~ CdtT«I115W&~<IfI!"'Qr1;!W
flrogffilnoff~JlJthe ~upport Itllk\nKItayaur C'P'itll-l:.ftafm.l~' theop.;.ll:rW
biii'lllo1it!l.ofP«!w~,pfu'.i; spIlcltK:bu!lf~'l"'~ro ,do~hQrjl1,m!)ttirk \I~tlon~pr.wOO"'ll
~~PJll;HtfO~I1~~£-:;;:4 pf;.'IPP'IW¢otpmOklrn.l';r ... ·9~.t:l9I<lflf1k:!Or.lltl,;:,M. )'[)ur .k.gy bu$.lrtoll~g
ho,,~r.ilda)l.}~./i. ;;peed up ~QlvtJo[l. "..Afl'J'!"t1i1l"l prWtklQS!J-:lt'i- prcce~S<I:'i-,.
,W(l'''','lt.3~41i)!,S_'',1'1iiir"-, ~~",!sla;nd,~l(y ... : -)l:~psuPpo)n~(l~~

.d~pi,oym~ni5,iil;d .!1~;'. :... .
~P'f~.,': .
Knowledge Center There is a WebReports Discussion location available from the

Knowledge Center (KC) at the following URL:
https:Uknowledge.opentext.com/knowledge/llisapi.dII/open/WebR
eportsDiscussion
You can start a conversation about WebReports, WebReports
Extensions, and ActiveView.
Page A-2 Content Server WebReport Design I

Documentation All the WebReport documentation for Content Server 10.5 was
merged into the core online help. Users, however, will find that
technical and user guides for previous WebReport versions are still
available from the KC for download.
The same User Help and Admin Help are also available as a PDF
version of the online help:
https:/lknowledge.opentext.com/knowledge!cs.dll?func=ll&obi Id =
47752119&objAction=browse&viewType=1
Figure A-3: Online Help as PDF Files From the Knowledge Center
Product v Customer Services .• Partner v Help v
Can we help you find something?
Content Server 10<5.0 Service Pack 1
Content Server WebReport Design I Page A-3

Online Help Online help for WebReports is available from the Main menu>
Help> Contents> Using WebReports, as illustrated in the figure
below:
OI'ENTEXT I eonlo"l SID", gAbout WobR_rts

~Gettlng Started USing WebReports
lid:: {".antll\'nl St!!fVt>r 1~/JI:i1 QI~
f':-
ffi GettnOStart:~d
i ..
._-2J 1;I;ti...__.___
_'.".
._---1 menl.l,Wh1JIlC:W"Ik"!/ilditElWWi!bne,/)(lJt/theuSla'rtJptompl'lldtQ',
~~~w:~~~Da~d~a:~~~~~~~~t:er;::~:t:~~~tio%t~~At~~=~t::b:~~O:;wn
,-', ."_,.
rtl. CUst(l:mttflo eu~l!£!m: $e',Ntr
1~ c.1l0V:l1f If data Sl,lIJ!te on whth thil W~bReport wfbij based.
1lJ. M",,,,IIJ1 Oo'"'!l..ts OlIdllo'.....
1}] RetoeWig JoriJ.Jl/:littl.n 2. .1f!Ied: a Jl"P1lJtV[IlW to use ~ the presentation hmpliltl;' fQe IIlIT tJataSO\Hte.
ill. C.....latllg wt~ ot~."
!!I CClII'UnUl1lc,atk19 N~~ arid llpdat:ils
ill Aul,grJ1ilUl!1 Bwmm P't:J)(e6Sl!'
!!) -Implementng a SU:Oll$PfQCtSia5" Wo~w
E1UsilgWe-bRtpotts
FigureA-4: r~1 Aboul We:b~ports PmoodLlres for WebRe.porls End Users: RJr@ndll5erstlfWebRQPol1Si:hi!retln!:
1nUcHJudllJ.n to: W~bAl1'pctts IOlpoltant items re~!erl to Ih& &xac.ution {jfWebP.ilpM5 to dfsp!ayor expcnt data. Th",
most uS(!ful items rorWebRepltIt kiS'l15 are~
WebReports Online Help trelIS1!!!J"PDmNl!'ffl1!l!1!
(fl WoMlO .,Ib WebReportt
ffi Rl)port~wnl)S
lB WebRepclts/tdvilJ(f§'d lnfuliTHltillli
r'tl D~ta""d Examples; Pro£edUfM' filr WMJRE'poTt9 oevdoper.>: Rlr WebRelitltts de....ekloe-lSsomilil: llf the
ill UsinlWebDAV most: us@ful PI'll(lHfores ('tn~:
li.I W(JM'l,g !'Ith QpanTelLt Entlllll$e Cunilli!{t
Page A-4 Content Server WebReport Design I

Appendix B. SubTypes
B. SubTypes
Overview
This appendix lists Content Server Subtype values and identifies

new SubTypes for Content Server 10.5 SP1.
When writing SQL queries for Content Server Live Reports, (i.e., 3-
0127 - Content Server Schema and Report Fundamentals) it is
useful to reference lists of SubType integer values.
Subtypes
Tables B-1 and B-2 identify [core and common] SubTypes,

alphabetically by display name, and their corresponding SubType
integer values. Entries appearing in bold font represent new
SubTypes for Content Server 10.5 SP1.
Table B-3 identifies [core and common] SubTypes, by ascending

integer value and their corresponding names. Entries appearing in
bold font represent new SubTypes for Content Server 10.5 SP1.
A complete list of instance-specific Content Server

SubTypes is available from a System Report - run from the
Administration pages or using ?func=admin.sysreport.
The Node Types Info and UI Only Node Types
Info sections of the report contain details of the node or
SubTypes for the system.
Content Server WebReport Design I Page B-1

Table 8-1: Database SubTypes by Display Name

..... .. ,..
._~-
,
Appearance 480 Appearance
Appearance Folder 484 VolumeFolder
Appearance Workspace Folder 483 AppearanceFolder
Enterprise Archive
Archived Document 753 Document
Backup Manager 290 BackupManager
Backup Process 291 BackupProcess
Best Bets 274 BestBets
Categories Volume 133 VolCategories
Category 131 Category
Category Folder 132 CategoryFolder
Channel 207 Channel
Channel Volume 209 ChannelVol
Collection 298 Collection
Column 902 Column
Compound Document 136 Compound Doc
Content Server Appearances 481 AppearancesVolume
Compound E-mail 557 Compound EMail
Content Move Job 797 SPCJOBDESCR
Content Move Job Folder 796 SPCJOBDESCRFOLDER
Content Move Volume 795 SPCVOLUME
csapps
Content Server Applications 32657 CSApplicationsVolume
Page B-2 Content Server WebRe port Design I

Appendix B. SUbTypes
,0; •••••
, ,,~U,~ ~UDIYP"
Content Server Search

Federator 257 OTClndexObj
csapps
CS Application Manifest 32658 CSApplicationManifes
Custom View 146 CustomView
Custom View Template 844 CustomViewTemplate
Data Flow Manager 270 DataFiowManager
Data Source Folder 276 DataSourceFolder
Deleted Documents Volume 402 Vol Deleted Doc
Deleted Items 405 VolDeletedltems
Directory Walker 277 DirWalker
Discussion 215 Discussion
Discussion Volume 143 VolDiscussion
Document 144 Document
Document Conversion 282 HTMLConversion
Domain Workspace 180 VolDomainWorkspace
Dynamic View 900 DynamicView
E-mail 749 EMail
E-mail Folder 751 LLNode Email Folder
Enterprise Extractor 259 LibraryExtractor
Enterprise Search Federator 272 LibraryObj
Enterprise Workspace 141 Vol Library
Facet 904 Facet
Facet Folder 905 FacetFolder
FacetTree 903 FacetTree
Content Server WebRe port Design I Page B-3

'" "r
fName I
SubType
Facets Volume 901 Vol Facets
Fixed System Column 906 FixedSystemColumn
Folder 0 Folder
Form 223 Form
Form Template 230 Template
Generation 2 Generation
Global Appearance 482 GlobalAppearance
HTMLView 226 HTMLFormView
Importer 293 Importer
Index Engine 368 IndexEngine
Index Tracer 147 IndexTracer
LiveReport 299 Report
Memcached Folder 919 MemcachedFolder
Memcached Process 920 MemcachedProcess
Merge 273 Merge
MicroPost 1281 MicroPost
Milestone 212 TaskMilestone
My Personal Staging Folders 397 VolPersonalStaging
My Reserved Items 870 MyReservedltems
My Workbenches S32 MyWorkbenches
My Workspace 142 VolWorkbin
News 208 News

Partition 371 Partition
Partition Map 370 PartitionMap
Personal Staging Folder 398 PersonalStagingFolder
Poll 218 Poll
Process 271 Process
Project 202 Project
Project Template S43 ProjectTemplate
Project Workspace 201 ProjectVol
Prospector 384 Prospector
Prospector Queries 380 ProspectorQueries
Prospector Snapshot 387 ProspectorSnapshot
Proxy 260 Proxy
Pulse 1282 MicroPostVolume
Release 138 Release
Release Volume 137 Vol Release
RembteCbhtent·Server 381 RemoteLLDataSource
Reply 134 Reply
Reports Volume 211 Vol Reports
Revision 139 Revision
Search Engine 369 SearchEngine
Search Form 292 SearchTemplate
Search Manager 269 SearchManager
Search Query 2S8 Search Broker
Search Result Snapshot 278 Search Report
Content Server WebReport Design I Page B-S

.-
,>uu'ype
I
Search Results Template 383 SearchResultsTemplate
Shortcut 1 Alias
Slice Folder 275 SliceFolder
Social Object Volume 1283 SocialObjectVolume
Social Object 1280 SocialObject
Spider 280 Spider
Submit Version 231 SubmitVersionNode
System Volume 148 Vol System
Task 206 Task
Task Group 205 TaskGroup
Task List 204 TaskList
Task List Volume 210 TaskListVol
Tee 294 2WayTee
Template Folder 542 ItemTemplateVolFolder
Template Folder 268 TemplateFolder
Templates Volume 541 ItemTemplateVol
Text Document 145 TextDocument
Topic 130 Topic
Tracer Volume 149 VolTracer
Transport Package 531 TransportBox
Transport Package Folder 530 BoxFolder
Transport Item S26 Transportltem
Transport Item Part 527 TransportltemPart
Page B-6 Content Server WebReport Design I

,..;,- ,.- <~Y~TYP"

TransportVVarehouse 525 VolWarehouse
Update Distributor 281 IndexUpdate
URL 140 URL
Virtual Folder 899 VirtualFolder
Warehouse Folder 529 WarehouseFolder
WebFormConnedionVolu
Web Forms Connections 236 me
Web Forms Database WebFormDatabaseConne

Connection 235 dian
Web Forms Database Lookup 234 WebFormLookup
Web Forms Lookups 233 WebFormLookupVolume
WebReport 30303 WebReports
Workbench 528 Workbench
Workflow Attachments 154 WorkflowAttachments
Workflow Map 128 WFMap
Workflow Status 190 WFStatusNode
Workflow Volume 161 VolWorkflow
Workflows Edit Volume 162 VolEditWorkflow
XML Activator Consumer 286 XMLActivatorCon
XML Activator Producer 285 XMLActivatorProd
XMLDTD 335 DTDLLNode
XML DTD Volume 336 VolDTD
<Unknown> 731 Inbox
<Unknown> 732 Mailbox

Table B-2: User Interface SubTypes by Display Name

:
I "uu, y~" ,
Content Server 1S0 VolRootsVirtuai
Current Milestones 710 CurrentMilestoneSec
Current News 711 CurrentNews5ection
Document 263 OTClndexResultNode
Documents of Interest 314 RecommendedDocs
Favorites 628 FavoritesVolsVirtua
Late Tasks 712 LateTasksSection
Mail Message 733 MailMessage
Mail Message Attachment 739 MaiiMessageAttachment
Most Active Items 312 MostActive
MyTasks 713 MyTasksSection
Newest Polis 714 NewestPolisSection
People Who Viewed This Item 316 ActiveUsers
People Who Viewed Th is Item

Also Viewed 317 SimilarDocs
People With Similar Interests 31S PeopleLikeYou
Project Summary 71S ProjectSummarySecti
Projects 203 ProjectVoisVirtual
Recently Visited Items 313 History
Status Page 191 WorkStatusPage
Sub-Projects 716 SubProjectsSection
Top Picks 311 TopPicks
Unassigned Tasks 717 UnassignedTasksSect

-" -, :>UOlype
What's New 310 WhatsNew
Workflow 189 WorkStatusltem
Workflow Status 188 WorkStatus
Workflow Step lS3 WFlnbox
XMLActivator 289 XM LActivator
<Unknown> 297 DeletedResultNode
<Unknown> 382 RemoteLLSearchResul
Content Server WebRe port Design I Page B-9

Table B-3: SubTypes by Integer Value
.>uu' YI'"
Folder 0 Folder
Shortcut 1 Alias
Generation 2 Generation
Workflow Map 128 WFMap
Topic 130 Topic
Category 131 Category
Category Folder 132 CategoryFolder
Categories Volume 133 VolCategories
Reply 134 Reply
Compound Document 136 Compound Doc
Release Volume 137 VolRelease
Release 138 Release
Revision 139 Revision
URL 140 URL
Enterprise Workspace 141 Vol Library
My Workspace 142 VolWorkbin
Discussion Volume 143 VolDiscussion
Document 144 Document
Text Dacu ment 14S TextDocument

,- .. . ..
Custom View 146 CustomView
Index Tracer 147 IndexTracer
System Volume 148 VolSystem
Tracer Volume 149 VolTracer
Content Server 150 VolRootsVirtual
Workflow Step 153 WFlnbox
Workflow Attachments 154 WorkflowAttachments
Workflow Volume 161 VolWorkflow
Workflows Edit Volume 162 VolEdltWorkflow
Domain Workspace 180 VolDomainWorkspace
Workflow Status 188 WorkStatus
Workflow 189 WorkStatusltem
Workflow Status 190 WFStatusNode
Status Page 191 WorkStatusPage
Project Workspace 201 ProjectVol
Project 202 Project
Projects 203 ProjectVolsVlrtual
Task List 204 TaskList
Task Group 205 TaskGroup
Task 206 Task
Channel 207 Channel
News 208 News
Channel Volume 209 ChannelVol
Task List Volume 210 TaskListVol
Content Server WebRe port Design I Page B·l1

o>uu I y~~
:
Reports Volume 211 Vol Reports
Milestone 212 TaskMilestone
Discussion 21S Discussion
Poll 218 Poll
Form 223 Form
HTMLView 226 HTMLFormView
Form Template 230 Template
Submit Version 231 SubmitVersionNode
Web Forms Lookups 233 WebFormLookupVolume
Web Forms Database Lookup 234 WebFormLookup
Web Forms Database WebFormDatabaseConne

Connection 23S ctian
WebFormConnectionVolu
Web Forms Connections 236 me
Content Server Search

Federator 2S7 OTClndexObj
Search Query 258 SearchBroker
Enterprise Extractor 2S9 LibraryExtractor
Proxy 260 Proxy
Document 263 OTClndexResultNode
<Unknown> 264 LibraryResultNode
Template Folder 268 TemplateFolder
Search Manager 269 SearchManager
Data Flow Manager 270 DataFlowManager
Process 271 Process
Enterprise Search Federator 272 LibraryObj

JJ
J
"~ -, '?U,,'yP"
Merge 273 Merge
Best Bets 274 BestBets
Slice Folder 275 SliceFolder
Data Source Folder 276 DataSourceFolder
Directory Walker 277 DirWalker
Search Result Snapshot 278 Search Report
Spider 280 Spider
Update Distributor 281 IndexUpdate
Document Conversion 282 HTMLConversion
XML Activator Producer 28S XMLActlvatorProd
XMLAetivator Consumer 286 XMLActivatorCon
XMLActlvator 289 XM LActivator
Backup Manager 290 BackupManager
Backup Process 291 BackupProcess
Search Form 292 SearchTem pi ate
Importer 293 Importer
Tee 294 2WayTee
<Unknown> 297 DeletedResultNode
Collection 298 Collection
LiveReport 299 Report

~
-
~uDlype --
What's New 310 WhatsNew
Top Picks 311 TopPicks
Most Active Items 312 MostActive
Recently Visited items 313 History
Documents of Interest 314 RecommendedDocs
People With Similar Interests 315 PeopleLikeYou
People Who Viewed This Item 316 ActiveUsers
People Who Viewed This Item

Also Viewed 317 SimiJarDocs
XMLDTD 335 DTDLLNode
XML DTD Volume 336 VolDTD
Index Engine 368 IndexEngine
Search Engine 369 SearchEngine
Partition Map 370 PartltionMap

~~lJType
Partition 371 Partition
Prospector Queries 380 ProspectorQueries
Remote Content Server 381 RemoteLLDataSource
<Unknown> 382 RemoteLLSearchResul
Search Results Template 383 SearchResultsTemplate
Prospector 384 Prospector
Prospector Snapshot 387 ProspectorSnapshot
My Personal Staging Folders 397 VolPersonalStaging
Personal Staging Folder 398 PersonalStagingFolder
Deleted Documents Volume 402 VoiDeietedDoc
Deleted Items 40S VolDeletedltems
Appearance 480 Appearance
Content Server Appearances 481 AppearancesVolume
Global Appearance 482 GlobalAppearance
Appearance Workspace Folder 483 AppearanceFolder
Appearance Foider 484 VolumeFolder
Transport Warehouse 525 VolWarehouse
Transport Item 526 Transportltem
Transport Item Part 527 TransportltemPart
Workbench S28 Workbench
Warehouse Folder 529 Warehouse Folder
Transport Package Folder 530 BoxFolder
Transport Package 531 TransportBox
My Workbenches 532 MyWorkbenches

~ "uu'Y~~
:
Templates Volume S41 ItemTemplateVol
Template Folder 542 ItemTemplateVolFolder
Project Template 543 ProjectTemplate
Compound E-mail 557 CompoundEMail
<Unknown> 731 Inbox
<Unknown> 732 Mailbox
E-mail 749 EMail
E-mail Folder 751 LLNode Email Folder
EnterpriseArchive
Archived Document 753 Document
Content Move Volume 795 SPCVOLUME
Content Move Job Folder 796 SPCJOBDESCRFOLDER
Content Move Job 797 SPCJOBDESCR
Favorites 628 FavoritesVolsVirtua
Current Milestones 710 CurrentMilestoneSec
Current News 711 CurrentNewsSection
Late Tasks 712 LateTasksSection
MyTasks 713 MyTasksSection
Newest Polls 714 NewestPolisSection
Project Summary 715 ProjectSummarySecti
Sub-Projects 716 SubProjectsSection
Unassigned Tasks 717 UnassignedTasksSect
Custom View Template 844 CustomViewTemplate
My Reserved Items 870 MyReservedltems

:
.~ "' .~uu'Y~~
Virtual Folder 899 VirtualFolder
Dynamic View 900 DynamicView
Facets Volume 901 VoiFacets
Column 902 Column
Facet Tree 903 FacetTree
Facet 904 Facet
Facet Folder 905 FacetFolder
Fixed System Column 906 FixedSystemColumn
Memcached Folder 919 MemcachedFolder
Memcached Process 920 MemcachedProcess
SocialObject 1280 SocialObject
MicroPost 1281 MicroPost
Pulse 1282 MicroPostVolume
Social Object Volume 1283 SocialObjectVolume
WebReport 30303 WebReports
csapps
Content Server Applications 32657 CSApplicationsVolume
csapps
CS Application Manifest 32658 CSApplicationManifes


Appendix C. Content Server and WebReport Licensing
C. Content Server and WebReport Licensing
Objectives
• Describe the Licensing features of Content Server 10.5 SP1 including Managing Licenses
• Install a Content Server system License File and WebReport module License File
Overview
This appendix deals with Content Server product and WebReport

modular licensing.
This chapter section provides a review of Managing Licensing, if you

have had previous experience with Content Server 10Ss licensing.
This section also provides an introduction to the navigation and
installation of Licenses, if you have not had previous exposure to
this functionality.
Content Server Licensing
System administrators will find that Content Server 10.5 includes a

series of new features and functionality to assist with the licensing
of the core product and some of its optional modules, like
WebReports.
Unlicensed and Content Server operates in Administrative Mode when:

Administrative Mode
• A temporary license has expired
• It is unlicensed
• It is newly installed
The CS10Sb instance of Content Server on the TrainGen

Windows Server 2008 R2 system is operating in
Administrative Mode since it is newly installed and
unlicensed.
Content Server WebReport Design I PageC-l

When Content Server is in Administrative Mode, only the Admin

User or accounts granted the System Administration privilege can
successfully log in.
If a user without System Administration rights attempts to log in to

Content Server when it is in Administrative Mode, an error
message stating "Error logging in. User does not have sufficient
privileges to log-in while Content Server is in administrative mode"
is displayed, as illustrated in the figure below.
OPENTEXT I Content Server
Em" logging In. Us.,. dMS not hiM! suffid.nt privilogo, I» f.9·;n while Cont.nl
SOlVer I~ In ~dnHn;mutl.n mod••
Figure C-1:
Administrative Mode Login Error
Po~wotd: i............ . _......... .jl
Step Set C-1: Navigating and Using Manage Licenses

1. Stop all of the services associated with CS105.
2. Start the CS10Sb Server service; the corresponding Admin and
Cluster Agent services are not required.
3. Select Start> Programs> OpenText Content Server 10.5 (CS105b)
> Content Server Administration.
4. Enter an Administrator Password of opentext.
5. Change the Administration page view by clicking the Show As Tabs
link.
Page C-2 Content Server WebReport Design I

Figure C-2: Server Configuration and Manage Licenses
arEN'TEXT I Content Server

Ip~t:'~.rli"~ •. ~.,.,.,~.I T""k Mm'".· '\)J. .. ..•.••.••.•.....•..... ....•..•. . . . • • .
I~. Content Server Administration
LAnDllllgn
~-- __ .~'.n··~_------i
l:IUi!.H.'(~n.'~~nt
Admll1lwateu1: CIlIl iil'l;;!y?;l!" 5Ol\wll~ In$la11~lj.rjr'lS: 3nd fk{Ifoy p.atclles <lUQ'i$ il. d\J.Sw.
Appearan~1 Admmhlr3twn J ~
6ut Betd Aoo-.ln~\lohiiUon -~-I CM(lqllfe ftJo:et flmctfDnjlity 4f1d dQtument c1i!oS$6 ~r!d >rlI~ •
.c~cc.':,:I".::':.:I.:.:"."A"d"m"I"':". :-=;tlo'-"~--
.. -·-i £m:!!!n\l~~.Jll!
-c·~~b:·;;t'S;;;rApP'~iJ~~·~··Ad·mw~~8«;;-i MWl: fIlnctfot'ls:t<J 'OrfroITl the: Mot.¢' s:ubm~nij.
'oiU;~01Y Sf!fItitl!~i;g;;Uon ~ Configure peWqnilnce SeldOQj
Admln'-8rk.ation 3 ConfiguN wvtt perfonnan<~~etti!lg$ SlJch as 1M- uU;r dghts thresMtd, rtl:nlU'lum flllfl'lb-et (If ~il$~ number of thi~J$"J adlt oonlrol ne4<'Wt ~rm te!-eiY.e bl'.:rore ~nd>
·~:~i;~i;~:.~~~~~~~?_~--=l CcmifnurrPrrlJl~nllltfnn
()Jl'lfi?~re' '!!l~etl~ rdilted to pt~fffitafuln in The Qlntent S".,er.
~~-~~n-===1
~
MlJlli.FUe Output A.drn-inltl,ation ~ C(",,(t~Ule<:Qn~t'It Smfr s:mmly p&rilmd:~ Indudillvlhe inJ.thoentl~n «Io);l~ JnflJoHl1i1UOll, (ookie r;nr;('jjJtJon key, ~r1d ywd CGl nests .
Notl~lIt1ol'l Alitmtlll1nl!on k2nfilnIJ:I'l StlNl!"f F'al'3rrn:i&!]
R~OOltOt't1&lr Admlf)~tmtiotl
--_._-_.~~,-~.-.-. __ ._-~~~
Configl1i1!' ContEnt 5eN~r flMammro, 1l1dudifl!i Ul~ "'j-rupport" dtr~ry ljfU.- p!tlix, the Cofltel'lt ~lNu Admillliliilhlr !la~motd a(ld e.lrlall acld!~, all.d 9.1ob~1 'rJSt'f tnteriacII;: prderattc:es.
SIl~fCbAttmlntlW3::.:::."'.";.-. -1 CQ:rll'!qUfl} SVllein Me::9W®t

S~gePrO\'ki&.0~ _ Ad-cl imd rt!'l1\'IlIll SY~WHlri!!lIret rn-e=;~a.gt!: broil.d~~~ llV-I':f tht Ne~ Pl'ayet.
Uurs ond G'Qupt Admlnl,tr.al:lon LImb fig; Admin Attl9urrt LwHg
W6(etaQI1J:.... Adminl.lJ'8tlOh
~Wcb Editi~t;;;;m;U~n~~~~·~~~-- I Thb pi1jj~ lett ytItl ,~d lil~ IF fl'(fdr~e$ (MEn whrd'l t"e Admin !j~l;l ~«OUf1t ("'0 lor)-in t6, Co!li~llt StlVo"f.
MID.~l,.~ g
-W;~Rl!Pc-rb-A;;i;~l;ttatlQ;iiJ;ak;~1<:dl 1l..1"~""'~.~·;Con;;t'"~'~s~.,.,:.:."'~,:•.;'".;d.;."';;..d;.;'I;;..,;;~';;'''';;.''..·. .da
-~:~;~=~~~:~:~~-~== ~~~~~~=~tt'~M n~.
~mM.£.qtl
S~edfy the PI1Jt nllmb~r on vtl1idl Y® i'l'Mot lhe c.an~ent $uv!r ttl l!sUn.
~
'Ge:!1 ;~ ~tffl1 RDM fit ~«.ss ~ r.reviQ~gr'lerilttdnW TtP9rt.
6. On the Server Configuration tab, click the Manage licenses IJ'nk

7. Log in as the Admin User (admin, password = fivelink) when
prompted and click the Log-in button.
Options Each of the license management options are available by selecting

the appropriate tab appearing under the Options heading,
including:
• License Overview
• License Management
• System Fingerprint
• License Report
8. Click the license Overview tab on the left under Options, if the tab
is not automatically displayed.
Content Server WebReport Design 1 Page C-3

License Overview The Content Server License Overview summarizes the features of
your Content Server license:
Manage Ucenses
Content ~er license Overview

Status: U.[lcons.d
FigureC-3: Prfjuutt Name, OponText Content Server
License Overview Product Vert(un: 10,5,0
licen•• Type: N/A

Company Name, N/A
Expiration Date: Nfl'.
Ac:I:i'I>! Users' 2
Status Displays the current license Status of the Content Server system.
Status values can be Valid, Invalid or Unlicensed. See Table C-l and
Table C-2 for additional details.
Product Name The product licensed by the license (i.e" OpenText Content Server).
Licensed Version The version of the product licensed by the license.
License Type The type of product license.
License Type values can either be Production, Temporary or Non-

production. See Table C-3 for additional details.
Valid Indicates that Content Server is licensed for use by a

specified number of users.
TableC-l:
Status Values Invalid Indicates a problem with your Content Server license.
Unlicensed Indicates you have not applied a license to your Content

Server installation. When Content Server is unlicensed, it
operates in Administrative Mode.

When the Status Value is Invalid, additional information is provided

regarding the issue with the licensing according to the following
table:
Invalid Version Your license applies to a different version of Content

Server than the one that you are running.
Invalid Fingerprint Changes in your Content Server environment have

caused your System Fingerprint to change, so that it
TableC-2: does not match the Fingerprint in your Content
Server license file.
Invalid Status Values
Expired The current date is after the Expiration Date
specified in your temporary Content Server license.
When its temporary license expires, Content Server
operates in Administrative Mode.
Exceeded Users The number of users in use exceeds the number of

users specified in the license file.
Production A Content Server production license enables full

functionality for a specified number of licensed users.
A production license is associated with a specific
version of Content Server (and database).
Temporary A temporary Content Server license enables all of the

TableC-3: same functionality of a production license, but has an
expiration date. The expiration date is always a
Types of Licenses specific date; and is not relative to when you apply
the temporary license.
Non-production A non-production license provides all of the same

functionality of a production license, but is issued for
environments used to support a production
environment. For example, you could apply a non-
production license to a development environment or
a User Acceptance Testing (UAT) environment.
Company Name The name of the company that the license is issued to. The
maximum length of the name is 100 characters.
Expiration Date If your license type is Temporary License, an expiration date

appears; otherwise the license has no corresponding Expiration
Date.
Content Server WebReport Design I Page C-5

Appendix C. Content Server and WebRe port Licensing
Licensed Users Maximum number of users supported by this OpenText license

(appears only when a valid license applied to the system).
Active Users Number of users that currently exist in Content Server.
~ Not all Content Server modules require a license.
9. Click the License Management tab on the left under Options.
License Management License Management allows system administrators to obtain and

then apply Content Server (or applicable modular) license files.
Obtaining a License File To obtain a license file, via the License Management tab, click the
provided Product Activation link (i.e.,
http://productactivation.opentext.com/ContentServer) and follow
the provided on-screen user instructions.
Contact OpenText Customer Support for specific details

regarding the securing of License files and the use of the
activation server.
When prompted to log on to the Knowledge Center, use the user

account and password information provided to you when you
purchased Content Server.
Only one license is required for multiple instances of

Content Server that connect to the same database.
Selectthe appropriate product and license file type, and use
your System Fingerprint to generate a license file for
Production systems.

Figure C-4: Obtaining a License File
Manage Licenses
Ucell5e Management
Ucense Ovetlliew Description: Please select a Wcense file 1;0 be applied In Content Server. A license file can be
acquired by Visiting the OpenText prodlldact:ivation website for ConlentServer.
lk;o:l1Se Management
Product Activation: bltp,!lpmductact:!yatioo.opentext.;;wr!ConlenISelVer
System Rngerpritlt Ucense Location:
Ucerl$8 Report I
10. Click the System Fingerprint tab on the left under Options.
System Fingerprint A System Fingerprint uniquely identifies your Content Server

deployment, using pieces of information from your Content Server
database. This information is used when requesting a Production
Server license file.
System Fingerprint information is encrypted and hashed so

that it is not readable, even by OpenText.
The system fingerprint is the same for every instance of Content

Server in your deployment, provided each instance connects to the
same Content Server database.
Figure C-5: License Fingerprint
Manage licenses
• OPTIONS System Fingerprint

A system fingerprint will he required when
requesting a Production license for Content
Description:
Ucense ~lanagemeJlt Server. The system fingerprint will be used to
uniquely describe a content server deployment
System Fingerpriltt
System Fingerprint: 765B4DBA
Utense Report

Invalid System Fingerprint In the unlikely event that changes in your database causes your
System Fingerprint to become invalid, your license status will
appear as Invalid Fingerprint on your Content Server License
Overview.
Having an invalid System Fingerprint has no effect on your

deployment. Your users can continue to access and use Content
Server normally. The system does not enter Administrative Mode.
However, if you see that your license status is Invalid Fingerprint,
OpenText recommends that you contact Technical Support for
assistance.
11. Click the License Report tab on the left under Options.
license Report The License Report page displays detailed information on your
Content Server license, including your End User Code, System
Unique Identifier (SUID) and System Fingerprint.
If the Content Server is not Licensed, it will display a message

informing the user to apply a valid Content Server license, as
illustrated below.
Figure C-6: License Report for Unlicensed System
Manage Ucenses
ORTlONS license Report

Omtent Server Is not ticensed.
Please 8Rl!Il a valid Content Server ifcense.
Uc:ense Management
System Fingerplint

When the Content Server system has been licensed, it will report
the same information previous discussed in the License Overview
section.
Figure C-7: License Reportfor a licensed System
Manage Ucenses
Ucense Report
Oesaiption: To produce thl~ report please select lhe "Generate Report" button below, The content of the
generated lIcense "'vort is shown below.
COntent seNer license Information
System fingerprint Ueense Status:
Product Name: OpenText content server
LieMsed Version: 10,5,X
Product VerSion: 10.5.0
Urens. Type:
OJmp,my Name: OpenText Learning Sefllle•• TrainIng Use Only
Explralion Date: No Expiration
Active Users: J
End Usar Code: EU0025397
System Unique Idantifier{SUID): 48382-38294
System Rngerprint: 765B4DBA
Module licensees) Overview

WebReports Unlicensed
12. To generate an XML copy of this report, click the Generate Report
button. You will then be prompted to save the resulting
LicenseReport . xml file to disk
Although license information is contained within Content Server

Thread logs (as illustrated in the subsequent figure) and with a
System Report, it is convenient for administrators to generate the
LicenseReport.xml file, without the report containing unwanted or
sensitive system or log information.

License Information
Status: Valid
Product Name: openText Content Server
Product Version: 10.5.0
License Type: Non-production
Company Name: OpenText Learning Services Training Use Only
Expiration Date: No Expiration
Licensed Users: soo
Active Users: 120
FigureC-8: SUlD: 48382-38294
End User Code: EU0025397
license Information in Thread Log Licensed Version: 10.5.x
Status: Unlicensed
Product Name: WebReports
Product Version: 10.5.0
License Type: N/A
Company Name: N/A
Expiration Date: N/A
Licensed Users: N/A
Active Users: o
The XML file contains the same license information found on the UI
(with an additional report hash or file checksum value) as illustrated
below.
~",l.i<:"''''''''Rep<lre",
,.<feat\lre>
<l"rocluctNal'llI':>OpenText com;ent $e:r:ver</P:t;o<:h-lct!1tmte>
<Lieel\lIe$t-at US} Vl\Ud</ l,icelli\le5tatu:ll:>
<Llcen"",dVersion>10 •S , x<1 LlceneedVe/Z"'lon;>
<P>:'OclUOtVel:''il 10n>10, 5,0<1 Produ.cl'Ver" iou>
<LicomseTl'pe:>Non-Production Licen:le</LioenseTl'pe>
<Comp,myN<\l1\e:>OpenText Lear;nlng S'I:l:viqes 1);l;l.lnlug ti':lH~' Only-</Col\1l'onyName:>
<£xpir... t lonOat;e:>No £xptrM 10n<1 Expitat; 1Qn1late>
<Lieelll"'~dU:!ler">SOO</Lloen"edUller:!l>
Figure C-9: <Aot iv"U""".'I:> H 0<1 Act. hreD""rs>
<EndUs",n:od":>EtIOOZ5397-,jr:ndU",,r;Code>
<SUIJ»~S3a2-38Z 9~ <ISUrD>
LicenseReport File <Syso:emF1l'9""l,rlnt.>4D21l6197</SY!'ltemFinq"",-pr;oiM>
</feature>
l'<Fea"ure>
<ProduotN<'l.l:lW>liIliliReport,,<!Pcoducl;Neroe>
<Seat us> unli",,,,n:.-ed<1 Sta.t.U(l>
-(/Feat;\lt:e>
",-<p"poct-Il(Ulh>
O$EuPcilllWay2Zt-TP9RjXG611115RZolllqr76ilt-6V7J)zq17Q/rqdRcSSliyOivGjDOlmY'llg'<::,SZtZliIk1JHehdJtDzu-'"
</R"'FQrur"",h>
</Licel'lseRellQl:t>
Administrators will find it useful to have the available license

information in a separate file that can be used to document system
usage (e.g., active users, user counts etc.). Also, if customers have
multiple production, non-production or temporary Content Server
systems, copies of LicenseReport files can also be used to assist in
documenting which licenses have been applied or referenced
during audits.
Administrators will find the report created using Generate

License on the Manage License page does not commit the
use of thread or similar resources as occurs with the other
reporting or logging options.

Appendix C. Content Server and Web Report Licensing
WebReport Module Licensing and Functionality

The WebReport module must be licensed in order for users to
create, edit or run/execute WebReports.
Module Not Licensed by By default, the WebReport module is not licensed in Content
Default Server 10.5, as illustrated in the figure below from the Manage
Licenses Administration page.
Figure C-10: WebReports Module Not licensed by Default
'}" Manage Licenses
Content Server License Overview

l.ic<!nse Overview Status;
Ucens.e f-tlfl.i!lgen\!nt
pmduct Name; OpenHxt Content Serv~r
Ucensed Version: HI.S.x

Syst"", Fingerprint
UtemeType; Non-Production Ucense
company Name: OpenTei<t Learning Services Training USe only
Expiration Date: No Expiration
Activ~ Us~rs; 120
Module liceme(s) Overview

WellReports Unljcen5~d
Users, like report writers, will not have WebReports

available on the Add Item menu until the module has been
licensed and the Content Server service has been restarted.
XML Import of WebReports The WebReport module must also be licensed in order for users to
XML import WebReport nodes or objects. Since XML import
creates new nodes, the behavior is the same as users experience
with the GU I interface.
Exception With Packaged There is an exception to the generaI rule of not being able to run
Applications like Records WebReports in an unlicensed system.
Management

OpenText packaged applications - such as the Records

Management (RM) WebReports or Physical Objects (PO)
WebReports, run using a separate application license and does not
require a WebReports module license.
The Applications Management page displays the License Status for

the reports, as illustrated in the figure below.
Figure C-11: RM and PO WebReport Application Management
OpRNTF,XT I Con~e:m Sflor'Jer
Applle<otlollS M.nagemoot
The 3-0124 - Content Server System Administration

course discusses Content Server Applications (Le., CSapps).
Some Applications like Other packaged applications, for example the OpenText Report
Report Pack Need Module Pack for WebReports, is also packaged using CSapps, but it requires
Licensed the WebReport module to be licensed. CSapps is a packaging layer
that sits on top of the standard Content Server XML import.
The Report Pack for WebReports is an application solution

built using WebReport technology and provides immediate
insight into many aspects of Content Server information by
providing tools that allow users to quickly view, understand
and action change of Content Server objects, activity,
permissions and more. For more information regarding the
Report Pack or the Content Intell igence bundle, visit the
Knowledge Center (i.e.,
https:ljknowledge.opentext.com/knowledge/llisapi.dli/ope
n/51747184).

Step Set C-2: Applying a Content Server License

1. We are continuing from the previous Step Set C-1, where steps 1
through 7 have already been performed.
2. Click the License Overview tab.
The License Overview information will be displayed, showing the

status is Unlicensed.
~, Manage Licenses
oi>nOlls Content senter license Overview

St~tU5: Unlicensed
Figure C-12: Product N.m&: 0P2nText Content server
Unlicensed Content Server System Product Version: 10.5.0

Sy:rtiml Fingerprint
license Type; N}A
Comp.ny N.me: NjA
Expjraijon Dale: N}A
Adlve Userli: 2
3. Click the License Management tab on the left under Options.
This Step Set assumes that a suitable Content Server

License has already been secured from OpenText and that
it is available on the file system.
Figure C-13: License Management
~~ Manage Licenses
license Management
Description: Ple~se 5elect ~ license file to be a pplled to Content Server. A kense file (~n be
acquired by visiting the OpenText product activation website for Content Server.
Product Activation: btto:llprorlu<tactN!l!l!>n.o"""t",,t,corniCuntentServer
SystemPlngerprinl Ucense Loca tion:
licen,. Report

4. Click the Browse button opposite the License Location field.

5. Select the Content Server license file and click the Open button (e.g.,
c: \ INSTALL CS 10.5 -
Release\Licenses\contentserver.li~.
Figure C-14: Selecting license File on Disk
'&' Manage Licenses

OPllQfiS Ucense Management
DeSCllptkm: Please fitlea a flcense file to be appli<!<J to Content Server. A flcense file can be acqujred bV
visiting the OpenTe.t product activation website for O'mrent SelVer.
Product Actlvation: bttR~JfQr04w;tadiyati9n,Gpt1ltM·mmlC6ntMt5frMr
sU INSTALL CS 10.S" Rote.,.

IE '# _CS 10.51'Ol' 00".00 Guido•
.,ll AmolJfjcement,
tfJ.16 Cllent.oO M51InoWi<f. lIe fie
1: Com"", Moou., (Ee, E:<P!"'ot)
1E.10 Dovol."", (I!<~p,., CSIdo)
M FQrm$~ WebFol'fIlS
rn Ji l.ng""QO Pod" (Core)
It! J; Olher Ollt",," Modules

I!J 1j PATCHD
.J,i RepaIrs (L~, WR, AV)
RMRolatedM_ I
Uti App,.
......".vc"'E;i:
The page refreshes and a New License File Details section appears
with information from the license fi Ie that you just opened and are
going to apply.

Figure C-1S: Contents of the License File Displayed
Manage Licenses
New l..«:ense File Details
Description: The license me has been validated and is ready tQ be app!led to Content ServH. Existing !lconse
v.!""s will be overwritten by new values as outRned below. Pleaso review these (hanges before
applying the new lkense file.
New Value Existing Value

licensed Version: lO.5,x fi/A
license Type: Non·production license N/A
LiconsOO \.Ims: 500 N/A
Expiration D~t.: No Expiration N/A
Company N~me: OpenText LearnIng SelVlteS Train;ng Use NfA

Only
sum: 48382'38294 NfA
NfA
6. Click the Apply License File button to apply the License File to the
Content Server installation.
When the license file is successfully applied, the Manage Licenses

page appears, and Valid appears in the Status field of the Content
Server License Overview.
Figure C-16: License File Applied
Manage Licenses
COntent Server license Overview

Status:
Product N~me: OpenTexl Content Sorver
Lkeo""d Version: 1O.5.x
SyStem F1ftgt~Jprin~
Ucense Type: Non'Production license
U<:ense Repolt
Company Name: OpenText learning Sorvlee. Training Use Only
Expirlition Date: No expiration
ActiVe Users:
Module Ucense{s} OvetVlew

WebRep<lrts Vnlice",,~d

The WebReports Module appears on the page as

Unlicensed.
No Content Server Service restart is required when a License is
A applied to Content Server. However, a Content Server service

restart is required when a modular License File is applied.
7. Click the Admin Home link to return to the Administration page.
Step Set C-3: Auditing of Licenses Application

1. Continue from the previous Step Set C-2 while logged in with an
administrative account using the CS10Sb instance.
2. Navigate to Admin pages> System Administration and click the
Administer Event Auditing link.
~ Administer Event Auditing
This page aUows you to administer the auditing of events in this COntent Server database. You can set up
auditing Interests, qU1!lY the informlllion In the audit J09, or selectively purge Information from the audit
log.
set Auditing lnleresls
DefIne which lWents you want to audit for which iterns in the COnl.ent Server database.
Figure C-17: Query Audit log

Query the ilUdlt log to ViIiNY information by Item type,. event type, USEr, and date range.
Administer Event Auditing
Purge Audit loo
Purge imonmilion from the audit log, based on event type, user, and date range.
M!lnsge Audit Re~9rds Cmltlld in PriOf" R,ll,,!!,"

The Content SelVl!( auditing system was changed after verslon 9.2. The Content Set'I'er auditing
system now stores more information in a IIIiNY format. Event records created in poor releases can be
managed here.
Audit S@!lcttv Settinglli

Allows the 'Adm]n' user to alter the SEl:urity settingS for auditing maintenance tasks.
3. Click the SetAuditing Interests link.

The Set Auditing Interests page is displayed.
Set AuditIng Interests

Figure C-18:
Apply License Audit Event DtialptfOD:; jlhis pa.ge allO'Wli Villi to ipedfy UJ¢ ecrent typl:$ that y.J~ w~nt to iludit for All itan i'yptS in this Conbmt SeNef d~tabase.
i EYe1lw·
i0 AddBl to BOl:: 0 Added to Vii'Hilt!C1US& 0 ApplY lit~l\t.t!
4. Enable the Apply License event.
~~ set Auditing Interests

Figure C-19:
Apply License Audit Event Enabled : D~-n~: Thls page allows you to spectfy tile eVMt~e:s thatyuu want to audJt:fof AU item types In tills Content Server-database.
o Added t. Worehou,.
5. Click the Set Interests button at the bottom of the page.

6. Click the Admin Home /in k at the bottom of the page to return to the
Administration page.
When one or more licenses are applied to Content Server or

applicable modules, the event wi II be logged to the DAudi tNew
table.
~ Apply License has an audit event 10 of 355.

~
Subsequent querying or reporting against the DAudi tNew table

would reveal which license files were applied to the system, when
(i.e., date/time) they were applied and by whom. An example of
OAuditNew table information is illustrated in the figure below.
Figure C-20: auditid ~ audiwate ~ performerld ~ valuekey value 1
Apply license Auditable Event

~ __ I.~0l14 :::17:14 ~l:.?~~_.J~.ontet:!7~~:~. 1~.~~~~lnge~~=·.;o~6i97.~~tiv..:"~<l..::.:.
3:.5. _ [1/28/201411:07121 ~1~00?_ l~~ep~ts ._J~<!,?,~r<lduc~a.,:,e·"''WebR:,:"rls·:st;,,~S~~:•.
The exercise at the end of this chapter will have you license
the WebReports module, using the provided license file.

Upgrading From Previous licensed WebReport Version
Previous versions of WebReports (e.g., 9.7.1,10.0 etc.) used their

own modular licensing methodology, as illustrated below:
Licensing Status: ** NO VALID LICENSE KEy;lq;

To initiate a free, fullY functional 30 day tria!
without a license key dickhere: 5TART TRIAL
Uvellnk WehReportsliren.e Key

Figure C-21:
plell,eentertheU[ense Keyexllttly as sUP>lied.
Some Optional Modules Manage
Their Own Key I..,~~~~~~~~~~:., ,.-!Livelinl< WebReports Standard
Il::on,wil"iNi~JJi~=:ll?p~!,!~xt.:.c:u;t_oErle~.s_uPP?'t
As previously mentioned, customers can obtain a [WebReport

module] license file, via the License Management tab and by
clicking the provided Product Activation link (i.e.,
http://produetactivation.opentext.com/ContentServer) and
following the provided on-screen user instructions.
WebReports Licensing - The WebReports self-certify feature allows customers to track

Self-Certify their use of WebReports themselves from the Administration
Pages> WebReports Licensing link.
Step Set C-4: Using WebReport Licensing -Self Certify

2. Navigate to the Administration pages and from the WebReports
Administration section, click the WebReports Licensing link. Enter
an Administration password of opentext if prompted.

The WebReport Licensing page is displayed.
The WebReport module must already be licensed,

otherwise the Licensing Status will display a value of '** NO
VALID LICENSE KEY **' and there will not be a SELF-
CERTIFY link as illustrated below.
Figure C-22: WebReport Self-Certify Licensing
ilcr WebReports Licensing

For information about purchasing licenses or obtaining an evaluation license visit www.ooentext.com.
licensing Status:
OK
You may eled to track license usage independently without help from WebReports.
To do this dick: SElF-eERTIFY
Content server Ucense Overview Ucense Management

_. - ~----"---'-~'~'----~~"------
Content server WebReports license Key
500
'.'
.. '.
'. , ;
' ... . ...
The provided Content Server Licensing Overview and License

Management links redirects users to the corresponding [Manage
Licenses] pages.
3. Click the Self-Certify link.
The WebReports Licensing - Self-Certify page is displayed.
4. Enter 25 into the Certified Number of Users field and select the Self
Certify On.

Figure C-23: Self-Certify 25 Users
WebReports Licensing - Self Q!rtffy
lise thl; page to to!rtify yClUr <lfganlzali<ll1's number oFWebReparls """'" if you do not want WebReporls to ••slstyou in lroddng usage. This "UIllIre< wililil"" be ••ed as
an altomallve to the WebRepo!t module's own Ifacking me<hanlsrro.
By chedci<lg the "Self Certify" ODlC and did<lng the "Sa•• Changes" botton below you ore agreeing to th. followfog t...... and condition.,
{w..... nt that my organrza~on has ImplemeAlted an auditable tracking proc:ess that complies with tile tenns ofthe end User lkense AgreeAllent (EUiA) governing the
WebRepClfts liun=. I agree that notwithstanding any pmwlon in the EULA it independenlfy and accurately traw the named W<'lhReports usersth.t have been assigned
Content Serur WebReports user licenses. I understand tIl.t Content SelVar u.ers reqUire a WeoReporls liCfllilll For any and all ""eo oFWabReports whats_er. Thl,
indudes but is not limited to: \/lewIng, reading, downloading, e>:polting and editing WebReports; 0' a"...lIlg report:5, do<uments and files that are ge<lOla!ed by
WebReports; Of accessing applKotions that use WebReport:5. r w.rrant that my organiullon's lracklng process will accurately monitor tIlese and all type. of use and will
ensure that named u.er license. are as.lgned In every case. If self certification Is later turned off, I agree t~ relaln the auditable retOfds of users covering the period when
self certmcaijon was In force fur as long as the EULA requires or at least five years if the EULA doe. not <pe<ify .. period.
I warrant that I h~ve th.. autlro1ity to accejlt these tenn. and condlti<lns on behalf of my (lfQaniution and aocepI that by dlecklng th.. ·Sl!1f CertifY" checkbox and didQng
·Save Chang.." below I am agreeing 10 them.
• Enler the number of n:amed ",ers that ha.e been a~gned WebReport!; licenses
• Check tile Self CWlfy Cileckbox
• COck Save Changes
5. Click the Save Changes button at the bottom of the screen.
Summary
• Described the Licensing features of Content Server 10.5.x

including Managing Licenses
• Installed a Content Server system License File and WebReport

module License File

Exercises
Overview
In this exercise, you will apply aWebReport module License File.
Apply a WebReport Module license File
1. Stop any CS10Sb services, if they are running and confirm all of the CS105 services are
running.
Supports System Event Notiflta~ .

Manages the configuration end tr ..
Maintains an upd.ted IJst of comp ..
Content Server Manual L<xal system

Content 5etver Admin server Started Manual local Systel1'l
II 'S\~Conterlt s<:rver Admin (CS lOSb) Content Server Admin 5etver Marrual Local Sy<tel1'l
II \g!!Conterlt Sf~ver Cluster Agent (C5100) Content Server Cluster Agent Started ManUill Local System
II 'tJi~Cor~ent Server Cluster Agent (CSI0Sb) Content Server Cluster Agent Manual local System
Provides secure ~orage and retrl.,. Marrual Local System
2. Select Start> Programs> OpenText Content Server 10.5 (CSlOS) > Content Server
Administration.
3. Enter an Administrator Password of opentext
4. From the Server Configuration tab, click the Manage Licenses link.
5. Log in to Content Server using Admin and a password of cs! and click the Log-in button.
6. On the License Overview tab, confirm that WebReports is unlicensed.
)t' ManageLicen~
OPnONS , Content Server license ov.,rvi.,w

U~ove:rvtew
Status; Valid
Product Nam.: OpenText Content Server
lir:ensed Version: 10.5.x
License Type,
cnmpany Name: OpenTe><t Learning Services Training Use Only

Explratlon Dare: NO Expiration
Active UseIs~ 120
Module Urense{s) Overview

WebReports UnlicenSed

Appendix C. Content Server and Web Report Licensing
7. Select the License Management tab.

8. Click the Browse button opposite the License Location field.
Manage Ucenses
License Management
Description: P1~ase selecl a llcense fila to be app~ed to Cont*nl Server, Alicense file em be
acqlJfre<! by \'l~itlng Ule OpenT.xt product activation website 1m Content SeNer.
product Attivatian:
Ucense LQcatlon:
9. Select the Content Server license file -- C:\INSTALL CS 10.5-

Release\Licenses\webreports.lic -- and click the Open button; the page will refresh and
display the newvaJues from the license file.
~ Manage Ucenses
New License File [letllils

status: VolJd
DllSCrlpllon: The ""lOse file has been validated and Is ready to be applied tQ
Conlent Server. Existing license value. will be overwritten by new
valu•• as QullJned below. P1e••e re\'l1!W lhes. manges before
5ysrem fingerprint
applying the new license file.
w,,~<>rts:
'.-._ .. _-_._.- -- ----_... -'. New Value Existing Value
Uamsed Version: m~ ~
ucense Type: Non·Produttion Ucense N/A
Ucensed U~rs\ ~O ~
Expiration Date: No EiXpifiltlon N/A

Company Name: OpenTe'1 Leamlng SSMces Trainlng Use N/A
Only
SUrD: 4IDS2-3a2.94 N/A
End User CJlde' EUODl5397 filA
10. Click the Apply License File button.
Page C-22 Content Server WebRe port Design I

The page will update and show the WebReport license status as Valid.
Manage Ucenses
U<:~Ovet'd~w
status:
Product Name; OpMT!!Xt Conbmt Sflt\ler
UceMod Version: 10.5.x

U(ens& Type: Non'PtQdud:i~n lfc:en'Ge
Company N"ffie: OpenTroct LearnIng Se:lV1ces Tralnln9 Use Only
Expi~tioo Oat'l: N{) f:<pirati'I'JA

A(tlve USf.:!rs: 110
Modul" LiGense(s] Overview

WebReJ>'lrt5 show D.LlII, 'I'
11. Click the Show Details link to display additional modular licensing information.
Manage Ucenses
Content Sf'Nt:>X liCf'nse Overview

gt:rtu~: l1:-tlirl
Product Nam",; OpenTerl C{Jnt~nt S~rvcr
UC[!.flsed Verslon~ 10.5.x

licetl-S"E'" Typ~~ f-h,>n'flJouuctilJn LICenSE!
Companv Name: OpenT!!"xt Leamtllg Se:rvlre:2 Trafrlil1g Use Onty

Explro1tJPIi Date~ No 8qllratlon
Actiye USef$~ 120
~fu<lule lkellSe{s} Overview

WebRe:pjj.tU
Lk-ensed Vers!o.o:
Prodl..ldVer!jjnn~
l(cense.a US-o!lrs~
A<t1ve U~ers::
Explr.atlon D<lte; No Expiration
12. Restart the CS10S Server service (this makes WebReports available on the Add Item menu
etc.).
Content Server Mam.1 Lo,.1 System

II ",~,Q)nU",t Serve, AdrIJln «5105) Content SeMll' p,drnin Server stalted Manual Lo,.1 System
II ~1b(:onl:ent Server Admin «SlOSh) Content 5eM!r Admin server ~lanoal Loca! System
II !£~,C''''tent S;erv,~( clust'" A'gent (C5105) Contant S..ver cluster Agent Started Manual Local Sy<tem
1Il$)\(oI1terit Server 'Gusl"" ~Igent (CS105b) Content Server Cluster A(lOt1t Manu.1 La<:aISystem
Provides se.;Uffl storage aM rc\ri". Mamal LoralSystem
13. CI ick the Admin Home link to return to the Admi nistration pages home.
Content Server WebRe port Design I Page C-23


Appendix C. Introduction to the WebReport Pack
D. Introduction to the WebReport Pack
Objectives
• Describe the WebReport Pack's available reports

• Run a number of the reports, like the Category Manager and Storage Usage by File Type
Overview
This appendix provides an introduction or overview of the Report
Pack for WebReports.
The OpenText Report Pack forWebReports product is

referred to as the WebReport Pack or Report Pack within
this appendix for the sake of brevity.
Content Server WebReport Design i Page D-1

Appendix D. Introduction to the WebReport Pack
WebReport Pack Overview
The Report Pack for WebReports is a complete solution built using

WebReports technology that provides immediate insight into many
aspects of Content Server information and provides tools to work
the information displayed to allow users to quickly view,
understand, and action change of Content Server objects, activity,
permissions and more.
The Report Pack was created with OpenText customers and power
users in mind and how they are using WebReports in their
organizations to collect and summarize large amounts of
information, build bespoke tools and applications to make working
with content easier. The Report Pack also provides a complete
solution for the common requirements of administrators, business
users, managers and developers alike.
Pre-Configured Charts The Report Pack for WebReports delivers pre-configured charts,
dashboards and tools to manage information and content and
includes the following:
• Activity Report
• Anomalous Activity Chart
• Batch Update Wizard
• Category Manager
• Charting Wizard
• Deleted Items
• Duplicate Documents
• Forms Manager
• Item Permissions Manager
• Mass Delete Report
• Projects Overview
• Item Usage Charts
• User Permissions Manager
• User Privileges Identifier
• User Privileges Usage Chart
• Workflows Manager
Page D-2 Content Server WebReport Design I

Report Access via The individual reports, charts and managers in the Report Pack for
Dashboard WebReports are accessible through a single dashboard, to quickly
access each of the different tools.
Content Server Application Report Pack for WebReports is packaged using the Content Server
Packaging Tool Applications Management packaging tool in Content Server for
quick and easy installation.
The CS Apps functional ity is discussed in the 3-0124 -

Content Server System Administration course.
Figure D-1: Content Server Applications Managementwith WebReport Pack Installed
OPENTEx"r I COntent5ervef
>
'~ Applications Management
content Servc.r ApP~I(atkms· elK\{ to Qulld p new aopUwfion

Appendix D. I ntroduction to the WebReport Pack
Running Reports via the The easiest way to access these reports is to run the Report Pack
Launcher Launcher [report] located Content Server Applications [volume]
and Report Pack for WebReports folder.
This provides a launch menu containing a description and thumbnail

image for every report in the pack, as illustrated in the following
figure:
Step Set 0-1: Running a Report From the WebReport Pack

1. Log in using an account with system administration rights (e.g.,
sadmin,letmein).
2. Navigate to the Administration pages> Content Server Applications
Administration page and click the Open the Content Server
Applications Volume link.
3. Click the Report Pack for WebReports folder link.
The Content Server Application Volume's Report Pack for

WebReports folder is displayed including the Reports Pack
Launcher as a Featured Item, as illustrated in the figure below:
Figure D-2: Report Pack Launcher Link
Report Pack for WebReports v u
4. Click the Reports Pack Launcher link.

This provides a launch page, containing a description and a

thumbnail image for each Report in the Pack, as illustrated in the
following figure:
Figure D-3: WebReport Launcher
Report Pack For WebReports
Anomalous AdM!\' (bait

OOf.q»tfI:!:\U.fUf:;(~fW.g~\,<bc;~!'fflUlrr.=;iA~Wn~l'Ifif'I'bs"of
~ifIYlhe1t~~wd;lr;a~~r~
YOOCMIsp«ify\:toe~mat~~l!'ltJ.Ilr.umberofew:rJs:iJ-fOO1\!IIOI'etlUNik0.
cate<JOIY Manager
1liJ:MPOrto!Nble;the;~Md~IWrt5:!NIth!'o'!!!I~~.
AttribI.1eI'i!l!)Kanlb:lbe~Cf~ll'i6Jy~Wi.
ruswrarol~'iQJ.tf~lif=pt.l<Ald>.r.s!lun)"\iU"&m:wd;~aU.~.
Thei:Nrt.1auW:1i1R:~i':~il<!d~llbe~«"~tU:tf.qlifedrfur~
tob.;l~w~~~
---
Dele!edlrems
- \
<,"-~' ~ ~--~ -
111s~~~fie$·~Ifl.;ot~~be.:ndeleted~~~tQbe~tp
:::::.: i
---_._._~
... _~ "·_<_·y._d
Duplkale Doc1JJllenls
1ksnpm!tJcp.;!i~ts.INtOJJt.jfl~~~~~~
T1-i.${o$II1-~ob'~1oons~~il.tmtbe~~~~....m~u-~~to~
ilrd~fflrt,.<Jdd.O(reID(t..e~
Item f\;rm'tssWl'ls Manager

lli.:I~~~~~tI>leYIM~<:dit\lSetpem~~yt:&.iklllr,ytt~...utm
""""....
~ltd.~re~ainbe~.H·>'Y.!tm:l{,(ll'f~~.
Content Server WebReport Design I Page D-5

5. As an example, scroll down the page and click the Category

Manager button.
The Category Manager Report page is displayed and prompts you

to run the report against a selected Category. The report in this
example accepts user input.
Figure D-4: Specify the Content Server Category the Report is Going to Run Against
WebReport Parameters: category Manager
6. Click the Browse button and navigate from Content Server>

Content Server Categories (Volume) > Customer Service Categories
(folder) and click the Select link opposite the CustomerFeedback
Category.
7. Click the Run Report button.
Figure D-5: Category Manager Report Pack Results for the CustomerFeedback Category
~ Category Manager
lli1It
......... __ +1 -! _ .
':
6 3 '2
flo. of amn, \'lith ~ttdbl1to
---:--.....
TYP.H:l - ..... ~---~":"---,---
Q.;l,~II:fNlln"lft ~ . -
Typ<of
-"""
1F;~\_~f by r~o:ln~l}
Ulfll;!WlQl!
"""'"''' """"- """""""

@~- (<'.... ~pl~jjlt~ ;f'j'"
-
"
j i @ ?,E!'tioh.wp~dg.; .f 5t.:i!eVlSitor i'd:1ce.Wnd ""Ier Dtwiphoi'ldll, .. l:o:.(fIpl.:;'nt-f'l'
....."'"
S @] J:, Malbgoo ptw,d;r; w«>=~." r~~lilttxt E;>rd·r'I1:~MY... ~.)':'rl1~ol<,:mt - Fr."
:
l E'''''''
ijjJ,,,,,",_I\ss"' ('tVrt,:::l?j.nt~ >'(,.
a.J CQmWWtlJl rwmMlQD v "".""to< ""100_··· _D4' w,jol}.h bdl._, (Clm:;-birn:- 5,.. .....It<h
) tJ W5t9m«F~ F9ldw -,
, 7
ID CWtomI!! f!@bildi for fl!00ud X.rmf C.;:~... ;;i:ctntT 1)"".
fID Fmr.bp9t 9Qpmar COOI!!lJ:'m? i'il.\TtlMlry.dq; W.. "''''''''... E1.!nO.':a7%on fhrml'l ~1l a~:fum'!"fit U;fJ~lnt·Pr" Enol~
I:
!10
EJi~
L:J~'
~~itar .6'M'tT~t;el'l1t
"' ... Sb"Q-:~:)('J
Pilgelof1(131ona)
•
8. Click the Back link in the upper left corner to return to the previous
page.
9. Scro/l down towards the bottom of the Launcher page and click the
By File-Type button in the /tem Usage Charts section.
This represents another example of a Report, which tabulates and

reports the system usage by file type. This report, unlike the
previous one, does not accept any user inputs. An example of the
report output is illustrated in the figure below:
Figure D-6: Example of Storage Usage Report Results, for File-Type
~ Storage Usage Chart (by file-type)
<'II> fO
Typo Item sublype (ftle-type) Ntlmb", A _ sll:. 1'<>101 U"'ll"

@ DocuwmUdoc) 317 24.0 KB 706MB
I!B Dowmw\ (w.v) 2.0 Me 6.0MB
'~ CJ$fn View Templam t"rnn 9 370.6Kll 3.3MB
@ {)Qg:Jf!t§ntljog) 93 20.9 K3 L9MB
@ Docum;;ot (glf) U7 15.t KB t.6 r~6
iW Ct$m View (htMll 293 4AKB t.3 M6
~ Qrn;mwt!!l!IfI u 56.3 Kll 619.8 K6
® QQ<:lIm~nt ('lIs) 30 19.4 Kll 58U K6
l;'1l o""""'ntiZlPl 36MK!I 353.9 K6
oo~ 10 n.7KB 337.4 KB
I@ Oowmw (vsdl 1&!.4Kll 104.4 KB
@ Oocum-t\t (pot) 6 21.2K3 127.0KB
IKt1 Document (uno) 4 25.0 KB 100.0 KB
8J Dccumen\ (M) 1M 795.9 B 8M K8

.;§) Docum.n! loon) 3 6.2 K6 49.2 K5
i!1O Docum,nHdotl 2 nSK8 47.61\6
iili Cocum;:nt(gr/) 9 4.3KB 39.0Ke

~B tlixu",ent(l;mlll 33.5KB 33.S KB
00 tlixum.nt (d"",) 14.3 K8 2S,7KB
[@ Dgqiment {so!) 10 231<8 22.7 KB
Content Server WebRe port Design I Page D-7

Page D-8 Content Server WebRe port Design I

Appendix E. Default Reportviews
E. Default Reportviews
Objectives
On completion of this appendix, participants should be able to:
• Describe the available default Reportviews with WebReports
Overview
When adding a new WebReport 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 Reportviews
may be useful immediateiy but in other cases it will be necessary to
edit them to meet specific requirements.
Once a WebReport has been created using a default Reportview,

the user can either edit the Reportview online, or download the
Reportview for 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.
The following table lists default Reportviews with Content Server

10.5 SP1.
Content Server WebReport Design I Page E-l

,,~ ..v • • y.~ •• ,,,,, ...
.
~
_
basic]eport This is a no frills report and in terms of speed, it
should be the fastest because it contains less
HTML and fewer sub-tags. If you want a very
simple preformatted report to open in MS Excel,
remove the function menu and other graphics then
set the mime type to application/vnd.ms.excel.
basic_scripted As above but utilizing Oscript in the Reportview.

Useful as a starting point for reports using server
side scripting.
biankJeport This is simply a blank Reportview that the

developer can use for creating something from
scratch.
browse_flexible_csl0 This view is designed to mimic the standard

Content Server 10 folder browse functionality.
browse_f1exible_cslO_wi This view mimics the standard Content Server 10

th_sidebar folder browse functionality, with added sidebar
Table E-l: functionality.
Default Reportviews
browse_flexible_csl0_wi This view mimics the standard Content Server 10
th_sidebar_ajaxJequest folder browse functionality, with added sidebar
s functionality, It uses ajax requests for each
pagination/filter/sort action similar to a core
Folder browser view.
browse_flexible_csl0S- This view mimics the standard Content Server

with_sidebar_ajaxJeque 10.5 folder browse functionality, with added
sts sidebar functionality. It uses ajax requests for each
pagination/filter/sort action similar to a core
Folder browser view. For supported clients, it also
includes Drag and Drop without WebDAV.
browse_flexible_971 This view mimics the Livelink 9.7.1 folder browse

functionality
browse_97 This view mimics the Livelink 9.7.0 folder browse

functionality. In addition to Copy, Move and
Delete operations, it also allows the user to
perform multi-file output operations such as Zip
and Download, Zip and Email, and Print on data
from different locations as though it were located
within the same folder.
Page E-2 Content Server WebReport Design I

C5VJeport This Reportviewwiil output your data in a CSV

format. Double quotes are used as the escape
sequence.
c5v_scripted As above but utilizing Oscript in the Reportviewto

handle any number of columns.
formJeport This Reportview provides a replacement to the

Web Forms List Data functionality. The
Reportview also provides appropriately
permissioned links forthe editing and deletion of
form data.
form_scripted This is an advanced Reportview that contains

server side scripting. It wiil need to be enabled by
your administrator. The Reportview provides the
user with dynamic columns and filters meaning
that it can be applied to a form data source with
any number offields.
plainhtmlJeport A no frills HTML Reportview giVing results in a

tabulated format that can be readily interpreted
by WebRe ports if the output were to be used as a
data source.
spreadsheetmlJ€port This Reportview is a basic example of

SpreadsheetML with little formatting. It places
report data into a simpietable. The resulting file is
a complete and portable document that by default
opens in MS Excel. Note that for Excel to open by
default, the destination mime type must be setto
textlxml or application/vnd.ms-excel.
wordmlJeport Ailows WebReports to view Content Server data

in a preformatted Word document usingWordML.
This format is only supported by newer versions of
Microsoft Office. Note that the destination mime
type must be set to application/msword or
textlxml for Word to open.
xmlJeport A very simple XML report that might be used in an

Ajax type situation to pull back additional data to
an application. It is important to remember to set
the destination mime type totextlxml in this
situation.
browse_97_drag&droPJ Similar to the browse views in the

eport defaultReportviews folder but contains optional
drag and drop functionality by providing a tab at
the top of the report; this is meant to be used with
one of the draganddrop_view_webdav105_cs105
Reportviews.
Content Server WebRe port Design I Page E-3

draganddrop_view_web This creates a page similar to the drag and drop

dav10s_cs10s page provided by WebDAV, for use on Content
Server instances running WebDAV 10.5.0. It is
designed to be called from a WebReport similar to
the browse_f1exible_cs10 Reportview, which
provides a way to access drag and drop from a
WebReport.
browse_9s_96 This view mimics the Livelink 9.5 and 9.6 folder
browse functionality. It allows the user to perform
Copy, Move and Delete operations on data from
different locations as though it were located
within the same folder.
browse_s.0.1 Similar to the browse views in the

defaultReportviews folder but makes use of the
new SORT enhancements available in WebReports
5.0.1.
browsejssort Similar to the browse views in the

defaultReportviews folder but sorting with
Javascript rather than additional requests.
wordml_adv This Reportview is an example ofWordML with

formatting and images. It contains a cover page,
followed by a table containing the report data. The
resulting file is a complete and portable document
that by default opens in Microsoft Word. The
possibilities for formatting are extensive, and this
serves as an example of some features. Note that
you must set the destination mime type to
application/msword or text/xml to have the report
open in word.
spreadsheetml_adv Advanced $preadsheetML example containing a

coversheet with company data and a separate
worksheet with the report data.
draganddrop_view_web This creates a page similar to the drag and drop

dav3sx page provided by WebDAV, for use on Content
Server instances runningWebDAV 3.s.x.lt is
designed to be called from a WebReport similar to
the browse_97_drag&droPJeport Reportview,
which provides a way to access drag and drop from
a WebReport.
Page E-4 Content Server WebReport Design I

11111111111111111111111111111111111111111111111 11111111111111111111111111111111111111111111111111111111111111111111
* 2 - 0 1 1 7 - 1 0 5 1 - 0 0 - S G - MAN *
(
SALES CORPORATE EUROPEAN

sales@opentext.com HEADQUARTERS HEADQUARTERS
275 Frank Tompa Drive Technopark 2
North America Sales
Waterloo, ON Werner-von-Siemens-Ring 20
1 800 499 6544
N2L OA1 Canada 0-85630 Grasbrunn, Germany
International Sales Phone: +15198887111 Phone: +49 89 4629 0
1 80049965440 Fax: +1 5198880677 Fax +49 89 4629 1199 (
QPENTEXT
www.opentext.com
2-D117-1051.oo·SG

Content Server WebReport Design I PDF

Încărcat de

Informații document

Titlu original

Drepturi de autor

Formate disponibile

Partajați acest document

Partajați sau inserați document

Opțiuni de partajare

Vi se pare util acest document?

Este necorespunzător acest conținut?

Drepturi de autor:

Formate disponibile

Content Server WebReport Design I PDF

Încărcat de

Drepturi de autor:

Formate disponibile

(

Content Server WebReport Design I

OpenText Content Server

Content ServerWebReport Design I v10.5.x - First Edition: September 2014

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

Based on OpenText Content Server v10.s SP1

Course Name: Content Server WebReport Design I

Page ii Content Server WebRe port Design I

Welcome to the Content Server WebReport Design I course.

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

Sample Docs folder location: _

Content Server WebRe port Design I Page iii

This workbook uses the following conventions:

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

Italic Italics are used for Workshops and Exercises.

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

<> Angle brackets « » represent an element of syntax you must

This icon represents a caution that supplies warning information.

Pageiv Content Server WebReport Design I

Content Server WebRe port Design I Page v

5. WebReport Links and Constants

6. WebReport User Prompts and Parameters

Page vi Content Server WebReport Design I

A. WebReport Help and Resources

Content Server WebRe port Design I Page vii

D. Introduction to the WebReport Pack

Page viii Content Server WebReport Design I

Student Attendance Form

Course Delivery Information

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

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

OpenText Partner: 0 Yes 0 No

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

Introducing WebReports What is the WebReports module?

WebReports is an OpenText Content Server module that ships with

It provides a powerful processing engine that allows Content

Content Server WebRe port Design I Page 1-1

The figure below illustrates an actual customer example using

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

A WebReport has three main elements:

Page 1-2 Content Server WebReport Design I

The diagram below illustrates how the WebReports architecture

Figure 1-2: WebReport Architecture and Components

Sub WebRe ports PDF Conversion

Content Server WebReport Design 1 Page 1-3

Content Server File Content Server (Document, Version)

Content Server Categories Desktop

External Applications Workflow

Search Query Launch Content Server Form

What use is a data source of "None"? Sometimes a

The exercise in Appendix C: Licensing WebReports will

Page 1-4 Content Server WebReport Design I

WebReport Administration A number ofthe WebReport Administration options will be

Flush Cache Clear the cache of compiled Reportviews.

Manage WebRe ports Scripting Enable or disable scripting of individual WebReports.

I Manage WebReports Services Enable/disable or restrict the WebReports services feature.

Manage WR Triggers Determine which node types can trigger WebReports.

Miscellaneous WebRe ports Configure miscellaneous WebReports settings.

Content Server WebReport Design I Page 1-5

The Outdoor Gear Training Environment

Outdoor Gear Here is a short overview of the company:

CS10S Installation The C:\CS10S installation of Content Server consists of CS 10.5 +

Page 1-6 Content Server WebReport Design I