SPPA-T3000 User Guide

Documenation User Guide (1/1)

 Documenation User Guide (1/1) Page: 2 of 18
LKZ:DE AL:N ECCN:4E992

Documenation User Guide

SPPA-T3000 USER GUIDE .............................................................................................................................................. 1

1 DOCUMENTATION WINDOWS............................................................................................................. 6

1.1 Navigation Frame .................................................................................................................................. 6

1.2 Content Frame ....................................................................................................................................... 6

2 DOCUMENTATION FEATURES............................................................................................................ 8

2.1 Fonts and their Meanings..................................................................................................................... 8

2.2 Icons and their Meanings ..................................................................................................................... 8

3 ONLINE HELP ...................................................................................................................................... 11

3.1 Online Help Search ............................................................................................................................. 11

3.2 Short Help ............................................................................................................................................ 12

3.2.1 Single Choice ........................................................................................................................................ 14
3.2.2 Multiple Choice ...................................................................................................................................... 14

4 HTML HELP .......................................................................................................................................... 16

4.1 HTML Help Search............................................................................................................................... 16

Copyright © Siemens AG 2005 Version:

All Rights Reserved Date: 2008_01_29 rel_4.40_en_2008_01_28_17_45
 Documenation User Guide (1/1) Page: 3 of 18
LKZ:DE AL:N ECCN:4E992

WELCOME TO THE SPPA-T3000 USER GUIDE

Documentation Version

rel_4.40_en_2008_01_28_17_45

Publication

2008_01_29

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 © Siemens AG 2005 All Rights Reserved

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

SIMATIC© is a registered trademark of Siemens AG.

Embedded Component Services© is a registered trademark of Siemens AG.

Copyright © Siemens AG 2005 Version:

All Rights Reserved Date: 2008_01_29 rel_4.40_en_2008_01_28_17_45
 Documenation User Guide (1/1) Page: 4 of 18
LKZ:DE AL:N ECCN:4E992

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

OLE for Process Control (OPC) is a set of connectivity standards for industrial automation from the OPC Foundation.

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

ILOG Jviews © 1987-2007 ILOG S.A. - All rights reserved.

Java Runtime Environment © 2006 Sun Microsystems, Inc. All Rights Reserved.
http://java.sun.com/javase/6/docs/legal/license.html
Software Development Kit © 2003 Sun Microsystems, Inc. All Rights Reserved.
http://java.sun.com/j2se/1.4.2/docs/relnotes/license.html
Java Plug-in © 2006 Sun Microsystems, Inc. All Rights Reserved. http://java.sun.com/javase/6/docs/legal/license.html
JavaHelp © 2006 Sun Microsystems, Inc. All Rights Reserved. http://java.sun.com/javase/6/docs/legal/license.html
Apache HTTP Server © 2006 The Apache Software Foundation http://www.apache.org/licenses/LICENSE-2.0.html
Apache Tomcat © 1999-2007 The Apache Software Foundation. http://www.apache.org/licenses/LICENSE-2.0.html
Log4j © 2007 The Apache Software Foundation. http://www.apache.org/licenses/LICENSE-2.0.html
Jakarta POI © 2002-2003 The Apache Software Foundation. http://poi.apache.org/legal.html
Jakarta Commons © 2001-2007 The Apache Software Foundation. http://commons.apache.org/license.html
NTP © 1992-2007 David L. Mills. http://www.eecis.udel.edu/~mills/ntp/html/copyright.html
FLEXlm Java © 2002-2007 Macrovision Corporation. All rights reserved.
MySQL database © 1995-2004 MySQL AB. All rights reserved.
MySQL Connector/J © 1995-2004 MySQL AB. All rights reserved.
JasperReports © 2001-2003 Teodor Danciu (teodord@hotmail.com). All rights reserved.
http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html
JasperPal © 2003 H.S.Chin (hschin@users.sourceforge.net). http://jasperpal.sourceforge.net/license.html
JCalendar © 1999-2006 Kai Toedter. http://www.toedter.com/en/jcalendar/
Visual Automation © 2004-2006 Systems Automation & Management. http://www.sam.co.za/
Windows RSH daemon © 1989, 1991 Free Software Foundation, Inc. http://www.gnu.org/licenses/gpl-2.0.html#TOC1
PuTTY © 1997-2007 Simon Tatham. http://www.chiark.greenend.org.uk/~sgtatham/putty/licence.html
PHP © 1999-2002 The PHP Group. All rights reserved.
Zend Optimizer © 1999-2007 Zend Technologies Ltd. All rights reserved.
http://www.zend.com/de/products/zend_optimizer/license_agreement
Cygwin DLL and utilities are Copyright © 2000, 2001,2002, 2003, 2004, 2005, 2006, 2007 Red Hat, Inc. Other
packages have other copyrights. http://cygwin.com/licensing.html
iText © 2002 Paulo Soares. http://www.mozilla.org/MPL/MPL-1.1.html
BeanShell © 2000 Pat Niemeyer. All rights reserved. http://www.beanshell.org/license.html
RXTX © 1997-2004 Trent Jarvi taj@www.linux.org.uk http://users.frii.com/jarvi/rxtx/license.html
SNMP stack © 2000-2006 Westhawk Ltd. http://snmp.westhawk.co.uk/StackUsage.html

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.

Export Control Classification

LKZ:DE AL:N ECCN:4E992

Copyright © Siemens AG 2005 Version:

All Rights Reserved Date: 2008_01_29 rel_4.40_en_2008_01_28_17_45
 Documenation User Guide (1/1) Page: 5 of 18
LKZ:DE AL:N ECCN:4E992

DOCUMENTATION USER GUIDE

The general structure and characteristics of the SPPA-T3000 documentation are described in the Documentation User
Guide.

General Items

The practice of the User Guide is to describe each topic within SPPA-T3000 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 phrases and acronyms. The Equipment Catalog for external documentation completes the
documentation.

The Appearance of the Documentation

The on-screen version of the SPPA-T3000 documentation has two appearances:

• the Online Help, called up in SPPA-T3000 as context sensitive assistance

• the HTML Help, readable with a standard Web Browser.

The main contents of both versions are the same. The difference is in the way the information is accessed and the
form of the presentation.

The Structure of the Documentation

The SPPA-T3000 documentation includes the following sections:

• Documentation User Guide

• Engineering User Guide
• Operation User Guide
• The Library with the Automation Functions, Hardware Proxies and Management Proxies.
• Diagnostic System
• System Management
• Connectivity Products
• Add-Ons (if installed)
• Glossary

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

Copyright © Siemens AG 2005 Version:

All Rights Reserved Date: 2008_01_29 rel_4.40_en_2008_01_28_17_45
 Documenation User Guide (1/1) Page: 6 of 18
LKZ:DE AL:N ECCN:4E992

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 SPPA-T3000 User Guide. Scrolling within the Content
Frame is supported.

1.1 Navigation Frame

The Navigation Frame offers the ability to find and select information within the SPPA-T3000 User Guide. The Table of
Contents can be expanded and collapsed to Navigate through the documentation. The Full Text Search allows the
search for specific words. Toggle between the two functions via the icons in the header.

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.

Full Text Search

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. The
specific handling of the Full Text Search differs between the Online Help Search or HTML Help Search.

1.2 Content Frame

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

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

Getting Started

Some sections of the User Guide are prefaced with an introduction section. Within this section, the user is given an
example to aid them in becoming familiar with SPPA-T3000.

Since the Getting Started sections are only a short introduction, there are some limitations when compared to the Main
Information:

• Because only an overview of SPPA-T3000 is given, all links are self contained within the Getting Started. In
this way the user remains within the basic information topics that are appropriate for an introduction to the
system.
• No external link will navigate into the Getting Started section.

Copyright © Siemens AG 2005 Version:

All Rights Reserved Date: 2008_01_29 rel_4.40_en_2008_01_28_17_45
 Documenation User Guide (1/1) Page: 7 of 18
LKZ:DE AL:N ECCN:4E992

Main Information

Main information presents the SPPA-T3000 subjects 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 © Siemens AG 2005 Version:

All Rights Reserved Date: 2008_01_29 rel_4.40_en_2008_01_28_17_45
 Documenation User Guide (1/1) Page: 8 of 18
LKZ:DE AL:N ECCN:4E992

2 Documentation Features
Additional guiding information is given in the text using:

• specific Typography of distinguished Fonts,

• Icons with standardized meaning.

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

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

2.2 Icons and their Meanings

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

Copyright © Siemens AG 2005 Version:

All Rights Reserved Date: 2008_01_29 rel_4.40_en_2008_01_28_17_45
 Documenation User Guide (1/1) Page: 9 of 18
LKZ:DE AL:N ECCN:4E992

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 on how to work more efficiently or to provide an alternative approach to an action.

ESD

The component is an Electrostatically Sensitive Device. 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 © Siemens AG 2005 Version:

All Rights Reserved Date: 2008_01_29 rel_4.40_en_2008_01_28_17_45
 Documenation User Guide (1/1) Page: 10 of 18
LKZ:DE AL:N ECCN:4E992

Thumbnail Clicking a thumbnail

will return the picture to its
original size.

Copyright © Siemens AG 2005 Version:

All Rights Reserved Date: 2008_01_29 rel_4.40_en_2008_01_28_17_45
 Documenation User Guide (1/1) Page: 11 of 18
LKZ:DE AL:N ECCN:4E992

3 Online Help
The SPPA-T3000 User Guide can be accessed in the Workbench as a context sensitive help (Short Help) or directly
using the Help menu. The SPPA-T3000 Online Help is divided into two levels:

• Short Help, a brief overview information of the item, accessed contextually using the F1 key.
• Main Help, the complete description of the topic.

The switch from the Short Help to the Main Help occurs by clicking on the detail button at the bottom of the Short
Help window:

There are specific rules for searching in the Online Help version of the User Guide.

3.1 Online Help Search

The Online Help search is used to perform a full text search of the help topics. One or more search terms can be
combined in a natural language search. The results are ranked according to two factors:

The circle in front of the results indicates the degree of matching for that topic to the search. The more filled-in the
circle is, the higher the ranking:

The number following the circle indicates the number of times the search text was matched in the topic.

The Online Help search engine performs several techniques to find and rank results:

Relaxation Ranking where words can appear different than that of the search order.

Morphing where similar words are returned for a common search term (e.g. built and build).

Copyright © Siemens AG 2005 Version:

All Rights Reserved Date: 2008_01_29 rel_4.40_en_2008_01_28_17_45
 Documenation User Guide (1/1) Page: 12 of 18
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 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.

3.2 Short Help

Short Help information is available for:

• Menu items.
• Dialog boxes which require user input.
• Workbench views and editors.

Short Help information is context sensitive. The help information topic is called up for the action that the user is
specifically faced with.

How to Access Short Help

The user is working in the system.

1. One of the following conditions is present:

o A menu item is highlighted, but not yet clicked.

Copyright © Siemens AG 2005 Version:

All Rights Reserved Date: 2008_01_29 rel_4.40_en_2008_01_28_17_45
 Documenation User Guide (1/1) Page: 13 of 18
LKZ:DE AL:N ECCN:4E992

This does not apply to intermediate menu items (i.e. those which lead to further menus).
o A dialog box is open that requires user input.

o A view or editor is open.

2. Press the F1 key.

Copyright © Siemens AG 2005 Version:

All Rights Reserved Date: 2008_01_29 rel_4.40_en_2008_01_28_17_45
 Documenation User Guide (1/1) Page: 14 of 18
LKZ:DE AL:N ECCN:4E992

The Short Help will appear in a new window. Depending on the function this will be either a single or multiple choice
Short Help.

3.2.1 Single Choice

Normally single items (e.g. menu items or dialog boxes) in the Workbench correspond to single topics in the SPPA-
T3000 User Guide. For these items a Short Help is available containing:

• brief information about that item, or

• a sequence of instructions to execute the item.

The sequence of instructions is structured into

• the status information, which shows the requirements needed to start the operation sequence or the result
at the end of the sequence
• the instructions in order.

Additional hints or warnings may be included.

The Project View is open.

1 Select a Library Node in the Tree View or List View.

2 Menu: Project > New > Library Node
A new Node is created under the selected parent Node called DefaultName.

3 Rename the new Library Node

Alternatively select the function via the context menu (Right Mouse Click > Create New
Library Node ).

3.2.2 Multiple Choice

Sometimes single items (e.g. menu items) in the Workbench correspond to a number of topics in the SPPA-T3000
User Guide. In this case, the context help takes the user to a Multiple Choice Short Help selection table.

Selecting the link redirects the user to the single choice Short Help.

To go further click on one of the options below:

To Rename a Node in the Tree View
a Node in the List View when the Nodes are represented as symbols
a Node in the List View when the Nodes are represented in a list
a diagram in the Tree View
a diagram in the List View when the diagrams are represented as symbols
a diagram in the List View when the diagrams are represented in a list

Copyright © Siemens AG 2005 Version:

All Rights Reserved Date: 2008_01_29 rel_4.40_en_2008_01_28_17_45
 Documenation User Guide (1/1) Page: 15 of 18
LKZ:DE AL:N ECCN:4E992

The Main Help button performs no action in this window.

Copyright © Siemens AG 2005 Version:

All Rights Reserved Date: 2008_01_29 rel_4.40_en_2008_01_28_17_45
 Documenation User Guide (1/1) Page: 16 of 18
LKZ:DE AL:N ECCN:4E992

4 HTML Help
The SPPA-T3000 User Guide can be accessed separately from the Workbench as an HTML version that is viewable in
a standard Web Browser. Unlike the Online Help version, the SPPA-T3000 HTML Help does not include Short Help.

There are specific rules for searching in the HTML Help version of the User Guide.

4.1 HTML Help Search

The HTML Help search is used to perform a full text search of the help topics. One or more search terms can be
combined using the and or or operator.

If searching for multiple words, the and 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 is selected then all documents containing any of the search words will be located. The or searches will be sorted
by search word:

Copyright © Siemens AG 2005 Version:

All Rights Reserved Date: 2008_01_29 rel_4.40_en_2008_01_28_17_45
 Documenation User Guide (1/1) Page: 17 of 18
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.

Copyright © Siemens AG 2005 Version:

All Rights Reserved Date: 2008_01_29 rel_4.40_en_2008_01_28_17_45
 Documenation User Guide (1/1) Page: 18 of 18
LKZ:DE AL:N ECCN:4E992

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 © Siemens AG 2005 Version:

All Rights Reserved Date: 2008_01_29 rel_4.40_en_2008_01_28_17_45