ReportWorX

Training Manual
Version 9.20
 ReportWorX Training Manual

© 2010 ICONICS, Inc. All rights reserved worldwide. This document may not be
reproduced or copied in any manner without written authorization from ICONICS,
Inc.
The information contained within this document is subject to change without notice.
ICONICS, Inc. does not guarantee the accuracy of the information.
GENESIS32, GENESIS64, Pocket GENESIS, BizViz and their respective modules,
OPC-To-The-Core, and Visualize Your Enterprise are trademarks of ICONICS, Inc.
Windows, Windows 7, Windows Vista, Windows Server 2008, Windows Server
2003, Windows XP, Windows 2000, Windows NT, Windows XP-64, Windows 2003-
64 and Windows CE are registered trademarks of Microsoft Corp. in the United States
and other countries.
Other product and company names mentioned herein may be trademarks or registered
trademarks of their respective owners.

Document Number: TM-RWX-920

ReportWorX Training Manual

ICONICS LICENSE AGREEMENT

YOU SHOULD CAREFULLY READ THE FOLLOWING TERMS AND CONDITIONS!

Opening and using the enclosed software for any purpose indicates your acceptance of the terms and conditions of this license agreement. If
you do not agree with them you should return all software, documentation and copy protection keys within seven days of shipment unopened and
your money will be refunded.

ICONICS provides this program and licenses its use in the United States, Puerto Rico, or internationally. You assume the responsibility for the
selection of the program to achieve your intended results, and for the installation, use and results obtained from this program.

LICENSE
You are granted a personal license to use this program under the terms stated in this Agreement. You may: 1) Install and use the program on a
single machine. 2) Make a single archival back-up copy of the program for the sole purpose of supporting your use of the single program on a
single machine. 3) You may not use, copy, modify, or transfer the program, or transfer any copy, in whole or in part, except as expressly
provided in this license, or with a written contractual agreement with ICONICS, Inc.

TERM
The license is effective until terminated. It will terminate if you fail to comply with any term or condition of this Agreement. You agree, upon such
termination, to destroy the program and all copies that were made from it and to promptly return any copy protection key(s) to ICONICS.

LIMITED WARRANTY
ICONICS WARRANTS THE CD-ROM OR PHYSICAL DISKETTES, ON WHICH THE PROGRAM IS FURNISHED, AND PHYSICAL
DOCUMENTATION TO BE FREE OF DEFECTS IN MATERIALS AND WORKMANSHIP UNDER NORMAL USE FOR A PERIOD OF NINETY
(90) DAYS FROM THE DATE OF DELIVERY TO YOU AS EVIDENCED BY YOUR RECEIPT. THIS PROGRAM IS PROVIDED “AS IS”
WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE IMPLIED WARRANTIES
OF TITLE, NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE
QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE
ENTIRE COST OF ALL NECESSARY SERVICING, REPAIR, OR CORRECTION.

ICONICS SPECIFICALLY DISCLAIMS ALL OTHER WARRANTIES, EXPRESSED OR IMPLIED, INCLUDING BUT NOT LIMITED TO, IMPLIED
WARRANTIES OF TITLE, NON-INFRINGEMENT, MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. IN PARTICULAR,
WITH RESPECT TO ANY PARTICULAR APPLICATION, USE OR PURPOSE, IN NO EVENT SHALL ICONICS INC. BE LIABLE FOR ANY
OTHER COMMERCIAL DAMAGE, INCLUDING BUT NOT LIMITED TO SPECIAL, INCIDENTAL, CONSEQUENTIAL OR OTHER DAMAGES.
ICONICS DOES NOT WARRANT THAT THE FUNCTIONS CONTAINED IN THE PROGRAM WILL MEET YOUR REQUIREMENTS OR THAT
THE OPERATION OF THE PROGRAM WILL BE UNINTERRUPTED OR ERROR FREE.

LIMITATION OF REMEDIES
ICONICS’ entire liability and your exclusive remedy shall be the replacement of any CD-ROM or diskette not meeting ICONICS’ “Limited
Warranty” which is returned to ICONICS with a copy of your receipt within the warranty period. The remedy for breach of this warranty shall be
limited to replacement and shall not encompass any other damages including but not limited to loss of profit, special, incidental, consequential, or
other similar claims arising out of the use or inability to use such program even if ICONICS has been advised of the possibility of such damages,
or for any claim by any other third party.

GENERAL
This Agreement will be governed by the laws of the Commonwealth of Massachusetts. Should you have any questions concerning this
Agreement, you may contact ICONICS in writing at:

ICONICS, Inc.
100 Foxborough Boulevard
Foxborough, MA 02035

You acknowledge that you have read this agreement, understand it and agree to be bound by its terms and conditions. You further agree that it
is the complete and exclusive statement of the Agreement between you and ICONICS which supersedes any proposal or prior Agreement, oral
or written, and any other communications between you and ICONICS relating to the subject matter of the Agreement.

ICONICS RETURN POLICY

All sales are final (NO RETURNS) unless one of the following conditions is applicable: Program is returned in its original packaging material
within 7 days after shipment. In such a case, a full refund is provided, less all incurred shipping and handling costs. Program is returned within
30 days from the original shipment date. In such a case a 20% restocking fee is applicable. No returns are allowed on OPC ToolWorX or
ActiveX ToolWorX.
ReportWorX Training Manual
 Contents

1 Introduction
1.1 Overview of ReportWorX .................................................................................................................... 1-1
1.2 ReportWorX Configurator .................................................................................................................... 1-2
1.3 ReportWorX Excel Interface ................................................................................................................ 1-2
1.4 Unified Web Interface .......................................................................................................................... 1-4
1.5 ReportWorX Service ............................................................................................................................ 1-5
1.6 Using ReportWorX Configurator in ICONICS Workbench32 Tool..................................................... 1-5

L1.1 ReportWorX Example Overview ..................................................................................................... L1-1

2 Install ReportWorX
2.1 Objectives ............................................................................................................................................. 2-1
2.2 System Requirements ........................................................................................................................... 2-1
2.3 Pre-Installation System Setup ............................................................................................................... 2-2
2.4 ReportWorX Installation Procedure ..................................................................................................... 2-3
2.5 ReportWorX Licensing ....................................................................................................................... 2-12
L2.1 Attaching the Acmeseutical Database .............................................................................................. L2-1

3 ReportWorX Configurator
3.1 Objectives ............................................................................................................................................. 3-1
3.2 Introduction to Report Configuration ................................................................................................... 3-1
3.3 Creating a New Configuration Database .............................................................................................. 3-2
3.4 Starting the ReportWorX Configurator ................................................................................................ 3-2
L3.1 Creating a New Report ..................................................................................................................... L3-1

4 Report Scheduling and Triggers

4.1 Objectives ............................................................................................................................................. 4-1
4.2 Creating a New Report Trigger ............................................................................................................ 4-1
L4.1 Report Triggers................................................................................................................................. L4-1

5 Redirector Actions
5.1 Objectives ............................................................................................................................................. 5-1
5.2 Redirector Tasks and Actions Overview .............................................................................................. 5-1
5.3 Creating a New Redirector Action ........................................................................................................ 5-2
5.4 E-Mail Actions...................................................................................................................................... 5-2
5.5 Fax Actions ........................................................................................................................................... 5-5
5.6 File Copy Actions ................................................................................................................................. 5-6
5.7 Printer Actions ...................................................................................................................................... 5-6
5.8 Web Publishing Actions ....................................................................................................................... 5-7
5.9 Redirector Combined Action Properties ............................................................................................... 5-9
L5.1 Redirector Actions ............................................................................................................................ L5-1

ICONICS i
Contents ReportWorX Training Manual

6 Report Templates
6.1 Objectives ............................................................................................................................................. 6-1
6.2 Designing Report Templates ................................................................................................................ 6-1
6.3 Creating Report Templates ................................................................................................................... 6-2
L6.1 Configuring Templates...................................................................................................................... L6-1

7 Data Sources
7.1 Objectives ............................................................................................................................................. 7-1
7.2 Configuring a Report Template ............................................................................................................ 7-1
7.3 Connecting to OPC Tags ...................................................................................................................... 7-4
7.4 Connecting to ICONICS Tags ............................................................................................................ 7-10
7.5 Connecting to Open Databases ........................................................................................................... 7-14
7.6 Connecting to Web Services in Excel ................................................................................................ 7-25
7.7 Parameters .......................................................................................................................................... 7-29
L7.1 Quick Lab Overview ......................................................................................................................... L7-1

8 Layout Manager
8.1 Objectives ............................................................................................................................................. 8-1
8.2 Layout Manager ................................................................................................................................... 8-1
8.3 Mapping Data Fields ............................................................................................................................ 8-3
L8.1 Layout Manager ................................................................................................................................ L8-1

9 Report Configuration
9.1 Objectives ............................................................................................................................................. 9-1
9.2 Report Settings ..................................................................................................................................... 9-1
L9.1 Running Reports ............................................................................................................................... L9-1

10 Unified Web Interface

10.1 Objectives .......................................................................................................................................... 10-1
10.2 Introduction to the Unified Web Interface ........................................................................................ 10-1
L10.1 Unified Web Interface ................................................................................................................... L10-1

11 Client Management
11.1 Objectives .......................................................................................................................................... 11-1
11.2 Introduction to Client Management................................................................................................... 11-1
L11.1 Client Management ....................................................................................................................... L11-1

A.1 Report with Dynamic Parameter ................................................................................................................ A-1

ii ICONICS
ReportWorX Training Manual Introduction to ReportWorX

Introduction to
1
ReportWorX
1.1 Overview of ReportWorX
ReportWorX is a powerful and comprehensive reporting tool that uses the latest
Microsoft.NET technology to create, schedule, and redirect reports to be sent to
redundant printers, fax machines, computer screens, PDF files, and local or
remote disk drives. You can even publish reports to a Web server or send them to
your entire organization via e-mail. Reports can be accessed over company
intranets or over the Internet.

ReportWorX offers the most advanced reporting tool available today, taking
maximum advantage of Microsoft’s most powerful technologies. ReportWorX is
designed from the ground up using Microsoft.NET and Microsoft Excel
technologies. ReportWorX turns volumes of data into Manufacturing Intelligence.
Transforming data from any data source into reports is fast, efficient, and easy to
set up. ReportWorX uses Microsoft.NET technology to push data into your report
worksheets and forms, and to control the execution of these Excel forms without
the need for Excel to be visible or executing. ReportWorX performs complete
workbook duplication, manipulation, chart and data updates, formula
recalculation, automatic printout, and report scheduling.

ReportWorX includes the following basic components for creating, configuring,

and executing reports:

• Configurator
• Excel Interface
• Unified Web Interface
• ReportWorX Service

ICONICS, Inc 1-1

Introducction to Rep
portWorX ReportWorrX Training Manual

1.2 ReportW
R WorX Configu
C urator
The ReportWorX
R Configuratoor, shown inn Figure 1.1,, is the prim
mary interfacee that
you use
u to configgure how infformation annd data will beb displayedd in your repports.
The Configurator
C enables youu to:

• Create andd activate a configuration

c n database.
• Create andd configure reports.
r
• Edit reportt properties.
• Create repport templatees for defininng how reporrts will lookk.
• Schedule triggered
t repports for execution.
• Specify reedirector taskks such as e-mail,
e fax, PDF, file copy, printerr, and
Web publiishing actionns after a repport executess
• Define useer accounts and
a managedd lists for repport recipiennts.
• Set up report access peermissions for
f registeredd Windows usersu and grooups.
• Start the ReportWorX
R Service.
• Launch the Unified WebW Interfacee.
• Publish repports to the Web
W server.
• Execute annd view repoorts on demaand.
• Archive reeports.

For more
m informaation, please see the RepoortWorX help documenttation.

Figure 1..1 - ReportWorrX Configuratorr Screen

1.3 ReportW
R WorX Excel
E In
nterfacce
The ReportWorX
R X Excel interrface allowss you to creeate and connfigure Micrrosoft
Excel templates for
f your repoorts. The tem
mplate desiggn dictates how
h data displays
in you
ur report sprreadsheets. The
T Excel innterface alsoo includes ann embedded pop-
up meenu for connnecting to data
d sourcess for your reports.
r Youu can accesss this
1-2 ICONICS
S, Inc
ReportWorX Training Manual Introduction to ReportWorX

menu by right-clicking on one or more cells in the Microsoft Excel workbook.

Highlight a cell, right-click on the cell, and then select Connect to new Data
Source from the pop-up menu, as shown in Figure 1.2. From this pop-up menu,
you can connect to:

• OPC Data Access (DA) and Historical Data Access (HDA) tags
• ICONICS TrendWorX32 historical tags, text aliases, and language aliases
• Open databases, including Microsoft Access, Microsoft Excel, Microsoft
SQL Server, Oracle, SAP, ODBC, and OLEDB
• Preconfigured Alarm Analytic sources
• User-selectable parameters
• Hyperlinks to go to another Website
• Web services
• Custom Data Source

Reports are executed based on the data connections you specify in your Excel
templates. The ReportWorX Configurator provides several example templates to
help you get started. For more information, please see the ReportWorX help
documentation.

Figure 1.2 - Sample Report Template in Microsoft Excel

ICONICS, Inc 1-3

Introducction to Rep
portWorX ReportWorrX Training Manual

1.4 Unified
U Web In
nterfacce
The Unified
U Webb Interface, shown
s in Figgure 1.3, ennables you too execute reeports
on deemand and browse
b repoorts from anny Microsoftt® Internet Explorer client.
c
Reporrts can be acccessed overr company inntranets or over
o the Interrnet. The Unnified
Web Interface
I alloows you to:

• Execute reeports
• Visualize reports
r
• Manage reeports

The Unified
U Webb Interface displays connfiguration information from the active
a
config
guration dattabase, as well
w as enabbling you tot modify thet configurration
mation. Anyy configurattion changes that you make in thhe Unified Web
inform
Interfa
face are upddated in the active repoort configuraation database. Similarlyy, all
changges that are made
m to the active
a configguration database using the ReportW
WorX
Configurator are reflected
r in the
t Unified Web
W Interfacce.

Althou ugh the Uniified Web Innterface allow ws you to modify

m existiing reports in
i the
activee configuratiion databasee from the cllient side, yoou cannot crreate new reeports
(or reelated itemms). Those can be crreated only through thhe ReportW WorX
Configurator on thhe server sidde.

The Unified
U Web Interface allso features Windows
W NT® integrateed security. Only
registeered users or
o groups with
w access rights may view, execuute, and maanage
reportts.

F
Figure 1.3 - Visu
ualizing Reportts in the Unified
d Web Interfacee

1-4 ICONICS
S, Inc
ReportWorX Training Manual Introduction to ReportWorX

1.5 ReportWorX Service

The central module and runtime engine of ReportWorX is the ReportWorX
Service, which links together the ReportWorX Configurator, Excel interface, and
Unified Web Interface. The ReportWorX Service is responsible for managing:

• Report data source connectivity

• Report execution
• Report schedules
• Completed report redirection
• Performance monitoring
• NT Event reporting and integration
• Report administrative tasks
• Product license

For more information, please see the ReportWorX help documentation.

1.6 Using ReportWorX Configurator in ICONICS

Workbench32 Tool
Workbench32 is ICONICS’ Web-based centralized environment for system
configuration and monitoring, greatly saving time and money and streamlining
project development and deployment.

This topic covers how to add ICONICS ReportWorX Configurator Provider to the
Workbench32 configuration/runtime tool. For additional information on how to
add other Providers within Workbench32, consult the GENESIS32
V9.2/Workbench32 training or help documentation.

1. From the Project menu pulldown, select Add/Remove Providers.

Figure 1.6-1 - Adding Providers in Workbench32

ICONICS, Inc 1-5

Introduction to ReportWorX ReportWorX Training Manual

-OR-

Click on the Add/Remove Providers icon ( ) in the toolbars at the top of

Workbench32.

Figure 1.6-2 - Toolbar in Workbench32

This will bring up the "Select Applications in the Project" box, from where you
can choose your required Workbench32-integrated applications. Click the
checkbox next to "ReportWorX". You can also select the “ReportWorX Server”
from beneath the Runtime Providers section at this time.

Figure 1.6-3 - Provider Selection in Workbench32

1-6 ICONICS, Inc

ReportWorX Training Manual Introduction to ReportWorX

Once your selected Providers are successfully loaded into Workbench32, you will
see their representative icons appear in the bottom left of the Tree Explorer.

Figure 1.6-4 - ReportWorX Configurator Icon at Bottom of Tree Explorer in Workbench32

Should you not immediately see the Tree Explorer, you can make it appear by
clicking View from the top menu, then ensuring the checkmark appears next to
Tree Explorer.

Figure 1.6-5 - Selecting the Tree Explorer from Workbench32's View Menu

ReportWorX is a database-driven application, which will utilize Microsoft SQL

Server. You can use the ReportWorX Configurator provider in Workbench32 as
the interface to configure how information and data will be displayed in your
reports. Upon first use of the ReportWorX Configurator, before you can configure
any report settings, you may need to use the standalone ReportWorX Configurator
application to create a database in which your configuration can be stored:

1. To launch the ReportWorX Configurator from the Windows Start menu,

select Programs > ICONICS BizViz > ReportWorX > ReportWorX
Configurator.

2. The first time you open the Configurator, the ReportWorX Configuration
Database Wizard helps you create a new configuration database, as shown
in the following figure. Click the Next button to continue.

ICONICS, Inc 1-7

Introduction to ReportWorX ReportWorX Training Manual

Figure 1.6-6 - Introduction to ReportWorX Configuration Database Wizard

3. Select whether to use the local computer or a remote computer for your
SQL Server machine, as shown in the figure below. Click the Next button
to continue.

Figure 1.6-7 - Selecting Local or Remote SQL Server

1-8 ICONICS, Inc

ReportWorX Training Manual Introduction to ReportWorX

4. Select the proper authentication mode to log into your SQL Server, as
shown in the figure below. Click the Next button to continue.

Figure 1.6-8 - Logging Into SQL Server

5. You have two options for creating your new database, as shown in
following figure. You can either create a new Microsoft SQL Server
database, or you can add the ReportWorX configuration database structure
to an existing Microsoft SQL Server database. There is also an option to
include or exclude the ReportWorX samples in the configuration database.
Here we will assume that you will choose the first option (to create a new
database). Select I want to create a new Microsoft SQL Server
database on local node, and then click the Next button to continue.

Note: For information about how you can add the ReportWorX
configuration database structure to an existing Microsoft SQL Server
database, see Adding the ReportWorX Configuration to an Existing
Database.

ICONICS, Inc 1-9

Introduction to ReportWorX ReportWorX Training Manual

Figure 1.6-9 - Creating a New Microsoft SQL Server Database

6. Choose the settings for the SQL Server database parameters, as shown in
the figure below. In the SQL Server field, select the SQL Server on which
to create a new database. Type a name for the database in the Database
Name field. In the Database Path field, choose a directory path for the
new database. You can browse for a directory by clicking the … button to
the right of this field. Or you can use the default database file path and
size.

Note: Usually you have only one instance of SQL Server running on the
local node (in this case the SQL Server field has only one option:
"(local)". However, it is possible to run multiple SQL Server instances on
the local node, in which case the SQL Server field lists all those SQL
Server instances: "(local)" for the default instance and
"node_name/instance_name" for all others. Again, all those are local SQL
Servers.

Under the Database File Properties section, specify an initial size for the
database, which should be as large as possible. You can also specify a
Database Growth option (in megabytes) or as a percentage of the total
size. MSDE servers are capable of increasing the database size on the fly
to store more data. However, if this operation is performed frequently, the
overall system performance may decrease. Choosing an initially large

1-10 ICONICS, Inc

ReportWorX Training Manual Introduction to ReportWorX

database size and a corresponding database growth option can drastically

improve system performance. To shrink the size of the new database,
check the Auto Shrink check box.

Under the Log File Properties section, you can also modify the settings
for the database transaction log file. Specify a Log File Growth option (in
megabytes) or as a percentage of the total size. Again, a sufficient initial
size setting can greatly improve performance. The default options should
be adequate for most applications with a small to medium size load.

Click the Next button to create the new SQL Server database.

Figure 1.6-10 - Setting the Database Parameters

7. The Wizard creates the new SQL Server database, as shown in the
following figure. When it is finished, it will tell you whether or not the
operation has completed successfully. Click the Next button to continue.

ICONICS, Inc 1-11

Introduction to ReportWorX ReportWorX Training Manual

Figure 1.6-11 - Status of Database Creation

8. The ReportWorX Configurator uses Universal Data Link (.udl) files to

connect to the Microsoft SQL Server database. These .udl files contain
OLE database connection information that allows the Configurator to
create and manage connections to OLE databases. Enter a name and
directory path for the new .udl file in the Data Link File Name field, as
shown in the figure below. You can browse for a directory by clicking the
… button to the right of this field. Click the Next button to continue. If
you want this new database to be the active configuration database, check
Make Database Active.

1-12 ICONICS, Inc

ReportWorX Training Manual Introduction to ReportWorX

Figure 1.6-12 - Selecting a Directory and File Name for Universal Data Link (.udl) File

9. Once the Universal Data Link has been created, a summary appears, as
shown in the figure below. Click the Finish button to complete the
database creation.

Figure 1.6-13 - Completing the Database Creation

ICONICS, Inc 1-13

Introduction to ReportWorX ReportWorX Training Manual

10. Once you have finished creating a new configuration database using the
ReportWorX Configuration Database Wizard, the ReportWorX
Configurator screen opens, as shown in the figure below. The screen
consists of a split window with a tree control view in the left-hand pane
and a configuration view in the right-hand pane. The name of the .udl file
that you created appears in the title bar of the window. The Configurator
provides a standard format for the configuration database, as well as a
sample (default) ReportWorX configuration project. The Configurator also
includes a toolbar and menus with many command functions.

Figure 1.6-14 - ReportWorX Configurator Screen

11. Create a report template in Microsoft Excel to determine how your reports
will look. The ReportWorX Configurator provides several example
templates to help you get started.

12. Connect the report template to a data source.

13. Create a new report. In the folder in which the report is created, set up user
access permissions for viewing, executing, and managing reports.

1-14 ICONICS, Inc

ReportWorX Training Manual Introduction to ReportWorX

14. Create a report redirector action (e-mail, fax, file copy, printer, or Web
publishing) to define the method of report delivery to recipients.

15. Create a redirector combined action group to determine the sequence of

redirector actions.

16. Assign a trigger (schedule) to define when a report will be executed, or

specify that the report will be executed on demand.

17. Activate the configuration database.

18. Start the ReportWorX service.

19. Execute any "on demand" reports by running them from the ReportWorX
Configurator or ReportWorX Web Interface.

Note: If you would like to include Web publishing in any of your reports, you
must first configure the Web Interface and Web publishing actions. Please see the
ReportWorX Web Interface documentation for more information.

ICONICS, Inc 1-15

Introduction to ReportWorX ReportWorX Training Manual

1-16 ICONICS, Inc

ReportWo
orX Training Manual
M La
ab 1: ReporrtWorX Exa mples Overrview

Lab
b: ReportW
WorX X
1
Exa
ampples Oveervieew
1.1 Lab
L Ovverview
w
Throuughout this manual,
m you will be askeed to complete several exxercises, or
“labs"", in order too build your own
o ReportW WorX reportts. The labs will start veery
simplee, but they will
w build upoon each otheer such that in
i the end yoou will have an
advannced set of reeports. In thhis lab, you will
w see somee examples of o the reportts
you will
w eventuallly build.

1.1.1 Task
k Checkllist
In this quick lab, yoou will compllete the follow
wing task:

• Get an oveerview of thee Acmeseutiical Project to

t be built inn this class.

1.1.2 Supp
port Filees
You do
d not need any
a support file to compplete this lab.

1.2 Acmese
A eutical Overvi
O ew

In thiss ReportWorrX course, we

w will solvee some reporrting problem ms for the
pharmmaceutical coompany Acm meseutical. This
T is a globbal manufactturer for Painn
Mediccine, which has
h productiion facilities all over the world as shhown in Figuure
L1.1.

S, Inc
ICONICS L1-1
Lab 1: R eportWorX
X Examples Overview
O ReportWorrX Training Manual

Figure L1.1
L - Acmeseutical Global Loocations

The Acmeseutical
A l Headquarteers is in Foxbborough, Maassachusettss in the Uniteed
Statess. There are several
s Acm
meseutical facctories located in the Unnited States as
a
shown n in Figure L1.2.
L

Figure L1.2
L - Acmeseutiical Factories in
n the US

Other continents have

h their owwn regional headquarters. Europe haas several
factorries as shownn in Figure L1.3,
L while China
C and Australia
A havee only one
factorry. These facctories all repport directlyy to the US headquarters.
h .

Figure L11.3 - Acmeseutiical Factories in

n Europe

L1-2 ICONICS
S, Inc
ReportWo
orX Training Manual
M La
ab 1: ReporrtWorX Exa mples Overrview

The Acmeseutical
A l factories haave only onee productionn line: creatinng pain relief
pills. The
T recipes for these pillls consist off four differeent chemicals. A
visuallization of thhis is shown in Figure L11.4.

Figure L1.4 - Pill Prod

duction Visualization

The pill productioon line also has

h a bottlingg machine. This T machinee has certainn
setting
gs that are sppecified in each
e pill recippe (i.e. belt speed, fillingg level, etc)..
Visuaalization of thhis process is
i shown in Figure
F L1.5.

Figure L1.5
L - Bottle Prooduction Visualization

The reecipes for alll pill types are

a stored in the databasee of the manuufacturing plant.
p

1.3 Project
P Guidellines
When n finished wiith this projeect, you shouuld have repoorts that lookk similar to those
t
in Fig
gure L1.6.

S, Inc
ICONICS L1-3
Lab 1: R eportWorX
X Examples Overview
O ReportWorrX Training Manual

F
Figure L1.6 - Exxamples of Com
mpleted Acmeseeutical Reports

Acmeeseutical Heaadquarters haas the follow

wing requests for this prooject:

• Pill Production reportss should be generated

g evvery 20 seconnds, showingg
current reccipe and batcch information with prodduction and rejection tottals.
• The Pill Prroduction reeport should include detaailed informaation,
summarizeed informatiion, and a baar chart show wing the dataa.
• Bottling reeports shouldd also be gennerated on demand,
d showwing the datte the
pills were bottled, alonng with recippe and batchh informationn, and produuction
and rejectiion totals.
• The Bottliing reports shhould be coppied to an exxternal directtory for
browsing by b the manaagement.
• In a futuree phase, the reports
r will be
b e-mailed out to all off managemennt,
but Acmesseutical doess not yet havve the e-maill account sett up for this. For
now, they need an e-m mail redirectoor action creeated, directeed toward alll of
managemeent, so they canc apply it when ready..

L1-4 ICONICS
S, Inc
ReportWorX Training Manual Installing ReportWorX

Installing ReportWorX 2

2.1 Objectives
After completing this chapter, you should know how to:

• Set up your system for ReportWorX installation

• Install ReportWorX
• Create a ReportWorX configuration database during installation
• View licensing information using the ReportWorX License Monitor

2.2 System Requirements

This section describes the system requirements and steps for installing
ReportWorX. Be sure to close all other applications before installing
ReportWorX. To use this software, you must have the following minimum system
requirements:

• ReportWorX Lite: 2.0 GHz processor with 1 GB RAM

• ReportWorX Standard: 2.5 GHz processor with 2 GB RAM
• ReportWorX Enterprise: 3.0 GHz processor with 4 GB RAM.

NOTE: It is recommended that your total system paging file size be set to at
least four times the size of physical RAM. The above requirements assume that
ONLY ReportWorX is running on the PC (with Microsoft SQL Server). If other
applications will be running, then additional resources must be allocated.

• At least 100 MB of free hard disk space is required to install ReportWorX

(does not include space required for prerequisite components or Microsoft
.NET Framework).
• DVD Drive for installation
• Microsoft Windows XP Professional, Windows Server 2003, Windows
Vista SP1, or Windows Server 2008 or Windows Server 2008 R2 with the
latest service packs.

ICONICS, Inc 2-1

Installing ReportWorX ReportWorX Training Manual

• Microsoft® Internet Information Services (IIS) 6.0 or later (requires

approximately 20 MB disk space).
NOTE: If you install IIS after installing Microsoft .NET Framework, you must
run the aspnet_regiis.exe file with the “-i" argument in the
Microsoft.NET\Framework\v2.0.50727 directory in the Windows folder of your
operating system.

• Microsoft .NET Framework Version 2.0 and 3.0 and 3.5

NOTE: If Microsoft .NET Framework is not detected on your machine during
ReportWorX installation, it will be installed automatically.

• Microsoft® SQL Server® 2005 or SQL Server 2005 Express, SQL Server
2008 or SQL Server 2008 Express, SQL Server 2008 R2 or SQL Server
2008 R2 Express with latest service packs.
NOTE: If Microsoft SQL Server is not detected on your machine during
ReportWorX installation, you have three options: you can cancel the installation
at this point and install SQL Server locally yourself; you can allow SQL Server
Express to be automatically installed from the BizViz DVD; or you can
designate a remote instance of SQL Server, in which case you will not be forced
to install SQL Server Express locally.

• Microsoft Excel 2003 or higher with the latest service packs.

• ICONICS ReportWorX license. For more information, see the

ReportWorX Licensing section below. Without a valid ReportWorX
license, your ReportWorX Service will only run in two-hour demo mode.
NOTE: In order to run ReportWorX, you need a ReportWorX license, which is
based on the number of enabled reports and report templates. Please see the
ICONICS Software Licensing documentation for information about how to
authorize an ICONICS software license. You can also register for a license
online at www.iconics.com/support/licenseproduct.asp.

2.3 Pre-Installation System Setup

Before installing ReportWorX, you must complete the following steps:

• Update your Windows operating system with the latest service packs.
• Update your Web browser application with the latest service packs.
• Update your Microsoft Office installation with the latest service packs.
• Update Microsoft SQL Server with the latest service packs.

2-2 ICONICS, Inc

ReportWorX Training Manual Installing ReportWorX

2.4 ReportWorX Installation Procedure

To install ReportWorX, you should insert the product DVD and select the
ReportWorX installation from the software selection menu. The ReportWorX
Setup dialog box appears as shown in Figure 2.1, and you can click the Next
button to continue.

Figure 2.1 - ReportWorX Setup

NOTE: This setup procedure up will also install a PDF converter/printer driver
behind the scenes.

The License Agreement dialog box appears, as shown in Figure 2.2. Carefully
read the terms and conditions, select “I accept the terms in the license agreement,”
and then click the Next button to continue.

Figure 2.2 - Reviewing License Agreement

ICONICS, Inc 2-3

Installing ReportWorX ReportWorX Training Manual

The Customer Information dialog box appears, as shown in Figure 2.3. Enter a
User Name and Organization, and then click the Next button to continue.

Figure 2.3 - Customer Information Dialog

The Select Destination Folder dialog box appears, as shown in Figure 2.4. By
default, the directory for the ReportWorX installation is "..\Program
Files\ICONICS\BizViz\ReportWorX." You can also click the Browse button to
specify a different installation folder. Click the Next button to continue the
installation.

Figure 2.4 - Selecting Destination Folder

Click the Install button to proceed with installation, as shown in Figure 2.5.

2-4 ICONICS, Inc

ReportWo
orX Training Manual
M Installiing ReportW
WorX

Figure 2.5 - Confirmatioon Installation Location

L

The ReportWorX
R X Customizattion Wizardd appears, ass shown in Figure
F 2.6. Click
C
the Neext button too continue.

Figure 2.66 - ReportWorX

X Customization
n Wizard

The ReportWorX
R X User Connfiguration Wizard
W diallog box appeears, as show
wn in
Figuree 2.7. You should creaate a user account
a for managing thet ReportW WorX
servicce. Ideally, this
t would be
b a local administrativ
a ve account (one that’s in the
local Administra
A ators group) on the PC where
w ReporrtWorX is ruunning. An easier
e
alternative is to run
r the RepportWorX seervice underr the Adminnistrator acccount.
Enter the user namen and password
p innformation for the useer account. This
complletes the Useer Configuraation Wizardd. Click the Next
N button to continue.

S, Inc
ICONICS 2-5
Installin
ng ReportW
WorX ReportWorrX Training Manual

Figure 2.7 - ReportWorX

R U
User Configurattion Wizard

The Configurati
C ion Database Wizard helps you create a neew configurration
databaase, as show
wn in Figuree 2.8. Selectt whether to use the loccal computerr or a
remotte computer for your SQ
QL Server maachine. Clickk the Next button
b to conntinue.

Figurre 2.8 - Selectingg a Database Seerver

Selectt the proper authenticatiion mode too log into yoour SQL Serrver as show
wn in
Figuree 2.9. If youu are connecting to a remote SQL Server, youu should connnect
using a specific database ussername and passwordd. Click the Next buttoon to
contin
nue.

2-6 ICONICS
S, Inc
ReportWo
orX Training Manual
M Installiing ReportW
WorX

Figu
ure 2.9 - Loggin
ng into SQL Serrver

You have
h two opptions for creeating your new database, as shownn in Figure 2.10.
You can
c either crreate a new Microsoft SQL S Server database,
d orr you can addd the
ReporrtWorX connfiguration database strructure to an a existing Microsoft SQL
Serverr database. There is alsso an optionn to include or exclude the ReportW WorX
samplles in the coonfiguration database. Here we will assume thatt you will chhoose
the firrst option (tto create a new
n databasse). Select I want to crreate a neww MS
SQL Server dataabase, and thhen click thee Next buttonn to continuee.

F
Figure 2.10 - Creeating a New Microsoft
M SQL Server
S Databasee

Choosse the settings for the SQL Server database

d parrameters, as shown in Figure
F
2.11. The default options shouuld be adequuate for mosst applicationns with a sm
mall to
mediuum size loadd. In the SQQL Server field,
fi select the
t SQL Serrver on whiich to
S, Inc
ICONICS 2-7
Installin
ng ReportW
WorX ReportWorrX Training Manual

createe a new databbase. Type a name for thhe database in the Datab base Name field.
In the Database Path
P field, choose a direectory path for
fo the new database.
d You can
browsse for a direcctory by cliccking the … button to the right of this
t field. Orr you
can usse the defaullt database file
fi path and size.

NOTE: Usuually you have only one instaance of SQL Seerver running on o the local
node. In thhis case, the SQL Server field has onlly one optionn: "(local)".
However, it is possible to run multiple SQL S Server insstances on the local node,
in which caase, the SQL Server field lists all those SQL Serverr instances:
"(local)" forr the default insstance and "noode_name\instaance_name" foor all others.
Again, all thhose are local SQL
S Servers.

Underr the Datab base File Properties

P s
section, speecify an initial size for the
databaase, which should
s be as large as possible. You can also speecify a Dataabase
Grow wth option: inn megabytess or as a perccentage of thhe total size. SQL Serverrs are
capabble of increassing the dataabase size onn the fly to store more data. d Howevver, if
this operation
o occcurs frequenntly, the oveerall system performancce may decrrease.
Choossing an initiially large database
d size and a corrresponding database grrowth
optionn can drasticcally improvve system perrformance. To T shrink thhe size of thee new
databaase, check the
t Auto Sh hrink checkk box. Undder the Log File Propeerties
sectio
on, you can also modifyy the settinggs for the database d trannsaction logg file.
Speciffy a Log Fiile Growth option in megabytesm orr as a percenntage of the total
size. Again,
A a suffficient initiall size settingg can greatlyy improve peerformance. Click
C
the Neext button too create the new
n SQL Seerver databasse.

F
Figure 2.11 - Daatabase Settingss

The Wizard
W createes the new SQL
S Server database,
d as shown in Fiigure 2.12. When
W
it is finished, it will tell you
y whetherr or not thhe operationn has comppleted
successsfully. Click the Next button
b to conntinue.

2-8 ICONICS
S, Inc
ReportWo
orX Training Manual
M Installiing ReportW
WorX

Figuree 2.12 - Status of

o Database Creeation

The ReportWorX
R Configuratoor uses Univversal Data Link
L (.udl) files
f to conneect to
the Microsoft
M SQ
QL Server database. These
T .udl files
f containn OLE dataabase
conneection inform mation thatt allows thee Configuraator to creaate and maanage
conneections to OL LE databasees. Enter a name
n and dirrectory path for the neww .udl
file in
n the Data Link
L File Naame field, ass shown in Figure
F 2.13. You can brrowse
for a directory
d byy clicking the … button to the right of this fieldd. Click the Next
buttonn to continue. If you waant this neww database too be the actiive configurration
databaase, check Make
M Database Active.

Figurre 2.13 - Locatioon for the UDL

L File

Once the Universsal Data Linkk has been created,

c a suummary appeears, as show
wn in
Figuree 2.14. Clickk the Finish button to coomplete the database
d creaation.

S, Inc
ICONICS 2-9
Installin
ng ReportW
WorX ReportWorrX Training Manual

Figure 2.114 - Completingg the Database Creation

When wn in Figure 2.15.

n the installattion has finisshed, click thhe Close buutton as show
Then restart your computer.

Figure 2.155 - ReportWorX

X Installation Completed
C

2-10 ICONICS
S, Inc
ReportWo
orX Training Manual
M Installiing ReportW
WorX

2.5 ReportW
R WorX Licensi
L ing
In ord
der to run ReportWorX
R X, you need a valid ReeportWorX license,
l whiich is
based on the numbber of enabled reports annd report tem
mplates.

ReporrtWorX is avvailable in several

s diffeerent sizes too fit your neeeds, as show
wn in
Table 2.1. You canc also runn ReportWorX in demoo mode for up to two hours h
withouut an authorrized license..
Ta
able 2.1 - ReporrtWorX Licensing Schema

Unified Webb Numberr of

Version Interface Enabled Re
eports Numbe
er of Template
es

Enterprise Yes Unlimite

ed Unlimited

Standard Yes 15 100

Lite No 5 25

2hr Demo Yes 5 25

Pleasee see the ICO

ONICS Softw ware Licenssing documenntation for innformation abouta
how too authorize an
a ICONICS S software liicense. You can also reggister for a liccense
onlinee at www.icoonics.com/suupport/licensseproduct.assp.

To viiew your ReeportWorX license in the t ReportW WorX Configgurator, youu can
select Options froom the Toolss menu in thhe ReportWoorX configurator, as show
wn in
Figuree 2.16.

Fiigure 2.16 - Rep

portWorX License in the Repoort Configuratoor

The License
L Moonitor tab of
o the Optioons dialog box, shownn in Figure 2.17,
displaays the follow
wing inform
mation about your
y ReporttWorX license:

• Current License Mode: Displaays the liceense type (ee.g. Demo, Lite,
Standard, Enterprise, etc.).
e
• Number of o Enabled Reports: Shows S the number
n of ennabled reporrts in
the active report confiiguration thaat are currently being useed, as well as
a the
maximum number of active reporrts that your ReportWorX X license allows.

S, Inc
ICONICS 2-11
Installin
ng ReportW
WorX ReportWorrX Training Manual

Only one report connfiguration can c be activve, but therre can be many
m
enabled reeports in the configuratioon.
• Number of Templattes: Shows the numberr of report templates inn the
ReportWoorX configurration databaase, as well as the maxiimum numbber of
templates that your ReeportWorX license
l allow
ws.

Figure 2.177 - Options Diallog: License Moonitor Tab

2-12 ICONICS
S, Inc
ReportWorX Training Manual Lab 2: Attaching the Database

Lab: Attaching the

2
Database
2.1 Lab Overview
In this lab, we will begin building reports. Your reports will mine data from a
sample SQL Server production database. The first step will be to attach this
database to your local SQL Server.

2.1.1 Task Checklist

In this quick lab, you will complete the following task:

• Attach the sample database for the Acmeseutical Project.

2.1.2 Support Files

To complete this quick lab, you will need the following support files:

• Acmeseutical_Data.MDF
• Acmeseutical_Log.LDF

2.2 Attaching the Database

This Acmeseutical example already has a SQL Server database with production
information in it. In order to use this existing database and make it available for
reports, we must attach it to our local SQL Server. This will need to be done any
time you move a database from one SQL Server to another. Your instructor will
provide you with the database if it is not already installed on your machine.

If you have SQL Server 2005 installed on your system, you can use the SQL
Server Management Studio to attach the database. If you have other versions of
the SQL Server, you may use the appropriate management tool of your choosing.
ICONICS, Inc L2-1
Lab 2: A ttaching th
he Databasee ReportWorrX Training Manual

SQL provides
p a frree managem ment tool callled the SQL
L Server Mannagement Sttudio
Expreess. In this laab, we will assume
a that you
y have SQ QL Server 20005 installed and
will be using the SQL
S Server Managemennt Studio thaat comes withh this serverr.

To atttach an existting SQL Serrver database to your loccal SQL Servver using thee
SQL Server
S Manaagement Studio:

1. Op
pen the SQ QL Server Managemennt Studio frrom Start Æ Program
ms Æ
Microsoft
M L Server 20005 Æ SQL Server
SQL S Manaagement Studdio

2. In
n the Connecct to Server dialog that comes up, fill in the apppropriate server
s
information annd click on the Connectt button. Yoour connectioon string maay be
sim
milar to the one show inn Figure L2.11.

Figure L2..1 - SQL Serverr 2005 Connectiion Dialog

3. On
nce you have successsfully connnected to your y databaase server, your
management studio
s shouldd look similaar to Figure L2.2.

Figure L2.2 - Microsoft

M SQL Server Management Studio

L2-2 ICONICS
S, Inc
ReportWo
orX Training Manual
M Lab 2: Attachin
ng the Data
abase

4. In
n the tree-control on thee left-hand side,
s right-cllick on Dataabases and select
s
Atttach… to add
a the Acm meseutical database
d to the
t SQL Serrver as show wn in
Fiigure L2.3.

Figu
ure L2.3 - Attacching the Datab
base

5. Thhe Attach Daatabases diallog will appeear. Click onn the Add buutton and broowse
to the path whhere the Acm
meseutical_D Data.MDF is located (it’ss generally inn
\P
Program Files\ICONICS\\GENESIS32\Examples\\BizViz –
Trraining\Acmmeseutical_DData).

6. Fiigure L2.4 shows thee database details. You Y shouldd see bothh the
Accmeseutical__Data.MDF and the Accmeseutical__Log.LDf. ClickC on thee OK
bu
utton to finissh the databaase attachmeent process.

Figu
ure L2.4 - Attacching the MDF File
F

7. When
W the diallog disappeaars, and you are back in the
t SQL Serrver Manageement
Sttudio, expannd Databasess on the treee-control onn the left-hannd side, andd you
sh
hould now seee AcmeseutticalDatabase in the list asa shown in Figure L2.5.

ICONICS
S, Inc L2-3
Lab 2: A ttaching th
he Databasee ReportWorrX Training Manual

Figure L2.5 - AcmeseuticalDa

A atabase Successffully Attached

8. Noow your daatabase is reeady to be data-mined using RepoortWorX. Iff you

woould like too view thee contents of
o your AccmeseuticalD Database, siimply
do
ouble-click on
o it. Thenn click on Tables,
T andd you should see the tables
t
co
ontained in Acmeseutica
A alDatabase, as
a shown in Figure
F L2.6..

Figure L2.6 - Acmeseu

uticalDatabase Tables
T

9. To
o view the data
d in a tablle, you can select
s the tabble and thenn right-click on it
an
nd select Opeen Table.

This completes Lab 2.Youu have atttached the sample daatabase forr the
Acmeeseutical prooject. The next chaptter will inttroduce youu to the report
r
config
guration

L2-4 ICONICS
S, Inc
ReportWo
orX Training Manual
M ReportWorrX Configurrator

Rep
porttWorX
3
nfigurator
Con
3.1 Objecti
O ves
After completing this chapter,, you shouldd know how to:

• Start the ReportWorX

R Configuratoor
• Create a ReportWorX X configuraation databaase using the
t ReportW
WorX
Configurator

3.2 Introdu
I uction to Repoort Con
nfigurattion
The ReportWorX
R X Configuratoor is the interface that allows
a you tot configuree how
inform
mation and data
d are dispplayed in youur reports. These
T settinggs are configgured
in thee tree controol of the Configurator,
C , shown in Figure 3.1, which provides
severaal different configuratioon tools thaat help you set the paraameters for your
reportts. To help guide you through thee creation of o reports, thet Configuurator
appliees default setttings and saamples to eacch new databbase that youu create.

F
Figure 3.1 - Treee Control of th
he ReportWorX
X Configurator

The tree
t control (left-hand pane) of thhe Configurrator organizzes the dataabase
config
guration intoo the followinng general ittems:

• Report Coonfiguration ns: Sets the parameters for

f differentt types of repports.
• Report Toools: Configgures report templates annd redirectorr tasks (incluuding
e-mail, faxx, PDF, printter, and Webb publishingg).
• Client Maanagement: Registers usser accountss and definess managed liists.

S, Inc
ICONICS 3-1
ReportW
WorX Config
gurator ReportWorrX Training Manual

3.3 Creatin
C ng a New
w Conffiguratiion Dattabase
Similaar to many ICONICS coonfigurationss, the ReporttWorX confiigurator utiliizes a
databaase to store and
a retrieve informationn on the repoorts that you have configgured.
The in
nstallation auutomaticallyy creates a deefault configguration dataabase for youu, but
you caan always crreate a new one
o specificaally for a prooject.
NOTE: Thee lab followingg this chapter will
w outline thee steps necessaary to create
a new Conffiguration Dattabase for the ReportWorX Configurator. For more
information on this toppic refer to the ReportW WorX Configuurator help
documentatiion.
Keepiing consistenncy with alll of the BizVViz Suite appplications, the
t configurration
databaase must be of SQL Serrver type. It may be creaated and maiintained withh any
of thee compatiblee SQL installlations as deescribed in Chapter
C 2. The
T ReportWWorX
Configurator usess Universal Data Link (.udl) files to connect to the Micrrosoft
SQL Server dattabase. Theese .udl files contain OLE databbase conneection
informmation that allows the Configuratoor to create and manage connections to
OLE databases.
d

3.4 Starting
S g the ReportW
R WorX Configu
C rator
Once you have finished creating
c a new
n configuuration dataabase usingg the
ReporrtWorX Connfiguration Database Wizard,W the ReportWorX Configuurator
screenn opens, as shown
s in Figgure 3.2. Thee screen conssists of a spllit window with
w a
tree co
ontrol view in the left-hhand pane annd a configuuration view in the right--hand
pane. The name of the .udl file that youu created apppears in thee title bar of o the
windoow. The Configurator
C provides a standard format
f for the
t configurration
databaase, as well as a samplle (default) ReportWorX X configurattion project.. The
Configurator also includes a toolbar
t and menus
m with many
m comm mand functionns.

Figure 3..2 - ReportWorrX Configuratorr Screen

3-2 ICONICS
S, Inc
ReportWorX Training Manual Lab 3: Creating a New Report

Lab: Creating a New

3
Report
3.1 Lab Overview
In this lab, you will create a ReportWorX configuration database to be used as a
building block for all of the exercises that will follow. Although a configuration
database is created during installation, we will create one specifically for this
project.

3.1.1 Task Checklist

In this quick lab, you will complete the following tasks:

• Open the ReportWorX Configurator

• Create a new configuration database

3.1.2 Support Files

You do not need any support file to complete this lab.

3.2 Creating the Training Configuration Database

1. Start the ReportWorX Configurator by clicking on Start Æ Programs Æ
ICONICS BizViz Æ ReportWorX Æ ReportWorX Configurator.

2. Click on File Æ New Configuration Database.

3. The Configuration Database Wizard will appear, as shown in Figure L3.1.

ICONICS, Inc L3-1

Lab 3: C reating a New
N Report ReportWorrX Training Manual

Figure L3.1
L - Configuraation Database Wizard

4. Cllick Next to begin the wizard.

w

5. Leeave Use thiis Computerr selected too create the SQL

S Server Configuratio
C on
Daatabase locaally as shownn in Figure L3.2.
L Click Next
N to contiinue.

Figgure L3.2 - SQL

L Server Selection

6. Siince we are connecting

c too the local SQL
S Server, we can use Windows
W
In
ntegrated Seecurity as shhown in Figuure L3.3. Cliick Next to continue.
c

Figure L3.3 - Datab

base Security Loogin

L3-2 ICONICS
S, Inc
ReportWorX Training Manual Lab 3: Creating a New Report

7. Leave the settings in the next dialog as default, as shown in Figure L3.4, to
create a new database in which to hold the configuration, rather than append
the information to an existing database. We also want to include the samples
in the configuration database. Click Next to continue.

Figure L3.4 - Configuring Database Deployment Options

8. Name the database ReportWorX_Training and leave all other options

default as shown in Figure L3.5, as they are the ideal settings for most
configuration databases. Click Next to create the database.

Figure L3.5 - New Database Settings

9. The next dialog as shown in Figure L3.6 will show the steps being executed
while creating the new database, as all the predefined examples and structures
are added to the new database. When the steps are finished, you should be
informed that the operation was successful. Click Next to continue.

ICONICS, Inc L3-3

Lab 3: C reating a New
N Report ReportWorrX Training Manual

Figurre L3.6 - Database Creation Sttatus

10. Fiinally, acceppt the defaultt name and loocation for the
t .udl file to
t be used, and
a
make this the Active conffiguration daatabase by chhecking the Make
M Databbase
Acctive option as shown inn Figure L3.77. Click Nexxt to continuue.

Figgure L3.7 - Creaating the .udl File

11. Cllick Finish to

t close the wizard
w after viewing thee report.

12. Yo
our ReportW
WorX Configgurator should now lookk like Figure L3.8.

L3-4 ICONICS
S, Inc
ReportWorX Training Manual Lab 3: Creating a New Report

Figure L3.8 - The New ReportWorX Configuration

13. Now, create a new Report Configuration by right-clicking on

“Configurations” in the left navigation tree pane and selecting New Æ Report
Configuration. Name this new configuration as Acmeseutical Reports, and
then click Set As Active Configuration.

14. Next, right-click on the newly created Acmeseutical Reports configuration

listing in the navigation tree, and select New Æ Report Folder. Name the
folder as Acmeseutical Folder, and then click APPLY.

15. Right-click on the new Acmeseutical Folder, and select New Æ Report. Name
the report as Acmeseutical Report.

16. Be sure to enable this report by checking the Enabled checkbox to the
right of the Report Name field.

17. From the Report Template drop-down menu, be sure to select a template
such as Alarm Analytics.Alarm Distribution by Interval. We will create an
actual template in a later lab.

18. Finally, click on APPLY to save your new Report.

This completes Lab 3. We created a report configuration. The next chapter will
introduce you to report triggers.

ICONICS, Inc L3-5

Lab 3: Creating a New Report ReportWorX Training Manual

L3-6 ICONICS, Inc

ReportWo
orX Training Manual
M Reporrt Schedulin
ng and Trig
ggers

Repportt Sch
hedu
uling
g an
nd
4
Triiggeers
4.1 Objecti
O ves
After completing this chapter,, you shouldd know how to:

• Distinguissh between thhe different types of report triggers

• Create a reeport triggerr using the Unified
U Data Manager

4.2 Creatin
C ng a New
w Repoort Triggger
You can
c configurre triggers too execute your report based on a tim
me or event. Once
you have triggers configured, you can asssociate them
m to your repoorts. This caan be
done from the Advanced
A M
Mode of thee report prooperties. Once
O you are
a in
advan
nced mode, you can addd triggers by b using thhe Add buttton found inn the
Reporrt Schedulinng tab as shoown in Figurre 4.1.

Figuree 4.1 - Advanced

d Mode of the Report
R

S, Inc
ICONICS 4-1
Report Scheduling
S and Trigge rs ReportWorrX Training Manual

The trriggers that ReportWorX X uses residde in a centrralized locattion, namelyy, the
Unifieed Data Mannager (UDM M). In this way,
w multiplee ICONICS applications can
use th
he same triggger. You can
c get to the t UDM by b click on the “Run UDM U
Configurator” buttonn located too the lower--right corneer of the Report
R
Sched
duling tab.

4.2.1 Trig
ggers in the Unifieed Data Manager
M r
The EventTrigge
E ers tree conttrol of the Unified
U Dataa Manager (U UDM), show wn in
Figuree 4.2, contaains the trigggers that ReeportWorX canc use. Whhen you assign a
triggeer to a reportt, it will dettermine wheen (or on whhat conditionn) reports will be
execuuted. Reportss are executted based onn one or moore of the foollowing typpes of
triggeers:

• Event Grooups
• Event Swiitches
• Data/Timee Triggers
• Data Trigggers
• Alarm Trigggers
• File Triggers
• NT Event Triggers
• Database Triggers
T

Figure 4.2 - Triggers in th

he Unified Dataa Manager

In thee next few sections, we will describbe some of the

t most oftten used trigggers.
For more
m inform
mation abouut triggers oro the UDM M, refer to the UDM help
docummentation or the UDM appplication nootes.

4-2 ICONICS
S, Inc
ReportWo
orX Training Manual
M Reporrt Schedulin
ng and Trig
ggers

4.2.1.1 Datee/Time Triiggers

A Daate/Time triggger executtes an eventt periodically according to a speccified
recurrrence patternn (i.e. daily, weekly, moonthly, or yearly). The seettings for a time
triggeer are in the Time
T Triggeer Options tab
t as shownn in Figure 4.3.
4

Figurre 4.3 - Day/Tim

me Trigger Opttions

t you can configure thhe following settings:

In the Time Triggger Options tab,

• Name: Ennter a name forf the time trigger.

t
• Descriptioon: Enter a description
d f the time trigger
for t (optioonal)
• Start Datte/Time: Sppecifies a start s date and
a a start time for trrigger
execution.. Click the doown arrow tot select a daate from the calendar.
• Recurrence Pattern: Specifies the frequeency of thee periodic event e
execution (daily, weekkly, monthlyy, or yearly).
• Enable on n Tag: Cheecking this boxb links thee activation of the datee/time
trigger to a specific OPPC tag. Enteer the tag nam
me in the Ennable Tag fiield.
• Enable Tag:
T Specifyy a tag on which to enablee the date/time
d triigger.
Clicking the
t … button allows yoou to select a tag from the t Unified Data
Browser. The trigger will be dissabled if En nable Tag hash a value of 0,
FALSE, orr Bad Qualitty.
• Apply: Saaves all channges to the coonfigurationn database.
• Reset: Cleears all recenntly added innformation.
• Add New:: Creates a newn date/tim me trigger item m.

S, Inc
ICONICS 4-3
Report Scheduling
S and Trigge rs ReportWorrX Training Manual

In thee Related Values

V tab, as
a shown inn Figure 4.4,, you can asssociate diffferent
OPC tags
t to be read when thee Date/Time Trigger execcutes.

• Add Tag: Add a new tag to the reelated valuess.

• Add Valuue: Add a new w value to thhe related vaalues.
• Remove: Remove
R a taag or Value from
f the relaated values.
• Edit: Channge a selecteed tag or Vaalue.

Figure 4..4 - Date/Time Trigger

T Related
d Values

4.2.1.2 Recurrence Paatterns

As yo ou can see from Figuree 4.3, there are a few different
d reccurrence pattterns
availaable for the date/time
d triigger. Depennding on thee recurrencee pattern that you
choosse, you will have differeent options. We will desscribe each of o the recurrrence
patternns here.

• Daily Reccurrence Paattern: The daily

d recurreence pattern allows you to t set
up a time block for a daily
d recurriing period foor event exeecution. Speccify a
start date and start time for trrigger execuution, and then t specifyy the
frequency of daily exeecution everyy weekday or o every x nuumber of dayys.
• Weekly Recurrence
R Pattern: Thhe weekly reecurrence paattern allowss you
to set up a time blockk for a weekkly recurringg period for event execuution.
Specify a start date annd start time for trigger execution,
e annd then checck the
day on whhich you wannt to executee the event.
• Monthly Recurrence
R e Pattern: The
T monthly recurrence
r patttern allows you
y to
me block for a monthly reccurring periodd for event exxecution. Specify a
set up a tim
start date and
a start time for trigger execution,
e andd then specify
fy the frequenncy of
monthly exxecution (i.e. which
w day off each month).

4-4 ICONICS
S, Inc
ReportWo
orX Training Manual
M Reporrt Schedulin
ng and Trig
ggers

• Yearly Reecurrence Pattern:

P Thee yearly recurrrence patternn allows you to set
up a time block
b for a yeearly recurrinng period for event
e executiion. Specify a start
date and sttart time for trigger execuution, and theen specify thee frequency ofo the
yearly execcution (i.e. whhich day of a certain monthh to execute in the year).

4.2.1.3 Data
a Triggers
A Datta Trigger executes
e an event when an OPC tagg’s value chaanges. Depennding
on thee setup, youu can fire thhe trigger onn all data chhange, or onlly when thee data
changges to true orr false. In thhe Data Triggger Properrties tab, as shown in Figure
F
4.5, yo
ou can confiigure the following settinngs:

• Name: Ennter a name forf the time trigger.

t
• Descriptioon: Enter a description
d f the time trigger
for t (optioonal)
• Enable on n Tag: Checcking this boox links the activation ofo the data trrigger
to a speciffic OPC tag. Enter the taag name in thhe Enable Tag
T field.
• Enable Tag: Specify a tag on whhich to enabble the data trigger. Cliccking
the … buttton allows youy to selecct a tag from m the Unifieed Data Brow wser.
The triggeer will be diisabled if En nable Tag has
h a value of 0, FALS SE, or
Bad Quality.
• Apply: Saaves all channges to the coonfigurationn database.
• Reset: Cleears all recenntly added innformation.
• Add New:: Creates a newn event sw witch item foor you to connfigure.

Figu
ure 4.5 - Data Trigger
T Propertties

In thee Data Triggger Options tab, as show wn in Figuree 4.6, you can
c configurre the
condittion to fire thhe data triggger and the data
d tag to monitor.

• Execute Condition:
C T trigger executes
The e an event
e on anyy data tag change,
or when thhe data tag chhanges to TR
RUE (1) or FALSE
F (0).

S, Inc
ICONICS 4-5
Report Scheduling
S and Trigge rs ReportWorrX Training Manual

• Data Tagg: You can either

e type a data tag diirectly into this
t field, orr you
can click the
t … buttoon to the righht of this fieeld to open the Unified Data
Browser, where
w you caan select a data
d tag.

Fiigure 4.6 - Dataa Trigger Option

In thee Related Values

V tab, you can asssociate tagss to be readd when the Data
Triggeer is executeed.

• Add Tag: Add a new tag to the reelated valuess.

• Add Valuue: Add a new w value to thhe related vaalues.
• Remove: Remove
R a taag or Value from
f the relaated values.
• Edit: Channge a selecteed tag or Vaalue.

NOTE: Forr other triggerrs such as Allarm Triggers, File Triggerss, NTEvent
Triggers, ettc, please refeer to the helpp documentatiion in the Unnified Data
Manager.

4-6 ICONICS
S, Inc
ReportWo
orX Training Manual
M Lab 4: Report
R Trig
ggers

Lab
b: Report Trigg
T gers 4

4.1 Lab
L Ovverview
w
This lab will explain how to create
c a date//time triggerr and add thee trigger to a
reportt.

In the grand schem me of things, the trigger starts a repoort, and the report
r executtes.
If therre are redirecctor actions associated with
w the repoort, it will theen execute thhe
redireector actions when the reeport finishess. Figure L4.1 shows thee complete order
o
of the process.

F
Figure L4.1 - Prrocess Overview
w

In thiss lab, we willl focus on thhe first step of the process; the triggeers. We will first
configgure a triggeer in the Uniffied Data Maanager (UDM M) and then add it to a report
r
in the ReportWorX X Configuraator.

4.1.1 Task
k Checkllist
In thiss quick lab, you
y will com
mplete the foollowing taskks:

• Add a trigger to the UD DM

• Add a trigger to the coonfiguration

4.1.2 Supp
port Filees
To com
mplete this quuick lab, you will not needd any support files.

S, Inc
ICONICS L4-1
Lab 4: R eport Trigg
gers ReportWorrX Training Manual

4.2 Creatin
C ng a New
w Triggger
The fiirst step is too add a new trigger
t to thee UDM.

1. Laaunch the Unnified Data Manager

M by selecting Start Æ Programs ÆICON
NICS
ools Æ Uniffied Data Maanager.
To

2. Oppen the Even nt Triggers folder in thee tree controol. You will see
s the diffeerent
typ
pes of triggeers that are available.
a

w Æ Time Trigger
3. Riight-click onn Date/Time Triggers annd select New T Item, as
sh
hown in Figuure L4.2.

Figu
ure L4.2 - Add Time
T Trigger Ittem

a set it to recur every 20 seconds with

4. Naame the triggger Every 20 Seconds, and w
a Daily
D Recurrrence Patteern. Click onn Apply andd the trigger is ready to be
b
ussed. Your finnished Trigger may lookk similar to Figure
F L4.3.

Figu
ure L4.3 - 20 Seccond Time Triggger

L4-2 ICONICS
S, Inc
ReportWo
orX Training Manual
M Lab 4: Report
R Trig
ggers

5. Oppen the RepoortWorX Coonfigurator and

a go to thee Acmeseuticcal Reports
co
onfiguration.. Click on the Advanced
d Mode buttoon.

6. Neew tabs will appear. In the

t Report Scheduling
S t click on Add. The
tab
Un
nified Data Browser
B willl open.

7. In D tab, seleect the Timee Trigger folder and douuble-click onn the
n the UDM Data
Evvery 20 secoonds trigger as shown inn Figure L4.44. Then clickk on OK.

Figure L4.4 - Selectin

ng the Time Trigger

8. Yoou should noow be in the ReportWorX X Configuraator and youur Time triggger
sh
hould be listeed in the Repport Schedulling tab as shhown in Figuure L4.5. Cliick
on
n Apply, to save
s the channges. If yourr ReportWorrX engine iss running, yoou
wiill get a warnning asking if you want to notify thee ReportWorrX engine with
w
the new triggeers. Select “YYes, notify Report
R Enginne Now”.

Figure L4.5
L - Report Sccheduling with Trigger

9. Th
he ReportWoorX engine will
w now exeecute the repport every 200 seconds.
NOTE: Youu may want to manually execcute the report to
t make sure itt runs correctlyy first
before giving it a periodic trigger.

S, Inc
ICONICS L4-3
Lab 4: Report Triggers ReportWorX Training Manual

This completes Lab 4. We created a trigger and associated it to a report. The next
chapter will introduce you to Redirector Actions

L4-4 ICONICS, Inc

ReportWo
orX Training Manual
M Red
director Acttions

Red
direectorr Action
ns 5

5.1 Objecti
O ves
After completing
c t chapter, you should know how to:
this t

• Distinguissh between thhe different types of redirector actions

• Create a reedirector acttion using the ReportWoorX Configurrator
• Create a coombined acttion using thhe ReportWoorX Configurrator

5.2 Redirec
R ctor Tassks and
d Action
ns Overrview
The Redirector
R A
Actions treee control in the Configuurator, show
wn in Figuree 5.1,
allowss you to deffine a sequeence of redirrector actionns for reportt delivery (ii.e. e-
mail, fax, file coppy, printer, and
a Web pubblishing). A redirector taask defines a new
destin
nation for thee report oncee it completees.

Figure 5.1 - Redirectoor Tasks Tree Control

C

You can
c configuure Redirecttor Actions under the Report Toools tree conntrol.
ReporrtWorX usess the followinng methods for report exxecution andd delivery:

• E-mail
• Fax
• File Copy
• Printing
• Web Publiishing

S, Inc
ICONICS 5-1
Redirecttor Actions ReportWorrX Training Manual

5.3 Creatin
C ng a New
w Redirector Action
A
Each type of redirector
r a
action has its own folder withhin the Reeport
Toolss/Redirectorr Actions brranch of thee tree controol. Create reedirector taskks by
right-cclicking onn the folderr of the tyype you waant, and chhoosing New w Æ
Redirrector Actioon, as shownn in Figure 5.2.

Figure 5..2 - Creating a New

N Redirectorr Action

The dialog
d for a new redirecctor action is shown inn the right-hhand pane of o the
Configurator. Witth the excepption of a nam me and desccription, the redirector action
a
properrties will varry dependingg on the typee of action.

5.4 E-Mail
E Actions
An E--mail action n enables you to send ouut reports to one or moree recipients via
v e-
mail. Before youu can send reports viaa e-mail youu must speccify your e-mail
setting
gs in the SMMTP Settin ngs tab of thhe Options dialog box (under the ToolsT
menu)), shown in Figure 5.3, which sets thet secure connection
c a
access parammeters
for thee Reporting Service.

Figure 5.33 - Options Diallog: SMTP Setttings Tab

• SMTP Server: Speciffies the namme of the e-m

mail server ussed to send the
t e-
mail messsage. A serveer name muust be entered in this field in order for
f e-

5-2 ICONICS
S, Inc
ReportWo
orX Training Manual
M Red
director Acttions

mail notifi
fication messsages to be sent. It is reecommendedd that you create
c
an e-mail account
a to be
b used speciifically for e-mailing
e repports.
• Login Naame and Passsword: Entter a valid, alphanumeri
a ic user namee and
password (specified inn the Securityy Server connfiguration settings).
s
• Confirm Password:
P R
Re-enter youur password for confirmaation.
• Sender E-Mail:
E Enteer the e-maail address of o the sendder of the e-mail
message. (The
( Reportiing Service is
i the defaullt.)

You can
c configurre the follow
wing settings for an e-maail action, as shown in Figure
F
5.4:

• Redirectoor Action Naame: Enter a name for thhe redirectorr action.

• Action Tyype: Displaays the redirrector actionn type (e.g. e-mail, faxx, file
copy, printer, or Web publishing).
p
• Retry Nu umber: Sets the numberr of attemptss to deliver the report to t the
specified recipient
r if thhe initial atteempt fails.
• Retry Deelay: Sets delay
d time (in seconds) between subsequent retry
attempts. The
T minimum m delay is 202 seconds.
• Mail To: Specifies thhe recipient(s) to whom you wish too send the e-mail
message.
• CC: Sends a "carbon copy"
c of thee e-mail to annother recipiient.
• BCC: Sennds a "blindd carbon coopy" of the e-mail messsage to annother
recipient.

Figu
ure 5.4 - E-Maill Action Properrties

S, Inc
ICONICS 5-3
Redirecttor Actions ReportWorrX Training Manual

• Recipient(s) Type: For the Mail To, CC, annd BCC fiellds, select one of
the follow
wing recipiennt types from
m the drop-doown list:
o Ab bsolute Address: Sends thhe message too an individuaal’s e-mail address.
Whhen this optioon is selected,, you can clicck the arrow buttons
b next to the
Maail To, CC, and a BCC fields to browsee for an e-maail address ussing a
MA API-compliannt e-mail clieent (e.g. Micrrosoft Outloook). Under Profile
P
Naame, select your e-mail seerver from thhe drop-downn list, as show wn in
Figgure 5.5.
o Registered Useer: Sends the message to a single registeered user (meember
of a group).
o Registered Group: Sends the messagee to all regiistered users in a
speecified group..
o Maailing List: Sends
S the messsage to all reegistered userrs and/or grouups in
a managed
m list.

Figu
ure 5.5 - Selectin
ng an E-Mail Address
A From Your
Y E-Mail Serrver

NOTE: Ussers, groups, and managedd lists are coonfigured in the Client
Managemen
nt tree control of the Configuurator.

• Subject: Specifies
S thee subject linee of the e-maail message.
• Body: Typpe in the conntent of the e-mail
e messaage.

NOTE: In thet subject annd body text of

o an e-mail message,
m you can
c use the
following shhortcuts: %n for
fo Report Nam
me, %t for Repport Executionn Time, and
%d for Repoort Execution Date.
D

• Request Return
R Recceipt: Whenn this checkk box is cheecked, the seender
will be nootified whenn the recipieent of the e-mail
e messaage has readd the
message.
• Compresss (Zip) Attaachment: Zipps up attachhed files befoore sending the t e-
mail. Thiss reduces thee size of thee attachmentt, which mayy be importaant if
your e-maail server impposes limits on attachmeent size.
• Apply: Saaves all channges to the coonfigurationn database.
• Reset: Cleears all recenntly added innformation.
• New Actioon Object: Creates
C a neww e-mail acttion for you to configuree.

5-4 ICONICS
S, Inc
ReportWo
orX Training Manual
M Red
director Acttions

5.5 Fax
F Acttions
A Fax x action enaables you to send
s out repports to one or
o more recippients using a fax
machiine. In orderr to use the Fax Agent,, you must haveh Microssoft Fax Serrvices
installled on your computer. The
T availablle settings for
fo a fax actiion are showwn in
Figuree 5.6 and desscribed below:
NOTE: Goiing forward, we w will not desccribe some of the common properties
p to
the redirectoor task. Thesee properties incclude Redirecttor Action Naame, Action
Type, and onn Error Settinggs.

Figgure 5.6 - Fax Action

A Properties

• Fax Printter Name: Specifies the name of thee fax machinne.

• Fax Recip pient Number: Enter thee fax numbeer of the repoort recipient here.
• Recipient Name: Enteer the name of the reporrt recipient here. h
• Sender Naame: Enter the t name of the report seender here.
• Subject: Specifies
S thee subject linee of the e-maail message.
• Cover Page: You havve the optionn of includinng a separatee cover pagee with
the faxed report. To select a coveer page to seend, click thee ... button to
t the
right of thiis field and browse
b for a cover page (.cov) file.

NOTE: In thhe subject textt of a fax, you can use the folllowing shortcuuts: %n for
Report Nam
me, %t for Report Executionn Time, and %d % for Reportt Execution
Date.

S, Inc
ICONICS 5-5
Redirecttor Actions ReportWorrX Training Manual

5.6 File
F Coppy Actiions
A filee copy action
n copies repports to a selected directoory in Excell, PDF, or HTML
formaats. The avaiilable settinggs for a file copy action are shown in
i Figure 5.77 and
descriibed below.

Figurre 5.7 - File Cop

py Action Propeerties

• Destinatioon Folder: Click the … button to browse for and select a file
copy destination directory.
• Copy Repoort As: Fromm the drop-doown list, chooose the formaat (Excel, PD DF, or
HTML) in which the repport will be coopied to the selected directtory
• Compress (Zip) File: Zips up repoort files befoore copying them t to the target
directory. This
T reduces the
t size of thee report files.

5.7 Printer
P Action
ns
A priinter action n enables youy to printt out complleted reportts. The avaiilable
setting
gs for a printter action are shown in Figure
F 5.8 annd describedd below.

• Action Settings: Chheck all printers to which

w you want
w to send a
completedd report.
• Number ofo copies: Sppecifies how
w many copiees of the repoort to print.

5-6 ICONICS
S, Inc
ReportWo
orX Training Manual
M Red
director Acttions

Figu
ure 5.8 - Printerr Action Properrties

5.8 Web
W Puublishin
ng Actioons
A Weeb Publishin ng action ennables you too publish com
mpleted repoorts to a speccified
Web server so thhat recipientts can simpply downloaad and view w the report.. The
availaable settingss for a Webb Publishingg action aree shown inn Figure 5.99 and
descriibed below.

NOTE: If you y would like to include Weeb Publishing inn any of your reports,
r you
must first coonfigure a web server where you
y can publishh your files.

• Publishing Type: ReeportWorX supports tw wo types of Web Publisshing:

FTP (file transfer prootocol) and HTTP
H (hyppertext transffer protocol)). On
some OSees, you may not be able to use HTT TP to publishh because thhe OS
blocked thhis method. In this casee, you have to use FTP P to publish. You
must first setup your FTP
F server before
b you caan use it.
• Publish to URL: In the Publissh to URL field, use the t default URL
address for your local Web serverr: http://locaalhost/Reporrts. Make suure to
replace thee localhost with the nam
me of your WebW server computer, or o the
client com mputer willl not be able to see s the reeports overr the
Internet/inntranet.

S, Inc
ICONICS 5-7
Redirecttor Actions ReportWorrX Training Manual

• Publish Report
R As: From
F the drrop-down lisst, choose thhe format (E
Excel,
PDF, or HTML)
H form
mat in whicch the repoort will be ppublished too the
entered deestination.

Figure 5..9 - Web Publisshing Action Prroperties

• Authenticcation: You must specify fy a User Naame, Passwoord, and Dom main
(computerr) name for Windows NT integratted securityy needed to gain
access to the
t Web servver. The user account shhould have write
w privilegges to
the target location (UURL address specified inn "Publish to t URL") foor the
reports.
• Allow Anonymous Login: L Whenn this check box
b is checkked, users will
w be
able to logg in to the sppecified Weeb server witthout user name or passsword
authenticaation. This iss available foor HTTP onlly.
• User Nam me: Specifiess an alphanuumeric loginn name for access to the Web
server.
• Password d: Specifies an alphanum meric login password for
f access too the
Web serveer.
• Domain: Specifies thhe NT domaain (computter) name for fo Windowss NT
integrated security.

5-8 ICONICS
S, Inc
ReportWo
orX Training Manual
M Red
director Acttions

5.9 Combin
C ned Red
directorr Action Properties
Once you have configured
c a least onee report rediirector actioon, you can then
at
createe a combinned redirectoor action as a shown inn Figure 5.10. This is a
combiination of seeveral redirecctor actions, in any order.

Figure 5.10 - Redirector Coombined Action

n Properties

In thee Action Setttings, you caan specify a group of reddirector actioons. To creaate an
actionn group, cliick the Add d Action button.
b This opens the Add Redirrector
Action ns Group diialog box, as a shown in Figure 5.11. This dialog lists all other
redireector actions in the activve configurattion databasse. To add a redirector action
a
to the group, selecct the actionn and then cliick on the OK
O button. The
T added acctions
are lissted in the Action
A Settinngs, as show
wn in Figure 5.10. Click on the Movve Up
buttonn or Move Down
D buttonn to change the sequencce of redirecttor actions ini the
groupp.

Figure 5.11 - Adding Redirrector Action(s) to a Group

S, Inc
ICONICS 5-9
Redirector Actions ReportWorX Training Manual

5-10 ICONICS, Inc

ReportWorX Training Manual Lab 5: Creating Redirector Actions

Lab: Creating
5
Redirector Actions
5.1 Lab Overview
In this lab, we will create various redirector actions that we will later use in
combination with our Acmeseutical reports.

5.1.1 Task Checklist

In this quick lab, you will complete the following tasks:

• Create an E-mail Redirector Action

• Create a File Copy Redirector Action
• Create a Combined Redirector Action

5.1.2 Support Files

You do not need any support file to complete this lab.

5.2 Creating Redirector Actions

1. Navigate to the Redirector Actions branch of your ReportWorX
Configurator, under Report Tools.

2. First, we will create an E-mail Redirector Action. To do so, right-click on the

E-mail Actions branch and select New Æ Redirector Action.
NOTE: This Redirector Action will only work if your training PC has a
connection to the Internet, and your SMTP Settings (in the ReportWorX
Options found in the Tools menu) are configured properly.

3. In the Redirector Action Name field, specify Acmeseutical E-mail Action.

4. In the Mail To, CC, and BCC fields, specify any e-mail addresses that you
would like, but for the Subject and Body fields, please note the additional

ICONICS, Inc L5-1

Lab 5: Creating
C Red
director Ac tions ReportWorrX Training Manual

sh
hortcuts that are availablee to you in thhe bottom riight-hand coorner of the
dialog.

n the Subject field, type “E-mailing

5. In “ R
Report: %n”.

6. In
n the Body field, type:
Reeport name: %n
Exxecution daate: %d
Exxecution tim
me: %t

7. Yoour E-mail Redirector

R A
Action dialogg should lookk like Figuree L5.1. Clickk
Appply to savee the configuuration. Pleasse note that a warning message
m shouuld
ap
ppear in ordeer to acknowwledge this fiirst configuraation.

Figuree L5.1 - Acmeseeutical E-Mail Action

A

8. Neext, we will create a Filee Copy Redirector Actioon. To do soo, right-click on

Fiile Copy Actions and seelect New Æ Redirectorr Action.

9. In
n the Redirecctor Action Name
N field, put
p Acmeseu
utical File Copy
C Action
n.

10. Cllick on the “…” button to t browse for a Destinattion Folder, and then
naavigate to yoour C:\temp directory. ClickC the Neew Folder buutton to creaate a
neew folder underneath this directory and a call it FiileCopyDesttination. Then
cliick the OK button
b to sellect that locaation. Refer to Figure L55.2 for
claarification.

L5-2 ICONICS
S, Inc
ReportWo
orX Training Manual
M Lab 5: C reating Red
director Acttions

Figure L5.2 - File Cop

py Destination Folder
F

11. Inn the Copy Report

R As drop-down
d box, leave it as
a Excel, buut let’s also check
c
the Compresss (Zip) File check
c box too make the best
b use of ouur disk spacee.

12. Cllick Apply once

o you havve made thosse changes, and
a your com
mpleted Filee
Co
opy Action should
s resem
mble the one in Figure L5.3.

Figure L5.3
L - Acmeseu
utical File Copy Action

13. Fiinally, we wiill create a Combined

C Acction, whichh allows you to specify any
a
nu
umber of Reddirector Actions to execuute as a “grooup,” in any order that you
sp
pecify.

w Æ Redirecttor Action.
14. Riight-click onn Combined Actions andd select New

15. In
n the name field, specify Acmeseuticcal Combineed Action.

16. Ass you can see, you start with

w a blankk slate. Clickk on the Add d Action buttton
to choose fromm a list of exxisting Redirrector Actionns, or you caan even creatte a
neew action froom here usinng the Redireector Action Wizard.

S, Inc
ICONICS L5-3
Lab 5: Creating
C Red
director Ac tions ReportWorrX Training Manual

17. Frrom the Addd Redirector Action(s) diialog, use thee <Ctrl> keyy to select booth
the Acmeseuttical E-mail Action and the Acmeseeutical File Copy C Action n,
an
nd then clickk OK.

18. Yoour completed Acmeseuutical Combiined Action should

s look like Figure L5.4.
L
Cllick Apply to save the coonfigurationn.

Figure L5.4
L - Acmeseuttical Combined
d Action

This completes
c Laab 5. In the next lab youu will learn how
h to confiigure report
templates and beggin configuriing our existting templatees with Acm
meseutical daata.

L5-4 ICONICS
S, Inc
ReportWo
orX Training Manual
M Reeport Temp lates

Rep
portt Tem
mplatess 6

6.1 Objecti
O ves
After completing this chapter,, you shouldd know how to:

• Create a teemplate foldder

• Create a reeport templaate using the ReportWorX
X Configuraator

6.2 Designi
D ng Rep
port Tem
mplatess
The Report
R Temmplates tree control of the Configuurator, show wn in Figuree 6.1,
allowss you to creeate and connfigure Micrrosoft Excell templates for your repports.
The Excel
E spreaddsheet templlate design dictates
d whaat kinds of data
d your reeports
will contain and how
h the dataa will be dispplayed in yoour reports. The
T ReportW WorX
Configurator provvides severaal sample repport templattes. The report configurration
tree-control also provides a Report Tem mplate Wizaard to help you create your
templates.
NOTE: Youu must have a report
r templatee in order to exxecute a report.

Figure 6.1 - Report Teemplates Tree Control

C

S, Inc
ICONICS 6-1
Report Templates
T ReportWorrX Training Manual

6.3 Creatin
C ng Repoort Tem
mplates
Creatiing report templates invoolve the folloowing main steps:

• Creating a report tempplate folder

• Creating a new report template
• Setting repport templatee properties
• Configurinng a report teemplate in Microsoft
M Exxcel

You can
c create new
n templatte folders annd template objects in the ReportWWorX
Configurator by right-clickingg on a parennt folder and choosing thhe New comm
mand
as sho
own in Figurre 6.2.

Figure 6.2
6 - Creating a New Templatee Folder

When n you create a new reporrt template ittem, you willl have the foollowing opttions,
as sho
own in Figurre 6.3-:

• Create Bllank Excel Workbook k: Creates a new, blank Microsoft Excel

E
template workbook
w (e.g. without any
a formattinng or data coonfiguration).

NOTE: Users
U of RepportWorX Configurator
C r V9.2 and Microsoft
M O
Office
2007 can take
t advantaage of new functionality
fu . When creaating a new report
r
template the
t configurrator will automatically
a y detect if you are runnning
Microsoft Office 2007 and will provide
p the updated opption of seleecting
between Office
O 2007 and Office 2003
2 formatts for the creeation of thee new
blank tempplate workboook.

6-2 ICONICS
S, Inc
ReportWorX Training Manual Report Templates

Figure 6.3-1 - Office 2007 or Office 2003 Option in New Report Template Creation
in ReportWorX Configurator

In addition, following installation of the standalone version of the

ReportWorX V9.2 application (or complete BizViz V9.2 suite
installation), Microsoft Office 2007 will now display a native
ReportWorX ribbon tab. This is an update from how previous versions of
Office would provide access to ReportWorX functions (compatibility
menus under the Add-Ins tab).

Figure 6.3-2 - New ReportWorX Tab in Office 2007 for Users Running ReportWorX V9.2

Also, when using the new ReportWorX ribbon tab in Office 2007, and
having previously selected an Office 2007 (Excel 2007) report template,
users will have the option to save the template back to Office 2003 (Excel
2003 Template) format.

ICONICS, Inc 6-3

Report Templates ReportWorX Training Manual

Figure 6.3-3 - Reverting an Existing Office 2007 (Excel 2007) Report Template

Should a user have initially selected to create a report template in Office

2003 format, the new ReportWorX ribbon tab options will allow the
template to be "upgraded" to the newer Office 2007 (Excel 2007
Template) format.

Figure 6.3-4 - Upgrading an Office 2003 (Excel 2003) Formatted Report Template
to Office 2007 (Excel 2007) Format

6-4 ICONICS, Inc

ReportWorX Training Manual Report Templates

• Copy Formatting from Existing Workbook File: Uses an existing

Microsoft Excel workbook file as a basis for the design of your new
template. Click the Ellipsis (...) button to browse for an existing Excel
workbook.
• Copy Formatting from Existing Template Object: Uses an existing
Microsoft Excel template from the configuration database as a basis for
the formatting (i.e. style, design, fonts, etc.) of your new ReportWorX
template. Select the existing template from the drop-down list, which lists
all templates in the active configuration database.
• Copy Formatting and Data Links from Existing Template Object: It
does the same thing as the Copying Formatting From Existing Template
Object option. On top of that, it copies any data configurations (i.e. open
database connections, OPC tags, etc.) contained in the existing template to
the new template.

Figure 6.3-5 - Selecting a Template Type

6.3.1 Report Template Object Properties

You will notice, as shown in Figure 6., that once the template object is created,
there are almost no properties to set on the configuration page. This is because the
configurations are set by the template in Excel. The following options are found:

ICONICS, Inc 6-5

Report Templates
T ReportWorrX Training Manual

Figurre 6.4 - Report Template

T Propeerties

• Template Name: Entter a name for f the reporrt template. WhenW a tem
mplate
is created,, the Excel file will be named afteer the templaate name. Iff you
rename thee template, the
t Excel filee will also be renamed automatically
a y.
• Template Description n: Enter a deescription foor the templaate (optional)).
• Current Published
P V
Version: Thee version of template
t currrently used.
• Apply: Saaves all channges to the coonfigurationn database.
• Reset: Cleears all recenntly added innformation.
• New Repoort Templatte: Creates a new report template to be configureed.

You can
c modify a template by b Click the Ellipsis button. Thee message shhown
in Fig
gure 6. appeears, stating that while the templatte is being edited,e all active
a
reportts that are baased on the teemplate willl be temporaarily disabledd.

Figuree 6.5 - Editing the

t Report Tem
mplate

Once you acknow wledge this message,

m thee template oppens in Micrrosoft Excell, and
the ReportWorX
R Configuratoor temporariily closes while
w you aree working inside
the tem
mplate. Wheen you have finished editing the tem mplate, closee Microsoft Excel
E
and thhe Configuraator will reoopen to the template
t prooperties. All reports linkked to
the tem
mplate will be
b re-enableed.

6-6 ICONICS
S, Inc
ReportWorX Training Manual Lab 6: Configuring Templates

Lab: Configuring
6
Templates
6.1 Lab Overview
In this lab we will configure our Acmeseutical templates to mine data from the
Acmeseutical database.

6.1.1 Task Checklist

In this quick lab, you will complete the following tasks:

• Create a new template folder

• Create a new template

6.1.2 Support Files

To complete the Chapter 6 quick labs, you will need the following support files:

• Acmeseutical_Standard.xls

6.2 Creating Templates

1. If your ReportWorX Configurator is not already open, click Start Æ
Programs Æ ICONICS BizViz Æ ReportWorX Æ ReportWorX
Configurator.

2. Navigate to the Report Templates folder under Report Tools. You should
see the Sample Templates folder already there, as shown in Figure L6.1.
These are the templates that are included by default with a new ReportWorX
configuration database.

ICONICS, Inc L6-1

Lab 6: C onfiguring Templates ReportWorrX Training Manual

F
Figure L6.1 - Reeport Templatess

3. Teemplates muust be stored underneath a folder (theey cannot bee stored at the top
lev
vel). Therefoore, in this laab, we will create
c w template folder called
a new
Accmeseuticall Templates.

mplates and select New Æ Templatee Folder.

4. Riight-click onn Report Tem

5. In
n the Templaate Folder Naame field, ennter Acmeseeutical Temp plates. Enterr a
deescription if you
y wish, annd then clickk Apply, as shown
s in Figgure L6.2.

Figure L6.2
L - Acmeseuttical Templatess Folder

6. Neext, we will create a new

w template underneath
u thhis folder usiing a predefi
fined
Accmeseutical header from m an externall Excel file.

n your new Acmeseuticcal Templattes folder annd select Neew Æ

7. Riight-click on
Reeport Temp plate. The Insert New w Report Template
T diaalog will apppear,
wiith five diffeerent optionss for you to choose
c from
m, as shown inn Figure L6.3.

8. Seelect the Cop

py formattiing from exxisting Exceel workbook k file optionn, and
cliick the “…” button to brrowse for ann Excel workkbook file.
NOTE: Youu can select Crreate blank Exxcel workbook
k if you wish too work
with an emppty Excel templlate.

L6-2 ICONICS
S, Inc
ReportWo
orX Training Manual
M Lab
b 6: Configu
uring Temp lates

9. Brrowse to youur C:\Program m Files\ICO

ONICS\GEN NESIS32\Exaamples\Trainning -
BiizViz\ folderr, and then select the Acmmeseutical__Standard.xlss file. The Innsert
Neew Report Template
T diaalog should look like Figgure L6.3.

10. Cllick OK to create

c a new template baased on this Excel
E workbbook. Let’s name
n
it Acmeseuticcal Report Template,
T annd then clickk Apply.

Figgure L6.3 - Seleecting the Acmeeseutical_Standard.xls Templaate

11. Fiinally, to undderstand the effects of coopying an exxisting Excell file when
creating a new
w template obbject, click the
t buttoon in the Tem
mplate Versiions
fraame. This will
w allow youu to view your newly creeated templaate within Exxcel,
an
nd you shoulld see somethhing similar to Figure L6.4.

Figure L66.4 - Acmeseuticcal Formatted Template

T

12. Cllose Excel too return to thhe Configuraator, and clicck Commit Changes
C to save
the template. You
Y will reoopen this tem mplate to conntinue with thhe next two labs.

S, Inc
ICONICS L6-3
Lab 6: Configuring Templates ReportWorX Training Manual

This completes Lab 6. We have created a new report template using the
Acmeseutical template. The next lab will walk you through configuring data
sources.

L6-4 ICONICS, Inc

ReportWo
orX Training Manual
M Data Sou
urces

Data Sour
S rces 7

7.1 Objecti
O ves
After completing this chapter,, you shouldd know how to:

• Connect too OPC tags using

u the ReeportWorX Excel
E Interfaace
• Connectinng to databasses using the ReportWorrX Excel Inteerface
• Create an advanced daatabase queryy using the ReportWorX
R X Excel Interrface
• Add headeers to report templates
• Duplicate and deletee data conffigurations in the RepportWorX Excel E
Interface
• Distinguissh between thhe different types of report parameteers
• Use the Paarameter Broowser to browse for and select existiing parameteers
• Use the Paarameter Wizzard to creatte, edit, and delete reporrt parameterss

7.2 Configu
C uring a Report Temp
plate
Reporrt templatess are configgured in Microsoft
M Exxcel. In the report temmplate
properrties of the Configurator
C r, you can cllick the buutton to launnch the Micrrosoft
Excel workbook correspondding to yourr template. The templaate opens inside
Microosoft Excel, and the RepportWorX Coonfigurator temporarily
t closes whilee you
are wo
orking insidee the templaate in Excel.

The ReportWorX
R X template designer innserts a ReeportWorX menu intoo the
Microosoft Excel menu bar, as shown iin Figure 7.1. This meenu contains the
follow
wing commaands:

• Data Sourrce Manageer: Opens the Data Sourcce manager.

• Parameteer Browser: Opens the Parameter
P Brrowser.
• Duplicatee Worksheett: Creates a duplicate
d off the selectedd worksheet.
• Save As New
N Version n: Create a new
n version of the currennt template.
• Commit Template
T Chhanges: Ediit comments about the cuurrent template.

S, Inc
ICONICS 7-1
Data Sources ReportWorX Training Manual

• Template Information: Displays the history for the template.

• Template Designer Help: Launches the online Help documentation for
the ReportWorX Excel Template Designer.

Figure 7.1 - ReportWorX Menu in Microsoft Excel

NOTE: If you are using Microsoft Office 2003, there will be a ReportWorX
menu in the toolbar.

When you open Excel through ReportWorX, the following File menu commands
in Microsoft Excel are not supported:

• File - New: All new ReportWorX templates must be created through the
ReportWorX Configurator.
• File - Open: All new ReportWorX templates must be opened by clicking
the Edit This Template button in the ReportWorX Configurator.
• File - Save As: When a template is created in the ReportWorX
Configurator, the Excel file will be named after the template name. If you
rename the template, the Excel file will also be renamed automatically.

For every report that you want to run, you must format the cells with supported
data type in order to generate your reports correctly. The ReportWorX Excel
interface includes an embedded pop-up menu that allows you to specify data
sources for your reports, as mentioned earlier.

To format the data type, select the cell(s) you wish to format and then right-click
on the selected (highlighted) cells in the Microsoft Excel workbook. In the pop-up
menu options, choose Connect to new Data Source as shown in Figure 7.2.

From this pop-up menu, you can connect to:

• OPC Data Access (DA) and Historical Data Access (HDA) tags.
• ICONICS TrendWorX32 historical tags, text aliases, and language aliases.
• Databases, including Microsoft Access, Microsoft Excel, Microsoft SQL
Server, etc.
• Alarm Analytics
• Parameter

7-2 ICONICS, Inc

ReportWo
orX Training Manual
M Data Sou
urces

• Hyperlinkks
• Custom Data Sources
• Web services
• Integrationn Tasks

Reporrts are execuuted based on the data connectionss you speciffy in your Excel
E
templates.

Figure 7.2 - Selecting a Datta Type in Micrrosoft Excel

Once cells are connfigured witth data connnections, smaall red trianggles appear in
i the
top right corner of
o the cell, to
t show thaat it has its data
d connecttions configgured.
You can
c view comments aboout the data source for a particular cell by hovvering
the moouse pointerr over the cell, as shown in Figure 7..3.

NOTE: Youu may find it necessary to upddate commentss by selecting the

t Refresh
Comments command from m the ReportW WorX menu in Excel.

Figure 7.3 - Viewing Comm

ments in Excel Spreadsheet
S

Whenn you are fiinished conffiguring a template,

t saave and closse Excel ass you
normaally would an Excel worrkbook.

The ReportWorX
R X Configurattor will reoopen to the template prroperties, annd all
reportts linked to the
t template will be re-ennabled.

S, Inc
ICONICS 7-3
Data Sources ReportWorX Training Manual

7.3 Connecting to OPC Tags

The ReportWorX Excel configuration interface enables you to link data cells in
your spreadsheet template to real-time data sources. This way, you can generate
reports using real-time data from OPC tags, expressions, and global aliases. You
can connect to the following types of OPC tags:

• OPC Data Access (OPC DA) Tags

• OPC Historical Data Access (OPC HDA) Tags

7.3.1 OPC Data Access Tags

Right-clicking on a cell (or group), and then selecting Connect to new Data
Source Æ OPC Æ Data Access (DA) Tag from the pop-up menu, to launch the
OPC DA Connection Wizard as show in Figure 7.4.

Figure 7.4 - Connecting to an OPC Data Access Tag

The OPC DA Connection Wizard dialog box, shown in Figure 7.5, helps you
choose the tag connections.

To choose a DA tag with the OPC DA Connection Wizard, click on the ellipsis
(…) button to open the Unified Data Browser. Once in the browser, select the
tag, expression, or alias that you want to use.
NOTE: You can also select expressions or global aliases. Please refer to the
ReportWorX Configurator help documentation for information about the
Expression Editor and global aliasing.

7-4 ICONICS, Inc

ReportWo
orX Training Manual
M Data Sou
urces

Figuree 7.5 - OPC DA

A Connection Wizard
W

The selected
s tag appears in the Tag Naame field off the OPC DA Connection
Wizarrd dialog boox, as shownn in Figure 7.6.

Figure 7.6 - OPC Data

D Tag Selectted

Click on the Nexxt button to display thee Configure Engineeringg Units andd Tag
Descrriptions checck box as shown in Figuure 7.7, and enable it to allow the usser to
view this
t informattion.

S, Inc
ICONICS 7-5
Data Sou
urces ReportWorrX Training Manual

Figgure 7.7 - Configguring Engineeering Units and Tag Descriptioons

Clickiing the Nextt button andd checking thhe Configuree Data Sourcces Names check
c
box, as
a shown in Figure
F 7.8; allows
a the user to speciffy names andd descriptionns for
their data
d sources. Click on thhe Finish buttton to compplete the wizaard.

Figuree 7.8 - Configurre Data Source Name

N

When n you return to the tempplate after configuring the t tag connnections, thee data
tag will be linkedd to the seleected cell(s) in the tempplate, and a little red triaangle
indicaates the data point. Recaall that you can
c view com mments abouut the data soource
by hov vering the mouse
m pointeer over the ceell as shown in Figure 7..9.
NOTE: Thee Layout Mannager will appeear when finishhed, and will be
b discussed
in a later chaapter.

7-6 ICONICS
S, Inc
ReportWo
orX Training Manual
M Data Sou
urces

Figure 7..9 - OPC Data Access

A Tag in Template
T

7.3.2 OPC
C Historiical Dataa Access Tags
T
Right--clicking onn a cell (or group), andd then seleccting Conneect to new Data
Sourcce Æ OPC HDAÆ Historical Datta Access (H HDA) Tag from the poop-up
menu,, as shown in Figure 7.110, will allow
w you to connfigure cellss with OPC HDA
H
data connections
c using the OPC
O HDA Connection
C Wizard as shown in Figure
F
7.11.

Figure 7.10 - Connecting to an

n OPC Historicaal Data Access

The OPC
O HDA Connection
C Wizard dialog box, shoown in Figurre 7.11, helps you
choosse the tag connnections.

Click the ellipsis (…) buttonn to browse for HDA tags

t using thhe Unified Data
Browwser. In the Unified Datta Browser, select a tagg, and the taag appears in the
Tag Name
N o the OPC HDA Conn
field of nection Wizzard dialog box, as show wn in
Figuree 7.11.

S, Inc
ICONICS 7-7
Data Sou
urces ReportWorrX Training Manual

Figure 7.11 - OPC HD

DA Data Tag Seelected

Click the Next button

b and check the Configure Engineeringg Units andd Tag
Descrriptions checck box, as shhown in Figuure 7.12.

Figu
ure 7.12 - Confiiguring Engineeering Units and
d Tag Descriptioons

Click the Next buutton and cheeck the Configure Data Source Nam mes check boox, as
shown n in Figure 7.13.
7 This alllows the usser to specify
fy names andd descriptionns for
their data
d sources.

7-8 ICONICS
S, Inc
ReportWo
orX Training Manual
M Data Sou
urces

Figure 7.13 - Configurre Data Source Names

N

Click the Next button

b to dissplay the OPC
O HDA Tag
T group properties page
shownn in Figure 7.14.
7

Figure 7..14 - OPC HDA

A Tag Group Prroperties

At thee top of thee OPC HDA A Tag grou up propertiies dialog box, set the Data
retrieeval filter tot Raw, Avverage, Minnimum, Maxximum, Stanndard Deviaation,
Minim mum Actual Time, Maxiimum Actuaal time, or Laast Sample. IfI desired, ennable
the Fiill data in reeverse orderr option.

S, Inc
ICONICS 7-9
Data Sources ReportWorX Training Manual

If desired, set any one of the following options:

• The Set data retrieval start time section has the option to use a
parameter. Check the use parameter checkbox and click the … button to
launch the parameter browser. User could choose to use the Offset from
End Time setting as well.
• The Set data retrieval end time has a … button to launch the parameter
browser.
• The section on the bottom of the OPC HDA Tag group properties dialog
box has the option to Retrieve Multiple Data Values by checking off the
box next to it and setting the processing interval.

Select Finish to close the dialog box and return to Excel view.
NOTE: If the Fill data in reverse order check box is checked, cells in the
report template will be filled with data from the bottom up. The oldest data will
be in the bottom cell, and more recent data will be added to cells above the
bottom cell.

7.4 Connecting to ICONICS Tags

The ReportWorX Excel configuration interface enables you to link data cells in
your spreadsheet template to the following ICONICS data sources:

• Native Historical tag

• Text Aliases
• Language Aliases

7.4.1.1 Native Historical Tags

Right-clicking on a cell (or group), and then selecting Connect to new Data
Source Æ ICONICS Æ Native Historical Tag from the pop-up menu, as shown
in Figure 7.15, will allow you to configure cells with data connections to
TrendWorX32 specific history tags using the Native Historical Tag Connection
Wizard.

To configure native trend tags, you can select the Connect to new Data Source
Æ ICONICS Native Historical Tag Æ Native Trend Tag from the context
menu. In the Native Historical Tag Connection Wizard dialog box, click on the
ellipsis (…) button to browse for tags via the Unified Data Browser.
NOTE: You can also select expressions or global aliases. Please refer to the
ReportWorX Configurator help documentation for information about the
Expression Editor and global aliasing.

7-10 ICONICS, Inc

ReportWo
orX Training Manual
M Data Sou
urces

Figure 7.15 - Connectingg to a Native Trrend Tag

In thee Unified Daata Browser, you would need n to creaate a TrendW

WorX32 histoorical
databaase connectiion if you haven’t done so. Right click c on Histtorical Databbases
and select the correspondding database enginee connectioon where your
Trend dWorX32 hisstorical dataabase residess in as show wn in Figure 7.16. Follow w the
on-scrreen instructtions to creatte your connnection.

Figure 7.166 - New Historiccal Database Coonnections

Doublle click on the

t connectiion and select a tag. The selected taag appears in
i the
Tag Name
N field of
o the Nativee Tag Selecttion dialog box,
b as show
wn in Figure 7.17.

S, Inc
ICONICS 7-11
Data Sou
urces ReportWorrX Training Manual

Figurre 7.17 - Native Trend Tag Seleected

Clickiing the Nexxt button willl display a check box as shown inn Figure 7.118, to
allow the user to Configure
C Enngineering Units
U and Taag Descriptioons.

Figgure 7.18 - Configure Engineerring Units and Tag

T Description
ns

Click the Next buutton to dispplay a checkk box, as shoown in Figuure 7.19, to allow
a
the usser to specifyy names and descriptionss for their daata sources.

7-12 ICONICS
S, Inc
ReportWo
orX Training Manual
M Data Sou
urces

Figure 7.19 - Configurre Data Source Names

N

Click the Next button

b to dissplay the Native Trend
d Tag grou
up propertiies as
shownn in Figure 7.20.
7

Figure 7.20 - Native Tren

nd Tag Group Properties
P

In thee Native Trend Tag grroup properrties dialog box, set thee Data retrrieval
filter to Raw, Average,
A Minnimum, Maaximum, Staandard Deviiation, Miniimum
Actuaal Time, Maaximum Actuual time, or Last Samplle. You can also use thee Fill
data in
i reverse order option.
NOTE: If thet Fill data in i reverse ord der check boxx is checked, cells in the
report templlate will be fillled with data from
fr the bottom
m up. The oldeest data will
be in the boottom cell, andd more recentt data will be added to cellss above the
bottom cell.

S, Inc
ICONICS 7-13
Data Sources ReportWorX Training Manual

Set any of the additional options, as desired:

• The Set data retrieval start time section has the option to use
parameters. Check the use parameter checkbox and click the … button to
launch the parameter browser. The user could choose to use the Offset
from End Time setting as well.
• The Set data retrieval end time has a … button to launch the parameter
browser.
• The section on the bottom of the Native Trend Tag group properties
dialog box has the option to Retrieve Multiple Data Values by checking
off the box next to it and setting the processing interval.

Select Finish to close the dialog box and return to the Excel view.

7.4.1.2 Text Aliases

Text aliases include Global Aliases and Language Aliases. To add one, you can
right-click on a cell (or group), and then select Connect to new Data Source Æ
ICONICS Æ Text or Language Alias from the pop-up menu, as shown in
Figure 7.21.

Figure 7.21 - Connecting to a Text Alias

The Unified Data Browser opens and you can select the desired text alias on the
appropriate tab. To insert a Global Alias, browse for the one you need from the
Global Aliases tab. If you need to use a Language Alias instead, select the
Language Aliases tab, and browse for your language alias. Once you’ve selected
your alias, return to the report template and the text alias is linked to the selected
cell(s) in the template, and a little red triangle indicates the alias, as shown in
Figure 7.22.
7-14 ICONICS, Inc
ReportWo
orX Training Manual
M Data Sou
urces

Figure 7.22 - Text Aliaas Added to Tem

mplate

7.5 Connec
C cting to Databaases
The first
f step in defining a data
d source from whichh ReportWoorX will acccess a
databaase is establiishing a connection to ann OLE DB datad provider. Once you have
conneected to a dattabase, you need
n to speccify which daata will be retrieved from
m the
databaase and diisplayed inn the reporrt template. The RepportWorX Excel E
config
guration inteerface enablees you to linnk data cells in your spreeadsheet tem mplate
to manny types of databases,
d inncluding the following:

• Microsoft SQL Serverr

• Microsoft Access
• Oracle
• ODBC
• Generic OLEDB
O
• Excel
• SAP

Althouugh connectting to differrent types off databases have

h differennt connectionn and
config
guration propperties, the three basic steps of connfiguring an Open Dataabase
data connection
c too a cell (or group
g of cellss) are comm
mon to all typpes. They aree:

• Database Connection
C
• Data Selecction
• Data Mappping

NOTE: Thee basics of thee first two stepps will be explained in this chapter.
c For
information on data mappiing, refer to a later chapter.

7.5.1 Step
p One: Daatabase Connecti
C ion
You can
c create a database connection as the dataa source using the Dataabase
Conneection Confiiguration Wiizard.

S, Inc
ICONICS 7-15
Data Sou
urces ReportWorrX Training Manual

To create a databbase connecttion, right click on a ceell (or groupp), and selecct the
Connnect to New w Data Sourrce Æ Opeen Databasee from the context c mennu, as
shownn in Figure 7.23.
7

Figu
ure 7.23 - Opening Database Connection
C Configuration Wizaard

Click the Browse button in thhe Database Connection

C Configuratioon Wizard dialog
d
box to
o open the Database
D Connnections Brrowser, as shhown in Figuure 7.24.

Figure 7.24 - Databasee Connection Brrowser

Right click on thee desired dattabase conneection and seelect Insert New
N Connecction.
This will
w open a browser forr you to seleect the databbase you waant to use, which w
enablees you to sppecify the database
d namme and/or connection
c s
string in ordder to
createe a list of saaved databasse connectionns. This listt allows youu to configurre the
conneection inform mation only once
o and be able to use iti in other tem
mplates.

7-16 ICONICS
S, Inc
ReportWo
orX Training Manual
M Data Sou
urces

Click on OK to create
c the connection string. Select the
t connectioon and clickk OK.
We will
w continue to use the Database
D Coonnection Configuratio
C on Wizard in i the
next sub-section.
s So leave it open
o for now
w.

7.5.2 Step
p Two: Data Selecction
After selecting thee newly creaated connecttion string, you
y need to select the daata to
displaay in the repport. Continuuing from thhe proceduree above, youu can click ono the
Next button to bring
b up thee Configuree your dataa connectioon dialog boox as
shown n in Figure 7.25. Click the
t Edit buttton and set onne of the folllowing optionns for
data reetrieval:

• Simple Query:
Q Sim
mple Confi figuration Mode
M for Open Dataabase
Connectioons to query a single tablle
• Advanced d Query: Helps
H you crreate advancced SQL quueries to muultiple
tables.
• Custom Query:
Q Provvides an ediitor window w for writingg your own SQL
language queries.
q
• Stored Prrocedure Caall: Creates queries
q to exxecute storedd proceduress.

NOTE: Noot all four opptions will alw ways be avaiilable dependiing on the
connection type,
t as certaiin types of queries are not supported
s by all
a types of
databases.

F
Figure 7.25 - Daatabase Queriess

S, Inc
ICONICS 7-17
Data Sources ReportWorX Training Manual

7.5.2.1 Simple Query

The Simple Query allows for single table queries. To configure a query with the
SQL Command Designer, you can click on the ellipsis (…) button to the right of
the Table Name field and select a table from which to read data. Check the
desired table columns from the Column Name list, as shown in Figure 7.26.

Figure 7.26 - Selecting Table Columns

Add and/or edit SQL column names/expressions to each column by clicking the
Add Expression button.

In the SQL Expression dialog, edit the SQL Expression Title and SQL Column
Expression fields, as shown in Figure 7.27.

Figure 7.27 - Editing SQL Column Expression

7-18 ICONICS, Inc

ReportWorX Training Manual Data Sources

7.5.2.2 Advanced Query

The Advanced Database Configuration provides an Advanced SQL Query
Wizard to help you create complex SQL queries for your selected databases. The
Advanced SQL Query Generation dialog box opens, as shown in Figure 7.28,
allowing for multi-table queries and grouping.

Figure 7.28 - Selecting Data Tables to Include in Database Query

To create a multi-table query, click on the [+] button to display a list of the tables in
the database. In here, you can select from which tables to retrieve data from and
display in the report template.

Select the data tables to include in the database query by clicking on the table and
then click on the Ok button. Notice that the added table(s) show up in the bottom
Tables section.

Once you click Ok to the Multiple Table Selection dialog, the wizard displays all
columns from all the tables you have selected. For each table you chose, you can
select which data columns to include in the database query by checking the box
next to the name of each column, as shown in Figure 7.29.

If you select multiple tables, you can join the tables together by dragging a data
column from one table to the corresponding field in another table.

ICONICS, Inc 7-19

Data Sources ReportWorX Training Manual

A double-headed arrow that points to both connected tables will be drawn

automatically, indicating that a joint between the two tables exists, as shown in
Figure 7.29.

Figure 7.29 - Selecting Data Columns to Include in Query

To view the link details, double click the linking arrow to display the Table Join
Properties dialog box, shown in Figure 7.30.

You see a list of the names of the tables and columns that are joined. You can use
the expression options under SQL Join Type to define the relationship between
the two columns (i.e. Equal, Greater than, Less than, etc.). You can also manually
write a Custom Join Condition by clicking the Edit button.
NOTE: Please refer to the SQL language documentation for details about SQL
joins.

Figure 7.30 - Table Join Properties

7-20 ICONICS, Inc

ReportWorX Training Manual Data Sources

Selected data columns are listed in the bottom pane of the window, as shown in
Figure 7.29, determining which columns or expressions will be included in the
SELECT statement as well as the column titles that will be displayed.

You can use the Move Up/Move Down buttons to change the order in which the
columns will be displayed. To change an existing column/expression, click the
Edit Exp button and make your addition or changes. To insert a column or to

create a new expression, click the Add Column Expression button [ ] and
specify the expression.

Clicking the Records Grouping tab as shown in Figure 7.31 offers additional
options that are not available with the Simple SQL Query Wizard and lists the
selected tables and columns.

Figure 7.31 - Records Grouping and Aggregation

Grouping applies to records in a data column that have the same value. Click
checkboxes to change the grouping options for the data tables (or leave them
unchanged). Use the pulldown menus to assign an Aggregate Function (i.e.
Count, Average, Maximum, Minimum, Sum, Standard Deviation, etc.) to each of
the columns you did not include in the grouping list. The records of columns that
are assigned the same aggregate function will be grouped together in the query
result. You have two grouping options:

• Grouping using the SQL ‘GROUP BY’ statement: Grouping and

aggregation are performed using standard SQL language grouping. Please
refer to the SQL language documentation for details.

ICONICS, Inc 7-21

Data Sources ReportWorX Training Manual

• Running Periodic Summary: Clicking the Advanced Grouping

Options… button allows you to set Periodic Summary Reports
preferences, which are especially useful if you want to compare several
different sets of data over a specified time interval. For example, you
could run a company report that lists the hire dates for all employees of the
company that fall within the previous month.

You can specify both absolute and relative intervals for retrieving data from the
database. An absolute interval is a fixed period of time (i.e. the month of June, or
1 week ago, or an 8-hour shift). A relative interval is a period of time relative to
the report execution time. For example, if a one month relative interval is used,
the periodic summary report will include data in several chunks, each of which
covers an interval of one month calculated from the moment of the report
execution time. You have to specify a number of intervals for the report.

7.5.2.3 Stored Procedure Call

The ReportWorX Excel Interface Advanced Database Configuration Mode allows
you to create a SQL query to run a database stored procedure. Stored procedures
are precompiled on the SQL server; and execute much faster than ordinary SQL
queries.

The Stored Procedures dialog, shown in Figure 7.32, allows you to choose a
stored procedure from the Select Stored Procedure dialog. This will tell
ReportWorX the stored procedure in the database to execute and display the
results in the report. Since some stored procedures require input values, you can
select parameters as these input values in this dialog as well. You can add
Parameters by clicking in the list, and then on the ellipsis (…) button to bring up
the Parameter Browser.

7-22 ICONICS, Inc

ReportWo
orX Training Manual
M Data Sou
urces

F
Figure 7.32 - Stoored Proceduress

The Parameter
P N
Name list diisplays all paarameter objjects you havve created inn this
template. To moodify a paraameter's prooperties, douuble-click on o the param meter
name.. This openss the Param meter Browsser, as show wn in Figure 7.33. Param meters
will be discussed later in this chapter.

Figure 7.33 - Parameter Broowser for Stored Procedure

7.5.2.4 Cusstom Queryy

The ReportWorX
R X Excel Interrface Advannced Databaase Configurration Modee also
allowss you to mannually createe and edit SQ
QL data queeries for youur databases. This
is don
ne within ann editor dialoog box, wheere you can type in SQ QL commandds, as
shownn in Figure 7.34.
7

S, Inc
ICONICS 7-23
Data Sources ReportWorX Training Manual

Figure 7.34 - SQL Command Designer

7.5.3 Filtering and Sorting Options

No matter the type of data connection you use, or the manner in which the data is
selected, you always have filtering and sorting options. The filtering dialog shown
in Figure 7.35 is an example of how filters are setup. Filters can be set in each of
the query wizards.

To create a filter, click on the Records Filtering tab, and then on the [+] button.

Figure 7.35 - Filtering Records

In the Filtering Criteria dialog box, shown in Figure 7.36, a SQL filtering
expression will be created.

Select columns in the Column name to filter on drop-down list, and the
appropriate relation from the Relation Type and Relates To list.

7-24 ICONICS, Inc

ReportWorX Training Manual Data Sources

Figure 7.36 - Records Filtering Criteria

After filtering is configured (if desired), you can sort your records by clicking on
Sorting tab.

In the Sort Records dialog, shown in Figure 7.37, specify the priority by which
the columns and the records in each column are sorted. You can choose to sort on
any of the selected columns, or leave them unsorted. To determine the order in
which the data will be displayed within each column, select that column and
choose one of the following sorting options:

• Ascending: Sorts the data in the column in ascending order (e.g. from
least to greatest)
• Descending: Sorts the data in the column in descending order (e.g. from
greatest to least)

Figure 7.37 - SQL Records Sorting

ICONICS, Inc 7-25

Data Sou
urces ReportWorrX Training Manual

7.6 Connec
C cting to Web Services
S s in Exccel
The ReportWorX
R X Excel interrface enabless you to get data from Web
W services and
displaay the data inn your reportts.

To coonnect to a Web
W servicee in an Excel report tem mplate, you can
c right-cliccking
on thee cell (or grooup), and then selectingg Connect too new Data Source Æ Web
Servicce from the pop-up
p menu, as shown in Figure 7.38.

W Servicees Connectioon Wizard apppears in whhich you caan configure cells

The Web
with a Web Servicce data connnection.

Figuree 7.38 - Connectting to a Web Service

Comp plete the threee pages of Web

W Servicee Connectioon Wizard, the
t first of which
w
is sho
own in Figuure 7.39. Thhe three maain steps of configuringg a Web Seervice
commmunication coonnection arre: Web Servvice URL innfo, Select Web
W Servicee, and
Selectt Web Servicce Method.

Figure 7.39 - Web Serviice Connection Wizard

7-26 ICONICS
S, Inc
ReportWo
orX Training Manual
M Data Sou
urces

7.6.1 Step
p One: Web
W Serviice URL info
You can
c set the Web Servicce URL info formation byy clicking on
o the Brow
wse…
button
n in the Webb Service UR RL info secttion to open the Configu
ure Web Seervice
Connnection dialoog box, as shhown in Figuure 7.40.

Type the URL adddress of thee Web servicce under Web Service URL or sellect it
from the
t drop dow wn menu. Then,
T enter thhe User Name, Passwoord, and Dom main
name if necessaryy to log in to the Webb service. Fiinally, click on the Con nnect
button
n to connectt to the Weeb service. Once
O the serrvice is connnected, click the
Finish
h button.

Figure 7.40 - Browsse for Web Servvices

Other advanced parameters thhat may applly to selectedd Web servicces include:

• Request Timeout:
T Tiime (in secoonds) that thhe ReportWWorX Servicee will
wait for a response froom the Web service.
• Refresh Proxy
P DLL: When a connection
c too a Web seervice is maade, a
proxy .dll file is autoomatically created.
c If multiple
m repoort templatees are
connectedd to the samee Web servicce, they willl use the sam
me proxy .dlll file.
Checking the Refressh Proxy chheck box will w update the .dll, annd all
templates will use thatt proxy .dll file.
f
• Use Proxyy Server: Chheck this boox to use a prroxy server. This will reequire
you to alsso enter the Proxy Serrver URL, User U name,, Password, and
Domain iff necessary.

S, Inc
ICONICS 7-27
Data Sou
urces ReportWorrX Training Manual

7.6.2 Step
p Two: Seelect Web
b Servicee
After connecting to
t the Web Service
S o the drop down menu from
of chhoice, click on
the Seelect Web Service sectioon, as shownn in Figure 7.41,
7 to compplete step tw
wo.

Fiigure 7.41 - Seleect Web Service

7.6.33 Step
p Three: Select Web
W Serviice methood
After selecting thhe web servvice method, click on thhe Next buutton to openn the
Confiigure Web Service
S paraameters diallog, as show
wn in Figure 7.42.

Createe parameterss to be assiggned to eachh ID by cliccking on elllipsis (…) button

b
under the Parametter Binding section.

Figure 7.442 - Configure Web

W Service Paarameters

7-28 ICONICS
S, Inc
ReportWo
orX Training Manual
M Data Sou
urces

Once the parammeters are assigned,

a cliick on the Next buttoon to showw the
Confiigure Web Service datta mappingg dialog boxx. You can choose
c to incclude
the Return name value by chhecking the box under Include, as shown in Figure
F
7.43.

Figure 7..43 - Configure Service Data Mapping

M

Lastly
y, click the Finish
F buttoon to return to
t the reportt template where
w you caan see
that a little red triangle apppeared on thet cell to indicate thee data sourrce is
conneected to the WebServiceD
W DataSource as shown in Figure 7.444.

Figure 7.44 - Web Servicee Added to the Template

7.7 Parame
P eters
Parammeters can be b used to make
m reportss more flexibble and interractive. Therre are
severaal different types of paraameters:

• User selecctable: A Usser Selectab

ble Parametter is a param
meter type whose
w
value is determined by the user thhat is requesting executtion of the report
r
through thhe Unified Web
W interfaace. This typpe of param meter is ideaal for
user-custoomizable reports.

S, Inc
ICONICS 7-29
Data Sources ReportWorX Training Manual

• Automatic: An Automatic Parameter is a parameter type whose value is

automatically determined by ReportWorX. No user interaction is required.
This type of parameter is ideal for automatic reports.
• Special Functions: A Special Function Parameter is a parameter type
used to provide special functions, such as reading user information from
the Unified Web interface.

7.7.1 Parameter Browser

The Parameter Browser allows ReportWorX users to browse and select existing
parameters, create, edit, and delete parameters. The parameter browser can be
opened from many different locations, including cell configuration, filtering
criteria, and web service configuration.

To start the Parameter Browser in the Microsoft Excel template designer, you can
select Parameter Browser from the ReportWorX menu, as shown in Figure
7.45.

Figure 7.45 - Opening the Parameter Browser

The Parameter Browser lists the name, data type, parameter type, and if it’s
being used for each parameter. The up and down arrow buttons allow you to sort
the list of parameters. The Parameter Browser also contains five buttons:

• Validation Rules: Click this button to open the Validation Rules dialog,
which shows you any Rules and their validation Error Messages.
• Add: Click this button to launch the Configure your parameter dialog
box, which helps you create and configure your parameters. Select the
Help me choose button to launch the Parameter Wizard.
• Edit: Click this button to launch the Configure your parameter dialog
box, which allows you to modify the selected parameter. Select the Help
me choose button to launch the Parameter Wizard.
• Duplicate: Click this button to create a duplicate of the selected parameter

7-30 ICONICS, Inc

ReportWo
orX Training Manual
M Data Sou
urces

• Delete: Cllick this buttton to removve the currently selectedd parameter from
the Parameter Browser.

7.7.2 Para
ameter Wizard
W
Whenn adding a new param meter, click the Add buutton. The Configure your
param
meter dialogg box appearrs with the foollowing opttions:

• Parameteer Name: Ennter the param meter name..

• Parameteer type: Can be selected from the droop down meenu.
• Help me choose: Cliick this buttoon to launchh the Param meter Wizarrd to
help choosse your parammeter type.
• Data typee: Selects thee data type for
f the parammeter such asa String, Intteger,
Float, or Date
D Time.
• Configuree Parameterr Details: Click
C this buttton to launcch the Confiigure
the param meter properties dialog box.
• Web Proompt: Enterr the descriiption to diisplay in thhe Unified Web
Interface.

The Parameter
P W
Wizard can help you deecide on whiich Parameteer type to usse, as
shownn in Figure 7.46. The Parameter Wizard
W has thhree basic paarameter typpes as
descriibed before. We will go into more deetails of eachh now.

Figure 7.46 - Parrameter Wizard

d

7.7.2.1 Userr selectablee

Selectting User seelectable annd clicking the
t Next buutton brings you to the new
dialog
g box shownn in Figure 7.47. Here, yoou have the following
f opptions:

S, Inc
ICONICS 7-31
Data Sou
urces ReportWorrX Training Manual

• Manuallyy enter the value:

v For the
t user-seleectable param meter type called
c
manually enter the value,
v the usser will be abble to manuaally enter a value
v
for the paarameter. Thhis parameteer type is iddeal when yoou want to leave
maximum flexibility to F example, you could have a param
t the user. For meter
"day" that allows the user
u to chooose a day andd see all of the t productss sold
that day.
• Select froom a fixed liist of valuess: For the usser-selectablle parameterr type
called seleect from a fixed
f list of values, the user will bee able to chooose a
value from m a list of pre-configur
p red values. This
T parameeter type is ideal
when all the possiblle values foor the param meter are well
w known.. For
example, youy could have
h a parammeter "gendeer" that can assume onlly the
values "maale" or "femmale."
• Select froom a dynam mic list of values: For the t user-seleectable param meter
type calledd select from
m a dynamic list of vaalues, the useer will be abble to
choose froom an up-too-date list of o values coming from a database. This
parameter type is ideaal when the value of thhat parameteer cannot bee pre-
determinedd, or may beb constantlyy changing. For example, the user could c
select a naame from thee current listt of customerrs in a database.

NOTE: Thee parameter name cannot contain any special characterrs or blank
spaces. The parameter musst begin with a letter.

Figure 7.447 - User Selectable Parameterr Choices

Selectting one of these three options andd clicking thhe Finish button bringss you
back to the Conffigure your parameter
p d
dialog box with
w the new wly selected type
entereed in the Parameter Typee drop downn menu.

7-32 ICONICS
S, Inc
ReportWo
orX Training Manual
M Data Sou
urces

7.7.2.2 Automatic
Selectting Automaatic and cliccking the Neext button brings
b you too the new dialog
d
box sh
hown in Figuure 7.48. Heere you have the followinng options:

• Read the values froom a datab base: For thhe automaticc parameter type
called reaad the valuees from a database,
d thee value(s) will
w automatiically
be read froom a databasse at the timee of report execution.
• Evaluate an expresssion: For the automatic parameeter type called c
evaluate ana expressioon, the valuee will be onee of the folloowing: The result
r
of an exppression, the value of an a OPC tag, the value of an alias, or a
constant value.
v
• Evaluate a date and time: Foor the autom matic param meter type called
c
evaluate a date and time,
t the paarameter willl be a speciaal date or tim
me, or
combinatioon of both.

Figure 7.48 - Automattic Parameter Choices

C

Selectting one of these three options andd clicking thhe Finish button bringss you
back to the Conffigure your parameter
p d
dialog box with
w the new wly selected type
entereed in the Parameter Typee drop downn menu.

S, Inc
ICONICS 7-33
Data Sou
urces ReportWorrX Training Manual

7.7.2.3 Speccial functioons

Selectting Special functions and
a clicking the Next button
b bringss you to thee new
dialog
g box shownn in Figure 7.49. Here yoou can have the
t option too select:

• Read web b user ideentity param meter type. This param meter value will
correspondd to the ideentity of the Web user that is requuesting the report
r
execution.. This parammeter can be used to filtter informatiion on a perr-user
basis.
• Read report trigger informatioon parameterr type. This parameter value v
will corresspond to the informationn that triggerred the reporrt.

Figure 7.49 - Special Function Parameteer Choices

Selectting one of these three options andd clicking thhe Finish button bringss you
back to the Conffigure your parameter
p d
dialog box with
w the new wly selected type
entereed in the Parameter Typee drop downn menu.
NOTE: Forr specific infformation on configuration steps for eacch type of
parameter, see the ReportW
WorX Excel Innterface help doocumentation.

7-34 ICONICS
S, Inc
ReportWo
orX Training Manual
M Lab 7: Data Sou
urces

Lab
b: Data
D Sou
urcess 7

7.1 Lab
L Ovverview
w
QL Query Wiizard to creaate a database
In thiss lab, you wiill use the Advanced SQ
query.

7.1.1 Task
k Checkllist
In thiss quick lab, you
y will com
mplete the foollowing taskks:

• Create an advanced SQ
QL query.

7.1.2 Supp
port Filees
To com
mplete the Chhapter 6 quickk lab, you willl need the folllowing suppoort file:

• Acmeseutiical_Standarrd.xls

7.2 Advanc
A ced SQL
L Querry Wizaard Exaample
The ReportWorX
R Template Designer
D Advvanced Databbase Configguration Modde
provid
des an Advanced Query Wizard to helph you creaate advancedd queries for your
selected databasess. To run a query
q on an open
o databasse:

1. Open the Acmeseutica

A al Report Template
T forr editing by clicking
c on the
t
buttonn in the Tem
mplate Versioons frame.

2. Highlight a grid of cellls in your Acmeseutical

A l Report Teemplate from
m A6
to F7.

3. Right-clickk on this grooup of cells and

a select Connect to new Data Source
Æ Open Database
D froom the pop-uup menu, as shown in Fiigure L7. 1.

S, Inc
ICONICS L7-1
Lab 7: D ata Source s ReportWorrX Training Manual

F
Figure L7. 1 - Open
O Database

4. In the Dataabase Conneection Configuration Wiizard, click on

o the Browsse
button.

5. In the Dataabase Conneections Brow

wser, right-cllick on SQL
L Server
Connectioons and selecct Insert Neew Connectiion, as showwn in Figure
L7.2.

Figure L77.2 - Selecting a Database Servver Type

6. In the Datta Link Prop

perties dialoog, set the seerver name as
a "(local)" using
u
the Windoows NT Integgrated Securrity, and seleect the
AcmeseutticalDatabasse on your syystem, as shhown in Figuure L7. 3.

L7-2 ICONICS
S, Inc
ReportWo
orX Training Manual
M Lab 7: Data Sou
urces

Figgure L7. 3 - Dataa Link Properties

7. Click the Test

T Connecction buttonn to ensure thhat a connecttion can be
establishedd to the dataabase you havve chosen. Click
C OK to confirm thee test,
and then click
c OK to accept
a the neew settings.

8. Select the newly created database connection as shown in Figure L7. 4 and
click OK.

Figuree L7. 4 - Select Database

D Conneection

9. Click Nexxt to navigatee to the next step. In the Database Coonnection

Configuration Wizard, shown in Figure
F L7. 5,, click on thee Edit buttonn and
choose Addvanced Qu uery.

S, Inc
ICONICS L7-3
Lab 7: D ata Source s ReportWorrX Training Manual

Figure L77. 5 - Data Selection: Advanced Query

10
0. After the database
d schhema loads (tthis may take several miinutes depennding
on the sizee and locatioon of the seleected database), the Advvanced SQL
Query diallog box openns. The querry wizard waalks you throough a seriess of
dialogs to help you creeate your SQ QL query.

11
1. Click the [+]
[ button too display a list of the tablles in the dattabase, as shhown
in Figure L7.6.
L

Figure L7.66 - Selecting Datta Tables to Incclude in Databaase Query (Exam

mple Only)

12
2. Choose the ‘TotalProoductionDatta’ and ‘Reccipes’ tables by highlightting
each one individually and clickingg Add, as shown in Figuure L7.6. Theen
click OK. This will innclude these tables
t in thee database quuery.

L7-4 ICONICS
S, Inc
ReportWorX Training Manual Lab 7: Data Sources

13. In order to make a meaningful query using these two tables, we must
specify the field that is common to the two tables and create a “join”
between them. In our example, it is the RecipeID field from the
TotalProductionData table and the ID field from the Recipes table.

14. Click on the RecipeID field and drag it over to the ID field of the Recipes
table. It is extremely important that you drag it exactly over the ID field,
not just any field, and then release. This will create a join between the two
tables.

15. Now that we have established the link between these two tables, it is safe
to select any of the fields from either table to be included in our report.

16. From the Recipes table, select just the RecipeName field.

17. From the TotalProductionData table, select the following fields in this
order: TheDate, BatchID, Duration, PillCount, and RejectCount.
NOTE: The fields that you select in Advanced Mode will show up in the order
in which you select them, so you can use this to your advantage when building
reports. In Simple Mode you need to select the fields first and then adjust their
order by clicking the Move Up and Move Down buttons.

18. Before clicking Ok, verify that your dialog looks similar to the example in
Figure L7.7.

Figure L7.7 - Selecting Data Columns to Include in Query (Example Only)

ICONICS, Inc L7-5

Lab 7: Data Sources ReportWorX Training Manual

19. We will not be using the Records Grouping tab in this exercise. We will
not use this. Simply click on Next to continue.

20. Click on the Records Filtering/Sorting tab, as shown in Figure L7..1 and
then the [+] button to open the Filtering Criteria dialog, as shown in
L7.8.2.

Figure L7.8.1 – Filtering Records

Figure L7.8.2 - Filtering Criteria (Example Only)

21. Under the Filter Type, select Relational Filter.

22. Under Column Name to Filter On, use

dbo.TotalProductionData.RecipeID. Under Relation Type, you can
select a relational filter expression (e.g. Equal To, Greater Than, Less
Than, etc.) from the drop-down list to define the relationship between the
values. In our case, we will use the ‘Equal to’.

L7-6 ICONICS, Inc

ReportWorX Training Manual Lab 7: Data Sources

23. For the Relates To field, select Constant Value(s) and our constant will
be ‘1’. Click on OK when you are done.
NOTE: Please refer to SQL documentation for details about SQL expressions.

24. Click the Finish button to continue working through the SQL Query
Wizard. You will see the following query summary window, shown in
Figure L7.. Click Next.

Figure L7.9 - Database Query Summary Window

25. Be sure to replace the title DatabaseSource with another name, such as
Acmeseutical_Advanced_Query and then click on the Finish button.

26. This will take you to the Layout Manager, which will be discussed in the
next chapter. Just click OK.

27. You will return to the Excel template spreadsheet, which now contains
data mapping cells, as shown in Figure L7.. Report templates are used by
reports to visualize information from your data sources, such as statistics
for employees or manufacturing productivity.

ICONICS, Inc L7-7

Lab 7: D ata Source s ReportWorrX Training Manual

Figure L7.100 - Excel Spread

dsheet with Datta Mapping

28
8. Finally, beefore we savve our templaate, let’s fill in the <Inseert Report Title
T
Here> fielld. Replace that text witth Recipe Prroduction Report.
R

29
9. You may close
c out of the ReportWWorX Excel template.
t If prompted too
Commit Changes,
C pleease do so inn order to rettain your cusstomized
template.

Thhis completees Lab 7. You have just completed

c thhe creation of
o an Advancced
Quuery with filltering withinn ReportWoorX. The nexxt chapter wiill introduce you
to the Layout Manager.

L7-8 ICONICS
S, Inc
ReportWorX Training Manual Layout Manager

Layout Manager 8

8.1 Objectives
After completing this chapter, you should know how to:

• Merge cells and map data sources to them

• Insert unmapped columns between mapped columns of data (for Excel
formulas or calculations)
• Intelligently detect potential collisions in data-mapping layouts
• Span multiple rows with a single data source
• Auto-expand horizontally and vertically
• Quickly transpose configured cells from vertical alignment to horizontal
alignment with one click
• Map data fields to new rows or columns

8.2 Layout Manager

The ReportWorX Layout Manager allows you to map data fields from data
sources to cells in your report. To bring up the Layout Manager, right click a cell
or group of cells that contain data and select Edit Data Mapping.

The Layout Manager can be divided into three sections, as illustrated by Figure
8.1:

• a dynamic toolbar for manipulating the data

• a tree control to select the available data column
• a work area that gives a data mapping preview modeled after the Excel
spreadsheet

ICONICS, Inc 8-1

Layout Manager
M ReportWorrX Training Manual

Figure 8.1 - Laayout Manager

8.2.1 Toollbar
Alongg the top of the
t Layout Manager
M is a toolbar, whhich allows you
y to manippulate
the daata in the reeport and includes featuures such as moving, innserting, deleeting,
mergiing, transpossing, etc. cellls as shown in Figure 8.22.

Figu
ure 8.2 - Layoutt Manager Toollbar

8.2.2 Treee Control

The leeft hand sidee of the Layoout Managerr has a tree control, whiich lists all of
o the
data sources
s curreently conneccted to the reeport. They are organizeed by the tyype of
the daata source such
s as OP
PC DA Tagss, Databasess, Alarm Analytics,
A etcc., as
shownn in Figure 8.3.
8

Figure 8.3 - Layout Manager

M Tree Control

8-2 ICONICS
S, Inc
ReportWo
orX Training Manual
M L
Layout Man ager

8.2.33 Data
a Mappin
ng Previeew
In thee main panell of the Layout Manageer is the worrk area, show wn in Figuree 8.4,
for yoou to samplee the data mapping.
m Herre the user can
c manipullate the layoout of
data and
a configure how the daata will be displayed
d in the report. You
Y can alsoo give
each column
c a maanual title orr use the autoo detected coolumn title.

Figuree 8.4 - Layout Manager

M Data Fields
F

8.3 Mappin
M ng Dataa Fieldss
To maap data fieldds from the data source,, drag it from
m the tree coontrol on thhe left
and drop it in a column
c of thhe work areaa on the righht. You can also changee any
mappeed data cell to
t any differrent data souurce by expaanding the drrop down lisst of a
curren
ntly mapped cell as showwn in Figure 8.5.

Figu
ure 8.5 - Changiing Data Mappiings

The drop
d down coontains all data
d fields froom the conffigured data source as well as
an extra “<unmappped>” fieldd. Selecting this from the
t list would undo thee data
mappiing of the ceell.

8.3.1 Man
nipulatin
ng the Maapped Daata
Once you have seelected whicch data goes onto the exxcel spreadshheet and ordders it
in thee different columns in the work area, your report is mostly m readyy for
execu
ution. Howevver, there arre some optiions in the tooolbar that you
y may waant to

S, Inc
ICONICS 8-3
Layout Manager
M ReportWorrX Training Manual

set to further trannsform your data mappiing. The tooolbar of the Layout Mannager
offers the followinng options too manipulatee the data maapping:

• Move: Moove the curreent layout arround the sprreadsheet

• Insert: Apppend or insert rows/coluumns to the current layoout
• Delete: Delete
D data mappings or o the seleccted rows/coolumns from m the
current layyout
• Merge: Merge/Unme
M erge selectedd cells
• Show/Hid de Header: Toggles
T the header row which
w showws the field naame
• Transposee: Transposes the current data mapppings from column bassed to
row basedd or vice verssa
• Automap: Automaticcally map the t fields frrom the datta source too the
current layyout
• Runtime Options: Determines
D h
how ReportW
WorX fills in
i the data fields
f
from the data
d source when
w executiing the reporrt

NOTE: Forr more informaation on these forms of dataa manipulationn and others
not includedd, please refer to
t the ReportW
WorX help docuumentation.

8.3.1.1 Mov
ve
Underr the move button,
b you have
h the folloowing optionns:

• Move the current layout

l up byy one row
• Move the current layout
l right by one colum
mn
• Move the current layout
l downn by one row
• Move the current layout
l left by one colum
mn

The moving
m of thee data mapping is limited to the entire layout. Foor example, if the
data mapping
m staarted at cell 1A, clickinng on the doown arrow, would movve the
entire mapping doown one row w, to start at cell
c 2A.

8.3.1.2 Inseert
You get
g the follow
wing insert options
o by clicking
c on thhe triangle button
b next to
t the
insert button:

• Appennd a column at the end of

o the layout
• Appennd a row at the
t end of thhe layout
• Insert a column at the current selected coluumn
• Insert a row at thee current seleected row

8-4 ICONICS
S, Inc
ReportWo
orX Training Manual
M L
Layout Man ager

For th
he insert opttions, you caan either addd a row or column
c at the end of thee data
mappiing (append)) or insert a row or column on top or o in front off the selectedd row
or collumn. Once you have performed
p a insert funnction, clickiing on the insert
an i
button
n would perfform the lastt insert operaation.

8.3.1.3 Deleete
The following
f deelete optionss are availabble when cliicking on thhe triangle button
b
next to
o the delete button:

• Delette the data mappings

m for the current selected
s celll(s)
• Delete the currentt selected coolumn
• Delette the currentt selected row

You should
s note that you can delete anny row or columnc usinng these butttons.
Howeever, you caan only deleete data mapppings from m cells wherre there are data
using this button. If you selecct empty cellls or cells with
w literal strings,
s the delete
d
option
n will be graayed out. Thhe delete buutton auto deetects what is
i selected in
i the
work area to perfoorm the correct delete fuunction.

8.3.1.4 Merrge
Expannd the mergee menu withh the trianglee button nextt to the mergge button annd the
follow
wing options become avaailable:

• Merge the currentt selected ceells

• Unmeerge the seleected mergedd cell

Be caareful when you use thee merge funnctino. Simillar to how excel
e perforrms a
mergee, the result of the funcction only keeps
k data inn the first selected
s celll. For
exampple, if you seelected cell A1 and B1 for mergingg, and you haave “John” in i A1
and “D
Doe” in B1, the result off the merge would
w only leave
l “John”” in the cell.

8.3.1.5 Show/Hide Heeader

Eitherr the Show Header
H or the
t Hide Heeader buttonn will be avaailable depennding
if the header is alrready shownn.

You can
c click on the Show Header
H button to insert a heaader. The alrready
mappeed columns will automaatically contain a colum
mn header as shown in Figure
F
8.6.

S, Inc
ICONICS 8-5
Layout Manager
M ReportWorrX Training Manual

Figure 8.6 – Automatic Headerss

t cell usess Auto-text, which, wheen the

{{Autto}} in a header cell inddicates that the
reportt executes will
w be popullated with thhe column names used in i the SQL query
q
of the data source.

Once you have added

a a headder to your data mappinng, the buttoon in the tooolbar
ges to the Hide
chang H Header buttoon. If you click on the buutton again, it
i will
remov r for you as
ve the header row a shown in Figure
F 8.7.

F
Figure 8.7 - Header Removed

8.3.1.6 Transpose
Transppose the cuurrent data mapping
m froom expandinng verticallyy (data fieldds are
mappeed to a colum mn) as show
wn in Figuree 8.8, to horiizontal expannsion (data fields
f
are maapped to a roow) as show
wn in Figure 8.9.

Figu
ure 8.8 - Colum
mn based mappiing

8-6 ICONICS
S, Inc
ReportWo
orX Training Manual
M L
Layout Man ager

Fiigure 8.9 - Row

w based mappingg

8.3.1.7 Automap
You can
c have RepportWorX auutomaticallyy map the datta fields fromm the data soource
to new
wly added roows or colum
mns dependiing on the diirection of how
h the dataa fills.
Simplly click on the Automaap buttton, to enabble or disabble this funcction.
Whenn the buttonn is highlighhted, it is enabled.
e Note that in order
o to usee this
functiion, the firstt column orr row must contained mapped
m data. The Autoomap
functiion will use the next unnmapped daata field, skipping thosee that are alrready
mappeed.

8.3.1.8 Run
ntime Optioons
Click on Runtimee Options too expand thee menu as shhown in Figuure 8.10.

F
Figure 8.10 - Ru
untime Optionss

Selectt Auto Expaand to have ReportWorrX automaticcally expandd the currentt data
mappiing based onn the amounnt of data thaat is returnedd from the data
d source. If
I the
data mapping
m is vertical (yoour headers goes acrosss a row), thhe data mappping
wouldd expand doown the row ws. If the daata mappingg is horizonttal (your headers
goes down
d a colum
mn), the dataa mapping would
w expand across the columns.

S, Inc
ICONICS 8-7
Layout Manager
M ReportWorrX Training Manual

Any configured
c d
data cells in the way off the auto exxpansion (suuch as the annchor
row) will
w move doown to accom mmodate forr the expansion.

Auto Expand is the t default runtime

r option. The symmbol on the rows
r will chhange
from just
j a rectanngle (Auto Expand disaabled) to a rectangle with
w a blue arrow
a
pointiing down (A
Auto Expand enabled), ass shown in Figure
F 8.11.

Figure 8.11 - Auto

A Expand Iccon (left); Staticc Icon (right)

Other options avaailable underr the Runtim

me Options drop
d down menu
m are:

• Fill Selectted Region: Fill only thee current datta mapped laayout with data.
• Fill No More
M Than: Fill the speecified numbber of rows (if data exppands
vertically)) or columnns (if data expands
e horrizontally) with
w data. Iff you
select thiss option youu must alsoo specify thhe number in i the field.. The
default is one. You caan enter any positive intteger equal tot or greaterr than
one.

NOTE: Whhen the Auto Expand

E featuree is used, headers and footeers must be
enabled.

8-8 ICONICS
S, Inc
ReportWo
orX Training Manual
M Lab 8: Layout
L Man ager

Lab
b: La
ayou
ut Mana
M agerr 8

8.1 Lab
L Ovverview
w
In thiss lab we willl use the Layyout Manageer to adjust our
o Acmeseuutical Advannced
Template.

8.1.1 Task
k Checkllist
In thiss quick lab, you
y will com
mplete the foollowing taskks:

• Open the Layout

L Manager
• Move dataa mapping inn the Acmeseeutical Repoort Templatee
• Show the headings
h in the Acmeseuutical Reporrt Template

8.1.2 Supp
port Filees
You do
d not need any
a support file to compplete this lab

8.2 Openin
O g the Report
R T
Templa
ate
r is not alreaddy open, clicck Start Æ
1. If your ReeportWorX Configurator
C
Programss Æ ICONIC CS BizViz Æ ReportW WorX Æ Rep portWorX
Configuraator.

2. Navigate to
t the Acmesseutical Repport Template in the Acm
meseutical
Templatess folder

3. Open the Acmeseutica

A al Report Template
T byy clicking on the buttton
in the Tem
mplate Versioons frame.

4. Right clickk on one of the

t data mappped cells, noted by a redd triangle in the
top right corner,
c and select Edit Data Mappingg, as shown in
i Figure L88.1.

S, Inc
ICONICS L8-1
Lab 8: L ayout Mana
ager ReportWorrX Training Manual

Fiigure L8.1 - Ediit Data Mappin

ng

5. This will launch

l the Layout Manager. From heere, click onn the Show
Header buutton to show w the headerr that is automatically fillled in with the
t
appropriatte auto-text from
f the dataabase.

6. Click on thhe Move buttton and chooose Move Up U to move thet layout upp by
one row. This
T will repplace the exissting static header
h but reetain its
formattingg.

7. Then clickk OK. You willw notice thhat the headeer of each coolumn is now
w
filled in annd displays the
t header naame surrounnded by two curly brackeets.
For exampple, {{RecipeName}}, as shown in Figure
F L8.2.

Figure L88.2 - Auto-text Headers

H in the Template
T

8. Click on thhe Runtime Options buttton, and makke sure that Auto
A Expand is
selected. If so, you cann close the Layout
L Manaager.

9. To compleete this lab, you

y can savee the templatte and then go
g back to thhe
ReportWoorX Configurator. Be sures to commmit changes before closinng
the excel application.
a

Thhis completees Lab 8. Wee used the Laayout Managger to map thhe desired daata
fro
om the databbase in the way
w we wantt on the spreaadsheet. Thee next chapteer
wiill discuss crreating and running
r repoorts in greateer detail

L8-2 ICONICS
S, Inc
ReportWorX Training Manual Report Configuration

Report Configuration 9

9.1 Objectives
After completing this chapter, you should know how to:

• Configure advanced settings for a report

• Associate a Report Template to a report
• Associate a redirector task to a report
• Generate reports in different file formats

9.2 Report Settings

Each report can be customized using various settings which affect how the report
executes, the file format of the report, and where the report goes after execution.
In previous chapters, we’ve discussed triggers, which dictate when the report runs.
We have also discussed redirector actions, which will determine the destination of
the report. In this chapter, we will discuss how to associate a report template to a
report for execution, as well as how to associate your redirector actions.

9.2.1 General Report Settings

You can configure the following settings in the simple report mode:

• Report Name: Enter a name for the report.

• Report Description: Enter a description for the report (optional).
• Enabled: Before a report can be executed, you must activate it by
checking the Enabled check box. Any report configuration can have many
enabled reports.

NOTE: A report must have a report template assigned to it before the report can
be enabled.

ICONICS, Inc 9-1

Report Configurati
C on ReportWorrX Training Manual

• Report Template:
T S
Select a repport templatte from the drop-downn list,
which listts all templaates under thhe Report Tools T tree control.
c Youu can
also click the buttons to the rigght of this field f to eithher create a new
template (see
( the "Reeport Template Wizardd" section beelow) or eddit an
existing teemplate.
• Redirectoor Action: Select a redirector task from the drop-downn list,
which lists all redirecctor tasks unnder the Rep port Tools tree
t control. You
can also click
c the butttons to the right of thiss field to eitther create a new
redirector task (see the
t "Creatinng a Redirecctor Action from a Reeport"
section bellow) or edit an existing redirector
r taask.
• Generate Report Ass: Select thee file type(s)) for your report r file(s)) (i.e.
Excel file,, PDF, and HTML).
H Thee default file type is an Excel
E report;; note
that you cannot
c unchheck this opttion. Clickinng the PDF F Settings button
b
opens the Advanced PDF Optioons dialog, as a shown inn Figure 9.1. The
options in this dialog are:
a
o Protect PDF File:F Enabless security prrotection for generated PDFs.
P
o Lin nearize: Optimizes PDF Fs for Web viewing.
v
o Em mbed Fontss: When this check boxx is checkedd, any text fonts
conntained in thhe report will be embeddded in the resulting Adobe A
PDDF file uponn conversion to ensure thhat PDF reaaders will bee able
to view
v and priint the reporrt in its originnal font.

Figure 9.1 - Advan

nced PDF Optioons

• Create Neew Report Files(s):

F Whhen this box is checked, a new reporrt file
is created each time thhe report exxecutes by appending
a thhe execution time
stamp to thhe file namee.
• Apply: Saaves all channges to the coonfigurationn database.
• Reset: Cleears all recenntly added innformation.
• New Repoort Object: Creates a neew report to be configureed.

9.2.1.1 Rep
port Templlate Wizard
d
The report properrties dialog provides a Report Tem mplate Wizzard to helpp you
createe new reportt templates in Microsoft Excel. Too start the wizard,
w clickk the

9-2 ICONICS
S, Inc
ReportWo
orX Training Manual
M Reporrt Configura
ation

Createe New Tempplate Objectt buttoon next to thhe Report Template

T fieeld of
the rep
port propertiies, as shownn in Figure 9.2.
9

Figure 9.2 - Starting the Report

R Templatte Wizard

The Report
R Tempplate Wizardd, shown inn Figure 9.3,, allows youu to create a full
reportt template annd apply it tot the reportt, without neeeding to move
m to the report
r
template section of the Connfigurator. The T wizard will guide you througgh all
necesssary steps too create a woorking template.

Figure 9.3 - Report

R Templatte Wizard: Welcome Screen

NOTE: Forr more informmation about report

r templatees and how too configure
them, see Chhapter 6.

9.2.1.2 Creating a Red

director Acction from a Report
Redireector actionns specify thhe medium by which a report willl be delivereed to
recipients (i.e. PDDF publishinng, Fax, Weeb publishinng, E-mail, Printing,
P etcc). As
mentioned in a prior
p chapteer, a Redireector Action n defines how the resuulting
reportt will be proocessed oncee completed. To execute a redirectorr action wheen the
reportt is completeed, select a redirector
r acction from thhe drop-down list, whichh lists
director actions configuured under thhe Redirector Tasks trree control of
all red o the
Configurator, as shown in Fiigure 9.4. You Y can alsoo edit the seelected redirrector

S, Inc
ICONICS 9-3
Report Configurati
C on ReportWorrX Training Manual

action b clicking thhe buttons to the right of

n or create a new redirecctor action by o the
drop-d
down list.

Figuree 9.4 - Assigningg a Redirector Action

A

To crreate a new m a report,, click on the Create New

w redirector action from
Redireector Task button. Give
G the neww redirectorr action a naame, as show
wn in
Figuree 9.5 and cliick on OK. If the Naviggate to Red director Acttion Form check
c
box iss checked, thhe proper redirector taskk configuratiion comes upu once you click
on OKK. You can then
t edit the redirector action.

Figure 9.5
9 - Naming thee New Redirector Task

9.2.2 Adv
vanced Reeport Setttings
You may
m remem mber that wee had to go into the Addvanced Moode of the report
r
config
guration to add
a a triggerr. There are many more options undder the Advaanced
Modee, including:

• Report Schheduling
• Options
• Default Laanguage
• Global Aliiasing Them
mes
• Web Visibbility

9.2.2.1 Rep
port Schedu
uling
The Report
R Scheduling tabb of the advvanced reporrt settings defines
d whenn the
reportt will be exxecuted. Repports are exxecuted baseed on triggeers. To assiign a

9-4 ICONICS
S, Inc
ReportWo
orX Training Manual
M Reporrt Configura
ation

triggeer to the repoort, click the Add buttoon, which lists all triggeers configurred in
the Unified
U Dataa Manager. You can edite the seleccted trigger or create a new
triggeer by clickingg the Run UD
DM Configuurator button.

If you
u do not wannt to assign a trigger to thhe report, yoou alternativeely can chooose to
execuute it manually by clickinng the Execu ute Report NowN button.

If the ReportWorrX service iss in runtimee mode, andd a configuraation changee has
occurrred that modifies
m the schedulinng of anyy report, thhe ReportW WorX
Configurator willl display thee following message
m as shown in Figure
F 9.6. Iff you
select Yes, the changes
c willl be transm
mitted immeediately to the
t ReportW WorX
Servicce. If you seelect No, youu must manuually inform
m the ReporttWorX serviice of
the scheduling changes
c by clicking the
t Reload Scheduless button onn the
Configurator toolbbar.

Figure 9.6 - Scheeduling Updatess

9.2.2.2 Opttions
In thee Options taab of the advvanced reporrt settings, you can checck one or moore of
the following checck boxes:

• Auto Fit Columns:

C W
When Auto Fit
F Column ns is checkedd, each colum
mn in
the report''s Microsoftt Excel workkbook/spreaadsheet will be automatiically
expanded to fit all repoort data withhin a columnn.

NOTE: Enaabling this optiion may alter or o distort the appearance

a of any images
that are emmbedded in coolumns within the Excel template. To avvoid image
distortion inn your templattes, while worrking in Excel right-click onn the image
and select Format Picturee from the pop-up menu. Theen click on the Properties
tab. Select thhe Don't movve or size with
h cells radio buutton, and thenn click OK.
This setting prevents the image
i from strretching when the column inn which the
image is embbedded gets exxpanded.

• Protect Workbook:
W W
When Proteect Workboook is checked, the geneerated
Microsoft Excel Repoort will be read-only (e.g.
( no onee will be abble to
modify it).
• Use Univeersal Coord dinated Tim me (UTC): When
W Use UTC
U is checked,
all time sttamps storedd in the report will be stored as UTC
U time staamps.

S, Inc
ICONICS 9-5
Report Configurati
C on ReportWorrX Training Manual

This is too accommoddate automaatic daylightt savings tim me switchinng in

Windows when the repport is execuuting.
• Keep Woorkbook Coomments: When W Keep p Workbook Commen nts is
t generated Excel filee will displayy comment tooltips for each
checked, the
data cell.
• Compresss Report Fille(s): Minim mizes the sizee of executedd report filess.
• Cancel Report on seerver shutdoown: Canceels a report in i progress when
w
the server is shutdownn.
• OPC Reaad Timeout:: Specifies thhe amount of o time (in milliseconds)
m ) that
the Reportting Service will wait forr OPC data when
w executting a reportt.
• Database Command Timeout: Specifies
S thee amount of time
t (in secoonds)
that the Reporting
R Seervice will wait
w for dataabase data whenw executting a
report.

If useer-selectable input param

meters are used in a repport, the folllowing addittional
optionns (normallyy grayed ouut) become available
a in the Option ns tab, show
wn in
Figuree 9.7:

• Merge Results
R in One
O Report: Combinees multiple values of input
parameterss into a single report.
• Generate Multiple Reports: Executes
E muultiple repoorts for muultiple
values of input
i parameeters.
• Allow Extternal Selecction: Enablles selectionn of multiplee values for input
parameterss through thee ReportWoorX Web Inteerface.

Figure 9.7 - Advanced

A Report Settings: Rep
port Options

9.2.2.3 Defa
ault Langu
uage
The Default
D Lannguage tab of
o the advancced report settings, show wn in Figuree 9.8,
gives you the optiion to speciffy a languagge for the repport that is different
d from
m the
defaullt language of
o the reportt configuratioon.

Figure 9.8 - Ad
dvanced Reporrt Settings: Report Language

9-6 ICONICS
S, Inc
ReportWo
orX Training Manual
M Reporrt Configura
ation

• Languagee: Click on thhe globe icoon button to open the Laanguage Seleector,
which alloows you chooose the report languagee. This is thhe language to be
used in thee reports. Alll language-aaliased entriies within thhe report tem
mplate
will be traanslated to thhe selected language,
l annd OPC valuues will be scaled
using the language
l connfiguration settings.
s
• Languagee Subset: Thhe default laanguage subbset (chosen in the Langguage
Selector) for
f the reporrt is displayeed in this fielld.

9.2.2.4 Glob
bal Aliasin
ng Themes
The Global
G Aliaasing Them mes tab of the
t advanceed report settings, show
wn in
Figuree 9.9, allowss you to brow
wse for global aliasing thhemes.
NOTE: Foor complete information
i abbout global aliasing,
a pleasse see the
GENESIS322 Global Aliasiing Configurattor help docum
mentation.

Figgure 9.9 - Advaanced Report Seettings: Global Aliasing Themees

ReporrtWorX suppports report--wide aliasess, and it resoolves the aliiases for selected
themees on a per-rreport basis. Global aliasses are assiggned to a cerrtain group based
b
on thee following delimiters:
d <
<#...#>. For example,
e ann aliased strinng for "Buildding"
wouldd appear as <#Building#
< >.

The reesolution off global aliasses is controolled by the Theme. Yoou need to define
d
themees on a per-rreport basis for all kindds of reportss. Themes are
a defined in i the
globall alias themee item browwser, shown in i Figure 9.10. For morre informatioon on
selecting global allias themes, see the ReportWorX doocumentationn.

Figure 9.110 - Choosing Global

G Alias Start Theme

S, Inc
ICONICS 9-7
Report Configuration ReportWorX Training Manual

When a report associated with a global alias theme is executed, the ReportWorX
Service will interface with the global aliasing engine (server) to resolve the global
alias and theme.
NOTE: The global aliasing configuration within ReportWorX itself may change
depending on the scheduling selected. For reports that are executed on demand,
you will configure a selection of themes to be presented via the ReportWorX
Web interface. For reports that are executed with a trigger on the server side,
there is only one theme selection.

9.2.2.5 Web Visibility

You can decide which format of report (excel, pdf, html) to be viewable in the
Unified Web Interface by selecting it in this tab as shown in Figure 9.11. Note
that in order to view the reports in the selected format, you must check the option
to generate the report in that format.

Figure 9.11 - Web Visibility

9-8 ICONICS, Inc

ReportWorX Training Manual Lab 9: Running Reports

Lab: Running Reports 9

9.1 Lab Overview

In this lab we will edit the Acmeseutical Report to use the template that we have
configured to this point, and then we will execute the report.

9.1.1 Task Checklist

In this lab, you will complete the following tasks:

• Associate a report template to a report

• Associate redirector actions to a report
• Execute a report from the ReportWorX Configurator.
• Visualize the results using the Monitor View.

9.1.2 Support Files

To complete this quick lab, you will not need any support files.

9.2 Associating a Report Template to a Report

1. In the ReportWorX Configurator, select the Acmeseutical Report from
the Acmeseutical Reports folder in the Acmeseutical Configuration.

2. Click on the drop down list for the Report Template field

3. Select the Acmeseutical Report Template, and click on Apply. Your report
should look like Figure L9.1.

ICONICS, Inc L9-1

Lab 9: R unning Rep
ports ReportWorrX Training Manual

Figgure L9.1 - Acm

meseutical Repoort

4. You have now associaated the Acmmeseutical Reeport Templlate to the

Acmeseutiical Report using
u the Reeport Templaate field

5. Enable thee report using the Enabled check boox if it’s not enabled.
e

9.3 Associa
A ate Rediirector Action
ns to a Report
R
1. In the RepportWorX Coonfigurator, select the Acmeseutical
A l Report froom
the Acmesseutical Rep
ports folder in the Acmeeseutical Coonfiguration n.

2. Click on thhe drop dow

wn list for thee Redirectorr Action fielld and selectt the
Acmeseutiical Combinned Action. Your
Y report should
s look like Figure L9.2.
L

Figure L9.2 - Acmeseutical

A Reeport with Rediirector Action

3. You have now associaated the Acm meseutical Coombined Redirector Acttion
to the Acm
meseutical Report
R using the
t Redirecttor Action field. Click onn
Apply to save
s the conffiguration.

L9-2 ICONICS
S, Inc
ReportWo
orX Training Manual
M Lab 9: Running
R Rep
ports

9.4 Starting
S g the ReportW
R WorX seervice
1. Click on thhe traffic ligght in the tooolbar of the ReportWorX
R X Configurator to
start the ReportWorX
R Service, as shown
s in Figgure L9.3.

Figure L99.3 - Starting th

he ReportWorX
X Service

2. The trafficc light shouldd turn green

n after abbout 15 to 200 seconds. Iff it
turns yelloow or gray innstead of greeen, please leet your instruuctor know, and
he or she will
w help youu troubleshoot the probleem.

3. Navigate back
b to yourr Acmeseutical Report and a click thee Execute
Report Noow button. YouY should receive a meessage tellinng you that thhe
report has been successsfully schedduled for exeecution, as shhown in Figuure
L9.4. Clickk OK to ackknowledge thhis message..

Figure L9.4 - Submitting the Report for Execution

9.5 Using
U Monitor
M r View to view
w reportts
1. To view thhe results of a report, wee can use Moonitor View
w from the
ReportWoorX Configurrator. Click on the icon to launch the Moniitor
View.

S, Inc
ICONICS L9-3
Lab 9: R unning Rep
ports ReportWorrX Training Manual

2. You shoulld see somethhing similarr to Figure L9.5, showingg you the
execution time, user, file
f name, staatus, and anyy error inforrmation (if
applicablee). If your reeport status is
i still “Runnning,” use thhe refresh
button at the bottom too refresh the status until you see “Coompleted.”

Figure L9.5
L - Report Exxecution Monitoor View

3. To view thhe report, sim

mply click on the Excel icon next to the report fiile
name. Thiis will open Excel and shhow you thee completed report.

Thhis completees Lab 9. We have assocciated a tempplate and reddirector actioons

to a report. We have also started
s the ReportWorX
R service, exeecuted a repoort
an
nd viewed thhe report usinng Monitor View.
V In the next chapteer you will leearn
ab
bout the Uniffied Web Intterface.

L9-4 ICONICS
S, Inc
ReportWorX Training Manual Unified Web Interface

Unified Web Interface 10

10.1 Objectives
After completing this chapter, you should know how to:

• Launch the Unified Web Interface from the ReportWorX Configurator.

• Execute reports from the Unified Web Interface.
• Visualize reports using the Unified Web Interface.
• Manage reports using the Unified Web Interface.
• Access the ReportWorX Web Service.

10.2 Introduction to the Unified Web Interface

The Unified Web Interface enables you to execute reports on demand and browse
reports from any client computer with Internet Explorer 5.5 or above. Reports can
be accessed over company intranets or over the Internet.

The Unified Web Interface allows you to:

• Execute reports
• Visualize reports
• Manage reports

The Unified Web Interface displays configuration information from the active
configuration database, and it also enables you to modify configuration
information. Any configuration change that you make in the Unified Web
Interface is updated in the active report configuration database. Similarly, all
changes that are made to the active configuration database using the ReportWorX
Configurator are reflected in the Unified Web Interface.

The Unified Web Interface also feature Windows NT integrated security. Only
registered users or groups with access rights may view, execute, and manage
reports.

ICONICS, Inc 10-1

Unified Web Interface ReportWorX Training Manual

NOTE: The Unified Web Interface allows you to modify existing reports in the
active configuration database from the client side. You can modify report
configuration and report scheduling, but you cannot create new reports. Reports
can only be created through the ReportWorX Configurator on the server side.

10.2.1 Launching the Unified Web Interface

You can launch the Unified Web Interface from the ReportWorX Configurator on
the server by clicking on the Visualize Reports button on the Configurator
toolbar, as shown in Figure 10.1.

Figure 10.1 - Starting the Unified Web Interface

The Unified Web Interface opens in Internet Explorer. You can also launch the
ReportWorX Unified Web Interface from a client machine on a company intranet
or over the Internet. Open Internet Explorer and go to the following URL address:

http://<mywebserver>/Main/Secured/LayoutProcessor.aspx

where <mywebserver> should be the actual server’s computer name or IP address.

The Unified Web Interface opens in Internet Explorer. You can use the same URL
to open the Unified Web Interface on the server machine.

10.2.2 The User Interface

Once the Unified Web Interface opens, you will notice that it is organized into
three main sections:

• Navigation Tree: Contains providers, groups, and tabs.

• Command Bar: This menu bar in the header above the work area allows
you to configure administration settings and user preferences.
• Content Area: Here, you can manage and visualize all aspects of the
Unified Web Interface plug-ins.

10.2.2.1 Navigation Tree

The Navigation Tree contains the provider, groups, and tabs configured by the
subscription. By default, if ReportWorX and BridgeWorX were installed before

10-2 ICONICS, Inc

ReportWo
orX Training Manual
M Unified
d Web Interrface

your Unified
U Webb Interface innstallation, both
b providers are in the navigation tree
t
as sho
own in Figurre 10.2.

F
Figure 10.2 - Navigation Tree

Providders are avaailable for ReportWorX

R X, BridgeWoorX, Producctivity Analyytics,
and Custom
C XM
ML. The Custom XM ML Provider can be used u for addding
additional contentt such as extternal links too the Navigaation Tree.

10.2.2.2 Comman
nd Bar
The Command
C B shown in Figure 10..3, is a menuu bar that allows you to get
Bar, g to
the Unified
U Web Interface’s Administraation and Usser Preferennces page. There,
T
you can
c change some setttings for thhe Unified Web Interrface. For more
mation on the optionns, please refer to thhe Unified Web Inteerface
inform
docummentation.

Figure 10.3 - Command

C Bar

10.2.2.3 The Conttent Area

The Content
C Areaa, shown in the
t Figure 100.4, is the main work areea for the Unnified
Web Interface. What
W you seee in the Content
C Areaa varies acccording to which
w
der link item
provid m is selectedd in the Navvigation Treee. Here you can managee and
visuallize all aspeects of a repport, includiing report configurationn, execution, and
manag gement.

S, Inc
ICONICS 10-3
Unified Web Interfa
ace ReportWorrX Training Manual

F
Figure 10.4 - Th
he Content Areaa

Featurres of the Coontent Area include:

• Context-seensitive mennus that prrovide shorttcuts to thee most com mmon

functionality for visuaalizing data
• Support for
f item sorrting and grouping,
g ennabling easiier analysiss and
retrieval of data
• Filtering data
d by time range
• Paging slidder bar for easy
e navigatiion between pages
• A search field
f that enaables full-texxt search of all
a data item
ms and colummns

10.22.3 Interacting with

w Reports in th
he Unifieed Web In
nterface
The Unified
U Webb Interface allows userss with appropriate acceess right to view
reportts over the Internet andd intranets. Windows inntegrated security is used to
authennticate user identity. Once
O a userr's identity is known, the
t ReportW WorX
securiity engine esstablishes which
w reportss can be gennerated, view
wed, or moddified
by thee user. (See the
t ReportW WorX Configgurator docum mentation foor details.)

In ord
der to visualiize reports using
u the Uniified Web Innterface, youu must first create
c
and configure youur reports inn the ReporrtWorX Connfigurator onn the server side.
Reporrts can be creeated only thhrough the ReportWorX
R X Configuratoor.

From the client side, the Unified

U Webb Interface only allowss you to modify
m
existin
ng reports inn the active configuratioon database. By default, reports are made
m

10-4 ICONICS
S, Inc
ReportWo
orX Training Manual
M Unified
d Web Interrface

availaable throughh the Unifiedd Web Interrface as Miccrosoft Exceel files. Youu can
optionnally make reports
r availaable in Adobbe PDF or HTML
H formaats.

NOTE: In order
o to view and
a modify repports in Excel, the client macchine needs
the Microsooft Excel View wer (availablee on the BizV Viz product CDC or as a
download frrom the ReporrtWorX Unifieed Web Interfaace). To view PDFs, you
will need Adobe
A Acrobat Reader. The PDF P and HTM ML formats aree static, but
Excel reportts enable you too manipulate thhe data containned in the reporrts.

To view your repports throughh the Unifieed Web Inteerface, you will w need too first
start the
t ReportW WorX Servicce on the seerver side. Once O it’s staarted, launchh the
Unifieed Web Inteerface from your web browser.
b Once you see the ReportW WorX
providder in the maain page, youu can navigaate to the dessired report for
f execution.

10.22.4 Execcuting Reeports

In thee ReportWoorX folder onn the Navigation Tree on
o the left haand side, youu can
expannd the folderr, and locatee the report you
y want to execute, as shown in Figure
F
10.5.

Figgure 10.5 - Execcute Report Pagge

10.2.4.1 Parameteers and Exxecution Op

ptions
You can
c select a report to runn from the appropriate
a R
Report Foldeer, which lissts all
enableed reports to which youy have permissions in the activve configurration
databaase, as show
wn in Figure 10.6.

Figure 10.66 - Unified Web Interface: Rep

port Folder

S, Inc
ICONICS 10-5
Unified Web Interfa
ace ReportWorrX Training Manual

The Unified
U Weeb Interfacee will dispplay all possible param meter selecctions
necesssary to run the
t report. Parameters
P arre configureed on the serrver side to allow
a
you to o refine the data in the report.
r For example,
e a pill
p inventoryy report couuld be
filtereed for a speccific pill nam
me, and alloow you to customize
c w
which pill wiill be
displaayed in the report,
r as shoown in Figuure 10.7. It iss possible too pass param
meters
to dattabase queriies as well as web serrvice calls and global aliases. Seee the
ReporrtWorX Exccel configuraation docum mentation foor informatioon about hoow to
config gure database parameterss or web servvice parameeters for repoorts.

Figure 10.7 - Parameter Op

ptions for Reporrt Execution

10.2.4.2 Report Execution

E O
Outcomes
If thee report is successfully
s executed, then
t you wiill be notifiied, as show
wn in
Figuree 10.8.

Fiigure 10.8 - Exeecuting a Reporrt

Some reports mayy take a long time to exxecute due too the amounnt of data inn it or
due to
o the time reqquired to connvert it into HTML. If thhe report takkes a long tim
me to
execu
ute, you will be notified with
w a messaage such as the t one show wn in Figuree 10.9.

Figure 10.9 - Reporrt Execution Meessage when It Takes

T a Long Time
T

The reeport will keep

k executinng, but the Unified
U Webb Interface will
w stop waaiting
for it. You can cliick the Execcute Anotheer Report buutton to go backb to the report
r
execuution page, orr you can usse the toolbaar to navigatee to another page, such as
a the
Visua alize Reportts page or thhe Manage page. The default
d timeoout for the report
r

10-6 ICONICS
S, Inc
ReportWorX Training Manual Unified Web Interface

execution result is 60 seconds, which means that the Unified Web Interface will
wait at most 60 seconds for a report to be executed. You can change this timeout
by going to the Preferences page and setting a different value for it (see the
“Preferences" section for details). You can also configure if you want to wait for
the report execution result.

When reports are executed in the Unified Web Interface, an auto-generated URL
address to the report file is made available at the resulting page. The URL address
would all start with: http://localhost/RwxWebService/tmp/<report_identifier>
where <report_identifier> is an auto-generated ID by ReportWorX for the
particular report.

If the report is executed but no link is shown on the resulting web page, it may
mean that the report did not execute successfully.

If the resulting page shows a link to a report but you cannot see the report by
clicking on it, you may not have access rights to view the report.

If the report link contains localhost instead of the Web server name, it may be
impossible for you to see the report because the ReportWorX provider address has
not been properly configured. Ask your system administrator to change the
ReportWorX provider address to match the server name.

10.2.5 Visualizing Reports

The Content Area page of the Unified Web Interface, shown in Figure 10.10, is
the main page for viewing data for reports executed from the active report
configuration. All executed reports can be viewed from this page. The page also
shows the currently logged user account.
NOTE: Only registered users or groups with access rights may view reports. In
order to view a report, you must have permission for report viewing for the
folder in which the selected report is located. Please refer to the ReportWorX
Configurator documentation for information about configuring report
permissions.

ICONICS, Inc 10-7

Unified Web Interfa
ace ReportWorrX Training Manual

Figure 10.10 - Unified Web In

nterface: Visuallizing Reports

The reports
r are organized
o according to the report folders in the t active report
r
config
guration. Wiithin each folder,
f you can
c sort thee reports by each colum mn in
ascendding or desccending ordeer by clickingg on the coluumn headingg.

If the report is coonfigured to be saved as the same file (i.e. the Create
C new Files
checkk box in the report confiiguration prooperties is not
n checked), only the link to
the laast report exxecution will be displayyed because the existingg report filees get
overwwritten. If yoou delete thee report files from the web
w server, they will notn be
listed in the Unified Web Inteerface.

Each report
r folderr lists the folllowing dataa columns:

• Report Name:
N Displaays the repoort names ass shown in the
t configurration
database. The Reportt Name collumn in the Content Area A page of
o the
Unified Web
W Interfacee lists both reeports that were
w executeed successfullly as
well as repports that faiiled to execuute.
• Executed At: Lists the date and tiime each repport was execcuted.
• Executed By: Lists thhe user and the domain they are froom who execcuted
the report.

10.2.5.1 Report Iccons

In thee column to the left of the Report Name coluumn, there is i a column with
differeent icons next to each exxecuted repoort that indiccates the forrmat in whicch the
reportt was executted (i.e. HTMML page, Addobe Acrobaat PDF, or Exxcel spreadssheet).
You can
c click on the icon to viewv the repport. If you have
h multiplle formats foor the
same report, the report will be executedd in multiplle formats, and a you willl see
multipple icons, eaach representting a single format.

The iccons have thhe following meanings:

10-8 ICONICS
S, Inc
ReportWo
orX Training Manual
M Unified
d Web Interrface

• No Icons:: When a repport appearss in the visuaalization pagge but there is no

icon assocciated with thet report, iti means thaat the reportt did not execute
successfullly.
• PDF: Report
R has been
b executeed successfuully in PDF format. Clicck on
the icon too view the reeport.
• HTM ML: Report has been exxecuted succcessfully inn HTML format.
Click on thhe icon to viiew the report.
• Excel: Report hass been execuuted successsfully in Exccel format. Click
C
on the iconn to view thee report.

10.2.5.2 Report Status

S Iconss
In thee column to thet left of thhe Report Icoons are iconns indicating the status of
o this
reportt execution. You can cliick on the iccon to view report tracinng informatiion if
the repport failed too execute or if it executeed with errorrs.

The iccons have thhe following meanings:

• Successful: Reportt completed successfullyy

• Error:: Report com
mpleted withh errors
• Cancellled: Reportt has been caancelled duriing executionn
• Failed: Report hass failed to exxecute for som
me unknownn reason

10.2.5.3 Viewing Excel Repoorts in the Unified Web

W Interface
Clickiing on the Excel
E icon next
n to an executed
e repport allows you to view w the
reportt in an Exceel spreadsheeet format, ass shown in Figure
F 10.111. The reporrt has
all thee Microsoft Excel functtionality, so you can display data in i charts, grraphs,
and otther formatss. You can allso create neew worksheeets, charts, and
a perform other
functiions.
NOTE: Anyy modificationns made to the Excel file on the t client side will not be
stored in thee server side coonfiguration daatabase. To vissualize native Excel
E report
files, you will
w need to have Microsooft Excel instaalled on yourr computer.
Alternativelyy you can instaall the Excel Viewer
V from thhe Unified Weeb Interface,
or install thee viewer from the
t BizViz product CD.

S, Inc
ICONICS 10-9
Unified Web Interfa
ace ReportWorrX Training Manual

Figu
ure 10.11 - View
wing Excel Repoorts in the Uniffied Web Interfface

10.2.5.4 Filtering Report Daata

The Content
C Areea page of thhe Unified Web
W Interfacce allows you to filter reeports
by theeir date of exxecution as shown
s in Figgure 10.12.

Figu
ure 10.12 - Filteering Report Daata

10.22.6 Man
naging Reports
R
By seelecting a reeport from thhe Navigation Tree to the left of thet Unified Web
Interfa
face, and righht clicking itt, you are able to select the
t Configurre Report option
o
as sho
own in Figurre 10.13.

10-10 ICONICS
S, Inc
ReportWo
orX Training Manual
M Unified
d Web Interrface

Figu
ure 10.13 - Con
nfiguring a Repoort

This will
w display many conffiguration opptions in thee Content AreaA to the right,
r
similaar to those inn the ReportW
WorX Confiigurator, as shown
s in Figgure 10.14.

Figure 10.14
1 - Report Configuration
C O
Options in the Unified
U Web Interface

NOTE: Forr more informaation on the coonfiguration opptions for eachh tab, please
refer to the ReportWorX
R d
documentation.

S, Inc
ICONICS 1
10-11
Unified Web Interface ReportWorX Training Manual

10-12 ICONICS, Inc

ReportWo
orX Training Manual
M Lab
b 10: Unified
d Web Interrface

Lab b: Unifie
U ed Web
W
10
Intterfaace
10.1 Lab Overview
O w
The ReportWorX
R web part in the Unified Web Interfaace enables you
y to interaact
with ReportWorX
R X from Internnet Explorer. Reports cann be accesseed over comppany
intran
nets or over the
t Internet. The Unifiedd Web Interfface allows you
y to:

• Execute reeports
• Visualize reports
r
• Manage reeports

10.11.1 Task
k Checkllist
In thiss quick lab, you
y will com
mplete the foollowing taskks:

• Configure report optioons in the Unnified Web Interface

I
• Execute a report from the Unified Web Interfaace
• Visualize reports
r usingg the Unifiedd Web Interfface

10.11.2 Supp
port Filees
To complete this quick
q lab, yoou will not need
n any suppport files.

10.2 Launcching th
he Unifi
fied Weeb Interrface
To lau
unch the Uniified Web Innterface from
m the ReporttWorX Conffigurator on the
t
serverr side:

1. Cllick the Visu

ualize Reporrts button on the connfigurator’s toolbar,
t as
sh
hown in Figuure L10.1.

S, Inc
ICONICS L
L10-1
Lab 10: Unified We b Interface ReportWorrX Training Manual

Figure L100.1 - Starting th

he Unified Web Interface

2. Thhe Unified Web

W Interface opens in Innternet Expllorer to the following
f default
URRL address on o the local machine:
htttp://localhoost/Main/seccured/Layou
utProcessorr.aspx.

10.22.1 Execcuting Reeports

To execute reports from a clieent machine using the Unnified Web Interface:
I

1. Cllick on the plus

p sign to expand
e the ReportWorX
R X folder in thhe Navigatioon
Trree, and naviigate to the folder
f that coontains the report
r that yoou want to
ex
xecute.

2. Riight-click onn the report that

t you wannt to executee and then select Executee
Reeport from the
t pop-up menu,
m as shoown in Figurre L10.2.

F
Figure L10.2 - Execute
E Reportt

NOTE: Youu must have access

a rights to
t execute repports. If you dod not have
access, the menu item will be grayyed out. Pleasse see the ReportWorX
R
Configuratorr help documeentation for moore informationn about configuuring report
access privilleges.

3. Thhe main repoort executionn page will appear

a on thee screen in thhe content arrea,
ass shown in Fiigure L10.3..

L10-2 ICONICS
S, Inc
ReportWo
orX Training Manual
M Lab
b 10: Unified
d Web Interrface

Figure L10.3 - Report Executtion in Unified Web

W Interface

4. Fiill in the userr-selectable parameter values listed for

f the reporrt (if any).

5. Yoou can use thhe Snapshott Name fieldd to give a frriendly namee to the repoort
beeing executedd, such as Acmeseutica
A l Snapshot. You can alsso specify thhe
im
mportance off the report execution.
e
NOTE: If you
y do not see the
t Snapshot Name field, ennable it from Preferences
P
Æ General Settings Æ Exxecution

6. When
W you aree ready to runn the report, click the Exxecute buttoon to executee the
rep
port. When you
y execute a report, theere may be a delay as thee Unified Web W
nterface gets data from thhe active connfiguration database
In d andd the
ReeportWorX runtime
r engiine as shownn in Figure L10.4.
L

Figgure L10.4 - Exxecuting a Repoort

7. When
W the repoort finishes running,
r youu should see a message similar to thee one
sh
hown in Figuure L10.5.

Figure L10.5 - Report Executtion Completed

d Successfully

8. Affter the repoort has been executed,

e yoou can click on the hyperrlink to view
w the
rep
port, or you can click onn the Executte another report
r buttonn to go backk and
ex
xecute another report.
NOTE: If thhe report is connfigured to be saved always on the same file
f (e.g. the
Create new Files
F check boxx in the report configuration properties is not
n checked),
each report execution
e will overwrite the previous
p one.

S, Inc
ICONICS L
L10-3
Lab 10: Unified We b Interface ReportWorrX Training Manual

10.22.2 Visu
ualizing Reports
R
The ReportWorX
R Viewer webb part in the Unified Web Interface, shown in Figure
L10.6
6, enables yoou to view all executed reeports. To viiew a report:

1. Cllick on the Acmeseutica

A al Reports reeport folder to visualize all executedd
rep
ports as showwn in Figuree L10.6.

Figgure L10.6 - Vissualizing Reporrts

2. Thhe content arrea displays a list of item

ms, each onee of them reppresenting a
sin
ngle executeed report. Thhe items are displayed
d inn an easy-to-aaccess grid
format with roows represennting report executions
e a columns representingg
and
ex
xecution propperties.

3. Viiew reports by
b clicking on
o the Excell, PDF or HT
TML icon neext to the
ex
xecuted report.

10.22.3 Man
naging Report
R Coonfigurattion
To maanage reportts from a clieent machine using the Unified Web Interface:
I

1. Cllick on the plus

p sign to expand
e the ReportWorX
R X folder in thhe Navigatioon
Trree and naviggate to the folder
fo that coontains the reeport that yoou want to
co
onfigure.

2. Riight-click onn the report that

t you wannt to configuure and then select Confiigure
Reeport from the
t pop-up menu,
m as shoown in Figurre L10.7.

Figgure L10.7 - Con

nfiguring Reporrts

L10-4 ICONICS
S, Inc
ReportWo
orX Training Manual
M Lab
b 10: Unified
d Web Interrface

NOTE: Youu must have access

a rights too configure repports. If you do
d not have
access, the menu item will be grayyed out. Pleasse see the ReportWorXR
Configuratorr help documeentation for moore informationn about configuuring report
access privilleges.

he main repoort configuraation page will

3. Th w appear onn the screen in the contennt
area, as shownn in Figure L10.8.
L

Figu
ure L10.8 - Rep
port Configurattion in the Unifiied Web Interfaace

4. Yoou can checkk the optionss to generatee reports in PDF

P and HT
TML, and theen
cliick on the Apply
A Changees button to save it.

5. If you check inn the ReporttWorX Conffigurator now

w, these optiions should be
b
ch
hecked.

S, Inc
ICONICS L
L10-5
Lab 10: Unified Web Interface ReportWorX Training Manual

L10-6 ICONICS, Inc

ReportWorX Training Manual Client Management

Client Management 11

11.1 Objectives
After completing this chapter, you should know how to:

• Register users and groups using the ReportWorX Configurator.

• Create a managed list using the ReportWorX Configurator.
• Add users and groups to a managed list.
• Associate managed lists with an e-mail action.
• Add users and set folder permissions

11.2 Introduction to Client Management

The ReportWorX Configurator allows you to set the report access permissions for
Windows users and groups on the local computer or in a Windows NT domain
over an intranet. The Client Management tree control of the Configurator, shown
in Figure 11.1, manages the registration of user and group accounts for the
ReportWorX Service. ReportWorX can automatically detect the users and groups
that are configured in your Windows system/NT domain and add them under the
Client Management tree control. You can also set up lists of users and groups for
report delivery.

ICONICS, Inc 11-1

Client Management
M t ReportWorrX Training Manual

Figure 111.1 - Client Man

nagement Tree Control

11.22.1 Userr Accoun

nts Registtration
The User
U Accoun nts tree conttrol of the Coonfigurator, shown in Fiigure 11.2, lists
l a
set off users alreaddy added to the
t ReportW WorX configuuration.

Figure 11.2 - User

U Accounts

To seet up an acccount for repport access, click the UserU Accounnts Registraation
buttonn on the righht-hand pane. In the Accoounts Regisstration dialog box, show wn in
Figuree 11.3, all avvailable userrs and groupps for the loccal computer are listed in
i the
upper pane of thee Window. Simply
S clickk on the user or group and
a then clicck on
the Addd to Selectted Accountts list buttonn to add the user
u or groupp. Once youu have
all of the desired users,
u you caan click OK to exit this dialog.
d

11-2 ICONICS
S, Inc
ReportWo
orX Training Manual
M Clie nt Managem
ment

Figgure 11.3 - Accoount Registratioon

NOTE: If youy are on a domain,

d you can
c select dom
main users andd groups by
clicking the Add Domain Groups… buttton.

Registtered users and

a groups will
w appear under
u the User Accoun
nts tree contrrol of
the Co
onfigurator.

11.2.1.1 Group Prroperties

The group
g properrties dialog,, shown in Figure 11.4, displays some inform
mation
about the group; however,
h youu cannot ediit these fieldss.

F
Figure 11.4 - Grroup Propertiess

• Group Naame: Displayys the name of the registtered group.

• Descriptioon: A descriiption for eacch group typpe is provideed.
• Domain: Displays thhe name off the compuuter on whiich the grouup is
registered..
• User Accounts Registration: Clicking this button openns the Accoounts
Registratiion dialog box,
b which allows
a you to
t register users
u and groups.
S, Inc
ICONICS 11-3
Client Management
M t ReportWorrX Training Manual

User Accounts Registratiion" sectionn above for more

(Please seee to the "U
informatioon.)

11.2.1.2 User Prooperties

Each user group may containn many userrs. The user properties are a similar tot the
group
p properties, but you cann also enter contact
c inforrmation for users
u as show
wn in
Figuree 11.5. The user
u propertiies are:

• User Nam me: Displays the name off the registerred user.
• Descriptioon: A descriiption for eacch user type is provided.
• Domain: Displays
D thee domain thee user belonggs to, or if thhe user is loccal, it
displays thhe name of thhe computerr on which thhe user is reggistered
• User Accounts Registration: Clicking this button openns the Accoounts
Registratiion dialog boox, which alllows you to register useers and groupps.
• E-mail Ad ddress: Enteer the user'ss e-mail addrress. An e-m mail address must
be specifieed if the userr is to receivve reports viaa e-mail.
• Apply: Saaves all channges to the coonfigurationn database.
• Reset: Cleears all recenntly added innformation.

Figure 11.5 - User

U Properties

11.22.2 Fold
der Perm
missions
Once you have addded users orr groups, you may want to grant them permissioons to
view, execute, andd manage reeports. You can c do this inn the Reportt Folder. Clicck on
the Folder Perm missions… button,
b to laaunch the Reeport Permissions dialoog, as
shown n in Figure 11.6.
1 By deffault, two user groups will
w already have
h permisssions:
the loccal Adminisstrators groupp and Users group.

11-4 ICONICS
S, Inc
ReportWo
orX Training Manual
M Clie nt Managem
ment

The Administrato
A ors group will
w have fulll permissioons, allowing them to view,
v
execuute, and mannage reports. The Users group, on thhe other hand, will only have
the view report peermission.

Figurre 11.6 - Reportt Permissions Dialog

You can
c add morre users and groups intoo the permisssions window w by clickinng on
the ad
dd or removve button. Cllicking on thhe Add buttton brings up u the Add Users
U
and Groups
G dialoog, as shownn in Figure 11.7.
1 The ussers and grooups in the upper
u
pane are
a those thaat you have added in yoour user mannagement lisst. You can select s
any off the users or
o groups andd click on thhe Add buttoon to add it too the lower pane.
p
Once you click OK in this dialog, thhe users wiill be added in the Folder F
Permiissions. You can then sellect the userr or group, chheck the perm missions dessired,
and cllick OK to close the Repport Permissiions Dialog.

Figure 11.7 - Add Userrs and Groups Dialog

Clickiing on Remoove on eitherr of the dialoog removes the

t selected user.

S, Inc
ICONICS 11-5
Client Management
M t ReportWorrX Training Manual

11.22.3 Man
naged Lissts
The Managed
M Liists tree conttrol, shown in Figure 111.8, allows you
y to createe lists
of useers and grooups for repport deliveryy. This is thhe equivalennt of a com mmon
mailin
ng list for em
mail. These lists can be used
u with Emmail Redirecttor Actions.

Figuree 11.8 - Manageed List Tree Coontrol

11.2.3.1 Creatingg a New Maanaged Listt

To crreate a new w managedd list, rightt-click Man
naged Listss in the Client
C
Manaagement treee control annd select Neew Æ Man naged List from the poop-up
menu,, as shown inn Figure 11.9.

Figure 11.9 - Creatingg a New Manageed List

The properties
p diaalog for a neew managedd list shows up in the right-hand paane of
the Coonfigurator, as shown inn Figure 11.110.

Figure 11.10 - Managed List

11-6 ICONICS
S, Inc
ReportWo
orX Training Manual
M Clie nt Managem
ment

The Add/Remov
A ve List Enttries buttonn allows yoou to edit the t list withh the
Add/R Remove Maanaged Listt Entries dialogd box, shown
s in Fiigure 11.11.. The
left-haand pane lists Registerred Users and Group ps on the local machinne or
domaiin. To add a registered user/group
u t the managged list, seleect the user/ggroup
to
name in the left-hhand pane annd then clickk the Add buutton. When the user/grooup is
shown n in the rightt hand pane under Curreent Contentt of Manageed List, it will
w be
added d to the mannaged list. Too remove a registered user/group
u frrom the mannaged
list, seelect the useer/group nam
me in the rigght-hand panne and thenn click the Delete
D
button n.

Figure 11.111 – Add or Rem

move Managed List
L Entries

NOTE: Youu can also impport users/groupps from an e-m mail account adddress book
into your managed
m lists. To do so, clicck the Importt from Addreess Book…
button and thhen select yourr e-mail serverr profile.

11.2.3.2 Managed
d List Items
Once you have addded a user or o group to a managed list,
l a new ittem is createed for
each user
u or grouup. For each group in thee managed list, l all userss in the grouup are
listed in the manaaged list propperties dialogg. Click the Show Detaiils button to view
the lisst of users inn the group, as
a shown in Figure 11.122.

S, Inc
ICONICS 11-7
Client Management
M t ReportWorrX Training Manual

Figure 111.12 - Managed List: Group Prroperties

The same
s is truee for all reggistered users added too the managged list: the user
properrties are listeed in the maanaged list properties
p diaalog. Click the
t Show Deetails
button
n to view thee user properrties, as showwn in Figuree 11.13.

Figure 11.13
1 - Managed
d List: User Prooperties

NOTE: Makke sure that ann e-mail addreess is specifiedd for each user in the user
properties foor the manageed list. If a maanaged list is associated
a withh an e-mail
action, each user in the lisst must have a valid e-mail address
a in ordeer to receive
reports. This is one of thhe few user properties
p that is editable inn the Client
Managemennt tool.

11.2.3.3 Associatiing Managed Lists wiith an E-m

mail Action
When n e-mailing reports,
r you can send thhem to an enntire list of groups
g and users.
u
To doo this you must
m specifyy a managedd list in the e-mail actioon propertiees, by
selecting Mailingg List from the Recipieent(s) Type drop-down list, as show wn in
Figuree 11.14. Yoou can also apply a mannaged list inn the recipieents listed in the
Mail To, Cc, and BCC fieldss.

11-8 ICONICS
S, Inc
ReportWo
orX Training Manual
M Clie nt Managem
ment

When n a report is executed wiith the e-mail action, thee report willl be sent to every
e
user in
n the mailingg list.

Figgure 11.14 - Asssociating Manaaged Lists with an

a E-mail Actioon

You can
c also ediit the selectted managedd list or creeate a new managed list by
clickin
ng on the buttons
b to the
t right off the drop-ddown lists. Creating a new
manag ged list from
m here will bring you back
b to the properties dialog
d for a New
Managed List, shoown in Figurre 11.15.

Figure 11.15
1 - Naming the new Managged List

NOTE: Makke sure that ann e-mail addreess is specifiedd for each user in the user
properties foor the managedd list.

S, Inc
ICONICS 11-9
Client Management ReportWorX Training Manual

11-10 ICONICS, Inc

ReportWorX Training Manual Lab 11: ReportWorX User Management

Lab: ReportWorX User

11
Management
11.1 Lab Overview
In this lab we will learn about user management within the ReportWorX
application. We will also explore managed lists and other user-related tasks.

11.1.1 Task Checklist

In this quick lab, you will complete the following tasks:

• Register a user in the User Accounts Registration

• Modify folder permissions
• Create a Managed List and use it in your E-mail Action

11.1.2 Support Files

To complete this quick lab, you will not need any support files.

11.2 Configuring User Accounts

Navigate to the User Accounts branch, under the Client Management tree.

You should see that underneath User Accounts, there are two groups listed:
Administrators and Users, each prefixed with your PC’s name as shown in
Figure L11.1. This is because by default, ReportWorX imports the Administrators
and Users groups from your Windows NT accounts.

ICONICS, Inc L11-1

Lab 11: ReportWorX
R X User Ma
anagement ReportWorrX Training Manual

Figu
ure L11.1 - Defaault User Accou
unts

To addd or removee users or grroups from thhis list, firstt click on thee User Accoounts
Regisstration buttton. Then, if the userss you want to t remove area on your local
machiine, simply select the users
u from the
t Accountt(s) selectedd for Importt box
below
w as needed, then click Remove
R buttton to comm mit your channges. If you want
to mannage domainn users, simpply click the Add Domaain Groups button on thhe top
right and enter thhe Domain Name.
N Depending on thhe size of your y domainn, this
operattion may takke a few minnutes.

You can
c register all of the apppropriate ussers and/or groups,
g but it is importaant to
know the applicattions in whicch these accoounts are useed. As you learned earlier in
this training
t claass, ReportW
WorX securrity is foldder-based, not n report-bbased.
Becauuse of this, you
y must maake modificaations to the permission sets at the report
r
folderr level.

11.22.1 Report Foldeer Permiissions

1. Naavigate to your Acmeeseutical Reeports foldeer under thhe Acmeseuutical
Co
onfigurationn tree and click on the Folder Perm
missions buutton to openn the
Reeport Permisssions dialogg.

2. Nootice that the Administrrators and Users

U groupps are alreadyy present in your
Fo
older Perm missions dialog. The Addministratorss group has full permisssions
an
nd the Users group only has
h View peermissions.

3. Fo
or experimeental purposses, let’s unncheck the Execute
E chheck box foor the
Ad
dministratoors group, soo that it now looks like what
w you seee in Figure L11.2.
L

L11-2 ICONICS
S, Inc
ReportWo
orX Training Manual
M La
ab 11: Repo
ortWorX Us er Managem
ment

Figure L11.2
L - Removin
ng Execute Perm
mission

4. Cllick OK to commit
c the changes.
c

5. Too visualize the

t effect off this changee, select the Acmeseutical Report from
the Acmeseuttical Reporrts folder, annd then click the Execuute Report Now
bu
utton.

6. Yoou should see

s that, altthough you previously had accesss to executee the
Accmeseuticall Report, noow, a popupp dialog tellls you that you do not have
peermissions to
t execute this report. This is because
b the execute reeports
peermissions has been removed for youur user.

7. Noow, click ok
o on the popup dialogg and re-open the Fold der Permissions
dialog under the Acmesseutical Reeports foldeer in order to restore your
xecute permiissions.
Ex

11.22.2 Man
naged Lissts
1. Neext, we will create a Maanaged Listt and see how
w it can be used
u in an E-mail
Reedirector Acction.

2. Naavigate to thhe Managed

d Lists brancch under the Client Man
nagement foolder,
w Æ Managged List.
then right-clicck on Managged Lists annd select New

3. In
n the Manageed List Nam
me field, put Acmeseuticcal Manageers and then click
Appply.

S, Inc
ICONICS L
L11-3
Lab 11: ReportWorX
R X User Ma
anagement ReportWorrX Training Manual

4. Cllick on the Add/Remove

A e List Entriies button to build your managed
m listt.

5. Fo
or this list, let’s just addd two userrs: Adminisstrator and BizViz_Useer as
sh
hown in Figuure L11.3. After you havve added youur desired users, click thee OK
bu
utton and thee list will be updated.

Figgure L11.3 - Ad
dding Users to the
t Acmeseuticaal Managers Liist

6. Yo ou can expannd your mannaged list to see each enntry, and assoociated withh each
usser will be an
a e-mail adddress. You canc view thiis e-mail adddress by cliccking
onn the Show Details
D button. E-mail addresses
a wiill be autom
matically impported
if you use youur Outlook address
a bookk to create the
t managedd list. If nott, you
mu ust manuallyy enter e-maail addresses for each useer.

7. Foor our managed list, we must enter an e-mail adddress for Administrato
A r and
BiizViz_User. Let’s make them [email protected], as shhown
in Figure L11.4, and BizV
[email protected].

Figuree L11.4 - Email Address for thee Administratorr Managed Listt User

8. Cllick on Applly to save yoour changes.

L11-4 ICONICS
S, Inc
ReportWorX Training Manual Lab 11: ReportWorX User Management

9. Now we can use this Managed List in our E-mail redirector action, so that
instead of always having to type in strings of addresses, we can simply select
our Acmeseutical managed list and e-mail to a group of people at one time.

10. Navigate back to your Acmeseutical E-mail Action. In the Mail To field,
instead of using the Absolute Addresses, select Mailing List and then choose
the Acmeseutical Managers list from the drop-down menu, as shown in
Figure L11.5.

Figure L11.5 - Modifying E-Mail Action

11. Click Apply to save your changes.

ICONICS, Inc L11-5

Lab 11: ReportWorX User Management ReportWorX Training Manual

L11-6 ICONICS, Inc

ReportWorX Training Manual Lab A: Report with Parameters

Lab: Report with

A
Parameters
A.1 Lab Overview
This chapter acts as an advanced lab, where you will configure some advanced
reports for your Acmeseutical application. This report will use various kinds of
parameters for filtering data. After completing this chapter, you should know how
to:

• Create a new template based on your existing Acmeseutical Report

Template
• Add a constant value parameter to your new template.
• Change your constant value parameter to a user-selectable parameter.
• Add another parameter to your template that depends on the value of the
first parameter.
• Enable multi-selection for your user-selectable parameter.
• After each template modification, use the Unified Web Interface to
execute a new copy of your report.

A.2 Creating a New Template

1. First, we will create a new template based on Acmeseutical Report Template.
To do so, navigate to your Acmeseutical Templates folder, right-click and
select New Æ Report Template.

2. Choose the fourth option, which is Copy formatting and data links from
existing template object, and then select Acmeseutical Report Template from
the list, as shown in Figure A.1.

3. Click OK to create the template.

4. Name the template Acmeseutical Parameters, and then click Apply.

ICONICS, Inc LA-1

Lab A: Report
R with Parameterrs ReportWorrX Training Manual

Figure A.1 – Insert New Report

R Templatte Dialog –
Choose
C the fourrth option “Cop
py formatting and data links frrom existing Teemplate object”

5. Cllick on the button to open thee template for f editing. Notice thatt this
temmplate shouuld look like a carbon coopy of Acmeseutical Reeport Temp plate.
Thhis prevents us from havving to recreaate the entiree thing. Now
w we just haave to
modify some of the connnections in order to shoow the advaanced featurres of
paarameters.

A.2..1 Add
ding a Coonstant Value
V Parrameter
1. Frrom your new
n Acmesseutical Parrameters teemplate, rigght-click onn the
co
onfiguration in the first cell
c and selecct Edit Dataa Source: DaatabaseSource.

2. Do
ouble click on
o the DatabbaseSource name
n under the Open Database
D foldder to
op
pen the Dataabase Conneection Conffiguration Wizard.
W

3. Cllick Next annd then Edit Æ Advanceed Query

4. Cllick on the Records

R Filttering/Sortin
ng tab and thhen on the [+
+] button to open
the Filtering Criteria
C diaalog.

5. Coomplete the Filter Typ pe, Column name to fiilter on, Reelation Typee and
t pulldownn menus to edit the exiisting filter, then
Reelates To seettings via the
cliick OK.

6. No ow suppose we only waant to see daata pertaininng to a certaain recipe. Inn this
caase we will filter
fi on the RecipeName
R e field.

7. Seelect dbo.Reecipes.Recip peName from m the Colum mn Name too Filter On drop-
d
do
own list, leavve the Relatiion Type sett to Equal To, and makee sure the Reelates
Too field is set to Constant Value(s).

LA-2 ICONICS
S, Inc
ReportWo
orX Training Manual
M Lab A:
A Report with
w Parameeters

8. Cllick the icon to buildd a list of poossible valuees directly frrom the dataabase.
Yoou may recceive a warnning messagge telling you y that buiilding the liist of
daatabase valuues may takee a long tim me. Click on o Yes to acknowledge
a e this
message, andd if you wissh, check thhe box that says “Donn’t show mee this
message againn.”

9. Yoou will see a list of alll of the diffferent recipees that are currently
c in your
daatabase. Seleect the recippe called NooMorePain 2002 mg, as shown in Figure
F
A.2.

Figure A.2 - Creating a Constant Value Parameter

P

10. Cllick OK to add the filteer, and then click Next through the rest of the Data
Seelection diallogs without changing annything.

11. Cllick OK to apply your configuratioon changes. Note that you

y don’t haave to
ad
djust the Datta Mapping step at all.

12. Saave your tem

mplate and close
c Excel. Now, in ordder to test thhis new tempplate,
wee must assocciate it to a report
r in our Acmeseuticcal Configuration.

13. Naavigate to your

y Acmeseeutical Rep ports folder and create a new repoort by
ght-clicking on the foldeer and selectiing New Æ Report.
rig

14. Naame this repport Acmeseu

utical Param
meter Repoort

15. Frrom the Reeport Temmplate drop--down list, select youur Acmeseu
utical
Paarameter tem
mplate.

16. Make
M sure to check
c the boox that says Create
C New
w Report Fille(s) as well..

S, Inc
ICONICS L
LA-3
Lab A: Report
R with Parameterrs ReportWorrX Training Manual

17. En
nable the repport using the Enabled check
c box.

18. Fiinally, click Apply to complete

c o your report. Becausee this
thee creation of
repport uses a constant
c valuue parameter, it does noot require useer interactionn and
caan therefore be executedd from the Configuratoor or from the t Unified Web
nterface withh exactly the same resultss.
In

19. Cllick the Execcute Reportt Now buttonn to execute a copy of yoour new repoort.
NOTE: If your
y ReportWoorX Service iss not currently running, clickking on this
button will automatically
a s
start the servicee.

20. Usse Monitor View to vissualize this report.

r It should resembble the reporrt that
yo
ou see in Figgure A.3.

21. Noote that the only recordds returned in the first worksheet are those with
w a
Reecipe Name of NoMorePain 200 mg.

Figure A.3 - Completed

C Acm
meseutical Param
meter Report

LA-4 ICONICS
S, Inc
ReportWorX Training Manual Lab A: Report with Parameters

A.2.2 Creating a User-Selectable Parameter

It is nice to have a report that filters out just the data that you want to see, but
what if you want to see a different set of data each time? For example, what if
you wanted to view information about a different recipe the next time you
executed that report? This is a job for User-Selectable Parameters.

1. From your new Acmeseutical Parameters template, right-click on the

configuration in the first cell and select Edit Data Source: DatabaseSource.

2. Double click on the DatabaseSource name under the Open Database folder to
open the Database Connection Configuration Wizard.

3. Click Next and then Edit Æ Advanced Query

4. Click on the Records Filtering tab and then the [+] to open the Filtering
Criteria dialog.

5. Click on the existing constant value parameter filter and use the pulldown
menus to set the column name, relation type and “relates to”.

Figure A.4 - Editing Your Existing Constant Value Parameter (Example Only)

6. We will still filter on the RecipeName field, but this time, let’s select a
RelatesTo value of Parameter from the drop-down list.

7. Click on the button to begin creating your parameter. This will launch the
Parameter Browser.

8. Click the Add button to add a new parameter. This will open the Configure
your parameter dialog box, which consists of inputs for creating a parameter.

ICONICS, Inc LA-5

Lab A: Report
R with Parameterrs ReportWorrX Training Manual

9. En
nter RecipeN
Name for thee Parameterr Name.

10. Cllick the Help

p me choosee button to laaunch the Seelect a param
meter wizarrd.

11. Siince we wannt to allow the

t user to choose
c a value for this parameter in the
Un nified Web Interface,
I wee will make this parametter user-seleectable.

12. Cllick Next annd then seleect the third option: Sellect from a dynamic liist of
va
alues, as shoown in Figure A.5. Then click Finishh.

Figuree A.5 - Selectingg the Parameterr Type

13. Cllick the Con

nfigure Parameter Dettails button to configuree the parameeter’s
prroperties.

14. Thhe dialog thaat is launcheed here willl be differennt for each tyype of parammeter
that you selectt from the Seelect a paraameter wizaard, but sincee the dynamiic list
off values is a very comm monly used parameter
p tyype, it will be beneficiaal for
yo
ou to learn noow.

15. Thhe first thinng to configgure is the Database Connection

C . Note that it is
po
ossible to exxtract a list of
o parameterr values from
m a databasee that is diffferent
fro w use the same
om the one you selected in your orriginal queryy. But we will
daatabase becauuse that is what
w makes sense
s for the Acmeseuticcal applicatioon.

16. Cllick the Con

nnect button and select thhe Acmeseu
utical Datab
base from thee list.
Cllick OK, annd then clickk the Build Query… button
b and select
s Advaanced
Query to geneerate your quuery.

Yo
ou are also free to mannually writee SQL code instead of using the Query
Q
Wizard
W if you wish, but leet’s use the wizard
w for noow.
LA-6 ICONICS
S, Inc
ReportWo
orX Training Manual
M Lab A:
A Report with
w Parameeters

17. Cllick the Add

d Tables… button
b to addd the Recipees table and then
t click OK.

18. Ch
heck the cheeckbox for RecipeName
R e and click Next
N

19. Cllick Next onn the next dialog

d box to ds Filtering And
t bring up the Record
So
orting dialogg box.

20. We
W want to shhow all of thhe available Recipe
R mes, so theree is no need to do
Nam
an
ny filtering now.
n

21. Too make thinggs easier forr the user, leet’s sort the recipes alphhabetically. Click
C
the Edit… buutton on the bottom of thhe dialog boox to open thhe Sort Reccords
dialog box. Select ReccipeName from f the drop-down
d box and select
s
Asscending, annd then clickk OK.

22. Cllick Finish. The dialog should

s now look
l like Figgure A.6.

Figure A.6 - Comp

pleted SQL Queery

23. Cllick the Pickk a value buutton to seleect a default value for thhe parameterr that
wiill be used whenever
w a user
u cannot be present to t select onee manually. Note
that this dialog can also be
b used as a test button to t make suree that your query
q
is correctly formed.

24. Seelect the AchhesBeGone 400 mg enttry from the list, as show
wn in Figuree A.7,
an
nd then clickk OK.

S, Inc
ICONICS L
LA-7
Lab A: Report
R with Parameterrs ReportWorrX Training Manual

Figu
ure A.7 - Selecting a Default Vaalue

25. Cllick OK twicce to get bacck to the Con

nfigure you
ur parameteer dialog.

26. En
nter a descriiption of whhat this param t Web prrompt field. This
meter is in the
wiill be displayyed to the usser in the Unnified Web Innterface.

27. Cllick OK twiice to close the Parameeter Browseer and bringg you back to
t the
Fiiltering Critteria dialog,, which shouuld be similaar Figure A.88.

Figu
ure A.8 - Filteriing Criteria Diaalog

28. Cllick OK to close

c your SQQL Commaand Designeer dialog andd then click Next
thrrough the reest of the Daatabase Con
nnection Coonfiguration
n Wizard dialogs
to complete thhe change.

29. Cllick OK when you get back

b to yourr Data Sourrce Manager dialog to apply
a
the changes, and
a then Savve and Closee your templaate.

LA-8 ICONICS
S, Inc
ReportWo
orX Training Manual
M Lab A:
A Report with
w Parameeters

30. Noow since thhis parameterr requires user

u interactiion, it is best to executte the
rep
port from thhe Unified Web
W Interfaace. Launchh that now iff it is not alrready
op
pen.

31. Seelect your Acmeseuticcal Parameeter Reporrt from thhe Acmeseu utical
Reeports foldeer, right clickk the report and
a then clicck Execute Report.
R

32. Yo ou should seee your RecipeName paarameter com mplete with the default value
v
off AchesBeG Gone 400 mgg already sellected in thee drop-down list, as show
wn in
Fiigure A.9.

Figure A.9 - Exxecuting the Acm

meseutical Paraameter Report

33. Ju
ust to verify that the paraameter is woorking propeerly, let’s select a value from
the list that iss completelyy different from
f the tw
wo values thhat we have used
beefore. Selectt MigraineAAway Classiic and then click
c Executte.

34. When
W the repoort has beenn executed yoou can view
w the report to
t see that it used
the MigraneAAway Classiic recipe, as shown in Figure A.10.

Figure A.10 - Completed

C Acm
meseutical Paraameter Report

S, Inc
ICONICS L
LA-9
Lab A: Report
R with Parameterrs ReportWorrX Training Manual

A.2..3 Crea
ating a Dependen
D nt User-S
Selectablee Parameeter
In this example, suppose
s thatt we want too not only narrow
n our record-set
r b the
by
name of the recippe, but also by
b the particcular Batch ID.
I We cann add a parammeter
that will
w show onlly the BatchIDs that are related to thhe RecipeNaame chosen in i the
previo
ous step. ToT do this, we must esstablish a deependency between
b thee two
parammeters.

1. In
n your RepoortWorX Configurator, navigate back b to youur Acmeseu
utical
Paarameters teemplate andd click the Ed
dit selected template ob
bject buttton.

2. Cllick the b
button to ediit the templaate in Excel.

3. Riight click on a connfigured ceell and seelect Edit Data Sou

urce:
DaatabaseSource

hen double click on thee DatabaseS

4. Th Source from
m the Open Database foolder,
an
nd click Next. Then selecct EditÆAd
dvanced Quuery.

5. Cllick on the Records

R Filttering/Sortin
ng tab.

nstead of ediiting our exiisting filter, we will addd another fillter to our query.
6. In q
Cllick on the [+
+] button to begin this process.

7. Fo
or the Colum
mn Name too Filter On, select TotallProduction
nData.Batch
hID.

8. Fo
or the Relattes To fieldd, select Inp
put Parametter, and clicck the red arrow
a
bu
utton to launch the Parammeter Brow wser again.

9. Cllick Add to create anothher parameterr.

10. Naame the paraameter BatchID

11. Fo
or the Param
meter type drop down meenu select Seelect from a dynamic list of
va
alues.

12. Cllick Configu

ure Parameeter Details to configuree the databasse connectionn and
qu
uery.

base from thhe list, and then

13. Cllick Connecct and selecct Acmeseutical Datab
d Query… Æ Advanceed Query buutton to buildd your queryy.
cliick the Build

14. If the TotalP

ProductionD Data and Reecipe tables are not on the canvas, add
them using the [+] buttonn, because we need to doo a join that connects thee two
tab
bles. Recrreate the join betw ween the RecipeID field in the
TootalProducttionData tabble and the ID field in thhe Recipes taable.

LA-10 ICONICS
S, Inc
ReportWorX Training Manual Lab A: Report with Parameters

15. Select the BatchID field from the TotalProductionData table. Verify that
your dialog looks like Figure A.11, and then click on the Records
Filtering/Sorting tab and then the [+] button to move on to the Filtering
Criteria dialog.

Figure A.11 - Configuring the BatchID Parameter

16. This time, we will add a filtering criterion to filter out only the BatchIDs that
belong to the Recipe that we selected in the previous step. Click on the [+] to
begin this process.

17. In the Column Name to Filter On, select Recipes.RecipeName and in the
Relates To field, select Input Parameter.

18. Click the small red arrow button to launch the Parameter Browser again. Note
that we have a Parameter Browser opened inside a Parameter Browser
because we are now two levels deep in parameters.

19. There is no need to create another parameter this time though, since we want
to associate our filtering criteria with the RecipeName parameter that we
already created. Simply select that parameter from the list and click OK.

20. Click OK to close the Filtering Criteria dialog, and then click Edit… in the
Records Sorting Order section. This opens the Sort Records dialog for the
BatchID parameter.

21. To make it easier for the user, let’s sort by TotalProductionData.BatchID in

ascending order.

ICONICS, Inc LA-11

Lab A: Report
R with Parameterrs ReportWorrX Training Manual

22. Cllick Finish too complete the

t Query Wizard.
W

23. Noow click thee Pick a vallue button to select a deefault value for our BattchID
paarameter.

24. Ennter AchesBBeGone 400 mg when prrompted for a value for the RecipeN
Name
paarameter. Thhis is needed to completee the query reequest.

25. Seelect the firstt value in thee list and click OK.

26. Yo our Configuure the paarameter prroperties diialog shouldd now lookk like
Fiigure A.12.

Figure A.112 - Configuringg the BatchID Parameter

P

27. Cllick OK to close

c the Parrameter propperties dialogg

28. En
nter a description for this parameter in the Web prom
mpt field to
t be
displayed to thhe user in the Unified Web
W Interfacee.

29. Cllick OK threee more timees to compleete the param

meter creatioon process and
a to
retturn to the Records
R Filttering/Sortin
ng tab.

30. Cllick OK to close your SQL Com mmand Desiigner dialogg, and then click
Neext through the rest of the Databaase Connecttion Configguration Wiizard
dialogs to com
mplete the chhange.

31. Saave your teemplate andd then closee Excel to return to the
t ReportW
WorX
Coonfigurator.

32. Leet’s use our Unified Web

W Interfacce again to execute a new n copy off this
rep
port and seee how the new
w dependentt parameter affects it.

LA-12 ICONICS
S, Inc
ReportWo
orX Training Manual
M Lab A:
A Report with
w Parameeters

33. Naavigate to thhe Acmeseu

utical Repoorts page annd select youur Acmeseu
utical
Pa
arameter Reeport from the
t list.

34. When
W you clicck Execute Report, youu should seee your two parameters
p apppear
on
n the screen. If you clicck on the drrop down menu
m that haas 10001 in it, as
sh
hown in Figgure A.13, it will contain a list of values for f the BatchID
paarameter.

F
Figure A.13 - Exxecuting the Accmeseutical Parrameter Reportt

35. Cllick Executee to execute the report.

36. Affter the repoort is complleted, click on

o the hypeerlink to view the comppleted
repport. It shoould containn only one row of dataa, as shown in Figure A.14,A
beecause we haave only seleected one BaatchID. Woouldn’t it be nice to be abble to
seelect multiplee BatchIDs? In the nextt section youu will learn how.
h

Figure A.14 - Completed

C Acm
meseutical Paraameter Report

A.2..4 Enabling Mu
ulti-selection for a User-Seelectablee Parameeter
As wee noticed in the last example, it wouuld be nice if
i the user could select a few
Batch
hIDs to incluude in his oro her reporrt instead off just one. This is posssible
throug
gh the multiiselection chheck box in the
t Parametter Configuration dialoog.

1. Naavigate backk to your Accmeseutical Parameterss template and

a click the Edit
th
his Templatee button to laaunch Excell.

2. Thhis time, sinnce we only want to chaange one of the propertiies of an exiisting
paarameter, wee can bypasss the open database configurationn dialogs annd go
strraight to the Parameter Browser.

S, Inc
ICONICS L
LA-13
Lab A: Report
R with Parameterrs ReportWorrX Training Manual

3. Too launch thee Parameter Browser diirectly, clickk on the Paarameter Broowser
ico
on within thhe ReportWoorX ribbon in i Excel 20007, as shownn in Figure A.15.
A
Foor Excel 20003 users, clicck on the ReeportWorX menu
m item inn the Excel menu
m
toolbar and seelect Parametter Browser..

Figure A.15 - Launching

L the Parameter Broowser Directly

4. Yoou should seee your ReccipeName annd BatchID parameters listed. Clicck on
the BatchID parameter,
p a then click the Edit button
and b to opeen the Confiigure
yo
our parametter dialog boox.

5. In
n this way yoou can changge many thinngs about yoour parameteers, includinng the
typ
pe, databasee query, etc. Since we want
w to allow w multiselecttion, we can click
dirrectly on Coonfigure Parrameter Details button..

6. Ch wn in Figure A.16,
heck the cheeck box that says Allow multiselectiion, as show
an
nd then clickk OK.

Figure A.16
A - Enabling the Multi-selecction Bit

7. Cllick OK threee times to close

c the Paraameter Brow
wser.

LA-14 ICONICS
S, Inc
ReportWo
orX Training Manual
M Lab A:
A Report with
w Parameeters

8. Fiinally, save your templaate and closee Excel. Yoou do not have
h to makee any
othher modificaations.

9. Leet’s go backk to our Un

nified Web Interface to try out this
t new typpe of
paarameter.

10. Naavigate to thhe Acmeseu

utical Reporrts folder annd select your Acmeseu utical
Pa
arameter Reeport from the
t list. Righht click it and select Exeecute Reporrt.

11. Thhis time youu should seee a slightly different foormat(a list box insteadd of a
drrop-down boox) for the BaatchID, as shown
s in Figgure A.17.

Fiigure A.17 - BattchID Parameteer with Multi-seelection Enableed

12. Ussing the Ctrrl or Shift keys,

k you are now free to
t choose ass many valuues as
yo
ou want for the BatchIID parameteer. Select at a least a few
w and then click
Ex
xecute to runn the report.

13. When
W the repport is done executing, click on thhe hyperlinkk to visualizze the
results. You should
s see a record retuurned for eacch value of BatchID
B thaat you
seelected. See Figure
F A.18 for an exammple.

Figure A.18 - Completed

C Acm
meseutical Paraameter Report

This completes
c P
Practice Labb A and thee ReportWorrX Trainingg Manual. Iff you
have any
a outstandding questionns, feel free to discuss thhem with yoour instructorr, use
the ReeportWorX Help
H files, oro email [email protected].

S, Inc
ICONICS L
LA-15
Lab A: Report with Parameters ReportWorX Training Manual

LA-16 ICONICS, Inc

ReportWorX Training Manual
 ReportWorX Training Manual

OPC Automation at your fingertips

100 Foxborough Blvd., Foxborough, MA 02035

508.543.8600 • FAX 508.543.1503 • BBS 508.543.3881
www.iconics.com • E-mail [email protected]
© 2010 ICONICS, Inc. All Rights Reserved.
Specifications subject to change without notice.