Dream Report Getting Started.pdf

8/11/2019 Dream Report Getting Started.pdf

1/29

Dream Report Getting Started Page 1/29

Dream Report Getting StartedDream Report Getting StartedDream Report Getting StartedDream Report Getting Started


2/29


Table of ContentTable of ContentTable of ContentTable of Content

1. APPLICATION INTRODUCTION ..................................................................................................................... 3

1.1WARRANTY/TRADEMARKS........................................................................................................................................ 3

1.2CUSTOMER SUPPORT ................................................................................................................................................ 3

1.3SYSTEM REQUIREMENTS.......................................................................................................................................... 3

2. INSTALLATION ........................................................................................................................................................ 4

2.1INSTALLATION ........................................................................................................................................................... 4

2.2REMOVE/MODIFY.................................................................................................................................................... 4

2.3UPGRADE FOR A NEW MAJOR OR MINOR RELEASE ................................................................................................. 4

2.4FOLDERS ORGANIZATION ........................................................................................................................................ 4

3. PRODUCT OVERVIEW .......................................................................................................................................... 5

3.1BASE CONCEPT .......................................................................................................................................................... 5

3.2KEY DIFFERENTIATION.............................................................................................................................................. 5

3.3TECHNOLOGY............................................................................................................................................................. 5

4. PRODUCT INTERFACE.......................................................................................................................................... 6

4.1DREAM REPORT STUDIO .......................................................................................................................................... 64.2DREAM REPORT RUN TIME ...................................................................................................................................... 6

4.3DYNAMIC REPORT GENERATOR ............................................................................................................................... 6

4.4DREAM REPORT WEB PORTAL ................................................................................................................................. 7

5. PROJECT WORKFLOW.......................................................................................................................................... 8

6. BUILDING A DREAM REPORT APPLICATION......................................................................................... 8

6.1STARTING PROJECT DEVELOPMENT BY LAUNCHING STUDIO................................................................................ 8

6.2USER MANAGEMENT ................................................................................................................................................. 9

6.3PHASE 1CONNECTION TO DATA SOURCES ..................................................................................................... 106.4PHASE 2DATA AND ALARM LOGGING .............................................................................................................. 11

6.5PHASE 3REPORT DESIGN.................................................................................................................................. 12

6.6PHASE 4STATISTICAL AND ANALYTICAL VALUE EXTRACTION....................................................................... 136.61 Object 1 - SINGLE Data .......................................................................................................................... 13

6.62 Object 2 - COMPOUND Data ................................................................................................................. 16

6.63 Object 3 - EXPRESSION Data ............................................................................................................... 16

6.64 Object 4 - DATA Table ............................................................................................................................. 17

6.65 Object 5 - ALARM Table .......................................................................................................................... 18

6.66 Object 6 - SQL Table ................................................................................................................................ 19

6.67 Object 7 - STEP Table.............................................................................................................................. 20

6.68 Object 8 - FREE Table.............................................................................................................................. 21

6.69 Object 9 Pie Graph ................................................................................................................................ 22

6.70 Object 10 Bar Graph ............................................................................................................................ 23

6.71 Object 11 Chart...................................................................................................................................... 24

6.72 Object 12 Date and Time ................................................................................................................... 26

6.73 Object 13 Page Number...................................................................................................................... 26

6.74 Object 14 Report Name ...................................................................................................................... 266.75 Object 15 Project Name ...................................................................................................................... 26

6.8PHASE 5REPORT GENERATION AND DISTRIBUTION SETTINGS .................................................................... 276.81 Report Generation On Schedule .......................................................................................................... 27

6.81 Report Generation On Condition ......................................................................................................... 28

6.81 Report Distribution.................................................................................................................................... 28

7. RUNNING AN APPLICATION WITH DREAM REPORT RUN TIME .............................................. 29

7.1LAUNCHING DREAM REPORT RUN TIME ............................................................................................................... 29

7.2REPORT ON DEMAND .............................................................................................................................................. 29


3/29


1. Application Introduction

This software program is an advanced Enterprise Information Integration (E.I.I) and Proactive Reportingsystem used as an applications development tool that enables any company to log Data and Alarms frommultiple data sources, connect to most historian databases to create, generate and distribute advancedreports for a variety of industries.

1.1 Warranty/Trademarks

This document is for information only and is subject to change without prior notice. It does not represent acommitment on the part of Ocean Data Systems. If you find any problems in the documentation, pleasereport them in writing. Ocean Data Systems does not warrant that this documentation is error-free. Copyright 2004-2006 by Ocean Data Systems.

Dream Report and Dream Connect are trademarks of Ocean Data Systems. All other products and brandnames are trademarks of their respective companies.

1.2 Customer Support

You can receive technical support from your local distributor. To receive prompt support, make sure thatyou complete the activation form available from Dream Report Studio and send it to Ocean Data Systemsat [email protected]

1.3 System Requirements

Before you install the application verify that you have the following Hardware:

Computer: Minimum Pentium III 1Ghz Memory: 256MB (recommended 512MB) Hard Disk: 150MB minimum for installation only

Operating systems supported:

Windows 2000 workstation,

Windows 2000 Server, Windows XP Professional Edition,

Windows 2003 Server

Additional Software Requirements:

To visualize PDF files - you have to install Adobe Acrobat Reader

To use Web Portal - you have to install Web Server (Internet Information Server)


4/29


2. Installation

2.1 Installation

Please launch executable file named DR_Release_Setup x.y.z.exe, and read carefully the End UserLicense Agreement.

Dream Report has two types of install:1. Complete By selecting this option setup will install all components available in Dream Report.2. Custom By selecting this option user will get a Components Dialog where will be possible to

select only components that user would like to install for his needs

Note: Please be aware that in case and SQLserver is installed on current computer theUtility component will be hidden and SQLMSDE wont be installed.

User has possibility to specify path where hewould like to install Dream Report in hiscomputer but we recommend keeping default

path

When finished user will be asked to restartcomputer for the reason that some componentshave to be registered on start-up of OS:

2.2 Remove / Modify

It is possible to Modify or to Remove Dream Report from client computer by either:1. Launching original installation executable.2. Or, In Control Panel of Windows OS from Add/Remove programs component.

Be aware that not all folders will be removed during uninstall process. Directory thats includes alldeveloped on that computer project will remain. Also License and Template directories will not be erased.

2.3 Upgrade for a new major or minor release

In Dream Report installer procedure auto upgrade feature is activated. It will automatically recognize theversion previously installed and start upgrade. During this process all new files will be copied to theappropriate place.

2.4 Folders Organization

By default the program install the program at: C:\Program Files\ODS\Dream Report

And installs the following folders

Clipart: Library of Reports Backgrounds and ImagesDatabase: Multilanguage file (lexicon.mdb)DR_Web_Portal: For all web configuration filesHelp: With the web on line help filesLicense: Where your product license and registration form will be savedProject: Where all project by default will be savedRelease Notes: With all latest information about new release

Systems: With all system application FilesTemplates: Where all templates will be savedUtilities: Some utilities


5/29


3. Product Overview

3.1 Base concept

Dream Report concept is based on the integration of 5 functions. This unique combination positions it asthe best proactive reporting solution available in the market.

3.2 Key differentiation

Dream Report is a unique solution for 3 main reasons.1. It includes a communication kernel like any manufacturing systems (HMI, SCADA, DCS systems)2. It enables to Log data and alarms on any standard database3. It generates and distributes report in real time through its unique and powerful Run Time.

The integration of this unique functions into a user friendly studio, position Dream Report as the firstcomplete reporting solution available in the market today, very intuitive and easy to use.

In fact Dream Report is the first reporting solution that can run on a standalone mode, collecting andlogging Data itself, or be connected to any systems and leverages their historian database.

One day training is enough to learn completely the product, this perfect integration brings to customers aunique advantage, they can forget complex solutions based on the integration of multiple modules and

competences. Thus, the product adoption is fast, minimal support is needed to be fully autonomous.

3.3 Technology

Dream Report was developed with the latest technology standard. It can exchange Data usingAutomation and Enterprise technology such as OPC, Xml and Soap. Dream Report Logger enables to logclean and accurate Data on any standard Database such as SQL server, Oracle, Access, My SQL and more.Dream Report generates Reports in PDF format but can also export all Data into an Excel file.


6/29


4. Product Interface

The product is divided in 2 modules called the Dream Report Studio and the Run Time.Basically project must be developed with the Studio, and executed launching the Run Time.

4.1 Dream Report Studio

Dream Report Studio enables to define and configure:

Connection to real Data sources

Connection to any historical Database

The archive conditions for real time data & alarms Create, modify report templates All statistical and analytical objects Define report generation conditions Define report distribution

Project settings (user management, language, web,macros, database )

4.2 Dream Report Run Time

The Run Time enables to execute and manage:

The access rights The data and alarm acquisition The data and alarm logging

The queries to all historian databases The report generation The report distribution The web Portal

Moreover, for the day to day report management ODS as developed the Dynamic ReportGeneratorModuleandDream Report Web Portal.

4.3 Dynamic Report Generator

Dynamic report generator (DRG) enables to change report settings and execute new report on demandwithout opening and making any change from the Studio.

This module is ideal to control and drive new report generation from anyapplication (HMI, SCADA, DCS, MS Office, Windows ). It is available asan ActiveX, a Java applet and an exe application.

From any report available, the user can:

1. Either change the report period and force all objects in thetemplate with this new interval (for example template was madefor a daily report and he wants a weekly report)

2. Or force the CPU time, in this case objects setting doesntchange, DRG will generate new report not base with the currentdate and time but the new date and time selected.

Finally users can also dynamically change Data source and Tags assignin the template selected using the mask.

Dream Report Studio

Dream Report Run Time


7/29


4.4 Dream Report Web Portal

With Dream Report Web Portal any authorized user can access over the intranet or the internet to anyDream Report Station to:

Visualize all report archived

Generate new reports on Demand

Change report setting before generation

Dream Report Web Portal is ideal for distributing reports across the enterprise but also to customers,organizations, suppliers and more. It can be customized and fully integrated within any customer webportal

To access to Dream Report Web Portal the user must log withhis name and password.

Then he visualizes the list of his authorized reports with thedate and time of the last generation, the number of report inthe history.

The portal will be automatically updated, each time the RunTime will generate new report. The user can also force the RunTime and ask for new report on demand.

When he selects one the report in the list, he switchesautomatically to the report summary.

Dream Report Web Portal displays the latest reportgenerated, but the user visualizes the list of history reportand displays any, by clicking on its icon.

Then, users are free to add comments, print or email thereport displayed.


8/29


9/29


Then Studio opens. To facilitate product project development, the studio is divided in 2 sections named theLoggerand the Designer.

To configure data sources connection and data logging (Phase 1 and 2) you must display the LoggerStudio. To design reports and define their properties (phase 3, 4 and 5) you must switch to the DesignerStudio.

The navigation between the 2 sections isdone in the left side of the studio throughthe buttons:

Logger Studio Report Designer Studio

This navigation methodology was not only done to facilitate project development, but also to protect theconfiguration of the communication and the database. Frequently System Integrators and projectEngineers prepare all data needed to develop reports and give access rights to different kind of End Users(management, finance, production ) to create their own reports without any risk to alter the data pipe.

6.2 User Management

From The project setting, tab general, you can open the user management windows.

There is no limitation in terms of users.

You simply must define Name andPassword and the rights for each user.

- Designer Studio -Enables user to define or modify reports

- LoggerStudio -Enables user to define or modify driverconfiguration and logging properties

- Run Time -Enables user to control the Run Time

- Web Portal -Those users will have access to reportsover Dream Report web Portal

- User definition -Enables user to define or modify Userauthorization

Please note that each user can be frozentemporary and can expire on a predefine date. It is also possible to load Studio with a different languagefor each user.

Logger Studio Designer Studio


10/29


6.3 Phase 1 Connection to Data Sources

To connect data sources you must define drivers

Then The Driver configuration Wizard appears

Dream Report supports 3 types of drivers

Real Time Data Real Time Alarms

History (using ODBC, HDA or customdriver access)

Native drivers to SCADA systems for example

support all 3 drivers. This means that you canaccess to their Data and Alarm in real Time butalso read their native History.

Dream Report integrates OPC DA, AE and HDA Client. It means that any OPC Server can connect andexchange data, alarms and history with it.Thats the reason why Dream Report can be directly connected to most Devices, I/Os, PLC, Fieldbuses,Manufacturing Systems and other open application.

Connection example with and access History databaseSuppose you have an access database to connect to Dream Report, its structure is columns based andhas multiple tables.

1. First step is to create the DSN using Microsoft ODBC driver to connect data source, we call it

Process2. Then in the Dream Report Driver Configuration you declare a new data source named Process also3. You select History Driver ODBC

4. you click on Configure and the followingWizard appears

5. You select the DSN previously created6. You define the database structure (column

in this case)7. You click on the ConnectButton, and you

will see all tables for this database

Then because Dream Report supports predefineData and alarms objects, you simply must indicateby tables:

1. The field used for the Timestamp if you

want to extract data Only

2. The Fields used for the alarm ID, Text,Priority, Start time, End time and Acktime.

Thus, your database will be fully available in eachDream Report Objects.

Dont forget to click on Done to close this Wizardand to add and save this driver to your list.


11/29


12/29


6.5 Phase 3 Report Design

Once all real time data source are connected and databases connectivity ready, you can shift to theDesigner Studio. To create new report right click in the list of reports and select New Report.

Designer Studio was build to be used by

any operator.

Report can be made with multiple pages.The following icons are the most used tocreate nice reports

Add Page

Insert Text

Insert Picture / Logo

Insert background

Background can either be a color, or an image. If its an image, this image can be applied to all pages orto a specific page only.

Regarding Colors, Dream Report Designer Studio enables you to select colorfor fonts, line and background.

The product also manages the transparent color but also enables to define yourown palette.

Page Template / Report templateAny Report can be saved as a page or a report template to be loaded anytime to create new reports fast.

When you save as a Page Template, the system only captures the static objects like Text, Forms, Images,Background and also the base Object Date & Time, Report Name, Project Name and Page Number.

When you save a Report Template it captures the entire report with all Objects attached like Pie, Bar,Charts, Tableswith their base configuration (data source, tags and time settings).


13/29


6.6 Phase 4 Statistical and Analytical Value Extraction

The following toolbar enables to extract data analysis with different object views.

Objects can be divided by categories.

The first 3 objects enable to extract Data analysis and represent it as a text Result

6.61 Object 1 - SINGLE Data

A. Definition

In the definition tab of the Wizard you select any tags

coming either from Dream Report History or from anynative historian Database to extract from any relativeand/or absolute period:

The Current value

The Last value

The Maximum value

The Minimum value

The Sum value

The Integral value

The Average value

The Weighted Average

It also enables to know the:

The timestamp of the First value

The timestamp of the Last value

The timestamp of the Maximum value

The timestamp of the Minimum value

It calculates directly:

The System availability (i)

The Standard Deviation (i)

Moreover it offers you to count

The number of value logged in the Database (i)

The number of alarms for an interval of priorities (i)

The duration between any value interval (i)

To define your own counter with min-max limits (i)

On OFF ON/OFF (i)

And finally enables to directly insert any SQL command (i)

(i): detail explanation just below

Know More about:

System availability: Gives you in % the time during the value was notequal to 0 for the period selected

In this example the system availability was 75 %for 1hour

Standard deviation: Calculates

Text Objects


14/29


Number of value loggedin the database:

Count of much value are logged for the valuerange specified

In this example if we count values between 100and 200, result will be 2

Duration Calculates the Duration time in HH:MM:SS for thevalue Range specified.

In this example:The Up time (1 to 1) is 00:45:00The Down Time (0 to 0) is 00:15:00

ON - OFF Counter Calculates how many times the digital tag wentfrom 0 to 1 (ON) or 1 to 0 (OFF)

In this example: there is 3 ON and 2 OFF

ON/OFF Counter Calculates a complete On OFF Wave

In this example there is 2 complete ON/OFF waves

Counter ???

Alarm Counter Count how many alarms are in the priority range specifiedDo not forget to define alarm filters first

To create Filters you simply must: Give a name Select the alarm data source Define the priority range Add it as a new Filter

Then select the Group of alarms youwant to count and click OK.

SQL Command You can also directly define a SQL command


15/29


B. Representation

In the second tab of the wizard

You can select the following option: Visible / Invisible: to display or not the analytical

Data in report

Unit: the Unit selected will be automatically displayedwith the result

The decimal Precisionis configurable between 0 to 6digits

The write backoption enables to write the analyticalItem result of on any tag from any source connected

The advanced displayoptions enables:A - To change numeric color (do not put text) Example:

0 to 10 -> Blue11 to 90 -> Green91 to 100 -> Red

B - To replace numeric by Text; Example0 To 0: Stop1 To 1: Run

C. Advanced SQL Condition

Its a where command that enables to add a specific condition to adjust the query.For example: I want the Minimum Tank Value for January but only when Batch process was equal to 4

I will select the Tank level Tag Insert period from Jan 1 to Jan 31 Put a Where command : when Batch= 4


16/29


6.62 Object 2 - COMPOUND Data

Definition

Captures all previous analytics made and enables after

manual selection (using SHIFT and CTRL KEY and Mouse) tocalculates between them:

The maximum The Minimum The Sum The Average

Objective is to enable fast calculation without doing anyexpression.

6.63 Object 3 - EXPRESSION Data

Definition

Enables to build any expression using standard instruction

Mathematic Boolean

Trigonometric

User can mix Analytical Values and Tag from Data Sources.


17/29


The next 5 Objects enables to display series of tags and alarms into tables

6.64 Object 4 - DATA Table

A - Definition

Example 2

This table enables to display a list of Tag Values.In the definition tab you select one or more tags (clickon Edit List) either from Dream Report History orfrom any External historian Database.

You can choose to display from any relative and/orabsolute time period:

The Data logged in the database The Moving Average values

A filter based on the value range and the AdvancedSQL condition tab, will help you to adjust your tablequery and visualize precisely the right information.

Example 1

B- Appearance

In the appearance options, you can define The table name Set which column you want to display

(timestamp, source name, tag name, value) Customize the title of each column ( click on

caption text) Change all font properties Set how many records you want to visualize Sort from end or from start

Table Objects


18/29


6.65 Object 5 - ALARM Table

A - Definition

Its a predefine object that enables to extract alarms either

from Dream Report Historyor from any native historianDatabase

User must create first alarm filters (click on Edit List) andselect the ones you want to visualize in table

To select multiple filters you must use CTRL Key

Then select the time period

B- Appearance

In the appearance options, you can define The table name Set which column you want to display (Start

time, ack time, end time, alarm text andpriority) and how (move Up, Down)

Customize the title of each column ( click oncaption text, and change text as wanted)

Change all font properties Set how many records you want to visualize Sort from end or from start

Alarm Table example


19/29


20/29


6.67 Object 7 - STEP Table

A - Definition

This table was especially developed to check periodicallystatistical value coming from moving tags typically occurringin the automation Market.

First step is to build the table structure Define number of columns The time period Define the step (from minutes to Moths)

Be careful you must adjust the time period to the step,otherwise you can seriously damage performance.

Ex: never select days in period if you want minutes as stepYou will create thousands of calculation

STEP table example 1

B- Appearance

The key thing in the appearance is to assign for each

column defined, the statistical value.

This is done through the last column in the right sidenamed Column Type

You can put the timestamp or a tagIf you select tag, you will open the single data objectwith all statistical values available:

Last value

Maximum value

Minimum value

Sum value

Integral value

Average value

Weighted Average

Duration Counters

STEP table example 2


21/29


22/29


The next 3 Objects are graphical objects; they enable to display statistical value with different views

6.69 Object 9 Pie Graph

A- Definition

From the Pie Wizard you can define Pies of: Data values Alarms Logged values

Data are either from Dream Report History or from anynative historian Database.

a/ If you define a Pie ofData values then you cancompare between multipletags.

Last value Maximum value Minimum value Average value

b/ If you define a Pie of Alarms, means that you want tocompare alarms from different groups

c/ If you define a Pie of Logged values, means that you wantto compare logged values for different value range.

B - Appearance

In the appearance options, you can define the Pie nameand Display:

Pie legend Pie borders Values with or without units The percentage between slices Change all font properties

C - Advanced SQL Condition

Its a where command that enables to add a specificcondition to adjust the Pie query.For example: I want to compare the average productionbye production lines when Batch process was equal to 4.

Put a Where command : when Batch= 4

Graphical Objects

Pie example


23/29


6.70 Object 10 Bar Graph

A- Definition

Bar Graph enables to cut a period into several segments to visualize and compare the content ofeach (example: cut a week in days and compare each day of the week)

Like in Pie chart, Bar chart enables to define Bars of:

Data values Alarms Logged values

Data are either from Dream Report History or from any

native historian Database.

a/ If you define a Bar of Data values then you can comparefor each segment:

Last value Maximum value

Minimum value Average value

b/ If you define a Bar of Alarms, means that you want to

compare alarms groups for each period

c/ If you define a Bar of Logged values, means that you wantto know of much values were logged for each period

B - Appearance

In the appearance options, you can define the Pie nameand Display:

Pie legend X,Y Scales Values

You can also define Grid, date and time format, Bar Typeand of course define font properties

C - Advanced SQL Condition

Its a where command that enables to add a specificcondition to adjust the Bar query.For example: I want to measure the machine Downtimeper day when user is Jim.

Put a Where command : when user='Jim'


24/29


6.71 Object 11 Chart

A- Definition

Chart Object enables to visualize multiple tags in one chart. Data are either from Dream ReportHistoryor from any native historian Database.

ValuesUser can either displayed a chart based on:

The values logged in the database The moving average values for each tags

Graph Style

User can select to visualize Line with mark chart (by default) Line only Mark only

ScaleUser can display scale for each tag on uncheck the scalethey dont need.Each Tag is displayed according its own scale, but user canselect another scale as the scale reference.

B - Appearance

In the appearance options, you can define the Chartname and Display:

Pie legend X,Y Scales

You can also defineGrid, date and time format and the font properties

Chart Type

User can select if he wants a value or time based chart


25/29


Chart Window option

Enable to adjust the chart either to the period selected or to the data logged

In this example the chart configuration was define for a time period between A and B, but there is onlydata between A and B.

If you select chart fit to time period then you will see the chart for the entire period (A,B)If you select chart fit to data, the chart will be automatically adjusted (A,B)

F. C - Advanced SQL Condition

Its a where command that enables to add a specific condition to adjust the chart query.For example: I want to visualize only the chart for the batch 39

Put a Where command : when batch = 39 In the chart window option we adjust the chart to the data

Then the chart STARTS and is adjusted exactly when the batch starts and END also when the batch ends


26/29


6.72 Object 12 Date and Time

A- Definition

Enables to display the month, the week, the day, the day ofthe week, the hour, the minutes and of course the complete

date and time in different format

Date: dd/mm/yyyy or dd/mm/yyor

mm/dd/yyyy or mm/dd/yy

Time hh:mn:ss hh:mn

displaying hours either from 0 to 24 or 0 to 12 AM / PM

6.73 Object 13 Page Number

A- Definition

Enables to display the current page number

6.74 Object 14 Report Name

A- Definition

Enables to display the report name

6.75 Object 15 Project Name

A- Definition

Enables to display the project name

Example


27/29


28/29


29/29

7. Running an Application with Dream Report Run Time

7.1 Launching Dream Report Run Time

This icon will launch Dream Report Run Time; you can also launch it from Dream Report Studio,main menu, Run Time.

Application projects are saved with the suffix *.drt

When Run Time is launched, it starts several tasks:

It initiates and launches data acquisition It starts the logger and logs data and alarms in the selected database (SQL server by default) It loads all reports define in project and captures the settings for generation and distribution It launch the web server (IIS by default)

From the user interface you can: Activate or disable report generation Visualize the status of each report

Pressing Changebutton enables to load projectPressing Reload Projectbutton enables to reload the ongoing project with last updatesPressing Hidebutton willkeep the project running and minimize window to the system tray.

Pressing Exitbutton will close the current running project, close window and close the entire application.

Pressing Open report filebutton enables to open the last report generated.

7.2 Report on Demand

To generate report on demand, please select manually the report and then click on Generatebutton. Newreport will be immediately generated, saved and distributed according to its settings.

Documents

Dream Report Getting Started.pdf