0% found this document useful (0 votes)
10 views78 pages

Archive Data Reader Guide

Uploaded by

rcintas
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
0% found this document useful (0 votes)
10 views78 pages

Archive Data Reader Guide

Uploaded by

rcintas
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
You are on page 1/ 78

Archive Data Reader User Guide

Page 2 of 78

LKZ:DE AL:N ECCN:4E992

Table of Contents

Archive Data Reader User Guide .......................................................................................................... 1

Table of Contents ................................................................................................................................... 2

1 Welcome to the Archive Data Reader User Guide ........................................................................... 4

2 Documentation Guide ......................................................................................................................... 6

2.1 Documentation Windows ................................................................................................................ 7


2.1.1 Navigation Frame ........................................................................................................................... 8
2.1.2 Content Frame ................................................................................................................................ 9

2.2 Documentation Features ................................................................................................................. 10


2.2.1 Fonts and their Meanings ............................................................................................................... 11
2.2.2 Icons and their Meanings ............................................................................................................... 12

2.3 HTML Help Search ........................................................................................................................... 14

3 Archive Data Reader ........................................................................................................................... 16

3.1 Starting the Program ....................................................................................................................... 18

3.2 Exiting the Program ......................................................................................................................... 19

3.3 Exporting using the GUI Mode ....................................................................................................... 20


3.3.1 General Layout ............................................................................................................................... 21
3.3.1.1 Saving Export Settings ................................................................................................................. 23
3.3.1.2 Loading Export Settings ............................................................................................................... 24
3.3.1.3 Resetting Export Settings ............................................................................................................. 25
3.3.1.4 Editing XML File ........................................................................................................................... 26
3.3.2 Exporting the Archive Data ............................................................................................................. 27
3.3.2.1 Using the Input Tab ...................................................................................................................... 28
3.3.2.1.1 Selecting an IDB File ................................................................................................................ 29
3.3.2.1.2 Applying Filters ......................................................................................................................... 31
3.3.2.1.3 Selecting the Tags .................................................................................................................... 32
3.3.2.1.4 Editing the Tags ........................................................................................................................ 34
3.3.2.2 Using the Output Tab ................................................................................................................... 37
3.3.2.2.1 Setting the Time Period ............................................................................................................ 38

Copyright © 2012 Siemens AG. All Rights Date: 2013_08_26 Version: !ADR71_ArchiveTool!

Reserved _en_2013_08_26_08_54
Page 3 of 78

LKZ:DE AL:N ECCN:4E992

3.3.2.2.2 Selecting the Output File .......................................................................................................... 41


3.3.2.2.3 Selecting the Output Format ..................................................................................................... 42
3.3.2.2.4 Selecting the Export Columns .................................................................................................. 43
3.3.2.2.4.1 Interpreting the Export Columns ............................................................................................ 46
3.3.3 Exporting the Engineering Log ....................................................................................................... 53

3.4 Exporting using the Batch Mode .................................................................................................... 55

3.5 Structure of the Output File ............................................................................................................ 60


3.5.1 CSV Output File Structure .............................................................................................................. 61
3.5.2 HDF5 Output File Structure ............................................................................................................ 62

3.6 Special Events in the Output File ................................................................................................... 64

3.7 Important Files ................................................................................................................................. 65


3.7.1 Export Setting File .......................................................................................................................... 66
3.7.2 Configuration File ........................................................................................................................... 68
3.7.3 Log File ........................................................................................................................................... 72
3.7.4 Log4j Configuration File .................................................................................................................. 73

4 Glossary ............................................................................................................................................... 74

Copyright © 2012 Siemens AG. All Rights Date: 2013_08_26 Version: !ADR71_ArchiveTool!

Reserved _en_2013_08_26_08_54
Page 4 of 78

LKZ:DE AL:N ECCN:4E992

1 Welcome to the Archive Data Reader User Guide

Documentation Version

!ADR71_ArchiveTool!_en_2013_08_26_08_54

Publication

2013_08_26

System Version

This documentation is valid from the following system version: 07.1.09.00

Copyright © 2012 Siemens AG. All Rights Date: 2013_08_26 Version: !ADR71_ArchiveTool!

Reserved _en_2013_08_26_08_54
Page 5 of 78

LKZ:DE AL:N ECCN:4E992

Copyrights and Trademarks

The reproduction, transmission or use of this documentation is not permitted without express
written authority. Offenders will be liable for damages. All rights, including rights created by
patent grant, copyright or registration of a utility model or design, are reserved.

Copyright © 2012 Siemens AG. All Rights Reserved

Siemens Power Plant Automation (SPPA) is a trademark of Siemens AG.

Windows 2000, Windows 2000 Server, Windows 2003 Server, Windows XP, Windows 7 and
Internet Explorer are trademarks of Microsoft Corporation.

The following products are used in the SPPA-T3000 system, and may be referred to in this
documentation:

JCalendar © 1999-2006 Kai Toedter. http://www.toedter.com/en/jcalendar/


Log4j © 2007 The Apache Software Foundation. http://www.apache.org/licenses/
LICENSE-2.0.html
How to cite HDF5? The HDF5 Group. Hierarchical data format version 5, 2000-2010. http://
www.Hdfgroup.org/HDF5

Notice

The contents of this documentation has been checked for accuracy regarding the hardware
and software described herein. Since deviations cannot be precluded entirely, we cannot
fully guarantee accuracy. The data in this documentation is, however, regularly reviewed,
and any necessary corrections are included in subsequent editions. Suggestions for
improvement are welcomed.

Technical data is subject to change.

This documentation has been compiled independently from any specific system delivery. The
documentation may describe features or functionality which do not necessarily correspond
to, or appear in a specific system delivery. Delivered systems may also contain features or
functionality which are not described in the documentation.

The reference language of this documentation is English.

Export Control Classification

Appears on each description.

Copyright © 2012 Siemens AG. All Rights Date: 2013_08_26 Version: !ADR71_ArchiveTool!

Reserved _en_2013_08_26_08_54
Page 6 of 78

LKZ:DE AL:N ECCN:4E992

2 Documentation Guide

The general structure and characteristics of Archive documentation are described in the
Documentation Guide.

General Items

The purpose of the User Guide is to describe each topic within Archive once and only once.
The use of text links enable subsequent references to the original topic.

To find information within the User Guide, the user is supported by a Table of Contents and
a Full Text Search. A Glossary is used to explain terminology and acronyms.

The Appearance of the Documentation

The on-screen version of Archive documentation has the HTML Help appearance, readable
with a standard Web Browser.

The Structure of the Documentation

The Archive documentation includes the following sections:

• Documentation Guide (i.e. this section).


• Archive
• Glossary

As all the descriptions are contained in the same documentation set, the user can easily
switch between the different sections.

Copyright © 2012 Siemens AG. All Rights Date: 2013_08_26 Version: !ADR71_ArchiveTool!

Reserved _en_2013_08_26_08_54
Page 7 of 78

LKZ:DE AL:N ECCN:4E992

2.1 Documentation Windows

The on-screen documentation is presented in a window divided into two Frames:

• Navigation Frame:
The Navigation Frame contains the Table of Contents displayed as a topic tree and
the Full Text Search.
• Content Frame:
The Content Frame displays the selected topic of the Archive User Guide. Scrolling
within the Content Frame is supported.

Copyright © 2012 Siemens AG. All Rights Date: 2013_08_26 Version: !ADR71_ArchiveTool!

Reserved _en_2013_08_26_08_54
Page 8 of 78

LKZ:DE AL:N ECCN:4E992

2.1.1 Navigation Frame

The Navigation Frame offers the ability to find and select information within the Archive User
Guide. The Table of Contents can be expanded or collapsed to navigate through the
documentation.

Table of Contents

In the Table of Contents all topics of the documentation are listed. To view subtopics, click
the plus sign next to a topic. The topic will be expanded to show the subtopics it contains. To
view the contents, click on the topic. When navigating in the Content Frame via text links, the
associated position is highlighted in the Table of Contents.

Copyright © 2012 Siemens AG. All Rights Date: 2013_08_26 Version: !ADR71_ArchiveTool!

Reserved _en_2013_08_26_08_54
Page 9 of 78

LKZ:DE AL:N ECCN:4E992

2.1.2 Content Frame

The Content Frame contains the topics of the Archive User Guide. The topic descriptions
combine text, tables, and pictures to provide the user information as to how to work with
Archive.

The Typography of the text gives additional hints to special meanings (Fonts and their
Meaning).

The information on Archive subjects is presented in specific topic description. Every topic
describes a single subject and each subject is described only once.

Some graphics such as screenshots may be quite large and may sometimes interfere with
the readability of the document. To avoid this, these graphics are provided as thumbnails

which can be opened to their original size by clicking on them.

Copyright © 2012 Siemens AG. All Rights Date: 2013_08_26 Version: !ADR71_ArchiveTool!

Reserved _en_2013_08_26_08_54
Page 10 of 78

LKZ:DE AL:N ECCN:4E992

2.2 Documentation Features

Additional guiding information is given in the text using:

• specific Typography of distinguished Fonts.


• Icons with standardized meaning.

Copyright © 2012 Siemens AG. All Rights Date: 2013_08_26 Version: !ADR71_ArchiveTool!

Reserved _en_2013_08_26_08_54
Page 11 of 78

LKZ:DE AL:N ECCN:4E992

2.2.1 Fonts and their Meanings

The different fonts give additional information when reading the User Guide. Additional
attributes and meanings are given to the text using specific fonts. The following is a list of
fonts used within the User Guide and their meanings:

• Proportional Regular Font


○ Normal text
• Proportional Regular Font Bold
○ Names of menus
○ Buttons on the keyboard
• Proportional Italic Font
○ Path names
○ Host names
○ URL
• Non Proportional Font
○ Code examples
• Non Proportional Font Bold
○ User inputs
○ Code parts inside of code examples, regarding to
explanations in the text
• Non Proportional Font Italic
○ Parts inside of code examples to be replaced by the user
• Colored Proportional Regular Font (Green)
○ Denotes a glossary term. An explanation window for the term appears when
the cursor is held over the text.
• Underlined Colored Proportional Regular Font
○ Used in on-screen documentation as a Link button

Copyright © 2012 Siemens AG. All Rights Date: 2013_08_26 Version: !ADR71_ArchiveTool!

Reserved _en_2013_08_26_08_54
Page 12 of 78

LKZ:DE AL:N ECCN:4E992

2.2.2 Icons and their Meanings

Icons provide an eye-catcher to special information and warnings that the user should take
notice of.

Warning

A Warning indicates a situation where failure


to take or avoid a specified action could
cause bodily harm or loss of life.
Caution

A Caution indicates a situation where failure


to take or avoid a specified action could
damage a hardware device, program,
system, or data.
Note

A Note provides important information


concerning the operation.
Check

The user should Check their current action.


Tip

A specific Tip as to how to work more


efficiently or to provide an alternative
approach to an action.
ESD

The component is an Electrostatically


Sensitive Device (ESD). The rules of the
Safety Instructions for ESDs must be obeyed.
Status

The system Status prior to, or after a


sequence of actions.
Previous Page

Clicking this icon opens the Previous Page.


Next Page

Clicking this icon opens the Next Page.

Copyright © 2012 Siemens AG. All Rights Date: 2013_08_26 Version: !ADR71_ArchiveTool!

Reserved _en_2013_08_26_08_54
Page 13 of 78

LKZ:DE AL:N ECCN:4E992

Thumbnail Clicking a thumbnail will return the picture to its original size.

Copyright © 2012 Siemens AG. All Rights Date: 2013_08_26 Version: !ADR71_ArchiveTool!

Reserved _en_2013_08_26_08_54
Page 14 of 78

LKZ:DE AL:N ECCN:4E992

2.3 HTML Help Search

The HTML Help search is used to perform a full text search of the help topics. The full text of
the User Guide can be searched for specific words. After typing in the word, or group of
words, click on the search button. The topics which contain the search word will be listed. To
view the contents click on the topic.

One or more search terms can be combined using the and or or operator.

If searching for multiple words, the and operator can be selected for locating documents
containing all the search words. These terms do not need to be in the specific search order
to appear as a result:

If or operator is selected then all documents containing any of the search words will be
located. The or searches are sorted by search word:

Copyright © 2012 Siemens AG. All Rights Date: 2013_08_26 Version: !ADR71_ArchiveTool!

Reserved _en_2013_08_26_08_54
Page 15 of 78

LKZ:DE AL:N ECCN:4E992

The results are displayed in the Navigation Frame.

The order of the search results do not necessarily correspond to the order in which
the topics appear in the Table of Contents.

To determine the exact location of the search result, select it from the list (so that
the topic appears in the Content Frame) and then switch to the Table of Contents
in the Navigation Frame. The position of the topic is highlighted.

Copyright © 2012 Siemens AG. All Rights Date: 2013_08_26 Version: !ADR71_ArchiveTool!

Reserved _en_2013_08_26_08_54
Page 16 of 78

LKZ:DE AL:N ECCN:4E992

3 Archive Data Reader

The SPPA-T3000 archive provides mass storage and retrieval of process data. Archived
data is stored on the local hard disk of SPPA-T3000 Application Server in hourly and daily
files.

The fundamental unit of storage is called an event. Initially events are collected in hourly
files. At the end of the day, a daily file is created which contains all events of the day in a
compressed format. As the time progresses, the archived data accumulates on the hard disk
of SPPA-T3000 Application Server, and eventually has to be transferred, and stored for long-
term archiving on separate media such as DVDs or a NAS device.

The Archive Data Reader is a standalone program which is used to read the swapped out
SPPA-T3000 archive data (*.IDB files). Using this program, the complete archive data or only
the engineering logs can be viewed offine i.e. without being logged into SPPA-T3000 system.

The program performs the following functions:

1. Validates the input criteria given by the user.


2. Extracts the data from the Daily files (*.IDB) for the given input criteria.
3. Exports this data to an output file with a CSV or HDF5 file format.

The export can be made on any computer where Archive Data Reader program and the
swapped out archive data is available.

Copyright © 2012 Siemens AG. All Rights Date: 2013_08_26 Version: !ADR71_ArchiveTool!

Reserved _en_2013_08_26_08_54
Page 17 of 78

LKZ:DE AL:N ECCN:4E992

Locating the Archive Data Reader Program

Archive Data Reader program is available at a number of places.

On SPPA-T3000 Application Server

Archive Data Reader program is located at the following location on the Application Server:
\SPPA-T3000\Orion\software\util\ArchiveTools\ArchiveDataReader

On DVD

The program is copied onto the DVD during the swapping out of archive data from SPPA-
T3000 Application Server. It is available in the ArchiveDataReader folder of DVD.

The license SPPA-T3000 Copy Export Archive Data to DVD is required


on SPPA-T3000 Application Server for the program to be copied along with the
archive data.

On NAS

The program has to be manually copied by administrator on NAS from SPPA-T3000


Application Server.

Contents of ArchiveDataReader Folder

The ArchiveDataReader folder contains the following subfolders:

• bin: It contains the batch file for starting the program.


• config: It contains an XML configuration file containing the basic settings of the
program. It also contains a log4j configuration file containing the information such as
maximum log file size and count of the log files.
• doc: It contains the user manual for the program in PDF and HTML formats.
To view the user guide in HTML format, double click on the Start.exe file in the
Helpbook folder. The HTML user guide will then open in a web browser on the
computer.
• lib: It contains all the necessary *.jar files.
• logging: It contains the log files that are written for the program. By default, this
folder is empty.

Copyright © 2012 Siemens AG. All Rights Date: 2013_08_26 Version: !ADR71_ArchiveTool!

Reserved _en_2013_08_26_08_54
Page 18 of 78

LKZ:DE AL:N ECCN:4E992

3.1 Starting the Program

Archive Data Reader program can be started using a *.bat file available in the
ArchiveDataReader folder.

The program can be run in GUI mode or in batch mode.

Pre-conditions

Following pre-conditions must be satisfied to start the program:

• An installed 32 Bit Java Runtime Environment Release 1.6 or greater on the


computer where the program is being run. The 32 Bit Java must also be set in the
environment variable Path.
• In case the program has to be run on NAS, it must be already copied there.

In GUI Mode

To start Archive Data Reader program in GUI mode, proceed as follows:

1. Find the ArchiveDataReader.bat file on the DVD or NAS. It is located in the


following directory: ArchiveDataReader\bin
2. Double click on ArchiveDataReader.bat file.

Archive Data Reader program starts in GUI mode with opened Input tab.

A log file is automatically created when the program is started in GUI mode.

Alternatively, open the command prompt and execute the command


ArchiveDataReader.bat to start the program in GUI mode.

In Batch Mode

To start Archive Data Reader program in batch mode, proceed as follows:

• Open the command prompt and execute:


ArchiveDataReader.bat -b=<Export setting file>
where <Export setting file> = whole path of the export setting file.

Archive Data Reader program starts in batch mode. It uses the settings as defined in export
setting file.

A log file is automatically created when the program is started in batch mode.

Copyright © 2012 Siemens AG. All Rights Date: 2013_08_26 Version: !ADR71_ArchiveTool!

Reserved _en_2013_08_26_08_54
Page 19 of 78

LKZ:DE AL:N ECCN:4E992

3.2 Exiting the Program

To exit the Archive Data Reader program in GUI mode, proceed as follows:

The Archive Data Reader window is open.

1. Select the File menu, then Exit from the drop down menu.

Alternatively the Archive Data Reader program can be closed by the standard
window close button.

Copyright © 2012 Siemens AG. All Rights Date: 2013_08_26 Version: !ADR71_ArchiveTool!

Reserved _en_2013_08_26_08_54
Page 20 of 78

LKZ:DE AL:N ECCN:4E992

3.3 Exporting using the GUI Mode

The export of archive data and engineering log data in the GUI mode of Archive Data Reader
program is described in this section.

Copyright © 2012 Siemens AG. All Rights Date: 2013_08_26 Version: !ADR71_ArchiveTool!

Reserved _en_2013_08_26_08_54
Page 21 of 78

LKZ:DE AL:N ECCN:4E992

3.3.1 General Layout

Archive Data Reader program has the following layout:

The menu bar has three menus:

• A File menu with further drop down menus for:


○ Saving, loading and resetting the export settings.
○ Editing the XML files.
○ Exit menu which closes the Archive Data Reader program.
• A Data menu that provides the following export functions:
provides Archive Data and Engineering Log export functions.
○ Archive Data: The Archive Data view consists of Input and Output tabs.
These tabs contain the options to specify the export parameters for exporting
the archive data.
○ Engineering Log: The Engineering Log consists of Eng Log tab. The tab
contains the options to specify the export parameters for exporting the
engineering log data.
Click on Archive Data or Engineering Log to switch the view to the required
export function. The tabs and options corresponding to the selected view are
displayed in the program. By default the Archive Data view is visible.

Copyright © 2012 Siemens AG. All Rights Date: 2013_08_26 Version: !ADR71_ArchiveTool!

Reserved _en_2013_08_26_08_54
Page 22 of 78

LKZ:DE AL:N ECCN:4E992

• A Help menu that provides further menu items for:


○ Opening the User Manual of the program.
○ Opening the information about the version of the program and copyright
information.

A Work Area below the menu bar covers the entire window of the program. The settings for
export functions i.e. Archive Data and Engineering Logs are set in the tabs available in this
area.

Copyright © 2012 Siemens AG. All Rights Date: 2013_08_26 Version: !ADR71_ArchiveTool!

Reserved _en_2013_08_26_08_54
Page 23 of 78

LKZ:DE AL:N ECCN:4E992

3.3.1.1 Saving Export Settings

It is possible to save the export settings that have been entered by the user. The saved
settings can be loaded again instead of entering the export settings manually in the program.
The settings are saved in the form of an *.XML file called export setting file.

To save the export settings proceed as follows:

The Archive Data Reader window is open. The export settings have been already entered
by the user.

1. Select the File menu, then Save Export Setting from the drop down menu.
2. The Save dialog box appears.
3. Select a location and enter a File name.

By default, the current working directory is open in the opened file


chooser.

4. The File Type is entered automatically as *.XML.


5. Click on Save to save the export settings, otherwise click on Cancel.

The export setting file is saved at the selected location.

Copyright © 2012 Siemens AG. All Rights Date: 2013_08_26 Version: !ADR71_ArchiveTool!

Reserved _en_2013_08_26_08_54
Page 24 of 78

LKZ:DE AL:N ECCN:4E992

3.3.1.2 Loading Export Settings

To load a saved export setting file for use in export settings, proceed as follows:

The Archive Data Reader window is open.

1. Select the File menu, then Load Export Setting from the drop down menu.
2. The Open dialog box appears.
3. Browse to the saved export setting file.

By default, the current working directory opens in the opened file


chooser.

4. Click on Open to load the export settings, otherwise click on Cancel.

The export settings from the chosen export setting file are loaded into the program.

• All the already specified settings in the program are replaced by the
settings in the export setting file.
• Depending on the Export Type parameter in the export setting file, the
view in the program switches either to the Input Tab or to the Eng Log Tab
each time the export setting file is loaded.

Copyright © 2012 Siemens AG. All Rights Date: 2013_08_26 Version: !ADR71_ArchiveTool!

Reserved _en_2013_08_26_08_54
Page 25 of 78

LKZ:DE AL:N ECCN:4E992

3.3.1.3 Resetting Export Settings

The settings in the Archive Data Reader window can be reset to their original state as
during the start of the tool.

To reset the export settings in Archive Data Reader tool proceed as follows:

The Archive Data Reader window is open. The export settings have been already entered
or loaded by the user.

• Select the File menu, then Reset Export Setting from the drop down menu.

All the displayed settings in Archive Data Reader window are deleted.

Copyright © 2012 Siemens AG. All Rights Date: 2013_08_26 Version: !ADR71_ArchiveTool!

Reserved _en_2013_08_26_08_54
Page 26 of 78

LKZ:DE AL:N ECCN:4E992

3.3.1.4 Editing XML File

It is possible to edit the XML files used by Archive Data Reader program.

To edit an XML file proceed as follows:

The Archive Data Reader window is open.

1. Select the File menu, then Edit Xml File from the drop down menu.
2. The Open dialog box appears.
3. Select the XML file to be edited and click on Open to open and edit the file,
otherwise click on Cancel.

The file is opened with the XML editor as specified in the configuration file. The file can now
be edited as required.

If no XML editor is specified in the configuration file, then the menu item Edit Xml
File is grayed out.

Copyright © 2012 Siemens AG. All Rights Date: 2013_08_26 Version: !ADR71_ArchiveTool!

Reserved _en_2013_08_26_08_54
Page 27 of 78

LKZ:DE AL:N ECCN:4E992

3.3.2 Exporting the Archive Data

To export the complete archive data, proceed as follows:

The Archive Data Reader window is open.

1. Select the Data menu, then Archive Data from the drop down menu.
The work area view switches for Archive Data export.

By default the Archive Data view is visible.

2. Specify the tags whose archived data should be exported in the Input tab.
3. Click on the Next button at the bottom. The Output tab appears.

Alternatively, click on Output tab header to switch the tab.

4. Specify the output file and its contents in the Output tab.
5. Click on Export to export the archive data, otherwise click on Cancel.
The export progress in percentage is indicated by a progress bar at the bottom of
the window.
The archive data in the selected *.IDB file is exported. The exported file has the
format (either *.CSV or *.HDF5) as specified in Output tab. The structure of
output file is different for both the formats.

The Export button is enabled only when the following mandatory entries
are available:

• an IDB file is selected


• at least one tag in the Selected table in Input tab is
available
• the output file path is specified
• at least one data column in the Selected Export
Columns table in Output tab is available.

It is not possible to change the view to a different tab when the export
procedure is running.

6. After the export, the Archive Data Reader window remains open (and ready for
further export). Click on exit to close the window.

The archive data export is complete.

Copyright © 2012 Siemens AG. All Rights Date: 2013_08_26 Version: !ADR71_ArchiveTool!

Reserved _en_2013_08_26_08_54
Page 28 of 78

LKZ:DE AL:N ECCN:4E992

3.3.2.1 Using the Input Tab

The Input tab in Archive Data view is used to specify the tags whose archived data should
be exported by the Archive Data Reader program.

To set the input tags proceed as follows:

The Input tab in Archive Data Reader window is open.

1. Select the daily file (*.IDB) containing the archive data in Open Data File section.
2. If required, apply filters using the Filter Tags section. This reduces the amount of
available tags in the Select Tags section
3. Select the tags to be exported in Select Tags section.

The input tags for export are set.

Click on Next button at the bottom to specify the output file and its contents in Output tab.

Copyright © 2012 Siemens AG. All Rights Date: 2013_08_26 Version: !ADR71_ArchiveTool!

Reserved _en_2013_08_26_08_54
Page 29 of 78

LKZ:DE AL:N ECCN:4E992

3.3.2.1.1 Selecting an IDB File

The daily file (*.IDB) containing the archive data can be selected in the Open Data File
section.

The fields available in this section are as follows:

• Input Daily File: Select an IDB file or folder (with several IDB files).
Click on the browse button (on the right hand side of the field) to find the file or
folder using a browser. Only one file or a folder at a time can be selected using the
browser.
Once the IDB file is read, the tag list of the selected file is loaded and displayed in
the Select Tags Available table.
○ Text Field: The text field displays the path and name of selected IDB file. If a
folder is selected, the path of the folder is displayed. It is not possible to edit
the path of the IDB file or the folder directly in this text field.
○ Progress Bar: The progress of reading the IDB file is indicated by a progress
bar at the bottom of the window. The progress bar disappears when the IDB
file loading is complete.
• No. of selected IDB Files: The total number of found IDB files is displayed. If a
folder is selected, the number of the found IDB files in that folder is displayed. The
IDB files within the subfolders are also included into the displayed count.
If no IDB file or folder is selected, zero is displayed.

Copyright © 2012 Siemens AG. All Rights Date: 2013_08_26 Version: !ADR71_ArchiveTool!

Reserved _en_2013_08_26_08_54
Page 30 of 78

LKZ:DE AL:N ECCN:4E992

Which Files are Readable by Archive Data Reader

Following IDB files are readable by Archive Data Reader:

• A directly selected IDB file


• A folder which contains IDB files
○ All IDB files which are stored directly in a folder are read.

When a folder is selected and within that folder, an IDB file is missing in
between the first and the last IDB file, a message about the missing file is
displayed. Additionally, the missing file is written into the log file.

• A folder which contains subfolders with IDB files


○ All IDB files which are stored directly in a folder are read. Additionally, all IDB
files which are stored in subfolders of the selected folder are read.
○ If a folder is selected, only the IDB files which are maximum one hierarchy
step below are read. For example, when a folder A is selected containing
subfolders B and C and within the subfolder C, a further subfolder D is
available which contains IDB files, then the IDB files in the subfolder D are not
read.
○ The name of the subfolder must conform with the SPPA-T3000 naming
convention.

Copyright © 2012 Siemens AG. All Rights Date: 2013_08_26 Version: !ADR71_ArchiveTool!

Reserved _en_2013_08_26_08_54
Page 31 of 78

LKZ:DE AL:N ECCN:4E992

3.3.2.1.2 Applying Filters

Filters may be applied to the tags in the selected Daily file using the Filter Tags section. This
reduces the tags being displayed in the Available table in Select Tags section.

Following filter criteria can be set:

• Tagname Filter: Enter a text pattern. All the tags that correspond to this pattern are
listed in the Available table in Select Tags section.

Wildcard searches can be made as follows:

Enter an asterisk (*), to represent any number of characters, or a blank.

Enter a question mark (?), to represent any single character.

Further it is possible to search for the (*) and (?) character itself. In this
case, it is possible to quote these characters must be entered as (\*) and
(\?).

• Eng Unit Filter: Select the required engineering unit from the drop down list.
• Type Selection: Select the tag type using check boxes. By default the Analog
check box is checked. To display all available tags of the IDB file, it is necessary to
select all check boxes.

○ It is not possible to deselect all Type Selection check


boxes. At least one check box should always be selected.
○ Depending on the selected Type Selection check boxes,
the displayed columns in the Available Export Columns in
the Output tab differ.

The table with the Available Tags is updated each time a new filter is chosen.

Copyright © 2012 Siemens AG. All Rights Date: 2013_08_26 Version: !ADR71_ArchiveTool!

Reserved _en_2013_08_26_08_54
Page 32 of 78

LKZ:DE AL:N ECCN:4E992

3.3.2.1.3 Selecting the Tags

The tags to be exported are selected in the Select Tags section.

The fields available in this section are:

• Available table displays all the available tags for the selected IDB file that match the
filter criteria. For each tag, the corresponding engineering unit, Tag type and
description are displayed.
• No. of available tags below the table displays the total no. of tags currently present
in Available table.
• Selected table displays all the tags selected by the user. The archive data of all the
selected tags will be exported for the selected time range.

The Available and Selected table contents can be rearranged i.e.:

○ The position of the columns can be changed.


○ The width of the columns can be adjusted.

• No. of selected tags below the table displays the total no. of tags currently present
in Selected table.
• Tags may be copied to the Selected table by selecting the tag from the Available
table and then clicking the button:
○ Add tag when a single tag is selected.

○ Add all tags when all tags from the available table should be copied to the
selected table.

• Tags may be removed from the Selected table by selecting the tag in the Selected
table and then clicking the button:
○ Remove tag when a single tag is selected.

Copyright © 2012 Siemens AG. All Rights Date: 2013_08_26 Version: !ADR71_ArchiveTool!

Reserved _en_2013_08_26_08_54
Page 33 of 78

LKZ:DE AL:N ECCN:4E992

○ Remove all tags when all tags from the selected table should be removed.

Alternatively, remove tags via the context menu (right mouse click >
Delete) after selecting the tags in the Selected table.

It is possible to select several tags in the table.

Select a single item, then press the CTRL key to select more items.

Alternatively, select a single item, then press the SHIFT key to select
another item. Both the items and all the items in between them are
selected.

It is possible to edit the tags in the Selected table.

How the Selected Tags are Evaluated after New IDB File Import

The Selected table shows all selected tags which are evaluated by Archive Data Reader
program.

Each time a new IDB file is loaded, the selected tags are evaluated and the Selected table is
updated.

• When no tags are displayed in the Selected table, the table remains empty.
• When tags are displayed in the Selected table and a new IDB file (or folder with IDB
files) is loaded, it is checked if these displayed tags are available in that new loaded
IDB file.
○ The selected tags which are available in the new loaded IDB file remain in the
Selected table and the background color for the tag remains white.
○ The selected tags which are not found in the new loaded IDB file remain in the
Selected table and the background color is set to red.

During the export, for each exported red marked tag a logging is
written into the log file.

Copyright © 2012 Siemens AG. All Rights Date: 2013_08_26 Version: !ADR71_ArchiveTool!

Reserved _en_2013_08_26_08_54
Page 34 of 78

LKZ:DE AL:N ECCN:4E992

3.3.2.1.4 Editing the Tags

It is possible to edit the tag names of tags displayed in the selected table.

Editing a Tagname

To edit the tag name of a tag in the selected table, proceed as follows:

The Input tab in Archive Data Reader window is open with tags displayed in the selected
table.

1. Select the tag to be edited in the selected table.

Alternatively, select all red tags via the context menu (right mouse click
> Select all red) if all the red colored tags are required to be edited
simultaneoulsy.

It is possible to select several tags in the table.

Select a single item, then press the CTRL key to select more items.

Alternatively, select a single item, then press the SHIFT key to select
another item. Both the items and all the items in between them are
selected.

2. Click the right mouse button, then select Edit from the context menu.
3. The Edit Tag Name dialog box opens.

4. The Origin Tagname displays the original tag name of the selected tag. For each
character of the original tag name an X is displayed.

Copyright © 2012 Siemens AG. All Rights Date: 2013_08_26 Version: !ADR71_ArchiveTool!

Reserved _en_2013_08_26_08_54
Page 35 of 78

LKZ:DE AL:N ECCN:4E992

When multiple tags are selected, the number of displayed X is equal to


the number of characters that are available in the longest selected tag
name.

5. Enter the characters in Set characters. These characters replace the original
characters in the original tag name.
6. Define the starting position inside the tag name from which the characters should
be replaced using At position field.
The first character of the tag name is position number 1.
The position numbers in At position are limited from 1 to the number of
characters of the longest selected tag.
7. The Edited Tagname displays the edited tag name of the selected tag. The
changed characters are displayed at the specified position. The other characters
remain as X.
8. Click on Ok to edit the tag name, otherwise click on Cancel.

Results of Editing a Tagname

The results of editing a tag name are as follows:

• The selected tag name is edited at the specified position by the specified characters.
• Further it is checked if the edited tag name is available in the currently loaded IDB
file.
○ If the edited tag name is available in the currently loaded IDB file, the
corresponding red marked row in selected table is replaced with the edited tag
and the background color is set to white.
○ If the edited tag name is not available in the currently loaded IDB file, the
original tag name stays in the selected table.
• If for multiple selected tags, after editing their tag names, same tag is available in
currently loaded IDB file, then nothing is changed in the selected table. The original
tag name stays in the selected table. This avoids multiple entries in the selected
table.
For example, the selected tags to be edited are 10MAB11CT021A§§XQ01 and
20MAB11CT021A§§XQ01. Following are the values that are entered in Edit Tag
Name dialog box:
Set characters: 50
At position: 1
The result of above edit will lead to the same new tag name i.e.
50MAB11CT021A§§XQ01.
Therefore, in this case nothing is changed in the selected table. A message is
displayed to the user which says that the edit of those specific tags leads to doubled

Copyright © 2012 Siemens AG. All Rights Date: 2013_08_26 Version: !ADR71_ArchiveTool!

Reserved _en_2013_08_26_08_54
Page 36 of 78

LKZ:DE AL:N ECCN:4E992

entries. The specific tags that could not be edited are also displayed in the message
box.

Copyright © 2012 Siemens AG. All Rights Date: 2013_08_26 Version: !ADR71_ArchiveTool!

Reserved _en_2013_08_26_08_54
Page 37 of 78

LKZ:DE AL:N ECCN:4E992

3.3.2.2 Using the Output Tab

The Output tab in Archive Data view is used to specify the output file and its contents. It
provides several options where the export parameters for output file can be configured.

To configure the output parameters proceed as follows:

The Output tab in Archive Data Reader window is open.

1. Set the time period for which the archive data needs to exported in Set Time
section.
2. Specify the name and path of the output file in Select Output File section.
3. Define the format of the output file in Select Format section.
4. Select the columns that should be exported to the output file in Select Export
Columns section.

The output parameters for export are set.

Following buttons are present at the bottom in Output tab:

• Back: Click to navigate back to the Input tab.

Alternatively, click on Input tab header to switch the tab.

• Export: Click to export the archive data.


• Cancel: Click to cancel the export process.

Copyright © 2012 Siemens AG. All Rights Date: 2013_08_26 Version: !ADR71_ArchiveTool!

Reserved _en_2013_08_26_08_54
Page 38 of 78

LKZ:DE AL:N ECCN:4E992

3.3.2.2.1 Setting the Time Period

The time period for which the archive data needs to be exported can be set in Set Time
section.

The fields available in this section are as follows:


• Available Time: The available time range is displayed. The available time range is
dependent on the selected IDB files.
○ If just one file is selected, then From and To time contain the date of that file
and 00:00:00.000 as start time and 23:59:59.999 as the end time.
○ If a folder is selected, then
From time contains the date of the oldest file in that folder and
00:00:00.000 as start time, and
To time contains the date of the newest file in that folder and 23:59:59.999
as the end time.
• Selected Time: Specify the time range for the export.
1. Click From to specify the start date and time for export.
By default, the available From time is displayed.
2. The Select From Time dialog box appears:

3. Select a date using the drop down calender.


4. Select the hours, minutes, seconds and milliseconds in the subsequent
fields.

Setting the time in the time fields is possible by:

○ Typing the values directly into the text


fields, or
○ Clicking the up and down arrow buttons, or
○ Using the mouse scroll.

5. Similarly, specify the end time for export using To button.

Copyright © 2012 Siemens AG. All Rights Date: 2013_08_26 Version: !ADR71_ArchiveTool!

Reserved _en_2013_08_26_08_54
Page 39 of 78

LKZ:DE AL:N ECCN:4E992

It is not possible to specify a From time in Selected Time which is


before the available from time. Also, it is not possible to specify a
To time which is after the available to time.

The available time range and the selected time range are displayed in the
time format as specified in the configuration file.

Independent of the selected time range, the first entry inside the output file
is the initial event of the first IDB file.

• UTC Offset: Select the UTC Offset for the displayed Available Time, Selected
Time and the time in the output file.
To set the UTC Offset, proceed as follows:
1. Click on UTC Offset. The Select UTC offset dialog box appears.

Clicking on the info button opens a frame containing the world map
which displays an overview of the available timezones.

This can help to set the correct UTC offset.

2. Set the exact hours and the minutes of UTC offset in Select UTC offset
dialog box.

The value for hour field is limited from -12 to +14. The value for
minute field is limited from 0 to 45.
When a user tries to enter a value outside the limits, the last valid
value is displayed.

Copyright © 2012 Siemens AG. All Rights Date: 2013_08_26 Version: !ADR71_ArchiveTool!

Reserved _en_2013_08_26_08_54
Page 40 of 78

LKZ:DE AL:N ECCN:4E992

Setting the time in the UTC offset fields is possible by:

○ Clicking the up and down arrow buttons, or


○ Using the mouse scroll.

It is not possible to type the values directly into the UTC offset
fields.

3. Click on Ok to set the UTC Offset, otherwise click on Cancel.


The entered UTC offset is displayed next to the info button. By default the
UTC+00:00 is displayed.

When the UTC offset is set, the Available Time and the Selected
Time are updated accordingly.

Copyright © 2012 Siemens AG. All Rights Date: 2013_08_26 Version: !ADR71_ArchiveTool!

Reserved _en_2013_08_26_08_54
Page 41 of 78

LKZ:DE AL:N ECCN:4E992

3.3.2.2.2 Selecting the Output File

The name and the path of the output file containing the exported archive data is specified in
the Select Output File section.

• Specify the name and the path of the output file using the browse button on the right
hand side of Output File field.
The default path is the current working directory.

By default, the output file has the following naming convention:


<Selected From Time>_<Selected To Time>

The date and time format are as specified in the configuration file where the separator
symbols i.e. colon (:), semicolon (;), period (.), comma (,), minus (-), underscore (_),
backward slash (\), forward slash (/) and blank space ( ) are automatically replaced by the
underscore symbol (_). For example:
<YYYYMMDD_HH_MM_SS_mmm>_<YYYYMMDD_HH_MM_SS_mmm>

Depending on the selected output format, the suffix, either .CSV or .HDF5 is set
automatically to the name of output file.

It is possible to change the file name and path in the file chooser.

If the output file already exists and the export button is pressed, then:

• the user can either select to overwrite the file, or


• the export is cancelled if the user does not select to overwrite the file. In
this case, the user can change the path of the output file to avoid
cancelling the export.

Copyright © 2012 Siemens AG. All Rights Date: 2013_08_26 Version: !ADR71_ArchiveTool!

Reserved _en_2013_08_26_08_54
Page 42 of 78

LKZ:DE AL:N ECCN:4E992

3.3.2.2.3 Selecting the Output Format

The format of the output file containing the exported archive data is defined in Select Format
section.

• Select the option for required format. By default csv is selected.


○ csv: If csv is selected, the output file is created as a *.CSV file. The CSV file
lists all the events chronologically with each event stored in one row.
By default the separator of CSV file is semicolon (;). The value of separator
can be edited in the configuration file.
By default the CSV file is written in ANSI format. The value of char encoding
can be changed in the configuration file.
By default the CSV file is limited to 65535 rows. This value can be edited in
the configuration file.

If the specified exported data has more rows than the specified limit
of CSV file, then the exceeding rows are not exported. In this case a
warning is written into the last row of the output file. The warning
informs the user that the limit for maximum rows in CSV file is
reached and the data export is not complete.

○ hdf5: If hdf5 is selected, the output file is created as *.HDF5 file.


The HDF5 file creates for each tag name a superior Group element. Inside the
Group element, two Dataset elements are created. One of these Datasets
stores the timestamps and the other stores the data.
The HDF5 file is written in ANSI format.

The decimal point within the analog values is independent of the chosen output
format.

Copyright © 2012 Siemens AG. All Rights Date: 2013_08_26 Version: !ADR71_ArchiveTool!

Reserved _en_2013_08_26_08_54
Page 43 of 78

LKZ:DE AL:N ECCN:4E992

3.3.2.2.4 Selecting the Export Columns

The data columns that should be exported to the output file are selected in the Select Export
Columns section.

The fields available in this section are:

• Available Export Columns table displays all the available data columns that can be
exported to the output file.
A list of all the possible columns that can be available in this table is as follows:
○ Alarmtype
○ Auto-Suppressed
○ Description
○ Display-Suppressed
○ Engineering Unit
○ Gone Text
○ Priority
○ Project Status
○ Quality
○ Raised Text
○ Range High
○ Range Low
○ SOE
○ Suppressed
○ TagId
○ Tagname
○ Tagout
○ Timestamp
○ Value

Copyright © 2012 Siemens AG. All Rights Date: 2013_08_26 Version: !ADR71_ArchiveTool!

Reserved _en_2013_08_26_08_54
Page 44 of 78

LKZ:DE AL:N ECCN:4E992

The number and type of the columns displayed in Available Export


Columns table depend on the Type Selection filter in the Filter Tags
section in Input tab.

The columns Alarmtype, Project Status and Quality export an integer


value. The integer value can be interpreted using the corresponding tables.

• No. of available columns below the table displays the total no. of columns currently
present in Available Export Columns table.
• Selected Export Columns table displays all the columns selected by the user. By
default the columns Quality, Tagname, Timestamp and Value are available in
the selected table.

The selection of the columns has no influence on the sequencing of


columns in the output file.

• No. of selected columns below the table displays the total no. of columns currently
present in Selected Export Columns table.
• Columns may be copied to the Selected Export Columns table by selecting the
columns from the Available Export Columns table and then clicking the button:
○ Add columns when a single column is selected.

○ Add all columns when all columns from the available table should be copied
to the selected table.
when multiple columns are selected.

• Columns may be removed from the Selected Export Columns table by selecting
the columns in the Selected Export Columns table and then clicking the button:
○ Remove columns when a single column is selected.

○ Remove all columns when all columns from the selected table should be
removed.

Copyright © 2012 Siemens AG. All Rights Date: 2013_08_26 Version: !ADR71_ArchiveTool!

Reserved _en_2013_08_26_08_54
Page 45 of 78

LKZ:DE AL:N ECCN:4E992

It is possible to select several columns in the table.

Select a single item, then press the CTRL key to select more items.

Alternatively, select a single item, then press the SHIFT key to select
another item. Both the items and all the items in between them are
selected.

Copyright © 2012 Siemens AG. All Rights Date: 2013_08_26 Version: !ADR71_ArchiveTool!

Reserved _en_2013_08_26_08_54
Page 46 of 78

LKZ:DE AL:N ECCN:4E992

3.3.2.2.4.1 Interpreting the Export Columns

The columns - Alarmtype, Project Status and Quality export an integer value to the output
file. The integer value can be interpreted using the corresponding tables described below.

Copyright © 2012 Siemens AG. All Rights Date: 2013_08_26 Version: !ADR71_ArchiveTool!

Reserved _en_2013_08_26_08_54
Page 47 of 78

LKZ:DE AL:N ECCN:4E992

Alarmtype

The default Alarm Types available in SPPA-T3000 are listed in the table below. Additionally,
the corresponding Alarm Type IDs (integer values) that are written into the output file for
Alarmtype column are listed.

Alarm Type ID Alarm Type Abbreviated Name Description


Name
0 Undefined U UNDEFINED A Remote
Unit alarm
that has not
been defined
in the Local
Unit. This will
only appear in
the Multi Unit
Workbench.
1 Alarm A ALARM A critical
alarm.
3 Warning W WARNING A less critical
alarm.
5 Tolerance T TOLERANCE A least critical
alarm.
6 Instrumentati I&C I&C ALARM A fault in the
on and I&C system.
Control
7 Communicati C COM FAULT A system
on Failure communicatio
n fault.
8 Maintenance M MAINTAIN A
maintenance
or service
activity is
required.
9 Status S STATUS An important
device has
been started
or stopped, or
a device

Copyright © 2012 Siemens AG. All Rights Date: 2013_08_26 Version: !ADR71_ArchiveTool!

Reserved _en_2013_08_26_08_54
Page 48 of 78

LKZ:DE AL:N ECCN:4E992

Alarm Type ID Alarm Type Abbreviated Name Description


Name
changeover
has occurred.
12 Maintenance MP MAINTAIN PA A
PA maintenance
or service
activity will be
required in the
future.
14 Manual O MANUAL An indication
Operator OPERATOR to the
Response RESPONSE operator that
a Reset of the
device is
required
before
resuming
operation.

Project Status

A tag in SPPA-T3000 is archived only if the Archive>> column in parameter mask of an


Automation Function is checked.
The Project Status export column describes the archive status of the tag i.e. it indicates
whether the tag has been selected for archiving.

The table below lists the Project Status and the corresponding Project Status IDs (integer
values) that are written into the output file for the column Project Status.

Project Status ID Project Status Description


1 PROJECTSTATUS_A Tag is selected for
CTIVE archiving.
2 PROJECTSTATUS_D Tag is not selected for
ELETED archiving.

Copyright © 2012 Siemens AG. All Rights Date: 2013_08_26 Version: !ADR71_ArchiveTool!

Reserved _en_2013_08_26_08_54
Page 49 of 78

LKZ:DE AL:N ECCN:4E992

Quality

The SPPA-T3000 quality codes are listed in the table below. Additionally, the corresponding
quality values (integer values) that are written into the output file for Quality column are
listed.

Quality Value Quality Abbreviation Description


0 BAD BAD Value is BAD
with non-specific
reason
4 BCE Value is BAD
due to a
Configuration
Error
8 BNC Value is BAD
since it is Not
Connected to a
data source
12 BDF Value is BAD
due to a Device
Failure
16 BSF Value is BAD
due to a Sensor
Failure
20 BLV Value is BAD
and Last Known
(good) Value is
processed
24 BCF Value is BAD
due to a
Communication
Failure
28 BOS Value is BAD
since the module
channel is Out of
Service
64 UNCERTAIN UNC Value is
UNCERTAIN

Copyright © 2012 Siemens AG. All Rights Date: 2013_08_26 Version: !ADR71_ArchiveTool!

Reserved _en_2013_08_26_08_54
Page 50 of 78

LKZ:DE AL:N ECCN:4E992

Quality Value Quality Abbreviation Description


since a substitute
value is used
68 ULV Value is
UNCERTAIN and
the Last Usable
Value is held,
e.g. during
parameter
reconfiguration of
Hardware
Proxies
80 UNA Value is
UNCERTAIN
since it is Not
Accurate
84 UEX Value is
UNCERTAIN
since the
Engineering
Units
EXCEEDED
88 USN Value is
UNCERTAIN
SUB NORMAL,
i.e. the value is
derived from
multiple sources
and has less than
the required
number of Good
sources
192 GOOD GOD Value is GOOD,
i.e. in normal
state
216 GFO Value is GOOD
but manually
FORCED/
SIMULATED

Copyright © 2012 Siemens AG. All Rights Date: 2013_08_26 Version: !ADR71_ArchiveTool!

Reserved _en_2013_08_26_08_54
Page 51 of 78

LKZ:DE AL:N ECCN:4E992

Effects of LIMIT Bits and SYNC Event on a Quality Value

Quality Value Quality Abbreviation Description


1 LIMIT Bits LL Value for LIMIT
LOW
2 LH Value for LIMIT
HIGH
3 LC Value for LIMIT
CONSTANT
32 SYNC Event SYNC_EVENT SYNC_EVENT is
not a quality
code. It signifies
the timestamp.

LIMIT Bits and SYNC_EVENT are not quality codes. They are normally set together with
another quality code.

When a Quality Value is converted to binary:

• Bit 0 and Bit 1 represent the limit bits.


• Bit 5 represents the sync event.

Depending on both the limit bits i.e. 00 or 01 or 10 or 11, the limit is either Ok, Low, High or
Constant respectively.
To get a quality code, limit bits can be ignored. Therefore, if one of the limit bits is set, it can
be set to zero.

The sync event signifies the timestamp. When the sync event is set, the value is written as it
was at a specific timestamp. It does not indicate if the value changed exactly at that
timestamp. When the sync event is not set, the value change happens exactly at that
timestamp.
To get a quality code when the sync event is set, it must be set to zero.

An example containing the limit bits and sync event is described below:

The Quality value exported by the program is 250.

1. Convert 250 to binary value i.e. 1111 1010.


2. Remove the limit bits (bit positions 0 and 1) from the binary value 1111 1010 to
obtain 1111 1000.
3. Remove the sync bit (bit 5) from the resulting binary value 1111 1000 to get
1101 1000.
4. Convert 1101 1000 to get decimal value i.e. 216.

Copyright © 2012 Siemens AG. All Rights Date: 2013_08_26 Version: !ADR71_ArchiveTool!

Reserved _en_2013_08_26_08_54
Page 52 of 78

LKZ:DE AL:N ECCN:4E992

The resulting Quality value 216 corresponds to the quality code GFO (GOOD but manually
FORCED/SIMULATED) in the above table.

Copyright © 2012 Siemens AG. All Rights Date: 2013_08_26 Version: !ADR71_ArchiveTool!

Reserved _en_2013_08_26_08_54
Page 53 of 78

LKZ:DE AL:N ECCN:4E992

3.3.3 Exporting the Engineering Log

To export the engineering log, proceed as follows:

The Archive Data Reader window is open.

1. Select the Data menu, then Engineering Log from the drop down menu.
The work area view switches for Engineering Log export and Eng Log tab is
displayed.

2. Select the daily file (*.IDB) in Open Data File section.


3. Set the time period for which the engineering log data needs to exported in Set
Time section.
4. Specify the name and path of the output file containing the exported data in
Select Output File section.
5. Click on Export to export the engineering log data, otherwise click on Cancel.
The export progress is indicated by a progress bar at the bottom of the window.

The Export button is enabled only when the following mandatory entries
are available:

• an IDB file is selected, and


• the output file path is specified.

6. After the export, the Archive Data Reader window remains open (and ready for
further export). Click on exit to close the window.

The engineering log export is complete.

• The exported file containing the engineering logs of the selected *.IDB file has a
*.csv format. The structure of output file is as per the csv output file structure.
By default the separator of csv file is (;). The value of separator can be edited in the
configuration file.

Copyright © 2012 Siemens AG. All Rights Date: 2013_08_26 Version: !ADR71_ArchiveTool!

Reserved _en_2013_08_26_08_54
Page 54 of 78

LKZ:DE AL:N ECCN:4E992

By default the csv file is limited to 65535 rows. This value can be edited in the
configuration file.

If the specified exported data has more rows than the specified limit of csv
file, then the exceeding rows are not exported. In this case a warning is
written into the last row of the output file. The warning informs the user that
the limit for maximum rows in csv file is reached and the data export is not
complete.

• The data columns that are exported to the output file are Action, Object name,
Timestamp, Type, User and Value.

Copyright © 2012 Siemens AG. All Rights Date: 2013_08_26 Version: !ADR71_ArchiveTool!

Reserved _en_2013_08_26_08_54
Page 55 of 78

LKZ:DE AL:N ECCN:4E992

3.4 Exporting using the Batch Mode

The swapped out archive data can also be exported and read by running Archive Data
Reader program in batch mode. In this case, the program uses the export parameters and
their values as defined in the export setting file. The Archive Data Reader GUI window does
not open at all during the batch mode.

Batch Job with Export Setting File

To export and read the archive data using batch method, proceed as follows:

1. Open the command prompt and execute:


ArchiveDataReader.bat -b=<Export setting file>
where <Export setting file> = whole path of the export setting file.
2. The ArchiveDataReader takes the parameters and their values as defined in
the export setting file, validates them and export the data into the output file
based on the values of the parameters.
A message is written into the log file when the batch job runs successfully. If the
batch job fails an error message is written into the log file.

To display all the available parameters and their short description in command
prompt, execute the following:
ArchiveDataReader.bat -?

Example

An example to run the Archive Data Reader program in batch mode using the export setting
file is as below:

ArchiveDataReader.bat -b=D:\ExportSettingFiles
\my_export_setting_file.xml

Archive Data Reader program starts in batch mode. It uses the settings as defined in export
setting file.

Copyright © 2012 Siemens AG. All Rights Date: 2013_08_26 Version: !ADR71_ArchiveTool!

Reserved _en_2013_08_26_08_54
Page 56 of 78

LKZ:DE AL:N ECCN:4E992

Batch Job with Parameter Overriding in Export Setting File

It is possible to further specify the command line parameters. These parameters allow
completing the incomplete parameters in the export setting file. If a command line parameter
is specified and the parameter is also specified in the export setting file, then the command
line parameter overrides the parameter in the export setting file. This overriding happens
when the batch mode is started with the export setting file and additional command line
parameters.

The following parameters are available for overriding:

• exportType
• idbFilePath
• tagList
• tag
• outputFilePath
• dateFrom
• timeFrom
• dateTo
• timeTo
• utcOffset
• outputFileFormat
• columnList
• columnName

An incomplete export setting file can be used for multiple export requests.

To export and read the archive data using batch method with parameter overriding, proceed
as follows:

1. Open the command prompt and enter:


ArchiveDataReader.bat -b=<Export setting file>
where <Export setting file> = whole path of the export setting file.
2. Enter the parameters in command line in the following way, if required:
-<parameter name>=<parameter value> -<parameter
name>=<parameter value>
Where:

• The name of the parameter is prefixed with hyphen (-).


• The value of the parameter is prefixed with equal to (=).
• The parameter name is case sensitive.
• There is one blank space between each pair of parameter name and its
value.

Copyright © 2012 Siemens AG. All Rights Date: 2013_08_26 Version: !ADR71_ArchiveTool!

Reserved _en_2013_08_26_08_54
Page 57 of 78

LKZ:DE AL:N ECCN:4E992

• If a parameter has more than one value, then each value should be
enclosed in double quotation marks (" ") and separated by a semicolon (;)
sign. There should not be any spaces between the two values of the
parameter.
3. As per step 2, an example syntax to change all available parameters is as
follows:
-<exportType>=<value> -<idbFilePath>=<value> -
<tagList>=<value> -<outputFilePath>=<value> -
<dateFrom>=<value> -<timeFrom>=<value> -<dateTo>=<value> -
<timeTo>=<value> -<utcOffset>=<value> -
<outputFileFormat>=<value> -<columnList>=<value>
Where the following values are valid as parameter values:

• -<exportType>=<value>
value = either tags or engLogs written as String
• -<idbFilePath>=<value>
value = absolute path of the input IDB file written as String
• -<tagList>=<value>
value = tag name written as String enclosed in double quotation marks ("
").
If more than one tags are available they are separated by a semicolon (;).
For example: -
tagList="00BDT01CE102§§YX01";"10MAB11CT021A§§XQ01"
When the double quotation mark (") itself is part of the tag name, it must be
written as (\").
When the semicolon (;) itself is part of the tag name, it must be written as
(\;).
When the backward slash (\) itself is part of the tag name, it must be written
as (\\).
When all tags of the IDB file are requested, then value = "all"
• -<outputFilePath>=<value>
value = absolute path of the output file written as String
• -<dateFrom>=<value>, -<timeFrom>=<value>, -<dateTo>=<value> and -
<timeTo>=<value>
value = exact time in the time format as specified in the configuration file
• -<utcOffset>=<value>
value = offset as UTC+00:00. The value for hour field is limited from -12 to
+14. The value for minute field is limited from 0 to 45 in 15 minutes step.
• -<outputFileFormat>=<value>
value = either csv or hdf5
• -<columnList>=<value>

Copyright © 2012 Siemens AG. All Rights Date: 2013_08_26 Version: !ADR71_ArchiveTool!

Reserved _en_2013_08_26_08_54
Page 58 of 78

LKZ:DE AL:N ECCN:4E992

value = column name written as String enclosed in double quotation marks


(" "). If more than one columns are requested, they are separated by a
semicolon (;) sign.
4. The ArchiveDataReader takes the parameters and their values as input
parameters, validates them and export the data into the output file based on the
values of the parameters.
A message is written into the log file when the batch job runs successfully. If the
batch job fails an error message is written into the log file.

The batch mode exits if:

• A parameter other than the mentioned parameters is


entered into the parameter list.
• A parameter is neither available in the export setting
file nor specified in the command line.
• A parameter value does not correspond to the syntax.

A entry is written into the log file in these cases.

In batch mode, if the defined output file is already available, a suffix is added to the
output file name. The suffix counts up to 999. When an output file with the suffix
999 is already available, the batch mode exits. In this case, no further file is
created. An entry is written into the log file.

Examples

• Example 1: An example to run Archive Data Reader program in batch mode with all
the parameters specified in command line for overriding is as below:
ArchiveDataReader.bat -b=D:\ExportSettingFiles
\my_export_setting_file.xml -idbFilePath=C:\20100701.IDB -
tagList="00BDT01CE102§§YX01";"10MAB11CT021A§§XQ01" -
outputFilePath=C:\temp\test.csv -dateFrom=20100701 -
timeFrom=00:00:00.000 -dateTo=20100701 -timeTo=23:59:59.999 -
utcOffset=UTC+00:00 -outputFileFormat=csv
columnList="Tagname";"Value"
In this case, all the parameters from the export setting file are overridden by the
command line parameter values.
• Example 2: An example to run Archive Data Reader program in batch mode with
just two parameters specified in command line for overriding is as below:
ArchiveDataReader.bat -b=D:\ExportSettingFiles
\my_export_setting_file.xml -timeFrom=00:00:00.000 -
timeTo=23:59:59.999

Copyright © 2012 Siemens AG. All Rights Date: 2013_08_26 Version: !ADR71_ArchiveTool!

Reserved _en_2013_08_26_08_54
Page 59 of 78

LKZ:DE AL:N ECCN:4E992

In this case, only two parameters from the export setting file are overridden by the
abovementioned command line parameter values. The rest of the parameters are
taken from the export setting file.

Copyright © 2012 Siemens AG. All Rights Date: 2013_08_26 Version: !ADR71_ArchiveTool!

Reserved _en_2013_08_26_08_54
Page 60 of 78

LKZ:DE AL:N ECCN:4E992

3.5 Structure of the Output File

Archive Data Reader program exports the events for the specified tag names and time range
from the IDB file. The exported events are written directly in the exported output file. The
output file has the format either *.CSV or *.HDF5 as specified in Output tab.

Depending on the chosen format, the output file has a different structure.

Copyright © 2012 Siemens AG. All Rights Date: 2013_08_26 Version: !ADR71_ArchiveTool!

Reserved _en_2013_08_26_08_54
Page 61 of 78

LKZ:DE AL:N ECCN:4E992

3.5.1 CSV Output File Structure

The convention for output file in *.CSV format is:

• Columns:
○ The titles of the selected columns are written in the first line of output file.
○ When all the available columns are selected, the ordering of the columns in
output file is as follows:
Timestamp
Value
Quality
Alarmtype
Suppressed
Auto-Suppressed
Display-Suppressed
Tagname
TagId
Description
Engineering Unit
Project Status
Range Low
Range High
Gone Text
Raised Text
Priority
SOE
Tagout
○ When only a few columns are selected, the deselected columns do not appear
in the output file. For the rest of the columns the order remains as mentioned
above.
• Data Types: All data types are written as strings into the CSV file. Boolean values
are written as 0 or 1 into the file.
• Tags: The exported events for the selected tags are sorted in ascending order by
timestamp.
Each event is written into one line. Therefore, each line in the output file can belong
to a different tag.

Copyright © 2012 Siemens AG. All Rights Date: 2013_08_26 Version: !ADR71_ArchiveTool!

Reserved _en_2013_08_26_08_54
Page 62 of 78

LKZ:DE AL:N ECCN:4E992

3.5.2 HDF5 Output File Structure

The output file in *.HDF5 format has the following convention:

Attributes

Several attributes are used inside the HDF5 file. All used attributes are of type String.
Structure of the attributes is as below:
key = value

Root

The name of the root of the HDF5 file is same as the output file name.
The root has following two attributes:

• Version: It shows the version of Archive Data Reader program which has been
used to create the HDF5 file.
• Data column order: It shows the column order of each Data dataset which is
created inside the HDF5 file. If several columns are selected they are separated by
a semicolon.
For e.g., Data column order = Value if just one column is selected, and
Data column order = Value;Quality if more then one columns are selected.

Group

A Group element is created below the root for each exported tag. The Group element
contains all requested data of a specific tag.

• Group Name: The name of the Group is same as the Tagname. If the tag name
contains a slash (/), then the slash is replaced by percent (%) in the Group name.

When the Tagname is written as an attribute to a group, then the Tagname


is written in its original state i.e. the slash (/) is not replaced by percent (%)
in the tagname.

• Dataset: Following two Dataset elements are created inside the Group element:
○ Timestamp: This dataset contains all timestamps of the requested data. Each
row contains the timestamp of one event. It contains data of type Long.
○ Data: This dataset contains the following columns if these columns are
selected:
Value, Quality, Alarmtype, Suppressed, Auto-Suppressed, Display-
Suppressed, Project Status, Range Low, Range High, Priority, SOE, and
Tagout
The deselected columns do not appear in the Data dataset.

Copyright © 2012 Siemens AG. All Rights Date: 2013_08_26 Version: !ADR71_ArchiveTool!

Reserved _en_2013_08_26_08_54
Page 63 of 78

LKZ:DE AL:N ECCN:4E992

Each row in this dataset contains the data of one event. There are as many
rows available in the dataset as events are available.
The Data dataset contains data of type Float.
The index of the Timestamp dataset corresponds to the index of the Data
dataset.

• If a tag of type Long is written into the HDF5 file,


the values are written as Long.
• If a column is selected which is not available for
the exported tag type, a Float.NaN is written into
the HDF5 file. If the exported tag type is Long,
then -1 is written.

• Time Independent Tag Information: Tag information which is not time dependent
is stored as a Group attribute. Following columns are time independent:
Tagname, TagId, Description, Engineering Unit, Gone Text, and Raised Text

Copyright © 2012 Siemens AG. All Rights Date: 2013_08_26 Version: !ADR71_ArchiveTool!

Reserved _en_2013_08_26_08_54
Page 64 of 78

LKZ:DE AL:N ECCN:4E992

3.6 Special Events in the Output File

Independent of the selected time range, the first entry in an output file is the initial event of
the first IDB file. In addition, following special events are written into the output file.

Bad Not Connected Event

A Bad Not Connected event is written into the output file if the IDB file is not available on
the selected path. For example, when a folder is selected and within that folder, an IDB file is
missing in between the first and the last IDB file, a Bad Not Connected event is created
and written into the output file.

If multiple IDB files are not available on the specified path, a Bad Not Connected event is
written for each missing IDB file.
When the next IDB file is available again, an initial event for the next available IDB file is
written into the output file.

The Bad Not Connected event has the value 0 for analog values and false for binary
values and the quality code BAD NOT CONNECTED (BNC).

Bad Config Error Event

A Bad Config Error event is written into the output file if a tag is not available in the
selected IDB file.
For example, when the selected time range includes several days, then the program displays
the tag list of the newest IDB file. Therefore, a specific tag may not be available within an
older IDB file. In this case, a tag is available within the available tag list but is not available
within the loaded IDB file, and hence a Bad Config Error event is created and written
into the output file.

If multiple tags are not available, a Bad Config Error event is written for each missing
tag.
For the next available tag in the IDB file, an initial event is written into the output file.

The Bad Config Error event has the value 0 for analog values and false for binary
values and the quality code BAD CONFIG ERROR (BCE).

The value of a Bad event depends on the parameter substitutionBadValue in the


configuration file.

Copyright © 2012 Siemens AG. All Rights Date: 2013_08_26 Version: !ADR71_ArchiveTool!

Reserved _en_2013_08_26_08_54
Page 65 of 78

LKZ:DE AL:N ECCN:4E992

3.7 Important Files

To use Archive Data Reader program in a proper way, following files are required:

• The export setting file: It contains the export request.


• The configuration file: It contains general settings of the program.
• The log file: It contains the logs of the program.
• The Log4j configuration file: It contains information such as parameter settings for
the log file.

Copyright © 2012 Siemens AG. All Rights Date: 2013_08_26 Version: !ADR71_ArchiveTool!

Reserved _en_2013_08_26_08_54
Page 66 of 78

LKZ:DE AL:N ECCN:4E992

3.7.1 Export Setting File

The export setting file is an XML file containing a single request for export. All important
information for export such as time range, IDB file path, tag names etc. are stored in the
export setting file.

An export setting file can be used to:

• Save settings from the GUI of Archive Data Reader program.


• Reload the saved settings back into the GUI of the program.
• Run the batch mode of Archive Data Reader program.

The export setting file can be generated using the Save Export Setting option in the
Archive Data Reader window. It is possible to change the generated export setting file
manually.
The generated export setting file can be used both in the GUI and batch modes.

The following export parameters in form of XML tags are available in the export setting file:

• exportType
• idbFilePath
• tagList
• tag
• outputFilePath
• dateFrom
• timeFrom
• dateTo
• timeTo
• utcOffset
• outputFileFormat
• columnList
• columnName

Using Export Setting File in GUI Mode

Following are some of the conventions when using the export setting file in GUI mode:

• It is not necessary that all the XML tags in export setting file have values when it is
used in GUI mode during saving or loading the settings.
• During loading the export settings, only the values available in the export setting file
are loaded into the GUI. The XML tags without value in the export setting file do not
have any influence on the GUI.

Copyright © 2012 Siemens AG. All Rights Date: 2013_08_26 Version: !ADR71_ArchiveTool!

Reserved _en_2013_08_26_08_54
Page 67 of 78

LKZ:DE AL:N ECCN:4E992

• During saving the export settings, only the values as specified in the GUI are written
into the export setting file. If a value is not set in the GUI, a tag without a value is
saved into the export setting file.

Using Export Setting File in Batch Mode

The conventions for using the export setting file in batch mode are:

• It is not necessary that all the XML tags in export setting file have values when it is
used in batch mode.
• When the values are missing in export setting file, they must be specified as the
command line parameters otherwise the batch mode exits.
• When all the values are available in export setting file and no further command line
parameters are available, the values from export setting file are taken. When
command line parameters are available, then these parameters always override the
values from the export setting file.

Copyright © 2012 Siemens AG. All Rights Date: 2013_08_26 Version: !ADR71_ArchiveTool!

Reserved _en_2013_08_26_08_54
Page 68 of 78

LKZ:DE AL:N ECCN:4E992

3.7.2 Configuration File

The configuration file is an XML file which stores the basic settings of Archive Data Reader
program. These settings are independent of the export request. The settings in the
configuration file may be edited, if required.

A default configuration file is provided with Archive Data Reader program. The name of the
configuration file is ArchiveDataReaderConfiguration.xml. It is located at:
ArchiveDataReader\config

The following parameters are defined in the configuration file:

• xmlEditor: It contains the absolute path of the program which is used to edit the
XML files used by Archive Data Reader program. By default no editor is specified.

If no XML editor is specified in the configuration file, then the menu item
Edit Xml File in the GUI is grayed out.

• separatorTagname: It defines the separator used in displayed tag names in the


Select Tags section and in the output file. By default the value for the separator is
set to (§).
• dateFormat and timeFormat: These define the date and time format for the
displayed Available and the Selected time range in the Output and Eng Log tabs
and in the output file. By default, the value for dateFormat is set to yyyy.MM.dd and
for the timeFormat is set to HH:mm:ss.SSS.
The value for dateFormat and time format has to be based on SimpleDateFormat
syntax (http://docs.oracle.com/javase/1.5.0/docs/api/ --> SimpleDateFormat). Only
the SimpleDateFormat as mentioned below are supported.
The following formats are supported for dateFormat:
○ yyyy.dd.MM
○ yyyy.MM.dd
○ dd.MM.yyyy
○ MM.dd.yyyy
○ dd.yyyy.MM
○ MM.yyyy.dd
The following formats are supported for timeFormat:
○ HH:mm:ss.SSS
○ hh:mm:ss.SSS a
The following characters are supported as separators for dateFormat and
timeFormat:
○ period (.)
○ comma (,)
○ colon (:)

Copyright © 2012 Siemens AG. All Rights Date: 2013_08_26 Version: !ADR71_ArchiveTool!

Reserved _en_2013_08_26_08_54
Page 69 of 78

LKZ:DE AL:N ECCN:4E992

○ semicolon (;)
○ minus (-)
○ underscore (_)
○ backward slash (\)
○ forward slash (/)
○ blank ( )
If the provided value does not correspond to the abovementioned
SimpleDateFormat, the value for the dateFormat is set to yyyy.MM.dd and the
timeFormat to HH:mm:ss.SSS by default.
• maxRows: It defines the maximum number of rows in the output file. If -1 is entered
for this parameter, the output file is unlimited. By default the value for maxRows is
set to 65535.
• csvSeparatorArchiveData: It defines the separator which separates the columns
when archive data is exported into a CSV file. By default the value for this parameter
is semicolon (;).
• csvSeparatorEngLog: It defines the separator which separates the columns when
engineering logs are exported into a CSV file. By default the value for this parameter
is semicolon (;).
• csvCharEncoding: It defines which char encoding is used to write the output CSV
file. By default the value for this parameter is set to ANSI.
The following values for char encoding can be set:
○ ANSI
○ UTF-8
If a value other than the above two values is specified, then the default value
i.e. ANSI is taken.
• syncEventBeginning: If it is set to true, a sync event is written at the beginning of
the time period in the output file. By default it is set to false.
Example: Tag A has a value change to 50 at time 09:00. The next change is to 60 at
time 10:30. The time range for export is selected from 10:00 to 11:00 for Tag A:
○ When syncEventBeginning is set to False: The output file contains the
following one entry:
The value change to 60 at time 10:30.
○ When syncEventBeginning is set to True: The output file contains the
following two entries:
The sync event at time 10:00 with the value 50, and
The value change to 60 at time 10:30.
• syncEventEnd: If it is set to true, a sync event is written at the end of the time
period in the output file. By default it is set to false.
Example: Tag A has a value change to 50 at time 09:00. The next change is to 60 at
time 10:30. The time range for export is selected from 10:00 to 11:00 for Tag A:

Copyright © 2012 Siemens AG. All Rights Date: 2013_08_26 Version: !ADR71_ArchiveTool!

Reserved _en_2013_08_26_08_54
Page 70 of 78

LKZ:DE AL:N ECCN:4E992

○ When syncEventEnd is set to False: The output file contains the following
one entry:
The value change to 60 at time 10:30.
○ When syncEventEnd is set to True: The output file contains the following two
entries:
The value change to 60 at time 10:30, and
The sync event at time 11:00 with the value 60.
• syncEventBeforeBad: When it is set to an integer value other than 0, then a sync
event of that many milliseconds before a BAD quality code and BAD events (BNC and
BCE) is written in the output file. When it is set to 0, no sync event is written. By
default the value is set to 0.
Example: Tag A has a value change to 50 at time 09:00 of day 1. The next change
is to 60 at time 10:30 of day 2. The time range for export is selected from 08:00 day
1 to 11:00 day 2 for Tag A:
○ When syncEventBeforeBad is set to 0: The output file contains the following
two entries:
The value change to 50 at time 09:00 day 1.
The BAD event at 00:00 of day 2 with the value 0 because of the missing IDB
file.
○ When syncEventBeforeBad is set to 10: The output file contains the following
three entries:
The value change to 50 at time 09:00 day 1.
The sync event at 23:59:59.990 with the value 50.
The BAD event at 00:00 of day 2 with the value 0 because of the missing IDB
file.

An exception to this parameter is when a sync event occurs before a real


value change.

For example, if syncEventBeforeBad is set to 20 and in the IDB file, a


value change occurs 10ms before a BAD event. In this case,

○ A sync event would be written into the output file 20ms


before the BAD event.
○ Additionally, 10ms before the BAD event, the real value
change would be written and then the BAD event would be
written into the output file.

In this case, writing the sync event before a real value change would be of
no use. Therefore in such cases no sync event is written into the output
file.

Copyright © 2012 Siemens AG. All Rights Date: 2013_08_26 Version: !ADR71_ArchiveTool!

Reserved _en_2013_08_26_08_54
Page 71 of 78

LKZ:DE AL:N ECCN:4E992

• substitutionBadValue: If this parameter is empty, then:


For all BAD events generated by Archive Data Reader program, the value of BAD
events is written as 0 in the output file.
For all BAD events present in the IDB file, the value of the exported BAD events is
written in the output file as they are available in the IDB file.
By default this parameter is not set i.e. empty.
If substitutionBadValue is set to a numeric value, then all BAD values, whether they
are generated by Archive Data Reader program or read from the IDB file, are
substituted by the specified value.
Any numeric value is valid to set the parameter. Additionally, the string NaN (Not a
Number) is also allowed as value for the parameter. NaN is a numeric number but
has no specific value.
Similar to values with GOD quality code, the values with a BAD quality code are
written in a different way depending on the selected output format.
○ If the output file has HDF5 format, all BAD values are written as Float numbers
into the HDF5 file.
If NaN is set, then NaN is written into the HDF5 file as a numeric value.
○ If the output file has CSV format, all BAD values are written as String into the
CSV file.
If NaN is set, then NaN is written into the CSV file as a String.

The default values of the configuration parameters are used by Archive Data
Reader program if:

• No configuration file is available at:


ArchiveDataReader\config, Or
• The configuration file contains corrupt values.

Copyright © 2012 Siemens AG. All Rights Date: 2013_08_26 Version: !ADR71_ArchiveTool!

Reserved _en_2013_08_26_08_54
Page 72 of 78

LKZ:DE AL:N ECCN:4E992

3.7.3 Log File

The log file contains the export logs of Archive Data Reader program. The name of the log
file is ADRJobLog.log. It is located at: ArchiveDataReader\logging and can be opened with
a text editor.

When the maximum size of the log file is reached, the logs are written into a new log file.
When the maximum count of the log file is reached, the oldest log file is replaced by the new
log file. The maximum size and count of the log file can be adjusted using the log4j
configuration file.

If the log4j file is not available, no logs are written into the log file.

Error Logging

Following errors are written into the log file:

• The errors that occur during the process of Archive Data Reader program, whether
in GUI or batch mode, are written into the log file. Errors in GUI mode which are
displayed via message box, are not written into the log file.
• During IDB file selection in GUI, when a folder is selected and within that folder, an
IDB file is missing in between the first and the last IDB file, an entry is written into
the log file. An entry in log file is also made for such missing IDB files in batch mode.
For each missing IDB file one entry is made in the log file.
• In batch mode if the defined output file is already available, a suffix is added to the
output file name. The suffix counts up to 999. When an output file with the suffix 999
is already available, the batch mode exits. In this case, no further file is created. An
entry is written into the log file.

Event Logging

When the Archive Data Reader program is run, the following events are written into the log
file:

• The start time of the program.


• The output file name.
• The generation time of the output file.
• All used parameter values.
• Additionally, the export setting file being used, if the program is run in batch mode.

Copyright © 2012 Siemens AG. All Rights Date: 2013_08_26 Version: !ADR71_ArchiveTool!

Reserved _en_2013_08_26_08_54
Page 73 of 78

LKZ:DE AL:N ECCN:4E992

3.7.4 Log4j Configuration File

The Log4j configuration file contains the logging configuration such as the parameter settings
for the log file. The name of the log4j file is ArchiveDataReaderLog4j. It is located at:
ArchiveDataReader\config and can be opened with a text editor. The settings for log file in
the log4j file may be edited, if required.

The following parameters for the ADRJobLog.log log file are available in the log4j config file:

• MaxFileSize: It defines the maximum size of the log file. By default it is set to 1MB.
When the maximum log file size is reached, logs are automatically written into a new
log file.
• MaxBackupIndex: It is the count of the log file. When the maximum count of the log
file is reached, the oldest log file is replaced by the new log file.

If the log4j file is not available, no logs are written into the log file.

Copyright © 2012 Siemens AG. All Rights Date: 2013_08_26 Version: !ADR71_ArchiveTool!

Reserved _en_2013_08_26_08_54
Page 74 of 78

LKZ:DE AL:N ECCN:4E992

4 Glossary

Alarm

An Alarm is a message that informs the plant staff about abnormal events or conditions in the
plant (process alarms) or about malfunctions in the I&C system (system alarms).

Application Server

An Application Server is a server that manages the I&C data for a project, and provides all
the engineering and operation services.

Automation Server

An Automation Server is a server that is connected to IO interfaces, and performs Realtime


automation tasks.

BAD

The BAD quality code indicates that the value is bad with a no-specific reason.

BCE

The BCE quality code indicates a bad value due to a configuration error.

BNC

The BNC quality code indicates that the value is bad because it is not connected to a data
source.

Bytes

Bytes is a system specific data format consisting of a linear array of byte elements.

CLI

A Command Line Interface is an interface in which the user types in commands.

Copyright © 2012 Siemens AG. All Rights Date: 2013_08_26 Version: !ADR71_ArchiveTool!

Reserved _en_2013_08_26_08_54
Page 75 of 78

LKZ:DE AL:N ECCN:4E992

Command Line Interface

A Command Line Interface is an interface in which the user types in commands.

DVD

A Digital Versatile Disk (DVD) is an optical disk used to store data.

float

A Floating Point Number (float) is a number expressed as a mantissa and exponent (e.g.
3.456 E2 which equals 345.6).

Floating Point Number

A Floating Point Number (float) is a number expressed as a mantissa and exponent (e.g.
3.456 E2 which equals 345.6).

GOD

The GOD quality code indicates that the value is good.

Graphic User Interface

A Graphical User Interface (GUI) is a graphics based user interface that incorporates icons,
pull-down menus and a mouse.

GUI

A Graphical User Interface (GUI) is a graphics based user interface that incorporates icons,
pull-down menus and a mouse.

HDF5

HDF5 is a data model, library and file format for storing and managing large amounts of
complex data. The file structure of HDF5 includes 2 major types of objects i.e. Datasets and
Groups.

Copyright © 2012 Siemens AG. All Rights Date: 2013_08_26 Version: !ADR71_ArchiveTool!

Reserved _en_2013_08_26_08_54
Page 76 of 78

LKZ:DE AL:N ECCN:4E992

I&C

Instrumentation and Control

ID

An Identification Number (ID) is a unique alphanumerical identifier in the system.

int

An Integer (int) is a whole number which contains no fractional component.

Integer

An Integer (int) is a whole number which contains no fractional component.

NAS

Network Attached Storage Device

scp

secure copy

SOE

Sequence of Events

ssh

secure shell

ssh/scp

secure shell/secure copy

Copyright © 2012 Siemens AG. All Rights Date: 2013_08_26 Version: !ADR71_ArchiveTool!

Reserved _en_2013_08_26_08_54
Page 77 of 78

LKZ:DE AL:N ECCN:4E992

Swap Server

A Swap Server is a Thin Client equipped with a DVD drive which is used for transferring
archive data to or from DVDs.

ULV

The ULV quality code indicates that the value is uncertain and the last useable value is held.

UNC

The UNC quality code indicates an uncertain value since a substitute value is used.

URL

A Uniform Resource Locator (URL) is an address with a special format, which is used in the
address field of a Web Browser to access web pages.

Work Area

The Work Area is a Frame in a window or view that the user works in.

Copyright © 2012 Siemens AG. All Rights Date: 2013_08_26 Version: !ADR71_ArchiveTool!

Reserved _en_2013_08_26_08_54
Page 78 of 78

LKZ:DE AL:N ECCN:4E992

Copyright © 2012 Siemens AG. All Rights Date: 2013_08_26 Version: !ADR71_ArchiveTool!

Reserved _en_2013_08_26_08_54

You might also like