Professional Documents
Culture Documents
ALSTOM
Table Of Contents
Introduction................................................................................................................. 4
Legal........................................................................................................................... 5
Basic Technology ....................................................................................................... 6
Basic Functions .......................................................................................................... 6
Definitions................................................................................................................... 7
Matrix Structure....................................................................................................... 7
Icons ....................................................................................................................... 9
Property supported Document Search.................................................................. 11
Navigation-guided Document Search ................................................................... 12
Use Cases ................................................................................................................ 13
Change the Language of the Application .............................................................. 13
Log on to the system............................................................................................. 13
Change the view of the search results .................................................................. 14
Search Documents via Properties......................................................................... 15
Search Documents via its Properties .................................................................... 16
Search Documents via KKS/IS ............................................................................. 16
Search Documents via Subject ............................................................................. 17
Restrict Search in Search Results ........................................................................ 18
Filter the Navigation .............................................................................................. 19
To Provide Feedback ............................................................................................ 19
Save a reoccurring Document Search .................................................................. 21
Frames ..................................................................................................................... 22
Document Display................................................................................................. 22
Navigation via ....................................................................................................... 23
Search Result ....................................................................................................... 24
Quick Search ........................................................................................................ 25
Quick Search ........................................................................................................ 25
Submenus............................................................................................................. 26
Settings ............................................................................................................. 26
Info .................................................................................................................... 28
Feedback........................................................................................................... 29
Structure Filter................................................................................................... 32
Search ............................................................................................................... 33
Installation ................................................................................................................ 35
Glossary ................................................................................................................... 37
Application language ......................................................................................... 37
Arrangement plans ............................................................................................ 37
Components ...................................................................................................... 37
Corrective Maintenance..................................................................................... 37
DecO&M Manualissioning ................................................................................. 37
Description of the systems and units ................................................................ 38
Description of the system and the equipment................................................... 38
Description of the system .................................................................................. 38
Function test and tests of the protective devices during operation ................... 39
General maintenance documents..................................................................... 39
Interlocks ........................................................................................................... 39
Maintenance (preventive measures) ................................................................ 39
Maintenance lists............................................................................................... 40
Page 2 of 43
ABCD O&M Manual Viewer Help
Page 3 of 43
ABCD O&M Manual Viewer Help
Introduction
This help allows you to find the most important information you need
when working with the ALSTOM O&M Manual Viewer.
Basic functions of The ALSTOM O&M Manual Viewer has the following basic functions:
the ALSTOM O&M
Manual Viewer • Navigation-guided document search
• Property-supported document search
• Displaying, exporting, and printing documents
• Feedback from comments
Contacting Should you encounter problems using the ALSTOM O&M MANUAL
ALSTOM Viewer, please send an e-mail to the following address:
om_manuals@power.alstom.com
Include a brief description of the problem you are experiencing (if possible
include screen shots).
Entry points for the The program window of the ALSTOM O&M Manual Viewer consists of the
online help following frames:
Quick search
Navigation via
Search result
Document display
Menu bar
Calling up the There is a specific entry point for the help in each frame that you can
online help
call up by clicking the icon in the frame.
Page 4 of 43
ABCD O&M Manual Viewer Help
Legal
Copyright / The contents and design of the ALSTOM O&M Manuals as well as the
Reservation of ALSTOM O&M Manual Viewer are the property of ALSTOM.
proprietary rights
Science and If the instructions in the O&M Manuals appear to contradict the
technology established rules of science and technology, or if there are residual
dangers of unknown and undocumented origin, you are asked to notify
ALSTOM immediately in writing and request clarification.
Feedback Please use the basic function "Feedback" for this purpose.
Changes to the Changes to the equipment of the plant or its system are only permitted if
equipment they have been expressly approved by ALSTOM.
Product liability If you make changes to the plant equipment by installing components or
parts that do not meet the technical specifications, you alone will be liable
for the product and any consequential damages caused in other
components or systems.
Due diligence You must strictly observe the instructions in the O&M Manuals.
Responsibility The manuals must be consulted before you carry out any task, regardless of
the operating state of the plant or system in question.
The personnel in charge in the power plant are solely responsible for this.
Page 5 of 43
ABCD O&M Manual Viewer Help
Safety regulations See the topic "Safety regulations..." in the O&M manuals.
Basic Technology
No additional The ALSTOM O&M Manual Viewer works on your standard browser.
browser necessary You therefore do not need to install another browser.
Editable files Should you need the editable original formats of the documents,
please contact ALSTOM.
Basic Functions
• Displaying,
• Exporting,
• Printing
ADOBE Acrobat The integrated functionality is similar to the ADOBE Acrobat Reader.
Page 6 of 43
ABCD O&M Manual Viewer Help
Definitions
Matrix Structure
• Function
• Subject
Each document is assigned to at least one function and one subject.
Functional The functional structure consists of at least three levels whose contents are defined as
Structure follows:
Examples:
KKS Name
L Water/steam cycle
M Main machine blocks
Examples:
KKS Name
LA Feed water system
LB Main steam system
LC Condensate system
Examples:
KKS Name
LAA10 Feed water tank and degasser
4. Further levels
Provided this is useful, the levels for a deeper functional structure are adopted
by the supplier of the package.
Page 7 of 43
ABCD O&M Manual Viewer Help
Subject The subject structure of the O&M MANUAL consists of a maximum of 3 levels. The
structure necessary
life-cycle phases are embedded as the foundation.
Subject level 1 Subject level 2 Subject level 3 Note
Operating manual Regulations for -
operation pertaining
to the environment,
safety, and health
Operation Specification of
the operating
materials
Preparing for
operation
Start-up
Operation
Shutdown
Special operating
states
Description of the -
unit and the
equipment
General -
maintenance
documents
Maintenance -
(precautionary
measures)
Corrective -
Maintenance
Shutdown -
procedure
Packaging, -
transport, and
disposal
Components - Descriptions,
datasheets, and
information on
replacement parts
Technical Arrangement -
documentation diagrams
Description of the - As "bullet"
systems and units information taken
from operating and
maintenance
manuals
Operating lists -
Maintenance lists -
Cabling manuals -
Page 8 of 43
ABCD O&M Manual Viewer Help
Icons
Introduction This chapter lists the most important icons and provides a brief explanation of what they
mean.
Icons
Icon Name Function
Help
Opens the frame-specific help.
function
Expands
the
Opens the contents of the structure element.
structure
element
Collapses
the
Ends the displays of the contents of a structure element.
structure
element
Structure
End point of a structure branch.
element
Properties
Displays the properties of a document.
display
Displays a
Display the document as a PDF.
document
Displays the functional assignment of the selected document in the
frame "Navigation via".
Picture: Icons
Display
structure
Page 9 of 43
ABCD O&M Manual Viewer Help
Page 10 of 43
ABCD O&M Manual Viewer Help
Page 11 of 43
ABCD O&M Manual Viewer Help
Page 12 of 43
ABCD O&M Manual Viewer Help
Use Cases
Assumption / You want to change the language of the graphic user interface.
Starting situation
Assumption You want to log on to the system as a specific user so that you can save user-
/ Starting specific Settings so that you can use them over and over again.
situation
Page 13 of 43
ABCD O&M Manual Viewer Help
Result You are now known to the application as a specific user, and your settings will
be assigned to this user.
When you restart the application, your preferred settings will be loaded
automatically.
Result The properties displayed for the search results were saved.
If you now start a new search, the result will be displayed with the new
settings.
Good to know To open a document, click the first selected attribute or the document
title.
Both fields contain a link to the PDF file.
Page 14 of 43
ABCD O&M Manual Viewer Help
Assumption / You want to find documents of which you know one or more Properties.
Starting situation
Result The documents found in the search are displayed in the frame Search result.
Good to know If the search terms do not meet your needs, you can delete them with "Reset".
A search for several properties at simultaneously means that all conditions must be
fulfilled ("AND" operator).
For the properties "Supplier" and "Manufacturer" you can search for 2 different values
("OR" operator).
Page 15 of 43
ABCD O&M Manual Viewer Help
Assumption / You want to find all the documents of which you know the related
Starting situation function or the related location in the power plant.
Alternative:
1. Go to the frame "Navigation via".
2. Select "Function" from the list box.
A list of all the functions available appears in the drop-down list
box.
3. Now navigate through this Structure to the desired location.
4. Click the respective red marked structure element.
Result The documents found of the function are displayed in the frame
"Search result".
Assumption / You want to find documents of which you know the respective
Starting situation property "KKS/IS".
Alternative
1. Go to the frame "Navigation".
2. Select "KKS/IS" from the list box.
3. Click "OK" to confirm your selection.
A list of all the KKS/IS items available in the documentation
appears in the drop-down list box.
4. Now navigate through this Structure to the desired KKS/IS
position.
Page 16 of 43
ABCD O&M Manual Viewer Help
Result The documents found for the corresponding KKS items are displayed
in the frame "Search result".
Assumption / You want to find all the documents that contain a particular Subject
Starting situation that you know.
Alternative
1. Go to the frame "Navigation“,
2. Select the term "Subject" from the list box.
3. Click "OK" to confirm your selection.
A list of all subjects available in the documentation appears in
the drop-down list box.
4. Now navigate through this structure to the desired subject;
restrict the search further to the desired function.
Result The documents found for the corresponding subject are displayed in
the frame "Search result".
Page 17 of 43
ABCD O&M Manual Viewer Help
Assumption / You have carried out a search and want to further restrict the search
Starting situation criteria.
Result A search result now appears that fulfills the criteria of the initial search
and the restricted search.
Good to know You can further restrict the search result by conducting an additional
restricted search.
The restricted search always only searches in the documents already
found. Thus if you want to restrict the search using a different
criterion, you must restart the search.
You can also restrict a search with a saved search (see "Recurring
document search").
Assumption / You would like to change the Settings to your personal tastes.
Starting situation
Good to know Once you log back on, the viewer will respond in accordance to the
values last saved.
Page 18 of 43
ABCD O&M Manual Viewer Help
Assumption / You want to filter the Navigation according to your personal criteria.
Starting situation
Result The desired structure will be displayed in the frame "Navigation via".
It will only display those Structure elements that contain documents
and match the criteria you have entered.
To Provide Feedback
3. On a structure element
4. On a project document
Page 19 of 43
ABCD O&M Manual Viewer Help
Page 20 of 43
7. The feedback messages are assigned to the respective categories.
By clicking the respective entry, you open the following list:
ABCD O&M Manual Viewer Help
Assumption / You want to save a document search that you need time and time
Starting situation again.
To do this, a Search result must already exist, and you must be
known to the system as a specific user (see "Log on").
Good to know If you want to delete one or more search queries, do this in the form
"Settings":
Page 21 of 43
ABCD O&M Manual Viewer Help
Frames
Document Display
Purpose In the Frame "Document display" the contents of a document are displayed.
Tools used The document is displayed as a PDF file by the Adobe Acrobat Reader®
Application Only the entries under the columns "Number" and "Title" have
hyperlinks.
Good to You now have the full functionality of the Adobe Acrobat reader® in the frame
know "Document display".
You can size the frame as you like to make the document easier to read.
Page 22 of 43
ABCD O&M Manual Viewer Help
Navigation via
Purpose With the Frame "Navigation via ", you can find information using hierarchical structures
Navigation • Function
via... • Subject
• KKS
Starting The frame is located on the left side of the user interface.
the search
Picture: Navigation via
Page 23 of 43
ABCD O&M Manual Viewer Help
Good to Clicking the text (will be highlighted in red when you pass over it with the mouse pointer),
know displays the contents of the structure element in the "Search result".
Application
cases
Restricting navigation
Search Result
Purpose
In the Frame "Search result" all documents (structure element and project document) that fulfil
the criteria specified are displayed in a list.
Starting A search result is always generated if documents are found by means of a quick search,
the search Navigation or with a (general) query, which fulfil the criteria you entered.
Page 24 of 43
ABCD O&M Manual Viewer Help
Application To use the search results, find the following application case:
cases
Restricting search results
Quick Search
Purpose If you only know keywords for a search, without knowing if these are Properties, you
will find documents very easily via the quick search.
Starting The Frame "Quick search" is located in the upper left corner of the ALSTOM O&M
the search Manual Viewer.
The search is now carried out in all properties and in the full-text index.
If you want to limit the search for properties, click "Only in properties".
Page 25 of 43
ABCD O&M Manual Viewer Help
Submenus
Settings
Purpose You define values for displaying and showing search results under Settings.
Picture: Settings
Page 26 of 43
ABCD O&M Manual Viewer Help
Good to
know Once you have created your specific settings, you can then only save them after
you have created a user (this is you).
The personal settings are activated automatically the next time you log on to the
Viewer.
Page 27 of 43
ABCD O&M Manual Viewer Help
Info
Purpose All the plug-ins used and the status of the program environment can be
viewed in the "Info" menu.
Starting
the info Picture: Starting Info
Picture: Info
Good to The Internet addresses are active By clicking the HTTP entries you activate your
know Internet browser.
Page 28 of 43
ABCD O&M Manual Viewer Help
Feedback
Purpose Via the menu "Feedback" you can send your cO&M Manualents on the O&M
MANUAL Viewer, on the documentation in general, on the individual structure
elements as well as on the project documents to ALSTOM.
Starting The menu "Feedback" for documentation (in general) and application is
feedback on located here:
documentatio
n and
application Picture: Feedback
Picture: Feedback
Page 29 of 43
ABCD O&M Manual Viewer Help
Page 30 of 43
ABCD O&M Manual Viewer Help
Good to know Structure elements differ from project documents in that they do not have any
entries in the "Document number" column.
Page 31 of 43
ABCD O&M Manual Viewer Help
Structure Filter
Purpose Under the entry "Structure filter" you can restrict your search to a property from the very
beginning.
Starting Click the menu item "Structure filter" to open the respective frame:
the
search
Picture: Structure filter
Effect Afterwards, all Structure elements in the frame "Navigation via..." are only displayed is
on other they fulfil the criteria you have set.
frames
Page 32 of 43
ABCD O&M Manual Viewer Help
Search
Purpose Under the menu command "Search" you can search for documents in addition to
searching
via "Quick search and "Navigation via..." via Properties.
Picture: Search
Page 33 of 43
ABCD O&M Manual Viewer Help
Application The ALSTOM O&M Manual Viewer differentiates between "Structure element" and
"Project document".
Page 34 of 43
ABCD O&M Manual Viewer Help
Installation
Client and server Both client and the server are installed on the personal host of the user;
on one Host (all the documents are copied onto the same host according to the
data on a hard installation instructions.
disk)
Advantages There is no need to exchange data media for
different documents.
Work with the Viewer is independent from the
location.
Completion of After the installation, you will find the following shortcuts on your Desktop:
installation
Picture: Start
Server By clicking this icon, you start the locally
installed server.
Picture: Stop
Server By clicking this icon, you start the locally
installed server.
Page 35 of 43
ABCD O&M Manual Viewer Help
Picture: O&M
Manual Viewer By clicking this icon, you start the local client,
i.e. the ALSTOM O&M Manual Viewer.
Client and server The client installation will be carried out over a network for all users at
on different hosts the same time.
Details For further installation information, see the installation directions located
in the "root directory" of CD 1 of your set of data media.
Page 36 of 43
ABCD O&M Manual Viewer Help
Glossary
A
Application case
An application case is a predefined procedure that can be based on the
basic functions of the viewer.
Application language
The language of the application refers to the language that appears in
the menus and in the messages.
Arrangement plans
The subject "Arrangement plans" contains the following information:
• Dimension of buildings
• Representation of where components are placed in relation to each
other as well as within the building.
Caution: Cross sectional views and installation diagrams of components
are located under the heading "General Maintenance Documents".
B
Browser
The browser is the central element of the ALSTOM O&M Manual
Viewer.
C
Client
Physical speaking, a client is a user who accesses an application on a
server.
Components
Components are parts that are used either individually or preassembled
in a unit, a module, or a block.
The manufacturer is responsible for the component and also
documenting it.
A component description contains all the information pertaining to the
life cycles of the component.
However, component descriptions are assigned exclusively to the
subject "Components".
Corrective Maintenance
The subject "Corrective Maintenance" contains the required information
with the following objectives:
• Identifying the cause of malfunctions
• Eliminating malfunctions
• Restoring the normal operating state
Decommissioning
The subject of "Decommissioning" contains the information required for
the following goals:
• Preparing or equipping a system for storage
• Required maintenance tasks to be performed during storage
Page 37 of 43
ABCD O&M Manual Viewer Help
Description of the
systems and units
The subject "Description of the systems and units" combines the
contents from Description of the system and the equipment and
Description of the unit and the equipment.
All information is corrected after commissioning and stored in the status
"As constructed".
Description of the
system and the equipment
The subject "Description of the system and the equipment" familiarizes
the operator with the design and the function of the equipment and a
unit, a module or a block.
E
Entry point
An entry point is a predefined starting point for a frame-specific help.
F
Feedback
Feedback is a basic function of the viewer. This function puts you in
the position as a user to direct questions and comments pertaining to
the documents and viewer to ALSTOM.
Form
Each data entry in the menu bar is defined by a form. Forms are used
to standardize entries and results.
Frame
A frame is logic area related to specific activities in the application.
Full-text index
A full-text index is a directory of keywords that is accessed during a
quick search or a full-text search.
Function
A function is a synonym for a power plant function or for a structure
element.
Page 38 of 43
ABCD O&M Manual Viewer Help
General maintenance
documents
The subject "General maintenance documents" contain general
information which is useful for carrying out routine maintenance
H
Host
The term 'host' is used here as a synonym for a personal computer,
regardless if it is in a network or not.
I
Info
Info is a menu command and contains a list of links to the
manufacturers of the most important plug-ins for the O&M Manual
Viewer
Interlocks
The subject "Interlocks" contains a description of the operating
procedures of "protective and monitoring devices".
IS
IS is an abbreviation for identification system.
K
Keyword
Keyword is a synonym for a search query.
KKS
KKS is an abbreviation and stands for power plant designation system.
Maintenance
(preventive measures)
The subject "Maintenance (preventive measures)" contains information
and instructions with the following goals:
• Maintaining the designed state and the availability of the plant or
a system.
• Increasing the efficiency of the plant or a system by avoiding
sudden, unplanned downtimes.
• Scheduling the precautionary maintenance activities and the
spare parts orders.
Page 39 of 43
ABCD O&M Manual Viewer Help
Maintenance lists
The subject "Maintenance lists" contains the following additional
maintenance-relevant information:
• Valve lists
• Component lists
• Instrument lists
• Maintenance schedules
• etc.
Maintenance manuals
The maintenance manuals contain all the information required by the
maintenance personnel so that they can carry out their tasks.
The maintenance personnel are aware of the residual dangers and are
able to carry out the tasks safely.
Menu bar
Additional functions as well as functions for the entire program can be
invoked from this menu bar.
N
Navigation
The term 'navigation' refers to the user moving from one level to
another within a structure.
Navigation type
There are three navigation types for the Viewer: Function/Subject/KKS
Navigation via
Under "Navigation via", navigations structures for searching documents
are provided according to the function, subject, and KKS.
O
O&M Manuals
O&M Manuals refer to user manuals and contain the instructions for
operation and maintenance.
Operation
The subject operation contains all the information required about the
various phases involved in shutting down the plant or a system
including the normal and abnormal operating states.
Operating instructions
The subject "operating instructions" describes the "normal operation"
state. It provides instructions for monitoring operation and explains the
consequences of abnormal operation.
The operating manual contains all the information required for
understanding and operating the plant or their systems.
Those persons responsible for operation are aware of the residual
dangers involved and are able to operate the plant or its systems
safely.
Page 40 of 43
ABCD O&M Manual Viewer Help
Operating lists
The subject "Operating lists" contains the following additional
operation-relevant information:
• Alarm lists
• Setting values
• Signal lists
• etc.
Packaging, transport
and disposal
The subject "Packaging, transport, and disposal" contains the
necessary information for preparing and carrying out the named
activities.
PDF
PDF is an abbreviation and stands for "Portable Document Format"
Properties
Properties are attributes that can be assigned to documents. In
addition to the primary attributes (number, version, type and language),
there is also the structure assignment (subject, function and KKS) and
type-related information (supplier, manufacturer, and equipment type).
Q
Quick search
In the quick search, you can only search for documents via full-text
index and properties or only in the properties.
R
Root directory
The root directory of a data medium contains all the information directly
under the drive letter, for example C:\
Safety regulations
The subject "Safety regulations" informs the operator about the
potential risks and dangers of operating the system beyond its
specified limits.
The subject helps avoid improper use and emphasizes the care
required for preventing dangers when carrying out maintenance tasks.
Page 41 of 43
ABCD O&M Manual Viewer Help
Safety regulations
for operation
The subject "Safety regulations for operation" informs maintenance
personnel about the risks and dangers during the following situations:
• System or plant is in "normal operating mode".
• System or plant is "out of operation" or "secured".
The subject helps avoid improper use and emphasizes the care
required for preventing danger when carrying out maintenance tasks.
Search result
The search result is a list of all hits (project documents and structure
elements) that fulfil the criteria entered.
Settings
Settings are the values with which a user can enable and disable
specific characteristics of the viewer in certain situations.
Shutdown
The subject of "shutdown" includes the descriptions for switching off
the system from the operation state "normal operation" as well as the
description of "emergency shutdown".
Special operating
conditions
The subject "Special operating condition" contains a description of the
states not covered by the terms "Normal operation" or proper use.
Start page
Start page is an entry in the menu bar that reset all entries for filters or
search results.
Start-up
The subject "Start-up" provides all the information required for
describing the transition of the system from the state "stand-by" to "in
operation".
The residual dangers are a part of the description.
Structure
A structure is any construct of elements that has an hierarchical
organization
Structure elements
Structure elements are the building blocks of a structure
Structure filter
Structure filter is an entry in the menu bar with which you can restrict a
filter of the documents displayed in the search result via function or
subject
Subject
Page 42 of 43
ABCD O&M Manual Viewer Help
Technical documentation
The technical documentation supports the maintenance and the
operating personal while they carry out maintenance or operating
tasks.
Troubleshooting
The subject "Troubleshooting" contains information on how the
operator should react to malfunctions and events.
It describes their possible causes and how to eliminate them and
indicates how the system or plant can be restored to a normal working
condition.
U
User interface
A (graphic) user interface is the visual representation of the program
functions by means of menus, hyperlinks, buttons etc.
User names
For particular procedures it is necessary that you log on to the viewer
with a user name.
V
View
A view is a representation of the documentation based on structure
information. There are three views: Function, subject, and KKS/IS
Viewer
Viewer is a short form for the ALSTOM O&M Manual Viewer.
Wiring Manuals
The subject "Wiring Manuals" contains the following information:
• Cable lists
• Terminal boxes
• Wiring diagrams
• etc.
Page 43 of 43