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