Installation and Administration

Guide
Content Server WebReports Standard 10.0
For Content Server 10

December 2010
 Content Server WebReports 10.0 Installation and Administration

Contents
1 Overview ........................................................................................................................... 1
1.1 Purpose ......................................................................................................................... 1
1.2 Glossary of Terms ......................................................................................................... 1
2 Installation ........................................................................................................................ 2
2.1 Running the Installer in Windows.................................................................................. 2
2.2 Running the Installer in Solaris – GUI ........................................................................... 3
2.3 Running the Installer in Solaris – CLI............................................................................ 4
2.4 Unzip Installation Files ..................................................................................................5
2.5 Install the Module .......................................................................................................... 5
2.6 Downgrading to an Earlier Version ............................................................................... 5
2.7 Enter License Key ......................................................................................................... 6
2.8 Check for Updates ........................................................................................................ 7
3 License Key Functions ....................................................................................................8
3.1 License Usage Reports ................................................................................................. 8
3.2 Self Certification ............................................................................................................ 8
4 Administration Introduction............................................................................................ 9
5 WebReports Sub-Tag Builder .......................................................................................10
6 Manage Search Query Integration ............................................................................... 11
Technical Notes on Search Integration ..............................................................................12
7 Manage WebReports Conversion.................................................................................13
7.1 Introduction .................................................................................................................13
7.2 Steps to Configure Standard Conversion ...................................................................14
7.3 Adlib eXpress Job Ticket Conversion .........................................................................14
7.4 Steps to Configure Adlib eXpress Job Ticket Conversion...........................................15
7.5 Technical Notes on PDF Conversion ..........................................................................15
8 WebReports Scheduling ...............................................................................................17
8.1 Overview .....................................................................................................................17
8.2 Configuring Content Server for WebReports Scheduling ...........................................17
8.3 Managing Schedules...................................................................................................17
8.4 Database Schema.......................................................................................................18
9 Node Administration ......................................................................................................19
10 WebReports Database Administration and Downgrading to Earlier Versions
of WebReports................................................................................................................20
11 Manage WebReports Scripting .....................................................................................21
12 Restricting ‘Add New Item’ for WebReports ...............................................................22
13 Administering WebReport Events ................................................................................23
14 Storing WebReports in the Report Volume .................................................................24
15 Cached Views .................................................................................................................25
16 Default Reportviews ......................................................................................................26
17 WR Trigger Administration ...........................................................................................27
18 User/Group WR Trigger Administration.......................................................................28
19 Category as a Data Source ...........................................................................................29
20 Exporting to E-Mail ........................................................................................................30
21 Exporting and Importing WebReports .........................................................................31
21.1 Standard Export/Import ........................................................................................31

Page i
 Content Server WebReports 10.0 Installation and Administration

21.2 Special Import Features .......................................................................................31

21.3 Notes ....................................................................................................................32
22 Setting Permissions for WebReports Users ...............................................................33
23 Sample Reportviews ......................................................................................................34
24 Restricting WebReports Services ................................................................................35
25 WebReports Preferences in the opentext.ini File .......................................................36

Page ii
 Content Server WebReports 10.0 Installation and Administration

1 Overview

1.1 Purpose
This document provides information on the installation and administration of the WebReports
module from Open Text Corporation. It is primarily intended for Content Server system
administrators who will normally be responsible for controlling and managing WebReports for
all Content Server end users.

1.2 Glossary of Terms

With respect to this document, the following terms are defined as such:

End Users: This refers to Content Server consumers who would see the output of a
WebReport.

Developers: Any users who may be involved in creating new WebReports or editing existing
ones (to change the look, feel and behavior). For any particular WebReport, Developers fall
into two categories: Those who can edit or add a version to the reportview, and those who
can only fetch or download the reportview. The latter case is useful in terms of enabling
Developers to reuse an existing reportview in a new WebReport, without allowing them to
change the original.

Data source: Any Content Server object which is used to generate a data set for the
WebReport. This is most commonly a LiveReport (see below) but could also be a saved
search query, a form template or a form.

LiveReport: A Content Server item that enables users to obtain statistical information about
(and potentially modify) the Content Server database. The SQL statement in a LiveReport
communicates directly with the database. The Content Server Administrator may create new
LiveReports, and grant other users permission to run them. The LiveReports for which users
have permissions appear on the LiveReports tab on the Reports page of their Personal
Workspace.

Reportview: The term reportview is used throughout this document to refer to the document
which is stored for each WebReport object. These reportviews contain traditional Web code
(such as HTML) as well as custom tags which are used to determine where the data source
data fields will be inserted in the output Web page.

System Administrators: Besides the role of managing WebReport permissions and access
requirements, these users may also have access to the LiveReports (and or other data
sources) used to supply data to the WebReports. The various tasks and functions described
in this document are intended for this role.

Page 1
 Content Server WebReports 10.0 Installation and Administration

2 Installation

2.1 Running the Installer in Windows

To install on Windows:
• Download and run the WebReports-10.0.0-Setup.exe.
• Continue through the Welcome screen.
• Read the EULA and choose the appropriate radio button. If you agree and proceed
with the installation, a copy of the EULA is included in the installed files.

• Read the Third Party Terms and Conditions and, if you agree, click the checkbox and
proceed with the installation.

• Choose the Content Server instance where WebReports should be installed. To

browse for a staging folder manually, select the “Choose Directory” option and click the
Browse button. Please note a new folder named “WebReports_Documents” will be
created in the parent folder of the directory chosen in this step. This folder will contain
copies of the License Agreement and Release Notes.

Page 2
 Content Server WebReports 10.0 Installation and Administration

o The installer will check if the selected instance has any WebReports patches
applied. If so, it will ask if you would like to remove any patches that could
conflict with the included version of WebReports. Checking the “Remove old
patches for me.” checkbox will move the old patches to a new folder named
patch-oldxxxx-yyy, where xxxx-yyyy represents a date and time stamp.

• Review the installation parameters and click Next to perform the install.

• Once the installation is complete, click Finish to exit the installer. If you do not wish to
view the Release Notes, uncheck the check box.

• Proceed to the Content Server Admin pages to complete the module installation
process (See 2.5 – Install the Module).

2.2 Running the Installer in Solaris – GUI

The installation process for Solaris GUI is very similar to the Windows installation. The only
difference is that the installation location must be selected manually.

To install on Solaris using the GUI:

• Download and run the WebReports-10_0_0-Installer.bin.
• Continue through the Welcome screen.

Page 3
 Content Server WebReports 10.0 Installation and Administration

• Read the EULA and choose the appropriate radio button. If you agree and proceed
with the installation, a copy of the EULA is included in the installed files.
• Read the Third Party Terms and Conditions and, if you agree, click the checkbox and
proceed with the installation.
• Click the Browse button to browse for the Staging folder of a Content Server instance
in which to install the module. A new folder named “WebReports_Documents” will be
created in the parent folder of the directory chosen in this step. This folder will contain
copies of the License Agreement and Release Notes.

o The installer will check if the selected instance has any WebReports patches
applied. If so, it will ask if you would like to remove the patches which could
conflict with the included version of WebReports. Checking the “Remove old
patches for me.” checkbox will move the old patches to a new folder named
patch-oldxxxx-yyy, where xxxx-yyyy represents a date and time stamp.
• Review the installation parameters and click Next to perform the install.
• Once the installation is complete, click Finish to exit the installer. If you do not wish to
view the Release Notes, uncheck the check box.
• Proceed to the Content Server Admin pages to complete the module installation
process (See 2.5 – Install the Module).
• After the module is completely installed, give 755 permission to the following folders
and their contents:
o <ContentServerHomeDir>/support/webreports
o <ContentServerHomeDir>/support/help/_en_US/webreports
o <ContentServerHomeDir>/module/webreports_10_0_0

2.3 Running the Installer in Solaris – CLI

The Solaris version of the installer can also be run from the Command Line. This is a very
basic install which does not handle any patch removal, and should be run as the same user
that installed Content Server if possible.

To install on Solaris using the CLI version:

• Download the WebReports-10_0_0-Installer.bin.

• Ensure the installer has execute permissions. “chmod 775 WebReports-10_0_0-
Installer.bin” will give sufficient permissions in most cases.

Page 4
 Content Server WebReports 10.0 Installation and Administration

• Run the .bin using the –mode console switch. Eg: ./WebReports-10_0_0-
Installer.bin –mode console
• Enter “y” to start the installation process and display the EULA
• Press the space bar to read through the EULA and enter your response when
prompted.
• Press the space bar to read through the Third Party Terms and Conditions and enter
your response when prompted.
• Enter the location of the Content Server Staging folder in which you want to install the
module. (Using an absolute file path will ensure the files are installed to the correct
location, eg: /<ContentServerHomeDir>/staging)
• Once the files have been installed, proceed to the Content Server Admin pages to
install the WebReports module (See 2.5 – Install the Module).
• After the module is completely installed, give 755 permission to the following folders
and their contents:
o <ContentServerHomeDir>/support/webreports
o <ContentServerHomeDir>/support/help/_en_US/webreports
o <ContentServerHomeDir>/module/webreports_10_0_0

2.4 Unzip Installation Files

From the ZIP file you have been provided, extract the directory called webreports_10_x_x
into the Content Server staging directory located at <Content Server install
directory>/staging (the value of ‘x’ will depend on which minor version of the software
you have).

2.5 Install the Module

To install the module, take the following steps:
1. Open Content Server’s administration page in your Web browser and login as the
Content Server Administrator user. Do not attempt to install this (or any other module
containing database schema) unless logged in as the Content Server Administrator.
2. Under the Module Administration section, click the Install Modules link. The URL to
the administration page is listed below:

http://<domain name>/<Content Server service name>/livelink.exe?func=admin.index

3. Check the box beside Open Text WebReports Standard and click Install.
4. Restart the Content Server service when prompted and click Continue.

2.6 Downgrading to an Earlier Version

Should it be necessary to downgrade to a version of WebReports prior to WebReports 5.1.x,
please note that you must downgrade the module schema before uninstalling WebReports.
To do this use the WebReports Database Administration functions described in Section 10.

Page 5
 Content Server WebReports 10.0 Installation and Administration

2.7 Enter License Key

Please note that it is not necessary to enter a license key if WebReports is being installed
solely as part of an ActiveView installation and WebReports itself will not be used. (ActiveView
shares the same tag processing engine as WebReports).

From WebReports version 4.0.0 onwards it is necessary to install a license key or initiate an
automatic 30 day trial before being able to run or export a WebReport. To initiate a trial you
do not require a key but the length of the trial is fixed at 30 days. If you require a longer
evaluation period, please request an evaluation license key from Open Text.

Should the 30 day trial or an evaluation key expire, all WebReports and their settings will be
retained safely in Content Server, but you will not be able to run or export a WebReport until a
new key is entered.

To initiate a 30 day trial, simply click the “START TRIAL” link.

To enter the license key:

1. From Content Server’s administration page, select Administer WebReports License
Key.

2. Enter the license key details exactly as provided, including:

• Company Name
• Expiration Date (only applicable with evaluation licenses)
• Number of WebReport users. Note that this may not always be the same as
the number of general Content Server users.
• License Key
3. Click Save Changes and Content Server will respond, confirming that a valid key has
been provided.

Page 6
 Content Server WebReports 10.0 Installation and Administration

2.8 Check for Updates

After WebReports is installed or upgraded, please run a “Check for Updates” from the Edit
page. This gathers limited information about the WebReports installation – WebReports
version, subversion, any patches that are installed, and the Content Server version – and will
ask to submit this to Resonate KT’s website for real-time analysis.

To Check for Updates:

1. Create a new WebReport from the Add Item menu in Content Server.
2. Click on the WebReports function menu and select “Edit Reportview”.
3. Click the “Check for Updates” button in the top-right corner of the page:

4. Confirm the information in the popup box, and click OK to send on the information.
5. A new browser window will open displaying the status of your installation. The results will
show if there is a more recent version available, or if there is a patch available for your
system. Please follow any directions shown on the results page to keep the WebReports
installation up-to-date.

Page 7
 Content Server WebReports 10.0 Installation and Administration

3 License Key Functions

3.1 License Usage Reports

From version 3.0, Content Server WebReports provides a report that shows the WebReports
licensing status. The report indicates when license usage has exceeded 80% of available
licenses. It also indicates when the number of licenses has been exceeded. This makes it
simple to place orders for additional WebReports user licenses when required. It is advisable
to review the report on a regular basis to ensure that there are sufficient user licenses
available.

To view the report, go to the WebReports Administration section of Content Server’s

Administration Pages and select Administer WebReports License Key.

When a Content Server user that has used WebReports is deleted, the license for that user is
released automatically and becomes available for use by another user.

From version 4.0, Content Server WebReports also provides warnings to report developers if
the number of users exceeds the number of licenses by 10% or more. These warnings will
appear when editing or performing other configuration actions on a WebReport. Running
reports is not affected.

3.2 Self Certification

As described previously, WebReports includes functions to help customers ensure they have
sufficient licenses. For the vast majority of customers, using these functions is the simplest
and most appropriate choice. However, some customers may choose to override these
reports and warnings if they are recording and monitoring license usage independently. With
a license key installed, a link called “SELF CERTIFY” appears. Clicking this opens a page
where the current number of users using licenses can be entered. This number will then be
used in place of the number of users that WebReports has recorded.

Page 8
 Content Server WebReports 10.0 Installation and Administration

4 Administration Introduction
A WebReports Administration section in the Content Server Administration pages has been
provided for some of the unique WebReport functions that require settings.

Besides the various unique functions provided by WebReports, basic document management
functions are provided to allow full version control and other features for the reportviews.

This means that WebReports are subject to all of the administrative options that would
normally be available for documents. In particular, any document administrative options, such
as Administer Item Control, will also apply to reportview files.

Reportview files are fully indexed, allowing them to be located via the search facility, though
most users will not have read permissions.

Page 9
 Content Server WebReports 10.0 Installation and Administration

5 WebReports Sub-Tag Builder

This admin function is used as and when a new sub-tag “drop-in” may be provided.
WebReports supports the ability to create a new or replacement subtag and drop it in the
subtags folder in the WebReport installation. New or replacement sub-tags do not take effect
until the Build All Sub-tags option is executed and Content Server services are restarted.
Normally this should only be done with advice and or supervision from Resonate KT or Open
Text personnel.

Page 10
 Content Server WebReports 10.0 Installation and Administration

6 Manage Search Query Integration

The WebReports module supports a search integration feature that provides the capability to
launch one or more WebReports from the standard Advanced Search screen.

In order to enable this feature the following actions need to be taken:

• The feature is enabled from the Admin.index screen (see figure 1) and an appropriate
name for the new search button is specified
• The Content Server must be restarted after the feature is enabled
• One or more WebReports are set to use “search launch” as a data source from the
Properties->Source tab
• From the admin.index screen shown below, WebReports with this data source can be
enabled/disabled
• WebReports with this data source have permissions set so that only appropriate users
have access to them.

Admin Page Options

All WebReports with

Disable the feature Name of Search Button
“Search Launch” data
source listed here

Enable/disable

Given the setup in the previous figure, the Advanced Search screen would look something
like the example below.

Query specified using

advanced search screen

List of Search Launch

reports this user has New Search Button
permission to run launches or shows a
menu if more than 2
reports are available

Page 11
 Content Server WebReports 10.0 Installation and Administration

Technical Notes on Search Integration

Where multiple Content Servers are being used, the following points should be noted:

• The enable option is server specific (stored in the Opentext.ini file) so this feature
could be restricted to specific Content Servers. Conversely, if the same behavior is
required for all servers in a cluster, the feature must be enabled (and the button text
set) for all servers. This could also be achieved by copying the Opentext.ini file

• The activation/deactivation of individual WebReports is system wide so any disabled

WebReports will not be available on any Content Servers

• If this page is being viewed on a server where the feature is disabled, the list of
active/inactive WebReports is not visible. To make this list available the Search
Integration must be enabled, a name provided for the button, and then Apply
selected. As noted above, this will not actually activate the feature unless the server
is subsequently restarted

Page 12
 Content Server WebReports 10.0 Installation and Administration

7 Manage WebReports Conversion

7.1 Introduction
Several of the WebReports destinations support document conversion which can be used to
create PDF formatted reports. The destinations are

• E-mail

• Livelink Node

• Livelink Version

• Server

• Workflow (as an attachment)

In 3.x and ealier versions of WebReports, PDF conversion was supported in a slightly
different form. The user had the option of selecting a PDF MIME type which, upon selection,
caused the reportview to be converted into a PDF format. This had limitations in that the
reportview being converted to PDF could only be in HTML format.

From WebReports 4.0, the MIME Type and conversion process have been completely
decoupled. This means the user can use WebReports to create a document of any type e.g.
WordML or SpreadsheetML and then perform the conversion process on this document. This
brings much more flexibility to the look of the document being converted.

If PDF conversion is to be used, the Content Server Administrator must configure options in
the Manage WebReports Conversion section in the Content Server Admin Pages:

The conversion page allows you to add, view, or modify information about the WebReports
conversion directories. These directories are used in conjunction with a conversion tool such
as Adlib eXpress to allow WebReports to perform exports in PDF, or if required, other
formats.

When a user determines they want a WebReport to be formatted in, say PDF, the reportview
is rendered in the format they have defined in the WebReport and then delivered to the input
folder defined on the Manage WebReports Conversion page. The conversion tool should be

Page 13
 Content Server WebReports 10.0 Installation and Administration

configured to "watch" this directory. On finding a file, the tool should convert it, place the
resultant document in the output folder and delete the input file. When the converted
document appears in the output folder WebReports sends this to the defined export location
and removes it from the output folder.

7.2 Steps to Configure Standard Conversion

• Configure an external conversion engine (e.g. Adlib eXpress) to watch an input folder
for new files that need conversion
• Configure the same conversion engine to store the converted documents in a specific
output folder
• Configure the conversion engine to delete the source file from the input folder
• Establish the interval (this will be partly responsible for determining how quickly the
converted file appear back in Content Server) the conversion engine should check the
input folder
• Configure the conversion engine so that the destination file extension (e.g. .pdf)
replaces the source type (e.g. .html, .doc, .xls) rather than appends the new extension
onto the old one
• On the Content Server admin pages select the Manage WebReports Conversion option
and specify the paths of the input folder and the output folder respectively. It is
important that the Content Server has the permission to write a file to the input folder
and delete a file from the output folder.

7.3 Adlib eXpress Job Ticket Conversion

From WebReports 4.0.1 full support is provided for Adlib eXpress Job Tickets. When the
checkbox is selected to enable the Job Ticket feature, on the Manage Conversion Directories
page, users can provide detailed processing directives via an XML (Job Ticket) file. This XML
file can be stored in Content Server with individual WebReports either sharing a single Job
Ticket file or each having their own processing instructions. See the Adlib website
(http://www.adlibsys.com) for more details on XML Job Tickets.

When the Job Ticket feature is enabled the user is presented with two new conversion
directories:

Page 14
 Content Server WebReports 10.0 Installation and Administration

7.4 Steps to Configure Adlib eXpress Job Ticket Conversion

• Below the section to specify Input and Output directories, there is a checkbox to enable
the use of XML Job Tickets with conversion

• Upon checking this box and enabling XML Job Tickets, the following will occur:

o A second set of directories will appear to allow the user to specify an additional
set of directories for when files are converted using XML Job Tickets

o The interface for XML Job Tickets will be enabled in the destination tab for a
WebReports (provided the Use External Conversion Engine box is checked)

Notes

For conversion to be enabled at all, the first set of conversion directories must be specified.
The additional set of directories for XML Job Tickets are optional, and are useful for servers
running multiple instances of Content Server using different conversion methods (current
versions of Adlib eXpress only support conversion with or without Job Tickets, not both
simultaneously).

If only XML Job Ticket conversion is being used the administrator must specify the conversion
directories in the first two fields.

If XML Job Tickets are being used at the same time as standard conversion, the standard
conversion directories must be specified first and the XML Job Ticket directories specified
second.

The values entered on this page will be used to replace occurrences of $DEFAULT_PATH
specified in the Job Ticket itself.

A basic example of a Job Ticket can be found in the online help:

WebReports: Advanced Information: PDF Conversion

7.5 Technical Notes on PDF Conversion

• WebReports uses the Content Server cache to determine which converted file goes to
which destination. As with any cache, it has a finite life which means, although unlikely,
it is possible for converted files to be in the output folder that relate to an expired cache.
In this case WebReports won't know where to send the files as the destination
information is lost. This situation could occur if users have been exporting and
converting on a system with agents disabled on all servers. Enabling agents won't
clear the backlog of files unless they have a current cache. As a rule, if anything is in
the output folder more than an hour, it should be manually deleted.
• Content Server agents are used to look at the output folder and check for a converted
file every 5 minutes. This means agents must be enabled for conversion to function.
• The exact time a file is written to the input folder, how often the conversion tool checks
this folder, the time taken to do the actual conversion and the point this hits in the cycle
of the 5 minute agent above will determine how long it takes for a file to appear in the
export destination. This might vary from nearly instantaneous to 30 minutes depending
on the system.
• Folders at a network location might be specified as a UNC, e.g.: \\192.168.255.20\disk
1\PDF Conversion\input .

Page 15
 Content Server WebReports 10.0 Installation and Administration

• It is possible for an export to occur from any Content Server in a clustered environment.
It is therefore essential that the input directory is defined on every machine in the
cluster. The output folder is only monitored by the Content Server with the WebReports
conversion agent running. It is therefore essential to specify the output folder on that
server. It is, however, good practice to specify it on all Content Servers.

Page 16
 Content Server WebReports 10.0 Installation and Administration

8 WebReports Scheduling

8.1 Overview
The capability to schedule WebReports is provided in the Properties: Destination page.
WebReport developers (i.e. users with reserve permission) can set up execution schedules
for individual WebReports to run without user intervention. Scheduled reports run in the
background and output their results to a Content Server document node or to e-mail. The
schedule allows for reports to run a fixed number of times or forever, starting from a specific
date and time. The time between repeated report runs can be from 5 minutes to 520 weeks.
One schedule can be set per user per WebReport.

8.2 Configuring Content Server for WebReports Scheduling

It is not necessary for Content Server notifications to be enabled for WebReports scheduling
to function. However, Content Server Change Agents must be enabled on your Content
Server instance. The [options] section of the opentext.ini file for at least one of the Content
Servers will contain EnableAgents=TRUE if Change Agents are enabled. Normally Change
Agents are enabled, but if you are unsure about how to configure Change Agents for your
particular Content Server instance please consult Open Text Support.

8.3 Managing Schedules

To aid administrators in monitoring and managing these schedules, a report of all WebReport
schedules on the Content Server instance is available from the Content Server Administration
pages. Click on the link Manage WebReports Schedules under WebReports
Administration section. Assuming there are schedules set, Content Server will return a
screen similar to the one illustrated below.

Each row in the report represents a schedule set by one user for one WebReport. Individual
schedules can be disabled by un-checking the Enabled checkbox and clicking Apply. The
schedule information will be retained, but the report will not run until it is re-enabled by the

Page 17
 Content Server WebReports 10.0 Installation and Administration

user listed or by the Administrator. To permanently delete a particular schedule check the
Delete Schedule checkbox and click Apply.

Schedules are automatically deleted by Content Server if the user that set them is deleted or
if the WebReport itself is deleted.

8.4 Database Schema

A database table called WEBREPORTS is created when Content Server WebReports is
installed. The purpose of this table is to store WebReports schedule information. This table
has a two column key being USERID and NODEID (the nodeid of the WebReport).

Note: Uninstalling the WebReports module does not remove these tables. In order to
uninstall these tables, the WebReports Database Administration option under the
Content Server Administration pages prior to uninstalling the module.

An additional table called WEBREPORTSTATS is created when the module is installed or

upgraded.

Page 18
 Content Server WebReports 10.0 Installation and Administration

9 Node Administration
This page identifies existing WebReports using syntax which is out-of-date for the current
release. WebReports that continue to use out-of-date syntax might not work as they did in
previous releases. Updating the syntax via this utility will result in the selected WebReports
being updated with the current syntax in order to maintain the same functionality.

Current reason for upgrade are limited to:

• New variable syntax usage

• Syntax around LLURL:FORMEDIT needs updating for editable parameter
• Syntax for Sort tag has changed

Page 19
 Content Server WebReports 10.0 Installation and Administration

10 WebReports Database Administration and

Downgrading to Earlier Versions of WebReports
During an uninstall of the WebReports module, initiated from the Module Administration page,
the module’s database schema will remain in place in order to provide the system
administrator with more flexibility; for example to avoid the loss of schedule information when
WebReports is re-installed. Only WebReports 5.0.x or above can be re-installed under these
circumstances.

If you wish to permanently remove WebReports and its associated schema or downgrade the
schema, you can do this by selecting WebReports Database Administration on the
administration pages.

• If you choose to “Delete WebReports tables” the entire WebReports schema will be
removed and following this you will be taken through the uninstall of the module.

• If you choose to “Downgrade the scheme to 4.x.x” only the new schema added after
WebReports 4.1.1 will be dropped and following this you will be taken through the
uninstall of the module. All data valid in WebReports 4.x.x will be retained and you
can then install WebReports 4.x.x.

In the event that WebReports is uninstalled without using either of these options and an
attempt is then made to install a pre-5.0.x version of WebReports the installation will fail with
a schema mismatch error. It will be necessary to manual uninstall WebReports and then
either re-install WebReport 5.0.x and use one of the above options, or manually drop the
schema from the database. If in doubt please contact support.

Page 20
 Content Server WebReports 10.0 Installation and Administration

11 Manage WebReports Scripting

This page can be used to review and approve all WebReports that contain Oscript sections
within their reportviews. By default Oscript is disabled for a WebReport until a System
Administrator enables it (or adds a new version to the reportview, in which case it is enabled
automatically). It is the responsibility of the approving System Administrator to ensure that the
reports are safe; for example that they cannot result in an infinite loop.

By default Oscript in WebReports is heavily restricted to make it secure. For example there is
no access to global variables or many of the Builder Packages. What is allowed and restricted
can be altered via settings in the Opentext.ini file.

It is recommended that all reports containing Oscript are developed and tested on a
development instance of Content Server prior to being added to a production instance of
Content Server.

Each Oscript report can be enabled or disabled individually by checking or un-checking the
checkbox in this report. It is also possible to enable or disable Oscript for an individual
WebReport from its Properties -> Info page.

Note that WebReports with Oscript sections that are not enabled will still run, but all Oscript
calls are ignored and not processed.

Page 21
 Content Server WebReports 10.0 Installation and Administration

12 Restricting ‘Add New Item’ for WebReports

Like most other Content Server objects, WebReport objects can be controlled using the
Content Server ‘object factory’. This means that an administrator can restrict the creation of
WebReports to a selected group of users. This is done in the System Administration area of
the Content Server Administration pages, using the Administer Object and Usage
Privileges section.

Page 22
 Content Server WebReports 10.0 Installation
llation and Administration

13 Administering WebReport Events

Content Server events can be enabled for the WebReports object. Because a WebReport
reportview is treated like a normal Content Server document, all of the standard Content
Server events can be enabled and used.

In some situations these events may not be enabled. To enable them, the administrator
should click the Administer Event AAuditing link under the System Administration section
of the Content Server Administration pages
pages. Then choose Set Auditing Interests and select
WebReports in the drop-down
down list. Check the interests as desired and then click Set
Interests.

Auditing also needs to be enabled on the Specific tab of each WebReport. The “Run/Export
Audits Enabled” option is unchecked by default and allows each WebReport to have
additional audit events enabled so that every RUN or EXPORT event will generate an en entry in
the AUDIT log. This is to provide granular control to stop the Audit logs from overflowing.
 Content Server WebReports 10.0 Installation and Administration

14 Storing WebReports in the Report Volume

The WebReport object has been set up to behave like a LiveReport for any system functions
that are associated with reports. In particular, WebReports can be saved under the Reports
volume (LiveReports tab) from the Personal or Project menus. To save a WebReport under
this volume, the Administrator simply needs to browse to Content Server: Content Server
Reports when selecting the ‘create in’ container for an add, move or copy operation.

Page 24
 Content Server WebReports 10.0 Installation and Administration

15 Cached Views
Each time a WebReport is run, a cached file is created for the current version of the
reportview file. This functionality is similar to that used for WebForms. These cached views
can be found under the folder: H/support/webreports/views.

Because it is sometimes desirable for users to execute multiple versions of the same
WebReport, all versions of cached files are maintained in this folder. The administrator can
delete the contents of this folder at any time. These files are created as soon as any user runs
a WebReport for the first time.

Page 25
 Content Server WebReports 10.0 Installation and Administration

16 Default Reportviews
When WebReports developers select the Use a Default Reportview option, one of a number
of standard templates can be chosen instead of browsing for a reportview on the developer’s
desktop. These templates are stored as text files on the Content Server in the module
directory for WebReports (e.g. from the Livelink installation location
\module\webreports_x_x_x\defaultreportviews\10_basic_report.txt).

The Content Server Administrator can change these files and add new ones simply by editing
them, renaming them or placing additional files in the defaultreportviews folder. These files
will appear as selectable items on the default reportview drop-down menu. Default reportview
filenames should end in .txt and should start with X_ where X is a number that determines the
order of the default reportviews in the menu.

Adapting or adding new default reportviews might typically be done to include standard
corporate branding to reports or provide specific export (CSV, WordML, etc) reportviews for
exporting Content Server data to other applications.

Information about the pre-packaged reportviews provided by WebReports can be found in the
on-line help and the user guide.

Page 26
 Content Server WebReports 10.0 Installation and Administration

17 WR Trigger Administration
The WR Trigger feature allows events occurring within Content Server to trigger a
WebReport. The administration settings allow different Content Server sub-types to be
enabled or disabled. Enabling the feature for a sub-type will cause the WR Trigger option to
appear on function menus for that node. If this feature is disabled (not selected) for a
particular sub-type, no code associated with WebReports will execute for nodes of that sub-
type and the WR Trigger option will not appear in the node’s function menu. If all sub-types
are disabled WR Trigger has no performance cost associated with it. Following installation or
upgrade to a version of WebReports with this feature all sub-types will be disabled by default.

Page 27
 Content Server WebReports 10.0 Installation and Administration

18 User/Group WR Trigger Administration

Similar to WR Trigger, the User/Group WR Trigger feature allows events pertaining to users
and groups occurring within Content Server to trigger a WebReport. In order to use this
feature, the Enable User/Group WR Trigger checkbox must be selected. The administration
settings allow different Content Server users and/or groups to be selected, and for those
users/groups, any number of available Trigger Events can be selected (if the Trigger Event
should occur with any user or group, then select the Global checkbox). When the selected
Trigger Event occurs for any of the selected users/groups, the specfied WebReport will be
executed. The option for Inheritance specifies the scope to either Direct Members, or
Direct and Indirect Members. More than one trigger can be set up by adding rows as
needed.

Page 28
 Content Server WebReports 10.0 Installation and Administration

19 Category as a Data Source

The Category as a Data Source feature allows point and click configuration of reports on
Content Server Categories and Attributes. The admin settings for this feature allow basic
control of the output format and settings which can help set limits on the performance cost of
running the report.
• Maximum Number of Categories determines how many categories a user can select to
report on. The larger this number is, the more complex is the query sent to the
database in cases where a user selects the maximum number of categories.
• “Number of Attributes to Display Across” determines how many selectable attributes will
be presented per “row” on the WebReport data source configuration page (not in the
report itself).
• Multi-Valued Attribute Delimiter specifies the character used to separate multi-values
that are returned by a report.
• Maximum Number of Results sets a limit to the number of results returned by all reports
using Category as a Data Source, discarding any results above that number.

Page 29
 Content Server WebReports 10.0 Installation and Administration

20 Exporting to E-Mail
Content Server WebReports has the capability to export to multiple locations, including e-
mail. For e-mail exports to work correctly, the following details need to be filled out in the
Configure Notifications page in the Content Server Administration pages:
• SMTP Server ID
• SMTP Port
• Content Server Host Name

Note that although these details need to be filled in, Content Server Notifications do not need
to be enabled.

Page 30
 Content Server WebReports 10.0 Installation and Administration

21 Exporting and Importing WebReports

21.1 Standard Export/Import

Like most Content Server objects, WebReports provides the capability to store all the
WebReport data in an XML file for later importing. The basic functionality uses the same
syntax as other Content Server objects. For example, to export a single WebReport object the
following syntax could be used:

?func=ll&objId=10879&objAction=xmlexport&nodeinfo&content=base64
&versioninfo=current&scope=sub

(&attributeinfo can be used to include any assigned attributes;

&versioninfo=all can be used if all versions are required)

In this example the objid 10879 refers to a WebReport object. If an entire Content Server
container is being exported (using the &scope=sub parameter) and a WebReport exists
within it, the WebReport will be exported with exactly the same information. Because
WebReports include textual content, the &content=base64 must be used during any export.

To import a WebReport the standard import syntax is used. For example, to import a file
called TestImport.xml which is stored on Content Server’s C:\ drive to a folder in Content
Server with the object ID 22222, the following syntax would be used:

?func=admin.xmlimport&filename=C:\TestImport.xml&objid=22222

Note: The file to be imported must be saved/stored in a location where the Content Server
can retrieve it; in the example above, the C:\ drive is on the Content Server’s local disk, not on
the C drive for the user who is executing the command.

21.2 Special Import Features

Besides the standard features of export/import, WebReports provide some more advanced
features to aid in re-forming links to any dependencies on the destination system. This feature
is used to resolve the following objects on the target system:
• Datasource IDs
• Any constants set to LivelinkObject
• Any constants set to LivelinkUser
• Any parameter defaults set to ObjectID
• Any parameter defaults set to Custom
• Any parameter defaults set to User
• Any Global Constant IDs
• Any Global Parameter IDs

These objects are resolved using a series of actions to attempt to find the correct object on
the target system. In some cases there may be more than one appropriate matching object so
there is a priority order for matching. The items below show the order of matching. If any step
fails to find a match then the next step is tried.

Page 31
 Content Server WebReports 10.0 Installation and Administration

1. If the object to be matched is being imported as part of the same XML import operation,
then the new ID for the imported object will be used
2. If the original object ID exists on the target system then the associated node is tested to
ensure that it is the same type of object with the same name and data
3. If there is no equivalent object ID then the target system is searched (using a DB query)
to find an object with the same name and equivalent data. If a match is found then the
new object ID is added to the WebReport

Content Server user IDs are managed in a similar fashion; however user IDs are not imported
during the XML import so the first matching method doesn’t apply.

21.3 Notes
The following points should be considered.
• When a target system is being searched for a matching object, if more than one match
exists the import routine will currently use the first match found in the database. This
should normally be the first object which was created
• The WebReports export and import does not handle the following:
• Any categories or attributes associated with settings to export to a Livelink node will not
be re-linked to new objects on a target system
• Scheduling data is not currently exported or imported

Page 32
 Content Server WebReports 10.0 Installation and Administration

22 Setting Permissions for WebReports Users

Because WebReports combine aspects of running a report as well as document
management, there are some unique considerations for setting permissions.

The following table indicates the most common roles for WebReport users and the
recommended permissions settings.

Minimum Available
WebReport User Role
Permissions Commands
General users who are not allowed to run or edit the WebReport. See Make Shortcut
Open, Export (also
End Users allowed to run the WebReport. This will be the main standard See
permission setting for all End Users of WebReports. It differs from Contents
normal documents where users would need to View, Fetch, or See Contents commands such
Download. With WebReports these commands are only used for as Set Notification,
the users who actually create or edit the reportviews. Add to Favorites
etc.)
WebReport Developers who might create or edit other
WebReports but who are not allowed or required to have access to
modify this specific WebReport. This enables them to take the Copy, Open,
Modify
reportview (e.g., using download) and reuse it in another Download, View
WebReport for which they have Reserve permission. Note that this
may appear counter-intuitive!
WebReport Developers who are responsible for modifying the Add Reportview
reportview, selecting different data sources and or creating Version,
scheduled instances of a report. These are typically the Reserve Edit Reportview,
WebReport owners; however, they do not necessarily need to Properties:
have Delete or Edit Permissions access. Specific
Administrative users As Required
(normal E.g. Delete,
permissions Permissions.
behavior)

In addition to permissions for the WebReport itself, any user running the WebReport must
have See Contents permission to the underlying data source. This data source is selected
when the WebReport is first created or later via the Properties: Source page.

Developers with Reserve permission on the WebReport they are working on do not
necessarily require permission to edit or view the contents of the associated data source, but
they will have permission to change which data source the WebReport object is associated
with.

Page 33
 Content Server WebReports 10.0 Installation and Administration

23 Sample Reportviews
The WebReports module is packaged with various sample reportviews. Once the module is
installed, these reportviews can be found on the Content Server under the standard Content
Server location in: H\module\webreports_x_x_x\examplereportviews. As these
reportviews are useful for all WebReport developers, it may be desirable to place these
reportviews in a standard location that is accessible to the appropriate communities of users.

For example, an area in Content Server called WebReport development, containing sample
WebReports, could be created. These WebReports can be built using the sample reportviews
packaged with the module. Alternatively, the reportview files could simply be uploaded to
Content Server so they can be retrieved by developers.

Page 34
 Content Server WebReports 10.0 Installation and Administration

24 Restricting WebReports Services

The WebReports Services feature can be quickly disabled and enabled from the
administration pages from the Manage WebReports Services page, and selecting the
checkbox seen here:

Page 35
 Content Server WebReports 10.0 Installation and Administration

25 WebReports Preferences in the opentext.ini File

WebReports has a number of configuration preferences that can be set in the opentext.ini file.
The following table describes the options. Be cautious about making changes to settings in
the opentext.ini file. The Content Server must be restarted before any changes take effect.
Always consult support if in doubt.

Field Name Type Description

Describes the label used for the button to launch a
WebReport from Content Server search. This should be
addsearchbutton String or null set from the Admin pages in Content Server. Please refer
to the WebReports User Guide for more detail about this
feature.
Determines how many results are to be gathered in go
from the search API. Changing this setting will have an
impact on performance of WebReports that use search as
searchslice Integer
a data source. In general this setting should not be
altered without advice from Open Text support. Default is
300.
Determines a maximum limit on the number of results that
searchHardLimit Integer a WebReport using search as a data source can return.
Default is 50,000.
Turns on extra debug information in the thread log for
searchDebug true / false executing WebReports with search as a data source.
False by default.
Controls whether Oscript is permitted within reportviews.
Default is true. When set to false no oscript within any
reportview will be compiled or executed. This turns the
EnableOscriptReportviews true / false
scripting feature off completely on the Content Server.
Please refer to the WebReports User Guide for more
detail about this feature. True by default.
A list of individual oscript package functions to be
permitted within a reportview. Please refer to the
OscriptAllowFunction1 List of strings
WebReports User Guide for more detail about this
feature.
OscriptAllowWholePkg A list of oscript packages to be permitted within a
List of strings reportview. Please refer to the WebReports User Guide
for more detail about this feature.
MaxNestedSubWebReports Controls the upper limit of how deep sub-WebReports
Integer
may be nested. Default value is 5 if this field is absent.
VersionInput Specifies the input directory for a converter (e.g. AdLib
String dir
eXpress). This should be changed via the “Manage
path
WebReports Conversion” administration page.
ConversionDir Specifies the output directory for a converter (e.g. AdLib
String dir
eXpress). This should be changed via the “Manage
path
WebReports Conversion” administration page.
additionalSearchColumns Determines the optional columns available to
WebReports that use search data sources. Possible
List of strings
values include: OTHotWords, OTSummary,
or list of lists
parentRecord, Score, shortOTSummary. These can be
specified as strings within a list or as a list of two element

Page 36
 Content Server WebReports 10.0 Installation and Administration

lists where the first element is the column coming back

from search and the second column is what you want it to
be called in the output. It should be noted that these
values are made available via the search index. If the
underlying structure of the index were to change in future
releases, these columns may no longer be available.
AllowFormCustomview Control whether WebReports can be added to form
templates as views. This feature is visible by navigating
true / false to the views tab of a form template. The options “Add WR
Power View” will be present if the feature is enabled. The
feature is enabled by default.
WRNodeMIMETypes Determines the list of MIME types that a WebReport node
itself may be set to. Effectively this is the MIME type of
List of strings the reportview. Normally WebReports are assigned the
text/plain MIME type, but sometimes it may be useful to
permit text/html or other MIME types.
destinationmimetypes The is the MIME type of the output that will be created by
WebReports. Depending on client settings this can
List of strings
determine what application is used to open the resulting
document.
WRTriggerSubtypes Controls the sub-types that are able to initiate
List of
WebReports from the WR Trigger feature. All sub-types
integers
are disabled by default.
DisallowServices Enables or disables the WR Services feature. WR
true / false
Services is enabled by default.
livelinkcategory_maxNumCats Defines the maximum number of categories selectable via
Integer
the category as a data source feature.
livelinkcategory_NumAttrAcross Defines the maximum number of attributes that should be
Integer displayed on a single line from the category as a data
source feature.
livelinkcategory_attrDelimiter This character is used to separate multivalue attributes in
String
the output from the category as a data source feature.
livelinkcategory_maxNumRows Controls the maximum number of results that are
Integer
retrievable from the category as a data source feature.
AllowFormCustomview Enables or disables the WR Power View feature which
true / false
allows a WebReport to be used as a form view.
EnableLAPIFunctions This setting contains a whitelist of LAPI functions that can
be run as an AJAX request. The following functions are
always enabled by default to support WebReports:
List of strings {‘wrlistnodes’, ‘wrlistusers’, ‘setwizarddata’, ‘getobjectinfo’}
and doesn’t need to be explicitly set in the ini file. Other
functions can be added to this list, or a generic {‘all’} value
can be used to enabled all functions.

Page 37
 Content Server WebReports 10.0 Installation and Administration

The following example illustrates a typical arrangement:

[WebReports]
addsearchbutton=Custom Report
VersionInput=C:\AdLib eXpress\Input
ConversionDir=C:\AdLib eXpress\Output
OscriptAllowFunction1={'Scheduler.debugbreak','Web.CRLF','Web.Escape','Web.U
nescape','Web.DecodeForURL','Web.EncodeForURL','Web.Format','Web.EscapeHTML'
,'Web.EscapeXML'}
OscriptAllowWholePkg={'Assoc','Bytes','Date','List','Math','Pattern','RecArr
ay','Str','String','Boolean','undefined','void','integer','real','record'}
EnableOscriptReportviews=true
MaxNestedSubWebReports=10
additionalSearchColumns={{'OTSummary','Summary'},{'shortOTSummary','shortSum
mary'},OTHotWords,Score,parentRecord}

Page 38
 For additional information, please contact:
Open Text Corporation
275 Frank Tompa Drive
Waterloo, Ontario
N2L 0A1 Canada
Phone: 519-888-7111
Fax: 519-888-6737
Email: [email protected]
Web: www.opentext.com/services

Or
www.resonatekt.com
[email protected]

Copyright 2005-2010 Resonate KT Limited

The information in this document is subject to change without notice. All rights reserved.
Printed in Canada.
Open Text Corporation is the owner of the trademarks Open Text, ‘Further Faster’,
HyperInnovation, Accelerating Innovation, Livelink, myLivelink, BASIS, Techlib, OnTime among
others. This list is not exhaustive. All other products or company names are used for
identification purposes only, and are trademarks of their respective owners.

www.opentext.com Americas Europe Asia/Pacific

[email protected] 100 Tri-State international Pkwy Grosvenor House 138 Harris Street
3rd floor Horseshoe Crescent Pyrmont, NSW 2009
North America Sales Lincolnshire IL 60069 Beaconsfield, Buckinghamshire Australia
1-800-499-6544 USA England HP9 1LJ Phone: +61-2-9552-3334
International Sales Phone: 847-267-9330 Phone: +44 1494 679700 Fax: +61-2-9552-3446
+800-4996-5440 Fax: 847-267-9332 Fax: +44 1494 679707