WebReports Administration Guide

OpenText™ Content Server

Administer WebReports, Content Server applications, Content

Intelligence widgets, and WebReports Workflow. Also covers
best practices for WebReports security hardening.

LLESWEBR230200-AGD-EN-01
WebReports Administration Guide
OpenText™ Content Server
LLESWEBR230200-AGD-EN-01
Rev.: 2023-Feb-18
This documentation has been created for OpenText™ Content Server CE 23.2.
It is also valid for subsequent software releases unless OpenText has made newer documentation available with the product,
on an OpenText website, or by any other means.

Open Text Corporation

275 Frank Tompa Drive, Waterloo, Ontario, Canada, N2L 0A1

Tel: +1-519-888-7111
Toll Free Canada/USA: 1-800-499-6544 International: +800-4996-5440
Fax: +1-519-888-0677
Support: https://support.opentext.com
For more information, visit https://www.opentext.com

Copyright © 2023 Open Text. All Rights Reserved.

Trademarks owned by Open Text.

One or more patents may cover this product. For more information, please visit https://www.opentext.com/patents.

Disclaimer

No Warranties and Limitation of Liability

Every effort has been made to ensure the accuracy of the features and techniques presented in this publication. However,
Open Text Corporation and its affiliates accept no responsibility and offer no warranty whether expressed or implied, for the
accuracy of this publication.
 Table of Contents
Part 1 WebReports Administration 5

1 About the WebReports Module ................................................ 7

2 Providing Access to WebReports ............................................ 9

2.1 To Provide Users with Access to the WebReport Object Type .............. 9

3 Using the WebReports Administration Section .................... 11

3.1 Enable WebReports ........................................................................ 12
3.2 Install the Requests.js Library .......................................................... 14
3.3 Manage Source Settings ................................................................. 15
3.4 Manage Destination Settings ........................................................... 16
3.5 Manage Global Scripting Settings .................................................... 18
3.6 Manage Secure Constants .............................................................. 19
3.7 Manage Tags and Sub-Tags ............................................................ 21
3.8 Manage Trusted Files ...................................................................... 22
3.9 Manage User/Group WR Triggers .................................................... 25
3.10 Manage WebReports Containing Oscript .......................................... 26
3.11 Manage WebReports Conversion ..................................................... 27
3.12 WebReports Schedules ................................................................... 30
3.13 Manage WebReports Search Integration .......................................... 33
3.14 Managing WebReports Services ...................................................... 35
3.15 Manage WR Triggers ...................................................................... 36
3.16 WebReports Node Administration .................................................... 37
3.17 WebReports Sub-Tag Builder .......................................................... 38
3.18 Custom Sub-tags ............................................................................ 38

4 Content Server Functions Available for WebReports .......... 43

4.1 Enabling Content Server Functions for WebReports .......................... 43
4.2 Cached Views ................................................................................. 44
4.3 Default Reportviews ........................................................................ 44
4.4 Setting Permissions for WebReports Users ....................................... 44
4.5 WebReports Preferences in the opentext.ini File ............................... 46
4.6 Accessing Content Server Logs ....................................................... 46

5 Best Practices for WebReports Security Hardening ............ 47

5.1 Preventing XSS-vulnerable Syntax ................................................... 47

6 Configuring Content Intelligence Widgets ............................ 49

Part 2 WebReports Workflow Extensions Administration 51

LLESWEBR230200-AGD-EN-01 OpenText™ Content Server iii

Table of Contents

7 WebReport Step Configuration .............................................. 53

8 Show Workflow Maps .............................................................. 55

Part 3 Content Server Applications Administration 57

9 Administering Content Server Applications ......................... 59

10 Applications Components ...................................................... 61

11 Applications Management ...................................................... 63

11.1 Building or Rebuilding a Content Server Application .......................... 65
11.2 To Build or Rebuild a Content Server Application .............................. 73
11.3 Installing a Content Server Application ............................................. 75
11.4 Viewing a Content Server Application ............................................... 76
11.5 Defining Special Components for a Content Server Application .......... 77
11.6 Upgrading a Content Server Application ........................................... 78
11.7 Uninstalling or Deleting a Content ServerApplication ......................... 80
11.8 Cleaning up a Content ServerApplication .......................................... 82
11.9 Downloading the Application ZIP File ............................................... 82

12 Applications Volume ............................................................... 83

iv WebReports Administration Guide LLESWEBR230200-AGD-EN-01

 Part 1
WebReports Administration
Chapter 1
About the WebReports Module

Important
The WebReports module is installed with Content Server but not enabled by
default. It can be enabled according to your licensing agreement with
OpenText. If you have recently upgraded and WebReports features are not
available, you may need to enable the WebReports module. For more
information about how to enable WebReports, see “Enable WebReports”
on page 12. If WebReports features are not available after enabling the
module, please contact OpenText Customer Support.

A WebReports Administration section in the Content Server administration pages

has been provided for some of the unique WebReports functions that require
settings.

Definitions of Key Terms

This documentation uses the following terms:

• System Administrators are users who manage WebReports permissions and

access requirements, and who also have access to the LiveReports, and other data
sources that supply data to the WebReports. The various tasks and functions
described in this document are intended for these administrators.
• End Users are Content Server consumers who can see the output of a
WebReport.
• Developers are users who may be involved in creating a new WebReport or
editing an existing one to change the look, feel, and behavior of the WebReport.
For any particular WebReport, Developers fall into two categories:

– Developers who can add or edit a version of the reportview.

– Developers who can only retrieve or download an existing reportview. These
developers cannot change a reportview, but can reuse an existing one when
generating a new WebReport.
• A Data source is any Content Server object that can be used to generate a data set
for a WebReport. This is most commonly a LiveReport, but could also be a saved
search query, a form template, or a form.
• A LiveReport is a Content Server item that uses SQL statements to communicate
directly with the database to obtain statistical information from, or potentially
modify, the Content Server database. The Content Server administrator may
create new LiveReports, and grant other users permission to run them. Each user
can see the LiveReports for which they have permissions in their Personal
Workspace, on the LiveReports tab on the Reports page.

LLESWEBR230200-AGD-EN-01 OpenText™ Content Server 7

Chapter 1 About the WebReports Module

• A Reportview is the template used as the starting point for generating a

WebReport object. Each reportview may contain traditional Web code, such as
HTML, as well as custom tags that are used to determine where the data source
data fields will be inserted in the output Web page.
A Reportview is the document that is stored for each WebReport object. These
reportviews contain traditional Web code, such as HTML, as well as custom tags
that are used to determine where the data source data fields will be inserted in
the output Web page.
• System Administrators are users who manage WebReports permissions and
access requirements, and who also have access to the LiveReports, and other data
sources that supply data to the WebReports. The various tasks and functions
described in this document are intended for these administrators.

8 WebReports Administration Guide LLESWEBR230200-AGD-EN-01

Chapter 2
Providing Access to WebReports

Before you can provide access to WebReports, first ensure that WebReports is
enabled. For more information, see “Enable WebReports” on page 12.

2.1 To Provide Users with Access to the WebReport

Object Type
To provide users with access to the WebReport object type:

1. In the Core System - Feature Configuration section of the Content Server

Administration page, click the Object Privileges link.

2. On the Administer Object Privileges page, in the Object Privileges area, scroll
to the WebReport object type and click the Restrict button .

Note: The WebReports module is installed with Content Server but not
enabled by default. It can be enabled according to your licensing
agreement with OpenText. If you have recently upgraded and
WebReports features are not available, you may need to enable the
WebReports module. For more information about how to enable
WebReports, see “Enable WebReports” on page 12. If WebReports
features are not available after enabling the module, please contact
OpenText Customer Support.

3. In the Perform Action dialog, click OK to confirm that you are aware that no
users can create any WebReports until you add users to the Edit Group for
WebReports.

4. On the Edit Group: WebReports page, follow the OpenText Content Server -
Content Server Administration Guide (LLESWBA-AGD) procedure.

LLESWEBR230200-AGD-EN-01 OpenText™ Content Server 9

Chapter 3
Using the WebReports Administration Section

The WebReports Administration section provides the following settings and

options:

• “Enable WebReports” on page 12 allows you to enable the WebReports

module.
• “Install the Requests.js Library” on page 14 provides an interface to install the
Requests Library and associated files to the JavaScript library location.
• “Manage Source Settings” on page 15 updates the maximum number of
categories and attribute display parameters.
• “Manage Destination Settings” on page 16 manages settings related to the
WebReports Destination property tab.
• “Manage Global Scripting Settings” on page 18 defines Oscript settings that
apply globally to both WebReports and ActiveView.
• “Manage Secure Constants” on page 19 maintains secure constants to store data
that can be used with the LL_WEBREPORT_RESTCLIENT tag.
• “Manage WebReports Search Integration” on page 33 manages the ability to
invoke WebReports directly from the search screen.
• “Manage Tags and Sub-Tags” on page 21 selectively disables WebReports tags
and sub-tags.
• “Manage Trusted Files” on page 22 configures a set of trusted external files for
use by WebReports.
• “Manage User/Group WR Triggers” on page 25 determines which User or
Group can trigger a WebReport.
• “Manage WebReports Containing Oscript” on page 26 enables or disables
Oscript in individual WebReports.
• “Manage WebReports Conversion” on page 27 sets the sleep interval for the
conversion agent and sets the input and output directories for PDF conversion.
• “WebReports Schedules” on page 30 sets the sleep interval for the schedule
agent, and allows you to enable, disable, or permanently delete individual
schedules.
• “Manage WebReports Search Integration” on page 33integrates with the
Advanced Search page.
• “Managing WebReports Services” on page 35 enables, disables, or restricts the
WebReports services feature.
• “Manage WR Triggers” on page 36 determines which node types can trigger a
WebReport.

LLESWEBR230200-AGD-EN-01 OpenText™ Content Server 11

Chapter 3 Using the WebReports Administration Section

• “WebReports Node Administration” on page 37 identifies and updates

WebReports using out-of-date syntax.
• “WebReports Sub-Tag Builder” on page 38 rebuilds all sub-tags including any
subtags that have been created in the sub-tags folder.
• “Custom Sub-tags” on page 38 allow you to generate sub-tag features
customized for your needs that you can include in your WebReport reportview
and use just like any other sub-tag.

3.1 Enable WebReports

After installation, the WebReports module is disabled by default. If your
organization has licensed Extended ECM, you need to enable WebReports before
you can use it, but you do not need to confirm WebReports licensing by providing a
licensed seat count or authority name. If your organization has standalone
WebReports licensing, you will also need to enable WebReports. In addition, you
will need to confirm the number of licensed seats for your organization as well as
provide the authority name for your licensing in the Standalone WebReports
License Confirmation section of the Enable WebReports page. For more
information, see “To Enable the WebReports Module” on page 12.

After the WebReports module is enabled, you can disable it, as described in “To
Disable the WebReports Module” on page 13.

After enabling standalone WebReports, you can change the number of WebReports
licensed seats, as described in “To Change the Number of WebReports License
Seats” on page 13, or you can change the authority name for your WebReports
licensing, as described in “To Set the Authority Name for your WebReports
Licensing” on page 14.

Notes

• Enabling or disabling WebReports requires a restart of the Content Server

service.
• Disabling WebReports may result in non-functional nodes. To reactivate
these nodes, you can re-enable WebReports.

3.1.1 To Enable the WebReports Module

To enable the WebReports module:

1. In the WebReports Administration section of the Content Server

Administration page, click the Enable WebReports link.

2. On the Enable WebReports page, in the WebReports section, select the Enable
WebReports check box.

3. In the Standalone WebReports License Confirmation section, do the following:

12 WebReports Administration Guide LLESWEBR230200-AGD-EN-01

 3.1. Enable WebReports

a. Depending on your license agreement, in the Standalone WebReports

Licensed Seats box, enter the number of WebReports licensed seats for
your organization.

b. In the Authority Name box, enter the name of the person who is
authorized to confirm licensing for your organization.

4. Click Save Changes.

5. Restart Content Server.

3.1.2 To Disable the WebReports Module

To disable the WebReports module:

1. In the WebReports Administration section of the Content Server

Administration page, click the Enable WebReports link.

2. On the Enable WebReports page, in the Confirmation section, clear the

Enabling WebReports check box.

3. Click Save Changes.

4. Restart Content Server.

3.1.3 To Change the Number of WebReports License Seats

To change the number of WebReports license seats:

1. In the WebReports Administration section of the Content Server

Administration page, click the Enable WebReports link.

2. On the Enable WebReports page, in the Standalone WebReports License

Confirmation section, do the following:

a. In the Standalone WebReports License Seats box, enter the new number of
licensed seats that your organization has purchased.

b. In the Authority Name box, update the name of the person who can
confirm the additional licensed seats.

Notes

• If there are one or more licensed seats, you must provide an

Authority name.
• The Standalone WebReports License Confirmation section only
appears if there is a positive value for the Licensed Seats
parameter.

3. Click Save Changes.

LLESWEBR230200-AGD-EN-01 OpenText™ Content Server 13

Chapter 3 Using the WebReports Administration Section

3.1.4 To Set the Authority Name for your WebReports

Licensing
To set the authority name for your WebReports licensing:

1. In the WebReports Administration section of the Content Server

Administration page, click the Enable WebReports link.
2. On the Enable WebReports page, in the Standalone WebReports License
Confirmation section, in the Authority Name box, update the name of the
person who can confirm the WebReports licensing for your authorization.

Notes

• You are not required to provide a licensed seats count in the Standalone
WebReports License Seats box.
• The Standalone WebReports License Confirmation section only
appears if there is a positive value for the Licensed Seats parameter.
3. Click Save Changes.

3.2 Install the Requests.js Library

The Install Requests.js Library page allows you to install the requests.js library
and associated files to the following JavaScript library location: /img/webreports/
library/

When the Install Requests.js Library page loads it is pre-populated with default
values.

3.2.1 To Install the Requests.js Library

To install the request.js library:

1. In the WebReports Administration section of the Content Server

Administration page, click the Install Requests.js Library link.
2. On the Install Requests.js Library page, provide the following values:

• URL Prefix Setting

Optional. If in doubt, accept the default settings for the current instance.

– If this is left blank, the installer will include JavaScript code to obtain the
values using information available in the URL during loading of the
requests.js file into the client.
– If you provide a value, the case of the value must match what a user
would type, or else it can cause problems with any requests that expect
specific responses. For example, if you provide /CS/cs.exe, using
uppercase CS, and a user tries to sign in with /cs/cs.exe, using
(lowercase cs), the sign in attempt will fail.

14 WebReports Administration Guide LLESWEBR230200-AGD-EN-01

 3.3. Manage Source Settings

• Support Directory Image Path

Optional. If no value is provided, the installer will include JavaScript code to
obtain the values using information available in the URL during loading of
the requests.js file into the client.
• Available Source Versions
Mandatory. Accept the default value, or select another version for the
requests.js library.

• Themes Location Path

Mandatory. Accept the default value, or enter another path to a themes
directory folder in your Content Server instance.
• Available Themes
Mandatory. Accept the default, pre-populated value, or select another theme
contained within the specified Themes Location Path.

3. Click Install.

3.3 Manage Source Settings

The Manage Source Settings page allows you to manage settings related to the
WebReports Source property tab.

Manage Source Settings

• FTP

Enable WebReports FTP Source

Optional. The WebReports FTP Source type is disabled by default, except on
systems that already contain at least one WebReport that uses FTP Source.
Select this check box to enable the FTP Source type, or clear the check box to
disable it. When disabled, users cannot configure WebReports to use an FTP
source. Any reports with an FTP source set will return an error when run.

• Category

Maximum Categories
Mandatory. Drag the slider or enter a number to determine how many
categories a user can select to report on.

Note: 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.

Attributes to Display
Mandatory. Drag the slider or enter the number of selectable attributes to
present on each row on the WebReports data source configuration page (not
in the report itself).

LLESWEBR230200-AGD-EN-01 OpenText™ Content Server 15

Chapter 3 Using the WebReports Administration Section

Delimiter Character
Mandatory. Enter the character used to separate multi-values that are
returned by a report.
Maximum Results
Mandatory. Drag the slider or enter a number to limit the results returned by
all reports using Category as a Data Source. Any results higher than that
number will be discarded.

Important
The WebReports module is installed with Content Server but not enabled by
default. It can be enabled according to your licensing agreement with
OpenText. If you have recently upgraded and WebReports features are not
available, you may need to enable the WebReports module. For more
information about how to enable WebReports, see “Enable WebReports”
on page 12. If WebReports features are not available after enabling the module,
please contact OpenText Customer Support.

3.3.1 To Manage the Source Settings

To manage the source settings:

1. In the WebReports Administration section of the Content Server

Administration page, click the Manage Source Settings link.

2. On the Manage Source Settings page, provide the information listed in Manage
Source Settings on page 15.

3. Click Save Changes.

3.4 Manage Destination Settings

The Manage Destination Settings page allows you to configure the settings related
to the WebReports Destination property tab.

• Email
Set the maximum character length for a destination email address.
• FTP
At the recommendation of OpenText Customer Support, configure the FTP
destination, logging, timeout, and command interval settings.
Enable WebReports FTP Destination
On a new system, FTP Destination is disabled by default. On an existing
system, FTP Destination is disabled unless there is at least one WebReport
with an FTP Destination set.
When disabled, users cannot configure WebReports to use an FTP
destination. Any reports with an FTP Destination set will return an error
when run.

16 WebReports Administration Guide LLESWEBR230200-AGD-EN-01

 3.4. Manage Destination Settings

FTP Log Enabled

When enabled, the FTP log is saved to the WRFTPDS_DEBUGLOG.txt file in the
Content Server logs folder.
FTP Timeout
Set the number of socket reads to make before timing out.
FTP Command Interval
Set the amount of time, in milliseconds, to pause between retrieving each line
during a socket read.

• Export Media Types

Add, edit, or delete the destination media types that a WebReport can use for
output. Any existing destination media types appear when the page is loaded.

3.4.1 To Manage Destination Settings

To manage destination settings:

1. In the WebReports Administration section of the Content Server

Administration page, click the Manage Destination Settings link

2. On the Manage Destination Settings page, do one or more of the following:

• To set the destination email address length, go to Step 3.

• To configure FTP options, go to Step 4.
• To manage media types, go to Step 5.

3. Optional In the Email area, move the Email slider to set the maximum character
length for a destination email address.

4. Optional In the FTP area, do one or more of the following:

• To enable FTP logging, select the FTP Log Enabled check box.
• To set the maximum time an FTP command will run before timing out,
move the FTP Timeout slider.
• To set the amount of time to wait before retrieving the next line during a
socket read, move the FTP Command Interval slider.

5. Optional In the Export Media Types section, do one or more of the following:

• To add a media type, on the last row, click the Add Row button , and, in
the text box, type the name of the new media type.
• To change the name of an existing media type, edit the name in the Media
Type box.
• To remove a media type, on the row for the media type that you want to
remove, click the Delete Row button .

LLESWEBR230200-AGD-EN-01 OpenText™ Content Server 17

Chapter 3 Using the WebReports Administration Section

6. Click Save Changes.

3.5 Manage Global Scripting Settings

You can manage WebReports scripting on the following Content Server
Administration pages:

• Manage Global Scripting Settings

Allows you to enable or disable OScript usage in both WebReports and
ActiveView. You can also define which packages and functions are allowed.
• Manage WebReports Containing Oscript
Allows you to enable or disable OScript in individual WebReports.

Notes

– OpenText recommends that you use a development instance of Content

Server to develop and test all reports containing OScript before adding
them to a production instance of Content Server.
– OScript is disabled by default for a WebReport unless it uses the default
reportview or if an Administrator adds a new version of the reportview.
It is the administrator’s responsibility to ensure that the reports are safe,
for example, avoiding infinite loops.
– A WebReport that contains disabled OScript will still run, but will return
an error.

3.5.1 To Manage Global Scripting Settings

To manage global scripting settings:

1. In the WebReports Administration section of the Content Server

Administration page, click the Manage Global Scripting Settings link.

2. Optional On the Manage Global Scripting Settings page, in the Global Scripting
Settings section, do one of the following:

• To enable OScript globally, in the Enable Globally area, select the Oscript
Enabled check box.
• In the Allowed Oscript Packages area, do one or more of the following:

– To remove an OScript package, on the row for the OScript package that
you want to remove, click the Delete Row button .
– To add an OScript package, on the last row, click the Add Row button
, and in the text box, type the name of the OScript package to be
added.
• In the Allowed Oscript Functions section, do one of the following:

18 WebReports Administration Guide LLESWEBR230200-AGD-EN-01

 3.6. Manage Secure Constants

– To remove an OScript function, on the row for the OScript function that
you want to remove, click the Delete Row button .
– To add an OScript function, on the last row, click the Add Row button
, and in the text box, type the name of the OScript function to be
added.

3. Click Save Changes.

3.5.2 To Manage WebReports that Contain OScript

To manage WebReports that contain OScript:

1. In the WebReports Administration section of the Content Server

Administration page, click the Manage WebReport Containing Oscript link.

2. Optional On the Manage WebReports Containing Oscript page, in the

WebReports Containing Oscript section, on the row for a WebReport that
contains OScript, do one of the following:

• To enable OScript for that WebReport, select the Oscript Enabled check box.
• To disable OScript for that WebReport, clear the Oscript Enabled check box.

3. Click Save Changes.

3.6 Manage Secure Constants

The Manage Secure Constants page allows you to define secure constants in the
system to store secret data that you can use with the
LL_WEBREPORT_RESTCLIENT tag in either a WebReport or an ActiveView.

• Name
Mandatory. Set the name for the secure constant.
• Value
Optional. Select the Change Value check box to enable the Value boxes to set and
confirm the secure constant value.

Notes

– Changes to this value are only saved if you select the Change Value
check box.
– This value is saved to the secrets repository that is FedRAMP-complioant.
• Description
Optional. Enter a description of the secure constant.
• WebReports and ActiveViews that can use the secure constant
Optional. Specify one or more WebReports or ActiveViews that can use the
secure constant.

LLESWEBR230200-AGD-EN-01 OpenText™ Content Server 19

Chapter 3 Using the WebReports Administration Section

3.6.1 To Add a Secure Constant

To add a secure constant:

1. In the WebReports Administration section of the Content Server

Administration page, click the Manage Secure Constants link.

2. On the Manage Secure Constants page, do one of the following:

• To add a first secure constant, do the following:

a. In the Name box, set the name of the secure constant.

b. In the Value column, select the Change Value check box.

c. In the Enter Value box, enter the value for the secure constant.

d. In the Verify Value box, re-enter the value for the secure constant.

e. (Optional) In the Description box, enter a description of the constant.

f. In the Node box, click the Select WebReport or ActiveView button and
browse to a WebReport or an ActiveView that can use the secure
constant.

g. To add another node, repeat Step f.

h. Go to 3.

• To add another secure constant, on the row for the previous secure constant,
in the Actions column, click the Add secure constant button .

• To edit a secure constant, on the row for the secure constant that you want to
edit, do one or more of the following:

– To edit the Name or Description, enter your changes.

– To change the value of the secure constant, select the Change Value
check box and enter the new values in both the Enter Value box and the
Verify Value box.

– To add another node, click the Add node button , then click the Select
WebReport or ActiveView button and browse to a WebReport or an
ActiveView that can use the secure constant.

– To delete a node, in the Node Actions column, click the Delete node
button .
• To delete a secure constant, on the row for the secure constant that you want
to remove, go to the Actions column and click the Delete secure constant
button .

3. Click Save Changes.

20 WebReports Administration Guide LLESWEBR230200-AGD-EN-01

 3.7. Manage Tags and Sub-Tags

3.7 Manage Tags and Sub-Tags

The Manage Tags and Sub-Tags page allows you to selectively show and hide
enabled WebReports tags and sub-tags.

Notes

• You must restart Content Server after you make changes on this page.
• Disabled tags can no longer be added to a WebReport or an ActiveView
template.
• Any existing reports that use a disabled tag or sub-tag will not process that
tag or sub-tag.

3.7.1 To Manage Tags and Sub-Tags

To manage tags and sub-tags:

1. In the WebReports Administration section of the Content Server

Administration page, click the Manage Tags and Sub-Tags link.

2. Optional Scroll through the Tag list and perform one or more of the following:

• In the Disabled Tags column, click the row for any tag that you want to
enable and then click the Add button or click Add All to enable all tags.
• In the Enabled Tags column, click the row for any tag that you want to
disable and then click the Remove button or click Remove All to disable all
tags.

3. Optional Scroll through the Sub-Tag list and perform one or more of the
following:

• In the Disabled Sub-Tags column, click the row for any sub-tag that you
want to enable and then click the Add button or click Add All to enable all
sub-tags.
• In the Enabled Sub-Tags column, click the row for any sub-tag that you
want to disable and then click the Remove button or click Remove All to
disable all sub-tags.

4. Click Save Changes.

5. Restart Content Server services to ensure that your changes take effect.

LLESWEBR230200-AGD-EN-01 OpenText™ Content Server 21

Chapter 3 Using the WebReports Administration Section

3.8 Manage Trusted Files

The Manage Trusted Files page allows you to configure a set of trusted external
files that WebReports can use.

• Trusted External Files for Data Sources

This is a whitelist of external file paths that are approved for use as a data source
for a WebReport. At runtime, the resolved value of the file path stored on the
Source tab of a WebReport is validated against this whitelist. If the requested
source file path does not match any entries in this list, the WebReport will return
an error message and will not execute.
• Trusted File Paths for Server Export Destination
This is a whitelist of external files that are approved for use as an export
destination for a WebReport. At runtime, the resolved value of the file path
stored on the Destination tab of a WebReport is validated against this whitelist.
The Server Export Destination feature in WebReports requires that the requested
destination file path must be included in this whitelist. The WebReport will only
execute if the requested destination file path matches an entry in this list. If the
requested destination file path does not match an entry in this list, the
WebReport will return an error message and will not execute.

Notes

• For security purposes, do not add C:* as a valid file path to either whitelist,
as that would make system files available as data sources or as destinations.
• To use an External File as a data source or a destination of a WebReport, the
file path must be included in the appropriate whitelist.

Consider the following criteria for valid file path entries in the whitelists:

• You can enter filename paths as a comma-separated list or as one path on each
line.
• To minimize the number of entries required, use of the asterisk (“*”) wildcard
character in the path.
• Matching is case-sensitive.
• Some examples of valid file paths include the following:

– C:\WRSourceData\mySourceFile.csv – a path directly to the file.

– C:\WRSourceData\mySource* – any file within C:\WRSourceData whose file
name begins with mySource will be allowed.
– C:\WRSourceData\* – any file path pointing to C:\WRSourceData\ and its
descendent directories will be allowed.
– C:\WRSourceData* – any file within C:\ whose name begins with
WRSourceData, or whose file path begins with WRSourceData will be allowed.
For example, C:\WRSourceData\mySourceFile.csv and C:
\WRSourceData22\myOtherFile.csv would be allowed.

22 WebReports Administration Guide LLESWEBR230200-AGD-EN-01

 3.8. Manage Trusted Files

3.8.1 To Add an External File to the Trusted External Files for

Data Sources List
To add an external file to the Trusted External Files for Data Sources list:

1. In the WebReports Administration section of the Content Server

Administration page, click the Manage Trusted Files link.

2. On the Manage Trusted Files page, in the Trusted External Files for Data
Sources box, enter a filename path for the external file that you want to add.

Important
For security purposes, do not add C:* as a valid file path to this whitelist,
as that would make system files available to be used as a data source.

Notes

• You can enter filename paths as a comma-separated list or as one path

on each line.
• To minimize the number of entries required, use of the asterisk (“*”)
wildcard character in the path.
• Matching is case-sensitive.
• Some examples of valid file paths include the following:

– C:\WRSourceData\mySourceFile.csv – a path directly to the file.

– C:\WRSourceData\mySource* – any file within C:\WRSourceData
whose file name begins with mySource will be allowed.
– C:\WRSourceData\* – any file path pointing to C:\WRSourceData\
and its descendent directories will be allowed.
– C:\WRSourceData* – any file within C:\ whose name begins with
WRSourceData, or whose file path begins with WRSourceData will be
allowed. For example, C:\WRSourceData\mySourceFile.csv and C:
\WRSourceData22\myOtherFile.csv would be allowed.

3. Click Apply.

LLESWEBR230200-AGD-EN-01 OpenText™ Content Server 23

Chapter 3 Using the WebReports Administration Section

3.8.2 To Add a Path to the Trusted File Paths for Server

Export Destination List
To add a path to the Trusted File Paths for Server Export Destination list:

1. In the WebReports Administration section of the Content Server

Administration page, click the Manage Trusted Files link.

2. On the Manage Trusted Files page, in the Trusted File Paths for Server Export
Destination box, add a trusted destination file path.

Important
For security purposes, do not add C:* as a valid file path to this whitelist,
as that would make system files available to be used as a destination.

Notes

• You can enter filename paths as a comma-separated list or as one path

on each line.
• To minimize the number of entries required, use of the asterisk (“*”)
wildcard character in the path.
• Matching is case-sensitive.
• Some examples of valid file paths include the following:

– C:\WRSourceData\mySourceFile.csv – a path directly to the file.

– C:\WRSourceData\mySource* – any file within C:\WRSourceData
whose file name begins with mySource will be allowed.
– C:\WRSourceData\* – any file path pointing to C:\WRSourceData\
and its descendent directories will be allowed.
– C:\WRSourceData* – any file within C:\ whose name begins with
WRSourceData, or whose file path begins with WRSourceData will be
allowed. For example, C:\WRSourceData\mySourceFile.csv and C:
\WRSourceData22\myOtherFile.csv would be allowed.

3. Click Apply.

24 WebReports Administration Guide LLESWEBR230200-AGD-EN-01

 3.9. Manage User/Group WR Triggers

3.9 Manage User/Group WR Triggers

Similar to “Manage WR Triggers” on page 36, the User / Group WR Trigger
feature allows events occurring within Content Server and pertaining to users and
groups to trigger a WebReport. To use this feature, you must select the Enable
User / Group WR Trigger check box. The administration settings allow you to select
different Content Server users or groups. For selected users or groups, you can select
one or more trigger events by adding rows as needed. The Inheritance list selection
allows you to specify whether the scope applies to either Direct Members, or Direct
and Indirect Members. When the selected trigger event occurs for any of the selected
users or groups, the specified WebReport will run.

Important

• The WebReports module is installed with Content Server but not enabled
by default. It can be enabled according to your licensing agreement with
OpenText. If you have recently upgraded and WebReports features are not
available, you may need to enable the WebReports module. For more
information about how to enable WebReports, see “Enable WebReports”
on page 12. If WebReports features are not available after enabling the
module, please contact OpenText Customer Support.
• If you have enabled WebReports and you still cannot see the Manage
Source Settings link, please restart Content Server.

3.9.1 To Enable a User/Group WR Trigger

To enable a user/group WR trigger:

1. In the WebReports Administration section of the Content Server

Administration page, click the Manage User / Group WR Triggers link.

2. On the Manage User / Group WR Triggers page, select the Enable User /
Group WR Triggers check box.

3. In the Enable User / Group WR Triggers: table, in the User / Group column,
click the here link to add an individual User Group WR event that will trigger a
WebReport and then perform the following steps:

a. To apply the trigger to one or more specific users or groups, do one of the
following:

• In the User / Group column, click the Choose User or Group button
to select the user or group.
• In the Global column, select the check box to specify all users and
groups.
b. In the Trigger Event column, on the list, select the event that will trigger
the WebReport. You have the option to click Select All to choose all the
trigger events available.

LLESWEBR230200-AGD-EN-01 OpenText™ Content Server 25

Chapter 3 Using the WebReports Administration Section

c. In the Inheritance list, select either Direct Members or Direct and Indirect
Members.
d. In the WebReport Action column, click Browse Content Server and select
the WebReport to run for the current trigger condition.
e. Optional The +/- column allows you to do one of the following:

• Click the Add Row button to add a new row for another trigger
event.
• Click the Delete Row button to delete the current row and trigger
event.

4. Click Apply.

3.10 Manage WebReports Containing Oscript

The Manage WebReports Containing Oscript page allows you to review and
approve all WebReports that include Oscript sections. Select or clear the Oscript
Enabled check boxes to enable or disable the Oscript in each WebReport.
WebReports containing disabled Oscript will return an error when run.

Notes

• By default, Oscript is only enabled for a WebReport if a System

Administrator added the reportview version, or if Oscript is present in the
default reportview. For more information about default reportviews, see
“Default Reportviews” on page 44. For more information about creating a
custom reportview, see OpenText Content Server - WebReports User Guide
(LLESWEBR-UGD).
• To manage global Oscript settings that affect all WebReports, use the
Manage Global Scripting Settings page.

3.10.1 To Manage WebReports Containing Oscript

To manage WebReports containing Oscript:

1. In the WebReports Administration section of the Content Server

Administration page, click the Manage WebReports Containing Oscript link

2. On the Manage WebReports Containing Oscript page, do one or more of the

following:

• To enable a WebReport that contains Oscript, go to the row for the

WebReport and select the Oscript Enabled check box.
• To disable a WebReport that contains Oscript, go to the row for the
WebReport and clear the Oscript Enabled check box.

Tip: To manage global Oscript settings that affect all WebReports, use the
Manage Global Scripting Settings page.

26 WebReports Administration Guide LLESWEBR230200-AGD-EN-01

 3.11. Manage WebReports Conversion

3. Click Save Changes.

3.11 Manage WebReports Conversion

Several of the WebReports destinations support document conversion. While it is
common to convert a WebReport to a PDF-formatted report, WebReports supports
any conversion provided by the external engine. The supported destinations include
the following:

• Email
• Content Server Node
• Content Server Version
• Server
• Workflow (as an attachment)

If you want to use the external conversion feature, you must configure options on
the Manage WebReports Conversion page, which can be found in the WebReports
Administration section of the Content Server Administration page.

The Manage WebReports 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 other formats.

To convert a WebReport, use the Manage WebReports Conversion page to define

an input folder, an output folder, and the target format, and to set the conversion
tool to monitor the input folder. Upon finding a file in the input folder, the tool
should render the reportview in the defined format, and then deliver the format to
the output folder and delete the input file.

3.11.1 Configuring the Conversion Agent

By default, the WebReports conversion agent is configured to run every 300 seconds,
or five minutes. If you want the agent to run more frequently, you can configure it to
run as often as every 60 seconds. You can set the frequency on the Manage
WebReports Conversion page, in the Converson Agent Sleep Interval area.

3.11.2 Adlib eXpress Job Ticket Conversion

WebReports provides full support for Adlib eXpress Job Tickets. On the Manage
Conversion Directories page, if conversion is enabled, you must specify the Input
Directory and Output Directory.

If you want to enable XML Job Tickets, select the Check this box if you would like
to use XML Job Tickets... check box, and then you have the option to provide
detailed processing directives using 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 providing their own processing instructions. For more
information about XML Job Tickets, see the Adlib website (https://www.
adlibsoftware.com).

LLESWEBR230200-AGD-EN-01 OpenText™ Content Server 27

Chapter 3 Using the WebReports Administration Section

If you enable the use of XML Job Tickets, you have the option to specify two
additional conversion directories:

• Input Directory (when using XML Job Tickets), which should contain the
WebReports intended for conversion.
• Output Directory (when using XML Job Tickets), which will contain the
converted WebReports.

Notes

• For conversion to be enabled, you must specify the first set of Input and
Output conversion directories. If you enable XML Job Tickets, you have the
option to specify additional XML Job Ticket Input and Output directories.
These are useful for servers running multiple instances of Content Server
using different conversion methods. Current versions of Adlib eXpress
support either conversion with Job Tickets or conversion without Job Tickets,
not both simultaneously.
• If you are only using XML Job Ticket conversion, you must provide paths for
the following fields:

– Input Directory (when using XML Job Tickets)

– Output Directory (when using XML Job Tickets)
• If you are using both XML Job Tickets and standard conversion, you must
first specify the standard conversion directories and then specify the XML
Job Ticket directories.
• The values entered on this page will be used to replace occurrences of
$DEFAULT_PATH specified in the Job Ticket itself.
• For information about a basic example of a Job Ticket, see My Support
(https://knowledge.opentext.com/knowledge/cs.dll/Properties/62285007).

3.11.3 Technical Notes on External Conversion

The following factors that may affect the External conversion:

• WebReports uses the Content Server cache to determine the destination for each
converted file. Since any cache has a finite life, it is possible, although unlikely,
for converted files to be in the output folder that relates to an expired cache. For
example, if you are exporting and converting on a system with disabled agents
on all servers, the backlog of files will not be cleared unless there is a valid record
in the current cache. In this case WebReports has lost the destination location and
will not know where to send the files. Cache expiry is set to 120 minutes, by
default, but can be increased as required. If the cache expires, the job cannot
complete and you should delete or manually process the converted document as
required.
• Content Server agents are used to look at the output folder and check for a
converted file every five minutes. This means agents must be enabled for
conversion to function.

28 WebReports Administration Guide LLESWEBR230200-AGD-EN-01

 3.11. Manage WebReports Conversion

• The amount of time it takes for a file to appear in the export destination may
vary, depending on the system, from nearly instantaneous to 30 minutes.
Influencing factors include the following:

– When a file is written to the input folder

– How often the conversion tool checks the input folder

– How long to perform the conversion

– When this hits in the cycle of the five-minute agent

• You can specify the folders at a network location as a UNC. For example: \\192.
168.255.20\disk1\PDF Conversion\input

• In a Content Server clustered environment, you must define the directories as

follows:

– Define the input directory on every instance in the cluster because an export
may come from any instance in a cluster.

– Define the output folder on the instance that is running the WebReports
conversion agent because that instance is the only one that monitors the output
folder.

Note: It is, however, good practice to specify the output folder on all
instances of Content Server in the cluster.

3.11.4 To Configure an External Conversion Task

To configure an external conversion task:

1. Configure an external conversion engine, such as Adlib eXpress, to do the

following:

a. Watch an input folder for new files that need conversion.

b. Store the converted documents in a specific output folder.

c. Delete the source file from the input folder.

d. Rather than appending the new file extension onto the old one, replace the
source type file extension, for example .html, .doc or .xls, with the
destination file extension, for example .pdf.

2. In the WebReports Administration section of the Content Server

Administration page, click the Manage WebReports Conversion link.

3. On the Manage WebReports Conversion page, in the Conversion Agent

Timings area, in the Conversion Agent Sleep Interval box, enter a value (in
seconds) for the interval the conversion engine should wait before checking the
input folder.

LLESWEBR230200-AGD-EN-01 OpenText™ Content Server 29

Chapter 3 Using the WebReports Administration Section

Notes

• This interval contributes to the amount of time it takes for the converted
file to appear in the destination folder.
• The default setting is 300 seconds, or five minutes.
4. In the Directories area, do the following:

a. In the Input box, specify the path of the input folder.

b. In the Output box, specify the path of the output folder.

Important
The operating system account that runs the Content Server service
must have permission to write a file to the input folder and to delete a
file from the output folder.
5. Optional To configure Adlib eXpress Job Ticket conversion, in the Job Tickets
area, select the Use Adlib XML Job Tickets check box and provide the
following mandatory directories:

a. In the Input Directory box, enter the XML Job Ticket input directory to use
when files are converted using XML Job Tickets.
b. In the Output Directory box, enter the XML Job Ticket output directory to
use when files are converted using XML Job Tickets.
6. Click Save Changes.
7. If you have changed the Conversion Agent Sleep Interval or any of the Input
or Output directory paths, restart Content Server.

3.12 WebReports Schedules

On the Properties > Destination tab for a WebReport, developers, or users with
Reserve permission, can set that WebReport to run automatically at scheduled times,
or for a fixed number of times, or forever, starting from a specific date and time. The
interval between repeated WebReport runs can range from five minutes to 520
weeks. Each user can set one schedule per WebReport. Scheduled WebReports run
in the background and output their results to a Content Server document node or to
an email.

The WebReports scheduling agent schedules the execution of WebReports nodes.

On the WebReports Administration > Manage WebReports Schedules page, you
can set the scheduling agent sleep interval. By default, the WebReports Scheduling
Agent Sleep Interval is set to run every 300 seconds, or five minutes. If you want to
execute a WebReport more frequently, the interval can be shortened to a minimum
of 60 seconds.

Notes

• Multiple users can use the scheduling agent to set multiple schedules on the
same WebReport.

30 WebReports Administration Guide LLESWEBR230200-AGD-EN-01

 3.12. WebReports Schedules

• After setting new values for an agent with a new values, you must restart
Content Server.

If any Scheduling Agent Sleep Interval is less than 300 seconds, on the Properties >
Destination tab for that WebReport, you can manually enter a Minutes value for the
scheduled report. This allows for more granular control of how often the WebReport
will run.

For example, to configure a WebReport to run every two minutes, set the
Scheduling Agent Sleep Interval to 120 seconds. Save the change and restart
Content Server. On the Properties > Destination tab for that WebReport, select the
appropriate destination, select the Set Schedule check box, and then click the Enter
Minutes (0-59) option. Now that the Minutes box has become a text box, enter the
value of 2 to have the WebReport execute every two minutes.

3.12.1 Configuring Change Agents for WebReports Scheduling

Although Content Server notifications are optional for WebReports scheduling, you
must enable Change Agents on your Content Server instance. By default, Change
Agents are enabled in the [options] section of the opentext.ini file for at least
one instance of Content Server will contain EnableAgents=TRUE.

If you are unsure about how to configure Change Agents for your particular
Content Server instance, please contact OpenText Support.

3.12.2 Database Schema

Installation or upgrade of the WebReports module, creates the following Content
Server database tables:

• The WEBREPORTS table stores WebReports schedule information. This table has
two column keys: USERID and NODEID, where NODEID is the node ID of the
WebReport.
• An additional table called WEBREPORTSTATS is created when the module is
installed or upgraded.

3.12.3 To Configure the Scheduling Agent

To configure the scheduling agent:

1. In the WebReports Administration section of the Content Server

Administration page, click the Manage WebReports Schedules link.

2. On the Manage WebReports Schedules page, in the Scheduling Agent Timing

area, in the Scheduling Agent Sleep Interval box, enter the amount of time (in
seconds) that the agent should wait between executions.

3. Click Save Changes.

4. Restart Content Server.

LLESWEBR230200-AGD-EN-01 OpenText™ Content Server 31

Chapter 3 Using the WebReports Administration Section

5. Optional If you have set the Sleep Interval to a value less than 300, you must
access the Properties page for the WebReport and do the following:

a. Click the Destination tab.

b. In the Output Destination list, select one of the following destinations that
support scheduling:

• Content Server
• E-mail
• Server
• Workflow
• Form
• FTP
c. Select the Set Schedule check box.
d. In the Every area, click the Enter Minutes (0-59) option.
e. In the Minutes box, enter the amount of time (in minutes) that defines the
repeat interval on which WebReports will run. For example, if you entered
120 in the Scheduling Agent Sleep Interval box, enter 2 in the Minutes box
to have the WebReport execute every two minutes.
f. Click Update or Apply.

3.12.4 To Manage Schedules

To manage schedules:

1. In the WebReports Administration section of the Content Server

Administration page, click the Manage WebReports Schedules link.

2. Optional On the Manage WebReports Schedules page, each row in the table lists
a schedule set by one user for one WebReport. For each schedule, you can do
one or more of the following:

• Disable the schedule by clearing the Enabled check box. This will retain the
schedule information, but the report will not run until a user or
administrator re-enables the report.
• Enable or re-enable a disabled schedule by selecting the Enabled check box.
• Delete a schedule by selecting the Delete Schedule check box.

Note: Content Server automatically deletes a schedule if the user that

created the schedule is deleted or if the WebReport itself is deleted.

3. Click Save Changes.

32 WebReports Administration Guide LLESWEBR230200-AGD-EN-01

 3.13. Manage WebReports Search Integration

3.13 Manage WebReports Search Integration

The Search Query Integration feature allows you to create a custom search button on
the Advanced Search screen. If a user clicks the custom search button, it launches a
WebReport to which the user has permission. If the user has permission for multiple
WebReports, clicking the custom search button will prompt the user to select a
specific WebReport from the list of WebReports to which they have permission.

To make use of the Search Query Integration feature, you should also do the
following:

• For one or more WebReports, on the Properties page, on the Source tab, set the
data source type to Search Query Launch.
• For each WebReport with a Search Query Launch data source type, set the
permissions so that only appropriate users can have access.

Technical Notes on Search Query Integration

If you are using multiple instances of Content Server, please note the following
considerations:

• The enable option is server-specific and is stored in the opentext.ini file. You
can use this file to restrict Search Query Integration to a specific Content Server
instance.
Conversely, if you require the same behavior for all servers in a cluster, you must
enable the feature and set the button text for all servers in the cluster. You could
achieve this by copying the same opentext.ini file to each server.
• On the Manage WebReports Search Integration page, the WebReports With
Data Source Set to Search Launch list is only editable when:

– The Search Query Integration feature is enabled.

– You have set at least one WebReports' data source type to Search Query
Launch.
• Activating or deactivating an individual WebReport takes effect system-wide. A
disabled WebReport is unavailable on any Content Server instance.

3.13.1 To Enable Search Query Integration

To enable search query integration:

1. In the WebReports Administration section of the Content Server

Administration page, click the Manage WebReports Search Integration link.
2. On the Manage WebReports Search Integration page, in the Search Query
Launch Settingsarea, do the following:

a. Select the Enable integration with the Advanced Search page check box.
b. In the Button Title box, enter an appropriate name for the custom search
button.

LLESWEBR230200-AGD-EN-01 OpenText™ Content Server 33

Chapter 3 Using the WebReports Administration Section

3. In the Configuration area, do the following:

a. In the Search Slice box, enter a positive integer to set the number of results
retrieved for each call of the search API.
Changing this setting will impact the performance of WebReports that use
search as a data source. In general, this setting should only be altered upon
advice from OpenText Support. The default is 300.
b. In the Search Hard Limit box, enter a positive integer to set the maximum
limit on the number of results that any WebReport using search as a data
source can return. The default is 50 000.
c. Optional To add extra debug information in the thread log when executing
WebReports using search as a data source, select the Search Debug
Enabled check box.
4. Optional To make optimal columns available to webreports that use search as a
data source, in the Additional Search Columns section, on the last row, click
the Add Row button and do the following:

Note: The default columns available are “shortOTSummary” and

“OTSummary”. Possible column values include: OTHotWords,
parentRecord, and Score.

a. In the Search Column Name box, enter the name of the column that will be
returned by the search.
b. In the Output Name box, enter the name of the column as it will appear in
the output.
5. Click Save Changes.
6. If you have changed the Enable integration with the Advanced Search page or
the Button Title parameters, restart the Content Server service.

3.13.2 To Activate or Deactivate a Search Query Launch

WebReport
To activate or deactivate a Search Query Launch WebReport:

1. In the WebReports Administration section of the Content Server

Administration page, click the Manage WebReports Search Integration link.
2. On the Manage WebReports Search Integration page, in the WebReports With
Data Source Set to Search Query Launch list, on the row for the Search Query
Integration WebReport that you want to activate or deactivate, do one of the
following:

• To activate the WebReport, select the Active check box.

• To deactivate the WebReport, clear the Active check box.

Note: The WebReports With Data Source Set to Search Query Launch
list is only editable when Search Integration is enabled and you have set at

34 WebReports Administration Guide LLESWEBR230200-AGD-EN-01

 3.14. Managing WebReports Services

least one WebReport's data source type to Search Query Launch. For
information about how to enable Search Integration, see “To Enable Search
Query Integration” on page 33.

3. Click Save Changes.

3.14 Managing WebReports Services

The Manage WebReports Services page allows you to manage access to
WebReports Services by the following restriction levels:

• Disable the WebReports Services feature.

• Restrict a tag or sub-tag from use by WebReports Services.
• Require a secure token for a tag or sub-tag with special security considerations
for use by WebReports Services.

Important

• The WebReports module is installed with Content Server but not enabled
by default. It can be enabled according to your licensing agreement with
OpenText. If you have recently upgraded and WebReports features are not
available, you may need to enable the WebReports module. For more
information about how to enable WebReports, see “Enable WebReports”
on page 12. If WebReports features are not available after enabling the
module, please contact OpenText Customer Support.
• If you have enabled WebReports and you still cannot see the Manage
Source Settings link, please restart Content Server.

For more information about WebReports Services, see OpenText Content Server -
WebReports User Guide (LLESWEBR-UGD).

3.14.1 To Enable or Disable a WebReports Service

To enable or disable a WebReports service:

1. In the WebReports Administration section of the Content Server

Administration page, click the Manage WebReports Services link.

2. On the Manage WebReports Services page, configure one or more of the

following options:

WebReport Services
In the Enable / Disable WebReports Services area, select the Disable
WebReport Services Feature check box to disable WebReports Services and
clear the check box to enable it.
Restrict the use of a tag or sub-tag by WebReports Services
In the Restricted Services area, do one of the following:

LLESWEBR230200-AGD-EN-01 OpenText™ Content Server 35

Chapter 3 Using the WebReports Administration Section

• Restrict the use of one or more tags or sub-tags by moving them from
the Enabled Tags list to the Disabled Tags list.
In the Enabled Tags list, click to select one or more tags or sub-tags and
then click Add. To move all the tags or sub-tags, click Add All.
• To re-enable the use of one or more tags or sub-tags by moving them
from the Disabled Tags list to the Enabled Tags list.
In the Disabled Tags list, click to select one or more tags or sub-tags and
then click Remove. To move all the tags or sub-tags, click Remove All.

Note: Running a WebReport that contains a restricted tag or sub-tag

will generate an error message.
Require a secure token for the use of a tag or sub-tag
In the Secure Services Sub-tags area, do one of the following:

• Require a secure token for the use of one or more tags or sub-tags by
moving them from the Not Secure list to the Secure list.
In the Not Secure list, click to select one or more tags or sub-tags and
then click Add. To secure all the tags or sub-tags, click Add All.
• To release one or more tags or sub-tags from the secure token
requirement by moving them from the Secure list to the Not Secure list.
In the Secure list, click to select one or more tags or sub-tags and then
click Remove. To move all the tags or sub-tags, click Remove All.

Note: Running a WebReport that contains a secure services tag or sub-

tag without providing a secure token will generate an error message.

3. Click Save Changes.

3.15 Manage WR Triggers

The WR Triggers feature allows events occurring within Content Server to trigger a
WebReport. You can use the Manage WR Triggers page to set which node types
work with WR Trigger. You can also set Maintain WR Trigger data on copy for a
node, to specify that all WR Trigger data applied to the node will be copied when
that node is copied.

If you enable WR Triggers for a node type, the WR Trigger Properties tab will
appear for all nodes of that type. If you disable WR Triggers for a node type, no
code associated with WebReports will execute for that node type and the WR
Triggers option will not appear in the function menu for that node. If you disable
WR Triggers for all node types, WR Triggers has no performance cost associated
with it.

Important

• The WebReports module is installed with Content Server but not enabled
by default. It can be enabled according to your licensing agreement with

36 WebReports Administration Guide LLESWEBR230200-AGD-EN-01

 3.16. WebReports Node Administration

OpenText. If you have recently upgraded and WebReports features are not
available, you may need to enable the WebReports module. For more
information about how to enable WebReports, see “Enable WebReports”
on page 12. If WebReports features are not available after enabling the
module, please contact OpenText Customer Support.
• If you have enabled WebReports and you still cannot see the Manage
Source Settings link, please restart Content Server.

3.15.1 To Manage WR Triggers

To manage WR triggers:

1. In the WebReports Administration section of the Content Server

Administration page, click the Manage WR Triggers link.

2. On the Manage WR Triggers page, do one or more of the following:

• To ensure that WR Trigger data is also copied when a node is copied, in the
Copy Settings area, select the Maintain WR Trigger data on copy check
box.
• To set which node types can have WR Triggers applied to them, in the Node
Types area, in the Available list of node types, click to select one or more
node types to which you want to apply WR Triggers and then click the Add
button. To select all node types, click the Add All button.
• To remove WR Triggers functionality from a node type, in the Selected list
of node types, click to select one or more node types from which you want to
remove WR Triggers and then click the Remove button. To select all node
types, click the Remove All button.

3. Click Save Changes.

3.16 WebReports Node Administration

Important

• The WebReports module is installed with Content Server but not enabled
by default. It can be enabled according to your licensing agreement with
OpenText. If you have recently upgraded and WebReports features are not
available, you may need to enable the WebReports module. For more
information about how to enable WebReports, see “Enable WebReports”
on page 12. If WebReports features are not available after enabling the
module, please contact OpenText Customer Support.
• If you have enabled WebReports and you still cannot see the Manage
Source Settings link, please restart Content Server.

The Node Administration page identifies any existing ActiveView or WebReports

nodes that use out-of-date or incorrect syntax.

LLESWEBR230200-AGD-EN-01 OpenText™ Content Server 37

Chapter 3 Using the WebReports Administration Section

To maintain functionality, use this page to update the selected nodes to use new
syntax that fixes known issues. Any nodes that continue to use out-of-date syntax
may not work as they did in previous releases. This page adds a new version to the
updated nodes. If the post-update results are not as expected, you can roll back the
update by deleting the new version on the Version property tab of each updated
node.

3.17 WebReports Sub-Tag Builder

The WebReports Sub-tag Builder page shows a list of custom sub-tags that have
been added to the system by being “dropped” into the subtags folder in the appData
directory: <Content Server_home>\appData\webreports\subtags on the server
where you installed Content Server. New or replacement sub-tags only take effect
after you restart Content Server.

Important

• The WebReports module is installed with Content Server but not enabled
by default. It can be enabled according to your licensing agreement with
OpenText. If you have recently upgraded and WebReports features are not
available, you may need to enable the WebReports module. For more
information about how to enable WebReports, see “Enable WebReports”
on page 12. If WebReports features are not available after enabling the
module, please contact OpenText Customer Support.
• If you have enabled WebReports and you still cannot see the Manage
Source Settings link, please restart Content Server.

Error messages will appear on the WebReports Sub-tag Builder page if one or more
sub-tags in the WebReports Ospace, or one or more sub-tags in the subtags folder,
are invalid and do not compile.

If your installation of WebReports has not been updated since loading the module
and you still see error messages on the WebReports Sub-tag Builder page, please
contact OpenText Support and inform them of these errors.

For information about custom sub-tags, see “Custom Sub-tags” on page 38.

3.18 Custom Sub-tags

38 WebReports Administration Guide LLESWEBR230200-AGD-EN-01

 3.18. Custom Sub-tags

Use ordinary text documents to create your own sub-tags and place them into a
folder on the server. This allows you to generate sub-tag features customized for
your needs that you can include in your WebReport reportview and use just like any
other sub-tag. There are no restrictions on what you can code in a custom sub-tag
because they are located on the server. This means that OScript packages that are
normally blocked for use in a WebReport reportview with server-side scripting are
available in a custom sub-tag. This results in a WebReports sub-tag that behaves just
like any other sub-tag that is packaged with WebReports. A sample custom sub-tag
called sample.txt is located in the <Content Server_home>\appData\webreports
\subtags folder on the server where you installed Content Server. Use this file as a
template to build new sub-tags and save them into the same folder. In addition,
there is an associated <Content Server_home>\appData\webreports\subtags\
sample.txt.json file that provides configuration for the sub-tag. This sample.txt.
json file is required for sub-tag functionality.

Notes

• To make the new custom sub-tags available, you must restart the Content
Server service.
• To test that your sub-tag code compiles correctly, use the Content Server
Administration > WebReports Administration > WebReports Sub-tag
Builder page. For more information, see “WebReports Sub-Tag Builder”
on page 38.

Example 3-1: Creating a custom sub-tag called ADDINTEGERS which

adds together the integers passed into the tag

1. Create a copy of the sample.txt file and rename it to addintegers.txt.

2. Create a copy of the sample.txt.json file and rename it to addintegers.
txt.json.

LLESWEBR230200-AGD-EN-01 OpenText™ Content Server 39

Chapter 3 Using the WebReports Administration Section

3. Replace the text in the addintegers.txt file with the following:

function Object Execute( \
List args = {} )

// Calling the "dataAs..." casting functions will operate on the data passed
to the sub-tag
// from any previous tags (.fData), provided the functions are not passed a
specific value to cast.
// For the [LL_REPTAG_'2' ADDINTEGERS:3:4 /] example this is operating on the
tag literal integer 2
// from [LL_REPTAG_'2'

Integer value1 = .dataAsInteger()

// Each tag argument separated by a colon is added to a list.

// For the [LL_REPTAG_'2' ADDINTEGERS:3:4 /] example the first argument, 3
would be accessible
// using args[1] as it is the first element in the args list
// The second argument, 4 would be accessible using args[2] as it is the
second element in the args list

Integer value2 = .dataAsInteger( args[1] )

Integer value3 = .dataAsInteger( args[2] )

if ( IsDefined( value1 ) && IsDefined( value2 ) )

.fData = value1 + value2

if ( IsDefined( value3 ) )

.fData += value3

end

else

return .SetError( 'ADDINTEGERS', 'Arguments must be valid integers',

1001 )

end

return this
end

This will create a custom sub-tag called ADDINTEGERS. The sub-tag takes
between one and two arguments and adds them to the value in the main
tag, returning the total. The code contains error handling, so if any of the
arguments are not integers, an error message will be returned instead of the
total.
4. Save the updated addintegers.txt file.

40 WebReports Administration Guide LLESWEBR230200-AGD-EN-01

 3.18. Custom Sub-tags

5. Replace the text in the addintegers.txt.json file with the following:

{
"fMinParms":1,
"fMaxParms":2,
"fShowInTagGuide":true,
"OverrideRule": "UPVERSION",
"Version": "1.0.1",
"Documentation":"<p>
Add the value of the main tag to the arguments passed in.
</p>
<br>
Examples:<br><br>

[LL_REPTAG_'2' ADDINTEGERS:3 /] returns 5.<br><br>

[LL_REPTAG_'2' ADDINTEGERS:3:4 /] returns 9.<br><br>

[LL_REPTAG_'x' ADDINTEGERS:'y' /] returns '* ADDINTEGERS: Arguments must be

valid integers *'.<br><br>
"
}

The keys in the JSON file are populated as follows:

• fMinParms is an integer defining the minimum number of arguments

that the sub-tag will accept. If less than the minimum arguments are
passed in, then an error will be returned.
• fMaxParms is an integer defining the maximum number of arguments
that the sub-tag will accept. If more than the maximum arguments are
passed in, then an error will be returned.
• fShowInTagGuide defines whether the sub-tag will appear in the online
Tag Guide. Can be set to TRUE or FALSE.
• OverrideRule defines the circumstances where the sub-tag will be
applied. It can have three values:

– UPVERSION: the custom sub-tag will only be added if it doesn't

already exist, or if there is already a version of the sub-tag in your
version of WebReports, then the custom sub-tag will take
precedence over the existing sub-tag only if the custom sub-tag has a
higher version number.
– NEWONLY: the custom sub-tag will only be added if it doesn't already
exist in your version of WebReports.
– ALWAYS: the custom sub-tag will always be applied, regardless of
whether or not it already exists in your version of WebReports.

Notes

• If a version field is present, the default is: UPVERSION , otherwise

ALWAYS.

• Documentation defines the text that will be displayed in the online

Tag Guide if fShowInTagGuide is set to TRUE.

LLESWEBR230200-AGD-EN-01 OpenText™ Content Server 41

Chapter 3 Using the WebReports Administration Section

6. Restart Content Server.

Example 3-2: Call the new custom sub-tag

Call the new custom sub-tag from any WebReport reportview as follows:

• [LL_REPTAG_'2' ADDINTEGERS:3 /] returns 5.

• [LL_REPTAG_'2' ADDINTEGERS:3:4 /] returns 9.
• [LL_REPTAG_'x' ADDINTEGERS:'y' /] returns “* ADDINTEGERS:
Arguments must be valid integers *”.

42 WebReports Administration Guide LLESWEBR230200-AGD-EN-01

Chapter 4
Content Server Functions Available for WebReports

In addition to the unique functions provided on the WebReports Administration

page, basic Content Server 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 Content Server documents. In particular, any
document administrative options, such as Administer Item Control, will also apply
to reportview files. For more information about these other Content Server
functions, see the following topics:

• “Enabling Content Server Functions for WebReports” on page 43

• “Setting Permissions for WebReports Users” on page 44
• “Accessing Content Server Logs” on page 46

Reportview files are fully indexed, allowing them to be located using the search
facility, though most users will not have read permissions. For more information
about reportviews, see the following topics:

• “Cached Views” on page 44

• “Default Reportviews” on page 44

For information about WebReports settings references in the OpenText.ini file, see
OpenText Content Server - Content Server Administration Guide (LLESWBA-AGD).

4.1 Enabling Content Server Functions for

WebReports
You can enable the following Content Server functions for WebReports through the
main Content Server administration page:

• Restrict the creation of WebReports to a selected user or group.

• Enable the standard Content Server events for WebReports.
• Store WebReports in the Content Server Report Volume.
• Export WebReports to email.

LLESWEBR230200-AGD-EN-01 OpenText™ Content Server 43

Chapter 4 Content Server Functions Available for WebReports

4.2 Cached Views

The first time that you run a WebReport, 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 at: <Content Server_home>/temp/
WRviews.

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

4.3 Default Reportviews

When you create a WebReport, you can either browse for a reportview on your
desktop or choose from a list of standard reportview templates in the Use a Default
Reportview list. These templates are stored as text files in Content Server in the
module directory for WebReports. For example, <Content Server_home>\module\
webreports\defaultreportviews\basic_report.txt

As an administrator, you can modify the template list by adding additional custom
reportviews to the appData directory. For more information about creating custom
reportviews, see OpenText Content Server - WebReports User Guide (LLESWEBR-UGD).

You might want to adapt or add new custom reportviews for the following reasons:

• To include standard corporate branding to reports.

• To provide specific export reportviews for exporting Content Server data to other
applications. For example, CSV or WordML.

For more information about the default reportviews provided with WebReports, see
OpenText Content Server - WebReports User Guide (LLESWEBR-UGD).

4.4 Setting Permissions for WebReports Users

Since running a WebReport combines aspects of running a report as well as
managing a document, there are some unique considerations for setting WebReports
permissions.

“WebReports Users Common Roles and Permission Settings” on page 45 indicates

the most common roles for WebReports users and their recommended permissions
settings.

44 WebReports Administration Guide LLESWEBR230200-AGD-EN-01

 4.4. Setting Permissions for WebReports Users

Table 4-1: WebReports Users Common Roles and Permission Settings

WebReports User Role Minimum Permissions Available Commands

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

In addition to permissions for the WebReport itself, any user running the
WebReport must also have See Contents permission for the associated data source,
which is specified when the WebReport is first created or later using the Properties:
Source page.

LLESWEBR230200-AGD-EN-01 OpenText™ Content Server 45

Chapter 4 Content Server Functions Available for WebReports

Developers with Reserve permission for a WebReport 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.

4.5 WebReports Preferences in the opentext.ini File

You can set a number of WebReports configuration preferences by editing the
opentext.ini file. For more information, see [xref to non-existent element "lleswba-
agd.wba-ini-webreports.rf"].

Notes

• Be cautious about making changes to settings in the opentext.ini file.

• After you make changes, you must restart Content Server.
• If you are unsure about a change, consult OpenText Support.

4.6 Accessing Content Server Logs

WebReports writes to the Content Server Thread Logs. Thread logging is disabled
by default in Content Server and must be enabled. For more information, see
OpenText Content Server - Content Server Administration Guide (LLESWBA-AGD).

46 WebReports Administration Guide LLESWEBR230200-AGD-EN-01

Chapter 5
Best Practices for WebReports Security Hardening

This section describes best practices for WebReports security hardening.

5.1 Preventing XSS-vulnerable Syntax

WebReports reportviews and ActiveView templates are built using a tag-based
syntax. These tags can be chained together to retrieve information or perform
various actions in the system. The Parameter data tag, [LL_REPTAG_&<parmName>/],
provides access to a parameter value in the request. For example: the [LL_REPTAG_&
sortDirection /] tag resolves to the value of the sortDirection parameter in the
request. This syntax is usually used to surface data from the request, either to pass to
additional WebReports (example: passing data to a Sub-WebReport) or to change
aspects of the current ActiveView override (example: changing the current page
size). The parameter values are resolved at runtime without any additional
validation occurring behind the scenes.

If left unvalidated, the Parameter tag can create Cross-Site Scriping (XSS)
vulnerabilities in a WebReports reportview or in an ActiveView template. For
example: if you place a Parameter tag inside an HTML input field or in a JavaScript
block, but the parameter is unvalidated, the resulting syntax could be vulnerable to
XSS. To illustrate, consider the following code:
<input type="hidden" name="count" value="[LL_REPTAG_&count /]">

In this case, the [LL_REPTAG_&count /] tag is replaced with the value of the count
parameter from the request. This syntax is vulnerable to XSS because the count
value is not validated. The count parameter value could contain HTML syntax to
terminate the HTML input field early and inject additional HTML tags, including a
<script> block.

As with any other web development, the users developing WebReports reportviews
and ActiveView templates are responsible for validating their Parameter tags
because they understand the context of how the parameter is used. The following
list includes several sub-tags that are available to help validate the passed values:

• CHECKURL – checks a URL for potential XSS vulnerable syntax.

Example: [LL_REPTAG_&nextURL CHECKURL:"" /]
• ESCAPEFORJS – converts a string using the same encoding as the specified
JavaScript escape function.
Example: [LL_REPTAG_&userName ESCAPEFORJS:HEX /]
• INT – attempts to cast the data to an Integer. This is useful if the parameter value
is expected to be an Integer.
Example: [LL_REPTAG_&count INT /]

LLESWEBR230200-AGD-EN-01 OpenText™ Content Server 47

Chapter 5 Best Practices for WebReports Security Hardening

• TODATE – attempts to cast the data to a Date.

Example: [LL_REPTAG_&startdate TODATE /] Supports custom date formats as
well.

The Tag Guide, available from the ActiveView Online Editor, provides a full listing
of the available sub-tags as well as full details for each sub-tag.

48 WebReports Administration Guide LLESWEBR230200-AGD-EN-01

Chapter 6
Configuring Content Intelligence Widgets

The WebReports module includes Content Intelligence widgets for use in Smart
View. For information about configuring widgets using Edit Page mode in Smart
View, see the Help available in Smart View. For information about creating
Perspectives, setting Perspective rules, and configuring widgets using the
Perspective Manager tool, see the Help available in the Perspective Manager. For
information about how to configure Content Intelligence widgets, see OpenText
Content Server - Widget Configuration Guide (CSAV-CWG).

LLESWEBR230200-AGD-EN-01 OpenText™ Content Server 49

 Part 2
WebReports Workflow Extensions
Administration
Chapter 7
WebReport Step Configuration

This section allows a workflow developer to configure the maximum number of

WebReports that can be selected in a WebReport step.

To configure this:

1. In the WebReports Workflow Extensions Administration section of the

Content Server Administration page, click the WebReport Step Configuration
link.

2. On the WebReport Step Configuration page, in the Maximum Number of

WebReports box, enter the maximum number of WebReports to be made
available to the WebReport Workflow step.

3. Click Save Changes.

LLESWEBR230200-AGD-EN-01 OpenText™ Content Server 53

Chapter 8
Show Workflow Maps

This page lists workflow maps that have the WebReports package enabled and that
have at least one WebReport attached.

LLESWEBR230200-AGD-EN-01 OpenText™ Content Server 55

 Part 3
Content Server Applications Administration
Chapter 9
Administering Content Server Applications

An application is a collection of Content Server nodes, support files, sub-tag files,

and properties files. The Content Server Applications Administration section of the
Content Server Administration page allows you to manage Content Server
applications.

LLESWEBR230200-AGD-EN-01 OpenText™ Content Server 59

Chapter 10
Applications Components

Installed applications will have a folder in the <Content Server_home>\appData\

webreports\csapps\csapplications directory on the server. Each application
folder can contain the following items:

manifest file
Details the Content Server nodes and support files that make up the application.
XML file
Contains an export of the Content Server nodes included in the application. If
the application does not contain any Content Server nodes, then it will not have
an XML file.
applicationfiles folder
Contains the application's support files. If the application does not contain any
application support files, then it will not have an applicationfiles folder.
Note: In older applications, this folder was named support.

supportcollateral folder
Contains the support files from other support paths on Content Server. If the
application does not contain such support files, then it will not have a
supportcollateral folder.

subtags folder
Contains the application's sub-tag drop-in files. If the application does not
contain sub-tag drop-in files, then it will not have a subtags folder.
properties folder
Contains the application's properties files. If the application does not contain
properties files, then it will not have a properties folder.

LLESWEBR230200-AGD-EN-01 OpenText™ Content Server 61

Chapter 11

Applications Management

The Content Server Administration > Content Server Applications Administration

> Applications Management page allows you to build, rebuild, install, upgrade,
uninstall, and delete Content Server applications. An application is a collection of
Content Server nodes, sub-tag files, and support assets consisting of support files
and properties files. You can also use the Applications Management page to define
a launch component or an initialization component for an existing Content Server
application.

Tip: Alternatively, you can reach the Applications Management page from
Enterprise > Applications Management.

The Applications Management page provides the following information:

• “Installed Content Server Applications” on page 63 lists details available for the
installed applications.

• “Installable Content Server Applications” on page 64 lists the details available

for the installable applications.

• “Available Actions” on page 64 lists the actions available for each application.

Installed Content Server Applications

Name Name of the application. Only alphanumeric characters (A-Z and 0-9) are
allowed. All non-alphanumeric characters, such as hyphens, underscores,
and spaces are not permitted.
Version Version of the application.
Description Description of the application.
Content Server Indicates that Content Server components have been installed for the
components application.
installed
Modified since Indicates that the application status has changed since it was installed.
installed
Unmodified Indicates that the application status is unchanged since it was installed.
since installed
Default launch Displays the default launch component for the application.
component
Available Lists the actions available for each application. For more information, see
actions “Available Actions” on page 64.

LLESWEBR230200-AGD-EN-01 OpenText™ Content Server 63

Chapter 11 Applications Management

Installable Content Server Applications

Name Name of the application. Only alphanumeric characters (A-Z and 0-9) are
allowed. All non-alphanumeric characters, such as hyphens, underscores,
and spaces are not permitted.
Version Version of the application.
Description Description of the application.
Contains Indicates that the application contains WebReports nodes and that no
WebReports application license is required.
nodes; No
application
license
required
WebReports Indicates that the application contains WebReports, but that WebReports
will be enabled is not enabled. WebReports will be automatically enabled if you install the
when this application.
application is
installed; No
application
license
required
Available Lists the actions available for each application. For more information, see
actions “Available Actions” on page 64.

Available Actions

Clean up For both installable and installed applications, opens the Clean Up
Application page where you can run the cleanup process to fix corrupt
applications. It completely removes the selected application and copies a
fresh version to staging for reinstallation. For more information, see
“Cleaning up a Content ServerApplication” on page 82.
Define special For installed applications, opens the Define Special Components page,
components which lists the WebReports that are part of the application. You can set a
WebReport as a launch component, an initialize component, and assign
nicknames. For more information, see “Defining Special Components for a
Content Server Application” on page 77.
Delete For installed applications, opens the Delete Application page where you
can delete the application. For more information, see “Uninstalling or
Deleting a Content ServerApplication” on page 80.
Download zip For installed applications, provides a button to download a ZIP file
file containing the selected application. For more information, see
“Downloading the Application ZIP File” on page 82.
Install For installable applications, opens the Install Application page, which
allows you to install the selected application. For more information, see
“Installing a Content Server Application” on page 75.

64 WebReports Administration Guide LLESWEBR230200-AGD-EN-01

 11.1. Building or Rebuilding a Content Server Application

Rebuild For installed applications, opens the Rebuild Application page, which
allows you to rebuild the application. For more information, see “Building
or Rebuilding a Content Server Application” on page 65.
Uninstall For installed applications, opens the Uninstall Application page where
you can uninstall the application. Uninstalled applications are moved to
the staging folder and can be reinstalled. For more information, see
“Uninstalling or Deleting a Content ServerApplication” on page 80.
Upgrade For installed applications, if a more recent version of the application is
available, opens the Upgrade Application page, which allows you to
upgrade the selected application. For more information, see “Upgrading a
Content Server Application” on page 78.
View For both installable and installed applications, opens the View
Application Application page, which provides more details about the application,
such as a list of the Content Server source objects. For more information,
see “Viewing a Content Server Application” on page 76.

11.1 Building or Rebuilding a Content Server

Application
The following table describes fields found in both the Build Application and the
Rebuild Application pages:

Field Name Mandatory? Description

Application Name Yes You must give your Content
Server application a name.
Only alphanumeric
characters (A-Z and 0-9) are
allowed. All non-
alphanumeric characters,
such as hyphens,
underscores, and spaces are
not allowed.
Application Description No You can optionally give your
Content Server application a
description.
Version Number Yes You must give your Content
Server application a version
number. For example, 1.0.

LLESWEBR230200-AGD-EN-01 OpenText™ Content Server 65

Chapter 11 Applications Management

Field Name Mandatory? Description

Content Server Source No You can optionally add
Objects Content Server nodes to your
application. In the Content
Server Source Objects box,
use the Browse For Source
Object button to browse to a
Content Server source object.
The Content Server source
object will be exported, and
will be imported into the
target system during the
installation process. If the
Content Server source object
is a container, all children of
the object will also be
included in the application.
Application Files No You can optionally add
application files to your
Content Server application.
Use the Browse button to
browse for files.

66 WebReports Administration Guide LLESWEBR230200-AGD-EN-01

 11.1. Building or Rebuilding a Content Server Application

Field Name Mandatory? Description

Support Paths No You can no longer define
Support Files or Support
Paths when you build a
Content Server application. If
your application uses any
bespoke support files that are
not in the Content Server
build, you must place those
files in the Support Asset
Volume > Support Asset
folder for your application.
You can access the support
files in the Support Asset
folder using the [LL_
REPTAG_SUPPORTASSETDIR
/] tag in an ActiveView
override or a WebReports
reportview.

Rebuilding an application
will update any WebReports
reportviews and ActiveView
overrides in the application
to use the [LL_REPTAG_
SUPPORTASSETDIR /] tag
instead of the [LL_REPTAG_
APPSUPPORTDIR /] tag. It
will also copy all the
application support files to
the application Support
Asset Folder in the Support
Asset Volume.

LLESWEBR230200-AGD-EN-01 OpenText™ Content Server 67

Chapter 11 Applications Management

Field Name Mandatory? Description

Sub-tags No You can optionally add sub-
tag files to your Content
Server application. In the
Sub-tags box, use the
Browse button to browse for
files. Each sub-tag should
consist of two files, a
subtagname.txt file and a
subtagname.txt.json
file. If the Tick to overwrite
the existing sub-tag if
present check box is selected,
then, when the application is
installed, the sub-tag files
attached to the application
will be used. If they already
exist on the system on which
the application is being
installed, the sub-tag files
attached to the application
will overwrite existing sub-
tags. If the box is cleared and
the sub-tag already exists on
the target system, then the
sub-tag files will not be
installed. If any sub-tags
attached to the application
are disabled on the target
system, they will be enabled
during the installation
process.

68 WebReports Administration Guide LLESWEBR230200-AGD-EN-01

 11.1. Building or Rebuilding a Content Server Application

Field Name Mandatory? Description

Module Dependencies No You can optionally add
module dependencies to
your Content Server
application. In the Module
Dependencies box, enter the
name of a module. For
example, if you type
WebReports in the Module
Name box, this will define
the name of a module that
must exist on the target
system before the application
can be installed. You can
enter the Version Number
and Update Number of the
module dependency. If any
module dependencies are
missing on the target system,
then an error will be thrown
when attempting to install
the application.
Tag / Sub-tag Dependencies No You can optionally add tag
or sub-tag dependencies to
your Content Server
application. In the Tag / Sub-
tag Dependencies box, enter
the name of a tag or sub-tag.
For example, LL_
WEBREPORT_INSERTJSON
or WFTASKINFO. This will
define the name of a
WebReports tag or sub-tag
that must exist on the target
system before the application
can be installed. If the tag or
sub-tag exists on the target
system but is disabled, then
it will be enabled during the
installation process. If the tag
or sub-tag is not found, then
an error will be thrown when
attempting to install the
application.

LLESWEBR230200-AGD-EN-01 OpenText™ Content Server 69

Chapter 11 Applications Management

Field Name Mandatory? Description

ActiveView Override Type No You can optionally add
Dependencies ActiveView override type
dependencies to your
Content Server application.
In the ActiveView Override
Type Dependencies box,
select an ActiveView
override type from the list.
For example, select Folder
Browse. This will define an
ActiveView override type
that must exist and be
enabled on the target system
before the application can be
installed. If the ActiveView
override type exists on the
target system but is disabled,
then it will be enabled during
the installation process. If the
ActiveView override type is
not found, then an error will
be thrown when attempting
to install the application.

70 WebReports Administration Guide LLESWEBR230200-AGD-EN-01

 11.1. Building or Rebuilding a Content Server Application

Field Name Mandatory? Description

INI Settings No You can optionally add INI
settings to your Content
Server application. These will
be added to the opentext.
ini file on the target system
during the installation
process. In the INI Settings
area, in the Section list, select
a section. For example, select
CSApps. Next, enter both a
Key and a Value. This will
define an INI Setting which
will be written to the
opentext.ini file.

For example, if you select:

• Section=CSApps
• Key=MyKey
• Value=x

MyKey=x will be added to

the [CSApps] section of the
opentext.ini file. If the
INI setting key already exists
on the target system, then its
value will be overwritten by
the application's value
during the installation
process.

LLESWEBR230200-AGD-EN-01 OpenText™ Content Server 71

Chapter 11 Applications Management

Field Name Mandatory? Description

Properties Files No You can no longer manually
add properties files when
you build a Content Server
application. If your
application uses any bespoke
properties files, you must
place those files in a
properties folder within the
Support Asset Volume >
Support Asset folder for your
application. You can access
the properties files in the
Support Asset folder using
the
APPPROPERTIES:<Applic
ationName> subtag in an
ActiveView template or a
WebReports reportview.

Rebuilding an application
will copy all of the
application properties files to
a properties folder within the
application Support Asset
Folder in the Support Asset
Volume.

When you build or rebuild a Content Server application, the following actions will
occur when you click Submit:

• When building a new Content Server application, a folder for the application will
be created in the <Content Server_home>\appData\webreports\csapps\
csapplications directory on the server.

• When rebuilding an existing Content Server application, the folder for the
application in the <Content Server_home>\appData\webreports\csapps\
csapplications directory on the server will be deleted and replaced with a new
version reflecting the entries on the Rebuild Application page.

• If the Content Server application contains application files, then they will be
copied to a folder in the support directory located at <Content Server_home>
\support\csapplications\<application_name>.

• If the Content Server application contains properties files, then they will be
copied to a folder in the support directory located at <Content Server_home>
\support\csapplications\<application_name>\properties.

• When rebuilding an existing Content Server application, the folder for the
application in the support directory on the server will be deleted, if it exists, and
replaced with a new version reflecting the entries on the Rebuild Application
page.

72 WebReports Administration Guide LLESWEBR230200-AGD-EN-01

 11.2. To Build or Rebuild a Content Server Application

Notes

• You can no longer define Support Files or Support Paths when you build a
Content Server application. If your application uses any bespoke support
files that are not in the Content Server build, you must place those files in the
Support Asset Volume > Support Asset folder for your application. You can
access the support files in the Support Asset folder using the [LL_REPTAG_
SUPPORTASSETDIR /] tag in an ActiveView template or a WebReports
reportview.
• You can no longer manually add properties files when you build a Content
Server application. If your application uses any bespoke properties files, you
must place those files in a properties folder within the Support Asset
Volume > Support Asset folder for your application. You can access the
properties files in the Support Asset folder using the
APPPROPERTIES:<ApplicationName> sub-tag in an ActiveView template or
a WebReports reportview.

11.2 To Build or Rebuild a Content Server Application

To build or rebuild a Content Server application:

1. In the Content Server Applications Administration section of the Content

Server Administration page, click the Applications Management link.

2. On the Applications Management page, do one of the following:

• To build a new Content Server application, click Build new application.

• To rebuild an existing Content Server application, on the row for the
application that you want to rebuild, choose Rebuild from the actions list.

Note: The Rebuild Application page for the application will be pre-
populated with data from the existing build of the application.

3. On the Build Application page or the Rebuild Application page, in the

Application Name box, enter, or change, the name of this Content Server
application. Application names must consist only of alphanumeric characters.

4. Optional In the Application Description box, enter or change the description of

this Content Server application.

5. In the Version Number box, enter, or change, the version number for this
Content Server application. For example, “1.0”.

6. Optional In the Content Server Source Objects box, click Browse For Source
Object, select a Content Server node to add to your Content Server application,
and then click the Add Row button to select multiple nodes.

Note: Place any application support files or properties files in a Support

Asset Folder for the application within the Support Asset Volume. Then
add the application Support Asset Folder as a Content Server Object.

LLESWEBR230200-AGD-EN-01 OpenText™ Content Server 73

Chapter 11 Applications Management

7. Optional To add one or more sub-tag files to your Content Server application, in
the Sub-tags area, do the following for each sub-tag:

a. Click Choose File and select a <subtagname>.txt file.

b. Click Choose File and select a <subtagname>.txt.json file.
c. Click the Add Row button .
d. Optional If you want to ensure that the sub-tag files attached to the Content
Server application overwrite any existing sub-tags, select the Tick to
overwrite the existing sub-tag if present check box.

Note: If you are rebuilding an existing Content Server application, any

sub-tags that are already present in the application will be listed in the
Existing Sub-tags area.
8. Optional To define the name of a module that must exist on the target system
before the Content Server application can be installed, in the Module
Dependencies area, add one or more module dependencies to your application:

a. In the Module Name box, enter the name of a module.

b. In the Version Number box, enter the version number of the module.
c. In the Update Number box, enter the update number of the module.
d. Click the Add Row button .
9. Optional In the Tag / Sub-tag Dependencies box, enter the name of one or more
tags or sub-tags to add to the dependencies to your Content Server application
and then click the Add Row button . For example, type LL_WEBREPORT_
INSERTJSON or WFTASKINFO.

Note: If the required tags or sub-tags are not found on the target system,
the Content Server application will not be installed.
10. Optional In the ActiveView Override Type Dependencies list, select one or more
ActiveView override type dependencies to add to your Content Server
application and then click the Add Row button .

Note: If the ActiveView override type(s) is not found on the target system,
the application will not be installed.
11. Optional In the INI Settings area, add one or more INI settings to your Content
Server application:

a. In the Section list, click an INI section selection.

b. In the Key box, enter a key name.
c. In the Value box, enter a value for the key.
d. Click the Add Row button .

Note: If the INI setting(s) already exist(s) on the target system, its/their
value will be overwritten by the Content Server application's value during
the installation process.

74 WebReports Administration Guide LLESWEBR230200-AGD-EN-01

 11.3. Installing a Content Server Application

12. Click Submit.

11.3 Installing a Content Server Application

When you install a Content Server application, the following actions will occur after
you click Submit:

1. When the Content Server application installs, WebReports will be enabled, if it

isn’t already enabled.
2. If the application contains Content Server nodes, the application XML files will
be imported, creating the Content Server nodes for the application in the
selected target container.
3. If the application contains support asset files, those files are copied to a folder for
the application within the Support Assets Volume.
4. Other actions are performed depending on the application definition. Use the
Preview option for more details.
5. The application manifest file and XML files are replaced with new versions. If
the application contains Content Server nodes, then the manifest file will contain
the node IDs that have been created on the target system.
6. The Content Server application folder is moved from <Content Server_home>
\appData\webreports\csapps\csapplicationsstaging to <Content
Server_home>\appData\webreports\csapps\csapplications.

11.3.1 To Install a Content Server Application

To install a Content Server application:

1. Copy the Content Server application folder to the <Content Server_home>

\appData\webreports\csapps\csapplicationsstaging directory on the
server.

2. In the Content Server Applications Administration section of the Content

Server Administration page, click the Applications Management link.

3. On the Applications Management page, in the Installable Content Server

Applications list, on the row for the Content Server application that you want
to install, choose Install from the actions list.

4. On the Install Application page, do one or more of the following and then click
Submit.

• If the Content Server application contains Content Server nodes, then the
form contains the Target Container box. To browse to a Content Server
source object where the Content Server nodes for the application will be
installed, click Browse For Container.
• To see details of actions that will be performed on the target system by the
installation process, click Preview.

LLESWEBR230200-AGD-EN-01 OpenText™ Content Server 75

Chapter 11 Applications Management

5. Click Submit.

11.4 Viewing a Content Server Application

For each Content Server application listed on the Applications Management page,
you can see more details about that application by choosing View Application from
the Available Actions list for that application.

The View Application page lists the following information about a Content Server
application.

Name Description
Application Name Name of the Content Server application.
Application Description Description of the Content Server
application.
Version Number Version of the Content Server application.
Content Server Source Objects Lists the Content Server nodes contained in
the Content Server application.
Support Files Lists the support files for the Content Server
application.
Support Paths Lists the support paths used by the Content
Server application.
Sub-tags Lists any WebReports sub-tags that are
included in the Content Server application.
Module Dependencies Lists any module dependencies by their
name, version number, and update number.
Tag / Sub-tag Dependencies Lists any tag and sub-tag dependencies.
ActiveView Override Type Dependencies Lists any ActiveView override type
dependencies.
INI Settings Lists any keys that the Content Server
application has written to the opentext.
ini file.
Properties Files Lists any properties files included in the
Content Server application.
Validate Source Code When Installing or Boolean for whether the source code must be
Upgrading Application validated when installing or upgrading.
Launch Component If defined, lists the WebReport that is set as
the Content Server application’s launch
component. The Applications Management
page will include a link to the launch
component for the application.

76 WebReports Administration Guide LLESWEBR230200-AGD-EN-01

 11.5. Defining Special Components for a Content Server Application

Name Description
Initialize Component If defined, lists the WebReport that is set as
the application’s initialize component that
will run when the Content Server application
is installed.

11.5 Defining Special Components for a Content

Server Application
In their actions list, installed Content Server applications have a Define special
components option that opens the Define special components page. This page lists
all the WebReports that are part of the Content Server application and can be used to
do the following:

• Define a default launch component for the application

An application can be launched using the URL: ?func=csapps.launchapp&
appname=<application_name>. Calling this URL will run the WebReport
defined as the default launch component.
• Define an initialize component for the application
A WebReport defined as the initialize component runs immediately after the
application is installed.
• Assign unique nicknames to each WebReport that is part of the application
You can give a unique nickname to each WebReport within an application and
then run the WebReport using the URL: ?func=csapps.launchapp&
appname=<application_name>&nickname=<unique_nickname>

11.5.1 To Define a Special Component for a Content Server

Application
To define special components for a Content Server application:

1. In the Content Server Applications Administration section of the Content

Server Administration page, click the Applications Management link.
2. On the Applications Management page, in the Installable Content Server
Applications list, on the row for the application for which you want to define a
special component, choose Define special components from the actions list.
3. Do one or more of the following:

• To define a WebReport as the default launch component for the application,

on the row for that WebReport, in the Default Launch Component column,
select the radio button.
• To define WebReport as the initialize component for the application, on the
row for that WebReport, in the Initialize Component column, select the
radio button.

LLESWEBR230200-AGD-EN-01 OpenText™ Content Server 77

Chapter 11 Applications Management

• To assign a unique nickname to one or more of the WebReports that are part
of the application, on the row for the WebReport, in the Unique Nickname
column, enter a unique nickname.
The system validates each nickname upon submission of the form. The
system will generate an error if a nickname is not unique within the
application.

Note: Nickname comparisons are case-insensitive. For example,

“mynickname” is the same as “MyNickName” and will cause a
validation error.

4. Click Submit.

11.6 Upgrading a Content Server Application

After an upgradeable Content Server application has been installed, you will see an
“Upgrade available” message. You can upgrade the application by choosing
Upgrade from the actions list on the row for that application in the Installed
Content Server Applications table.

When you upgrade a Content Server application, the following actions occur when
you click Submit:

1. The application folder for the currently-installed version of the Content Server
application is deleted from <Content Server_home>\appData\webreports\
csapps\csapplications.

2. Any nodes that are not in the new version of the application will be deleted
unless they are set to not be deleted by clearing the check boxes in the Delete
column for each application.

3. If the Content Server application contains Content Server nodes, then the
application XML files will be imported. Upon upgrade, any versionable nodes in
the existing application will have a new version added and any new nodes will
be created.

4. If the Content Server application contains support asset files, those files are
copied to a folder for the application within the Support Assets Volume.

5. Other actions are performed depending on the Content Server application

definition. Use the Preview option for more details.

6. The Content Server application's manifest file is replaced with a new version. If
the application contains Content Server nodes then the manifest file will contain
the node IDs that have been created on the target system.

7. The application folder for the new version of the Content Server application is
moved from <Content Server_home>\appData\webreports\csapps\
csapplicationsstaging to <Content Server_home>\appData\webreports\
csapps\csapplications.

78 WebReports Administration Guide LLESWEBR230200-AGD-EN-01

 11.6. Upgrading a Content Server Application

Note: After any Content Server upgrade, if you use the Physical Objects
reports, Records Management reports, or Security Clearance reports, verify
whether you also need to upgrade these applications.

11.6.1 To Upgrade an Application

To upgrade an application:

1. Copy a higher version of the application folder than is already installed to the
<Content Server_home>\appData\webreports\csapps\
csapplicationsstaging directory on the server.

2. In the Content Server Applications Administration section of the Content

Server Administration page, click the Applications Management link.

3. On the Applications Management page, in the Installable Content Server

Applications list, choose Upgrade from the actions list on the row for the
application that you want to upgrade.

4. On the Upgrade Application page, do one or more the following:

a. Optional If the application contains Content Server nodes that have been
renamed, been moved, or had a new version added to them since the
application was installed, the nodes will be listed in the Nodes that have
been altered since the application was installed table.
To delete the listed nodes when the application is upgraded, select the
Delete check box for the nodes you want deleted.

b. Optional If the application contains Content Server nodes that have remained
unchanged since the application was installed, the nodes will be listed in
the Nodes that have been unaltered since the application was installed
table.
To delete a node from this table, when the application is upgraded, select
the Delete check box next to the nodes you want deleted.

Note: Any Content Server nodes that have been deleted since the
application was installed will be listed in the Nodes that have been
deleted since the application was installed table.

c. Optional To select a target location for the new version of the application,
select the Tick to install a new version of the application in a different
location check box.
If this box is cleared then the application will install to the same location as
the previous version.

d. Optional To see details of actions that will be performed on the target system
by the installation part of the upgrade process, click Preview.

e. Click Submit.

LLESWEBR230200-AGD-EN-01 OpenText™ Content Server 79

Chapter 11 Applications Management

11.7 Uninstalling or Deleting a Content

ServerApplication
An installed Content Server application includes both Delete and Uninstall options
in the actions list. These options open the Delete Application page and the
Uninstall Application page, respectively.

When you uninstall an application, the following actions will occur after you click
Submit:

1. The application folder is moved from <Content Server_home>\appData\

webreports\csapps\csapplications to <Content Server_home>\appData\
webreports\csapps\csapplicationsstaging.

2. If a support folder exists for the application, it is deleted.

3. The Content Server nodes for the application are deleted, except for any nodes
that have been specified not to be deleted.

When you delete an application, the following actions will occur when you click
Submit:

1. The application folder is deleted from <Content Server_home>\appData\

webreports\csapps\csapplications.

2. If a support folder exists for the application, it is deleted.

3. The Content Server nodes for the application are deleted, except for any nodes
that have been specified not to be deleted.

11.7.1 To Uninstall an Application

To uninstall an application:

1. In the Content Server Applications Administration section of the Content

Server Administration page, click the Applications Management link.

2. On the Applications Management page, in the Installable Content Server

Applications list, choose Uninstall from the actions list on the row for the
Content Server application that you want to uninstall.

3. Optional On the Uninstall Application page, do one or more of the following

additional actions:

• If the Content Server application contains Content Server nodes that have
been renamed, been moved, or had a new version added to them since the
application was installed, the nodes will be listed in the Nodes that have
been altered since the application was installed table.
To delete a node from this table when the application uninstalls, in the
Delete column, select the check box next to the nodes that you want deleted.

80 WebReports Administration Guide LLESWEBR230200-AGD-EN-01

 11.7. Uninstalling or Deleting a Content ServerApplication

• If the Content Server application contains Content Server nodes that are
unchanged since the application was installed, the nodes will be listed in the
Nodes that have been unaltered since the application was installed table.
To delete a node from this table when the application is uninstalled, in the
Delete column, select the check box next to the nodes that you want to
delete.

Note: Any Content Server nodes that have been deleted since the
application was installed will be listed in the Nodes that have been
deleted since the application was installed table.

4. Click Submit. This will uninstall the Content Server application and move the
application folder for the uninstalled application into the <Content
Server_home>\appData\webreports\csapps\csapplications directory.

11.7.2 To Delete a Content Server Application

To delete an application:

1. In the Content Server Applications Administration section of the Content

Server Administration page, click the Applications Management link.

2. On the Applications Management page, in the Installable Content Server

Applications list, choose Delete from the actions list on the row for the Content
Server application that you want to delete.

3. Optional On the Delete Application page, do one or more of the following

additional actions:

• If the application contains Content Server nodes that have been renamed,
been moved, or had a new version added to them since the application was
installed, the nodes will be listed in the Nodes that have been altered since
the application was installed table.
To delete a node from this table when the application uninstalls, in the
Delete column, select the check box next to the nodes that you want deleted.
• If the application contains Content Server nodes that are unchanged since
the application was installed, the nodes will be listed in the Nodes that have
been unaltered since the application was installed table.
To delete a node from this table when the application is deleted, in the
Delete column, select the check box next to the nodes that you want deleted.

Note: Any Content Server nodes that have been deleted since the
application was installed will be listed under Nodes that have been
deleted since the application was installed.

4. Click Submit. This will uninstall the Content Server application and delete the
application folder from the <Content Server_home>\appData\webreports\
csapps\csapplications directory.

LLESWEBR230200-AGD-EN-01 OpenText™ Content Server 81

Chapter 11 Applications Management

11.8 Cleaning up a Content ServerApplication

To clean up a corrupted application, on the row for that application in the Installed
Content Server Applications list in the Available Actions list, select Clean up.

On the Clean Up Application page, the Cleanup tool completely removes a Content
Server application from the system, performing the following actions after you click
Run Cleanup.

Notes

The Clean up tool only works for the following applications that are included
with Content Server:

• OTPOReports - OpenText Physical Objects Reports

• OTRMReports - OpenText Records Management Reports

• OTRMSecReports - OpenText Records Management Security Reports

• Uninstalls and deletes the Content Server application.

• Deletes the application folder from the Content Server Applications volume.

• Purges all orphaned manifest files.

• Purges associated application files from the Recycle Bin.

• Deletes the application from both the Content Server Applications and Content
Server Applications staging directories on the file system.

• Copies the application from the Content Server source files into the Content
Server Applications staging directory on the file system, ready for installation.

After cleanup finishes, it verifies that the system is ready for a new installation of
this application.

Important
For clustered environments, run this cleanup on each server in the cluster
before attempting a new installation.

11.9 Downloading the Application ZIP File

You can download an installed Content Server application so that you can install it
on another system.

To download an application, on the row for that application in the Installed Content
Server Applications list, choose Download zip file from the actions list.

82 WebReports Administration Guide LLESWEBR230200-AGD-EN-01

Chapter 12
Applications Volume

Use the Enterprise > Content Server Applications Volume link to work with the
objects in the Content Server Applications Volume.

Tip: Alternatively, you can reach the Content Server Applications page from
the Content Server Applications Administration section of the Content
Server Administration, by clicking Open the Content Server Applications
Volume.

The Content Server Applications Volume is the default destination for applications
built or installed using “Applications Management“ on page 63.

LLESWEBR230200-AGD-EN-01 OpenText™ Content Server 83