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