Documentation
Communication for the open minded
OpenScape Alarm Response Professional
OScAR-ProV3 R2 Classic Applications
Communication for the open minded
Siemens Enterprise Communications
Reference No.: A31003-S1730-U103-1-7619
Contents
Contents
Contents
Contents
Contents
Contents
Contents
Contents
Contents
07/2010
OScAR-ProCustomized Operator, User Manual
Images
Images
07/2010
0-10
Images
OScAR-ProCustomized Operator, User Manual
Tables
Tables
0-11
0-12
Tables
0-13
Tables
0-14
Tables
0-15
Tables
07/2010
0-16
Tables
OScAR-ProCustomized Operator, User Manual
1 Conventions and Operating Instructions
Target audience and qualifications
Contents
1.1Reference manuals
Reference manuals
Conventions and Operating Instructions
Symbols
1.2Notations and symbols
Notations and symbols
Conventions
1.3Privacy and data security
Privacy and data security
2 Overview
Overview
Contents
2.1Description of functions
2.2Example application
Description of functions
Example application
Overview
2.3Interactions of the DCO components
Interactions of the DCO components
2.4The tasks of the OScAR-ProCustomized Operator
2.5The tasks of the DCO-Script
The tasks of the OScAR-ProCustomized Operator
2.6The tasks of the OScAR-Pro-TT Operator-Tool
The tasks of the OScAR-Pro-TT Operator-Tool
3 Installation
Contents
Overview
<CD-Romdrive>:\cdsetup
Task
Window
Install OpenScape Alarm Response ProfessionalV1
No. Task
Installation
4.The installation is now initialized
Installation
Task
Window
Installation
Task
Window
Installation
Task
Window
No. Task
Installation
5.The software is now uninstalled
Window
Installation
07/2010
OScAR-ProCustomized Operator, User Manual
Contents
Overview
4.1Start the OScAR-ProCustomized Operator
Start the OScAR-ProCustomized Operator
Task
Page
4.2.1The menu bar
4.2.2The toolbar
Generic entries
Menu item
Description
Open
Status bar
Default colors
Toolbar
German
Undo
Special entries of the Structure window
Edit
Copy
Ctrl+Arrow up
Move up
Moves an entry up in the order of the list view
Move down
Static control
Special entries in the Layout window
Pointer
Edit field
Combobox
Menu item
Description
Ctrl+7
1280 x
4.2.4Functions of the mouse
1024 x
User defined
4.2.5The status bar
The right mouse key Context menu
4.3Setup and application of the Structure window
Setup and application of the Structure window
4.3.1The tree structure of the Structure window
Setup and application of the Structure window
Sort the list
4.3.2The list view of the Structure window
Change the sequence of the columns
Edit entries
4.4Setup and application of the Layout window
Setup and application of the Layout window
Setup and application of the Layout window
4.4.1Toolbar and Controls
Control
Description
Setup and application of the Layout window
4.4.2Mark a Frame area or a Control
Button
Description
4.4.3Move Controls
Setup and application of the Layout window
4.4.4Change the size of Frames and Controls
Position of the black square
Setup and application of the Layout window
4.4.5Align and space elements automatically
Setup and application of the Layout window
4.5Setup and application of the Preview window
Setup and application of the Preview window
General user dialog windows
4.6General user dialog windows
4.6.1Edit project properties
Input field
4.6.2Administration of the Image lists
General user dialog windows
No. Task
General user dialog windows
Input field
Description
General user dialog windows
No. Task
1.Start the DCO-Designer
General user dialog windows
Input field
Description
Description
General user dialog windows
Input field
PIN entry re
4.6.4Edit fonts
General user dialog windows
No. Task
Input field
Summary of the fields in the window Font
General user dialog windows
Description
General user dialog windows
4.6.5Edit colors
Summary of the fields in the window Color
No. Task
Description
General user dialog windows
Input field
tally over the above prismatic color system
5 The Elements of a DCO-Script
Contents
Overview
The Elements of a DCO-Script
The Elements of a DCO-Script 5.11Instructions
The Elements of a DCO-Script
5.1General structure
General structure
Node
General structure
Description
Data type
5.2The DCO data types and their value ranges
The DCO data types and their value ranges
Value range
Data type
Examples
The DCO data types and their value ranges
Value range
List of logical operations in Formulas
5.3Formulas
Formulas
Logical opera
Effect on
Formulas
Effect on
tion
Constants
5.4Constants
5.4.1The attributes of Constants
Example
Constants
5.4.2Add a new Constant
5.4.3Edit the attributes of a Constant
No. Task
5.5Parameters
Parameters
Example
5.5.1Add a new Parameter group
Parameters
No. Task
Attribute
5.5.2The attributes of Parameters
Parameters
Description
Parameters
5.5.3Add a new Parameter
5.5.4Edit the attributes of a Parameter
Task
Variables
5.6Variables
5.6.1The attributes of Variables
Example
Variables
5.6.2Add a new Variable
5.6.3Edit the attributes of a Variable
Task
Short summary of the Data lists
5.7Lists
Lists
Short summary of Filters
Child node
The attributes of Data lists
The child nodes of the node Data lists
Lists
Lists
The attributes of data elements
color
Attribute
Lists
5.7.2Add a new Data list
5.7.3Edit the attributes of a Data list
Task
Lists
5.7.4Add a new data element
5.7.5Edit the attributes of a data element
Task
Attribute
The attributes of Filters
Lists
Description
Lists
The child nodes of the node Filters
The attributes of ID ranges
Child node
Lists
The attributes of Included IDs
The attributes of excluded IDs
Attribute
The Elements of a DCO-Script
Lists
Example
Lists
5.7.7Add a new Filter
5.7.8Edit the attributes of a Filter
Task
Lists
5.7.9Add an ID range
5.7.10Edit the attributes of an ID range
Task
Lists
5.7.11Add an Included ID
5.7.12Edit the attributes of an Included ID
Task
Lists
5.7.13Add an Excluded ID
5.7.14Edit the attributes of an Excluded ID
Task
The attributes of Frames
5.8Frames
Frames
Attribute
Frames
Attribute
Description
Frames
bool or
bool
Attribute
On_Load“
„On_Timer“
The child nodes of the node Frames
„On_Message“
Frames
5.8.2Add a new Frame
5.8.3Edit the attributes of a Frame
No. Task
The Elements of a DCO-Script
Frames
Task
5.8.5Add a new Control through the Layout window
Frames
Task
5.8.6Edit the attributes of a Control
Frames
No. Task
Frames
5.8.7OScAR-Procommand templates
Global attributes
Attribute
Attribute
The Elements of a DCO-Script
Frames
Description
byte, or
Additional attributes of the type BDC
string
byte
Attribute
bool, or
Frames
Description
Description
Frames
Attribute
string
msg_id
Child nodes of the node BDC
bdc_id
Frames
con_id
Additional attributes of the OScAR-Procommand ITL
Additional attributes of the type CON
itl_id
Frames
Additional attributes of the OScAR-Procommand SCN
phone_number
Attribute
Description
Frames
Attribute
bool
Frames
Additional attributes of the Command KILLPRC
uint
Attribute
Attribute
Additional attributes of the Command KILLBDC
Frames
Description
Attribute
Additional attributes of the Command KILLCON
Frames
Description
5.8.8Add a new OScAR-Procommand template
Frames
Task
The Elements of a DCO-Script
Frames
Task
„User“
5.8.10Add a new Function to a Frame
„On_Load“
„On_Timer“
No. Task
„On_Timer“
Frames
„On_Load“
Controls
5.9Controls
5.9.1The use of Controls
Attribute
Attribute
The Elements of a DCO-Script
Controls
Description
EDIT <Name of the Edit field >
5.9.2References to Controls
Declaration and description
CHECKBOX <Name of the Checkbox>
Attribute
5.9.3Attributes shared by all Controls
Controls
Description
Attribute
The Elements of a DCO-Script
Controls
Description
Attribute
The Elements of a DCO-Script
Controls
Description
Attribute
Special attributes of Static elements
Controls
Description
Attribute
The child nodes of Static elements
Controls
Description
Attribute
The Elements of a DCO-Script
Controls
Description
Attribute
The Elements of a DCO-Script
Controls
Description
Description
Controls
Attribute
color
Controls
Attribute
Position Font
Description
Attribute
5.9.5Special attributes of Edit fields
Controls
Description
Attribute
The Elements of a DCO-Script
Controls
Description
Attribute
Special attributes of Buttons
Controls
Description
Description
Controls
Attribute
color
Child node
The child nodes of Buttons
Controls
Description
5.9.7Add Functions to a Button
Controls
Task
The Elements of a DCO-Script
Controls
Task
5.9.9Add Static elements to a Button
Controls
Task
The Elements of a DCO-Script
Controls
Task
Attribute
5.9.11Special attributes of Checkboxes
Controls
Description
Description
Controls
Attribute
string
Attribute
The Elements of a DCO-Script
Controls
Description
Attribute
Special attributes of the type process
Controls
Description
For all other types
The child nodes of Listboxes
For the type process
Controls
Child node
The attributes of Process filters
Controls
Description
Controls
For the types PROCESS_BDC and PROCESS_CON
For the ROCESS_BDCMBR
Child node
Controls
5.9.13Double-clickevents of Listboxes
For the type PROCESS_CONMBR
Child node
5.9.14Add new Process filters to Listboxes
Controls
Task
5.9.15Edit the attributes of Process filters
Controls
Task
Attribute
The child nodes of Comboboxes
Controls
Description
5.9.17Selection events of Comboboxes
Controls
Functions
5.10Functions
5.10.1The attributes and child nodes of Functions
Attributes of Functions
Attribute
The child nodes of the node Functions
Functions
Description
Syntax
5.10.2Setup and syntax of conditions
General
Operators
Example of a condition with several elements
Functions
Example
5.11.2Overview of Instructions
5.11Instructions
5.11.1Arguments of Instructions
Instructions
Instructions for Static elements
Instructions to set Variables
Instructions to change the attributes of Frames
Instructions
Instructions
Instructions for Edit fields
Instructions for Buttons
Instruction
Instruction
Instructions for Checkboxes
Instructions
Description
Instructions
Instructions for Listboxes
Instructions for Comboboxes
Instruction
Instruction
5.11.3Add a new Instruction
Instructions
Description
Task
5.11.4Edit Instructions
Instructions
No. Task
The Elements of a DCO-Script
Instructions
Task
The Elements of a DCO-Script
Instructions
Task
Instructions
5.11.6The Instruction AddListToComboBox
Arguments
Description
Description
5.11.7The Instruction Call
Instructions
Arguments
Description
5.11.8The Instruction BroadcastMessage
Instructions
Arguments
Description
5.11.9The Instruction ClearComboBox
Instructions
Arguments
Description
5.11.10The Instruction Execute
Instructions
Arguments
Description
5.11.11The Instruction GetBroadcasts
Instructions
Arguments
Description
5.11.12The Instruction GetConferences
Instructions
Arguments
Description
5.11.13The Instruction GetComboBoxSelText
Instructions
Arguments
Description
5.11.14The Instruction GetInfotelephones
Instructions
Arguments
Description
5.11.15The Instruction GetListBoxSelText
Instructions
Arguments
Description
5.11.16The Instruction GetMessages
Instructions
Arguments
Description
5.11.17The Instruction GetScenarios
Instructions
Arguments
Instructions
5.11.18The Instruction GotoFrame
5.11.19The Instruction OffAllListBoxItemBlink
Description
Instructions
5.11.20The Instruction OffButtonBlink
5.11.21The Instruction OffEditBackColorBlink
Description
Description
5.11.22The Instruction OffEditTextColorBlink
Instructions
Arguments
Description
5.11.23The Instruction OffListBoxItemBlink
Instructions
Arguments
Instructions
5.11.24The Instruction SetButtonBlink
color, or
Description
The Elements of a DCO-Script
Instructions
Description
5.11.25The Instruction SetButtonColor
Instructions
Arguments
Instructions
5.11.26The Instruction SetButtonPicture
string, or
Description
Instructions
5.11.27The Instruction SetButtonPictureScal
float
Description
Description
5.11.28The Instruction SetButtonRect
Instructions
Arguments
Description
5.11.29The Instruction SetButtonStaticBackColor
Instructions
Arguments
Description
5.11.30The Instruction SetButtonStaticBorderColor
Instructions
Arguments
Description
5.11.31The Instruction SetButtonStaticPictureName
Instructions
Arguments
Instructions
5.11.32The Instruction SetButtonStaticPicturePos
choose from left, top, h-center,top, right, top
Description
Arguments
Instructions
Description
Arguments
Description
5.11.34The Instruction SetButtonStaticRect
Instructions
Arguments
Instructions
5.11.35The Instruction SetButtonStaticStatus
uint, or
Description
Description
5.11.36The Instruction SetButtonStaticText
Instructions
Arguments
Description
5.11.37The Instruction SetButtonStaticTextColor
Instructions
Arguments
Arguments
Instructions
Description
Arguments
Description
5.11.39The Instruction SetButtonStatus
Instructions
Arguments
Description
5.11.40The Instruction SetButtonText
Instructions
Arguments
Description
5.11.41The Instruction SetButtonTextColor
Instructions
Arguments
Description
5.11.42The Instruction SetCheckBoxBackColor
Instructions
Arguments
Description
5.11.43The Instruction SetCheckBoxCaption
Instructions
Arguments
Description
5.11.44The Instruction SetCheckBoxRect
Instructions
Arguments
Description
5.11.45The Instruction SetCheckBoxState
Instructions
Arguments
Description
5.11.46The Instruction SetCheckBoxStatus
Instructions
Arguments
Description
5.11.47The Instruction SetCheckBoxTextColor
Instructions
Arguments
Description
5.11.48The Instruction SetCheckBoxToVariable
Instructions
Arguments
Description
5.11.49The Instruction SetComboBoxBackColor
Instructions
Arguments
Description
5.11.50The Instruction SetComboBoxList
Instructions
Arguments
Description
5.11.51The Instruction SetComboBoxRect
Instructions
Arguments
Description
5.11.52The Instruction SetComboBoxStatus
Instructions
Arguments
Description
5.11.53The Instruction SetComboBoxTextColor
Instructions
Arguments
Description
5.11.54The Instruction SetComboToVariable
Instructions
Arguments
Description
5.11.55The Instructions SetEditBackColor
Instructions
Arguments
Description
5.11.56The Instruction SetEditBackColorBlink
Instructions
Arguments
Instructions
Arguments
Description
Description
5.11.57The Instruction SetEditRect
Instructions
Arguments
Description
5.11.58The Instruction SetEditStatus
Instructions
Arguments
Description
5.11.59The Instruction SetEditText
Instructions
Arguments
Description
5.11.60The Instruction SetEditTextColor
Instructions
Arguments
Description
5.11.61The Instruction SetEditTextColorBlink
Instructions
Arguments
Instructions
Arguments
Description
Description
5.11.62The Instruction SetEditToVariable
Instructions
Arguments
Description
5.11.63The Instruction SetFrameColor
Instructions
Arguments
Description
5.11.64The Instruction SetListBoxBackColor
Instructions
Arguments
Description
5.11.65The Instruction SetListBoxBlinkTime
Instructions
Arguments
Description
5.11.66The Instruction SetListBoxItemBlink
Instructions
Arguments
Description
5.11.67The Instruction SetListBoxItemColor
Instructions
Arguments
Description
5.11.68The Instruction SetListBoxList
Instructions
Arguments
Description
5.11.69The Instruction SetListBoxRect
Instructions
Arguments
Arguments
Instructions
Description
Arguments
Description
5.11.71The Instructions SetListBoxStatus
Instructions
Arguments
Description
5.11.72The Instruction SetListBoxTextColor
Instructions
Arguments
Description
5.11.73The Instruction SetListBoxToVariable
Instructions
Arguments
Description
5.11.74The Instruction SetStaticBackColor
Instructions
Arguments
Description
5.11.75The Instruction SetStaticBorderColor
Instructions
Arguments
Description
5.11.76The Instruction SetStaticPictureName
Instructions
Arguments
Description
5.11.77The Instruction SetStaticPicturePos
Instructions
Arguments
Description
5.11.78The Instruction SetStaticPictureScale
Instructions
Arguments
Description
5.11.79The Instruction SetStaticRect
Instructions
Arguments
Description
5.11.80The Instruction SetStaticStatus
Instructions
Arguments
Description
5.11.81The Instruction SetStaticText
Instructions
Arguments
Description
5.11.82The Instruction SetStaticTextColor
Instructions
Arguments
Description
5.11.83The Instruction SetStaticTextPosition
Instructions
Arguments
Description
5.11.84The Instruction SetVariable
Instructions
Arguments
Description
5.11.85The Instruction StartProgram
Instructions
Arguments
Contents
The planning and implementation of a DCO Project
Overview
The planning and implementation of a DCO Project
The planning and implementation of a DCO Project
6.1The case study project
6.1.1Case study requirements
The case study project
6.1.2Case study plant map
The case study project
Subscribers
6.1.3Objects administrated in OScAR-Pro
Name
Announcements
The structure of the case study user interface
6.1.4How to implement the case study
Broadcasts
The case study project
Global objects
The Functions of the Main page
The case study project
The planning and implementation of a DCO Project
The case study project
References
6.2Project administration 6.2.1Create the project
Project administration
Task
Task
6.2.2Open an existing project
Project administration
References
Create Frames and Controls
6.3Create Frames and Controls
6.3.1Create and customize the Frames
Create the Main page
Task
nouncement selection
Create Frames and Controls
References
1280
6.3.2Add a background image to the Main page
Plant map
1024
1080
6.3.3Add visual separators to the Main page
Horizontal Line
simple
Events
6.3.4Add Captions to the Main page
Event
Microsoft Sans Serif
left, v-center
Event name
Hints
Italics
2. Select area\n
Note text
1. Select event\n
3. Invoke
Fire alert
6.3.5Add Buttons to the Main page
Insert Event Buttons
FIRE.GIF
Leakage
Deflagration
EXPLOSION.GIF
ACID.GIF
RING_FILES.GIF
Create Area Buttons
Management
Create Frames and Controls
TECHNICS.GIF
AdminTechnics
Admin &&Technics
Production
Invoke
2 disabled
Create an Invoke Button
start.GIF
ment
Dialog title
Please select announce
Announcement list
Ok.GIF
Cancel
CANCEL.GIF
Cancel
Create Frames and Controls
6.3.7Screenshot of the final interface
Screenshot of the Structure window
6-26
Create Frames and Controls
Screenshot of the Main page
The planning and implementation of a DCO Project
Image 6-3Screenshot of the final Main page
Create Frames and Controls
Screenshot of the page Announcement selection
The planning and implementation of a DCO Project
6-28
Create the global objects
6.4Create the global objects
6.4.1Create Constants
Value
Name
6.4.2Create the Parameters
Create the global objects
Data type
Name
6.4.3Create the Variables
Create the global objects
Data type
Create the Filter
6.4.4Create the Lists
Create the Data list
1000
Announcement IDs
Attributes
Broadcast IDs
Create the global objects
Create the Functions of the Main page
6.5Create the Functions of the Main page
6.5.1The User Function: Fire alert blink on
Instructions
Create the Functions of the Main page
6.5.2The User Function: Deflagration blink on
6.5.3The User Function: Leakage blink on
Description
Create the Functions of the Main page
6.5.4The User Function: Short circuit blink on
6.5.5The User Function: More blink on
Description
Create the Functions of the Main page
6.5.7The User Function: AdminTechnics blink on
6.5.6The User Function: Management blink on
Description
Create the Functions of the Main page
6.5.8The User Function: Production 1 blink on
6.5.9The User Function: Production 2 blink on
Description
Create the Functions of the Main page
6.5.10The User Function: Disable invoke
6.5.11The User Function: Enable invoke
Description
Contents
6.5.12The User Function: Activate invoke
Contents
Create the Functions of the Main page
Contents
6.5.13The User Function: Blink Buttons
Contents
Create the Functions of the Main page
Instruction
Contents
Create the Functions of the Main page
Arguments
Contents
6.5.14The User Function: Reset areas
Contents
Create the Functions of the Main page
Contents
6.5.15The User Function: Reset events
Contents
Create the Functions of the Main page
Create the Functions of the Main page
6.5.17The User Function: Invoke AdminTechnics
6.5.16The User Function: Invoke Management
Description
Contents
6.5.18The User Function: Invoke Production
6.5.19The User Function: Invoke Production
Contents
6.5.21.1The Function: Delete Description
6.5.20On_Load Function: Set Buttons
6.5.21The Functions of the Button Fire alert
Create the Functions of the Main page
Attributes
6.5.21.2The Function: Set Description
Create the Functions of the Main page
Instructions
Create the Functions of the Main page
6.5.22The Functions of the Button Deflagration
6.5.22.1The Function: Delete Description
Attributes
Attributes
6.5.22.2The Function: Set Description
Create the Functions of the Main page
Instructions
Create the Functions of the Main page
6.5.23The Functions of the Button Leakage
6.5.23.1The Function: Delete Description
Attributes
Attributes
6.5.23.2The Function: Set Description
Create the Functions of the Main page
Instructions
Create the Functions of the Main page
6.5.24The Functions of the Button Short circuit
6.5.24.1The Function: Delete Description
Attributes
Contents
6.5.24.2The Function: Set Description
Contents
Create the Functions of the Main page
Create the Functions of the Main page
Contents
Contents
Description
6.5.26.2The Function: Set Description
6.5.26The Functions of the Button Management
6.5.26.1The Function: Delete Description
Create the Functions of the Main page
6.5.27.2The Function: Set Description
6.5.27The Functions of the Button AdminTechnics
6.5.27.1The Function: Delete Description
Create the Functions of the Main page
6.5.28.2The Function: Set Description
6.5.28The Functions of the Button Production
6.5.28.1The Function: Delete Description
Create the Functions of the Main page
6.5.29.2The Function: Set Description
6.5.29The Functions of the Button Production
6.5.29.1The Function: Delete Description
Create the Functions of the Main page
Create the Functions of the Main page
Contents
Contents
Description
Attributes
6.6.1The User Function: On cancel
Description
Instructions
Attributes
6.6.2On_Load Functions: Fill announcement list
Description
Instructions
Description
Contents
Contents
Attributes
Attributes
6.6.4The Functions of the Button Ok
6.6.4.1The Function: With selection Description
Instructions
Attributes
6.6.4.2The Function: Without selection
Description
Instructions
6.7Test the DCO-Script
Test the DCO-Script
Task
7 The DCO in the OScAR-Pro-TT Operator-Tool
Contents
Overview
7.1Publication of the DCO Script
7.2Layout in the OScAR-Pro-TT Operator-ToolNote
Publication of the DCO Script
7.2.1The DCO in the child window
Layout in the OScAR-Pro-TT Operator-Tool
Menu item
7.2.2The DCO in the toolbar
Layout in the OScAR-Pro-TT Operator-Tool
Description
The menu bar and buttons
7.3Operation of the DCO-Window
Operation of the DCO-Window
Loading DCO-Script
The DCO in the OScAR-Pro-TT Operator-Tool
Operation of the DCO-Window
The DCO in the OScAR-Pro-TT Operator-Tool
Operation of the DCO-Window
Task
The DCO in the OScAR-Pro-TT Operator-Tool
Operation of the DCO-Window
No. Task
Description of the window DCO parameter editor
7.4The DCO Parameter Editor
The DCO Parameter Editor
Edit field
Entry
7.5Special registry entries for the DCO
Special registry entries for the DCO
Description
Symbole
Index
Index
Index
Index
Index
Index
Index
Index
Index
Index
07/2010
Z-10
Index
OScAR-ProCustomized Operator, User Manual