Manuals / Siemens / Household Appliance / Home Security System

Siemens A31003-51730-U103-7619 5.11.8The Instruction BroadcastMessage, Instructions, Description

Models: A31003-51730-U103-7619

1 336

Download 336 pages 29.09 Kb

Page 172

The Elements of a DCO-Script

Instructions

5.11.8The Instruction "BroadcastMessage"

Description

Use this instruction to broadcast a message to the own page or i.a. an associated page (from normal page ➠ toolbar page or from toolbar page ➠ normal page). The broadcasted messages are processed in the specified Function of the branch “On_Message“ of both pages.

Arguments

Arguments		Description

Message		Editable combobox to specify the function name in the branch
		“On_Message“ that shall be executed.
		Here you can:
		● enter the name of an“ On_Message“ function direct or
		● select a “On_Message“ function from the list of all avail-
		able functions.

Table 5-76	The arguments of the Instruction "BroadcastMessage"

	07/2010
5-104	OScAR-Pro Customized Operator, User Manual

Image 172

Siemens A31003-51730-U103-7619 user manual 5.11.8The Instruction BroadcastMessage, Instructions, Description, Arguments

Contents

Communication for the open minded OpenScape Alarm Response ProfessionalDocumentation OScAR-ProV3 R2 Classic ApplicationsSiemens Enterprise Communications Communication for the open mindedReference No.: A31003-S1730-U103-1-7619 Contents ContentsContents Contents Contents Contents Contents Contents 07/2010 ContentsOScAR-ProCustomized Operator, User Manual Images Images0-10 Images07/2010 OScAR-ProCustomized Operator, User ManualTables Tables0-11 0-12 Tables0-13 Tables0-14 Tables0-15 Tables0-16 Tables07/2010 OScAR-ProCustomized Operator, User ManualTarget audience and qualifications 1 Conventions and Operating InstructionsContents Reference manuals 1.1Reference manualsConventions and Operating Instructions 1.2Notations and symbols Notations and symbolsSymbols Conventions1.3Privacy and data security Privacy and data securityOverview 2 OverviewContents 2.2Example application 2.1Description of functionsDescription of functions Example application Overview2.3Interactions of the DCO components Interactions of the DCO components2.5The tasks of the DCO-Script 2.4The tasks of the OScAR-ProCustomized OperatorThe tasks of the OScAR-ProCustomized Operator 2.6The tasks of the OScAR-Pro-TT Operator-Tool The tasks of the OScAR-Pro-TT Operator-ToolContents 3 InstallationOverview Task <CD-Romdrive>:\cdsetupWindow No. Task InstallationInstall OpenScape Alarm Response ProfessionalV1 4.The installation is now initializedTask InstallationWindow Task InstallationWindow Task InstallationWindow Installation 5.The software is now uninstalledNo. Task Window07/2010 InstallationOScAR-ProCustomized Operator, User Manual Contents OverviewStart the OScAR-ProCustomized Operator 4.1Start the OScAR-ProCustomized OperatorTask Page 4.2.1The menu bar 4.2.2The toolbarMenu item DescriptionGeneric entries OpenDefault colors ToolbarStatus bar GermanSpecial entries of the Structure window EditUndo CopyMove up Moves an entry up in the order of the list viewCtrl+Arrow up Move downSpecial entries in the Layout window PointerStatic control Edit fieldMenu item DescriptionCombobox Ctrl+74.2.4Functions of the mouse 1024 x1280 x User defined4.2.5The status bar The right mouse key Context menu4.3Setup and application of the Structure window Setup and application of the Structure window4.3.1The tree structure of the Structure window Setup and application of the Structure window4.3.2The list view of the Structure window Change the sequence of the columnsSort the list Edit entries4.4Setup and application of the Layout window Setup and application of the Layout window4.4.1Toolbar and Controls ControlSetup and application of the Layout window Description4.4.2Mark a Frame area or a Control ButtonSetup and application of the Layout window Description4.4.3Move Controls Setup and application of the Layout windowPosition of the black square 4.4.4Change the size of Frames and ControlsSetup and application of the Layout window 4.4.5Align and space elements automatically Setup and application of the Layout window4.5Setup and application of the Preview window Setup and application of the Preview window4.6General user dialog windows 4.6.1Edit project propertiesGeneral user dialog windows Input fieldGeneral user dialog windows 4.6.2Administration of the Image listsNo. Task Input field General user dialog windowsDescription No. Task General user dialog windows1.Start the DCO-Designer Input field General user dialog windowsDescription General user dialog windows Input fieldDescription PIN entry reGeneral user dialog windows 4.6.4Edit fontsNo. Task Summary of the fields in the window Font General user dialog windowsInput field Description4.6.5Edit colors Summary of the fields in the window ColorGeneral user dialog windows No. TaskGeneral user dialog windows Input fieldDescription tally over the above prismatic color systemContents 5 The Elements of a DCO-ScriptOverview The Elements of a DCO-Script The Elements of a DCO-Script 5.11Instructions The Elements of a DCO-Script 5.1General structure General structureGeneral structure NodeDescription 5.2The DCO data types and their value ranges The DCO data types and their value rangesData type Value rangeExamples The DCO data types and their value rangesData type Value range5.3Formulas FormulasList of logical operations in Formulas Logical operaFormulas Effect onEffect on tion5.4Constants 5.4.1The attributes of ConstantsConstants Example5.4.2Add a new Constant 5.4.3Edit the attributes of a ConstantConstants No. TaskParameters 5.5ParametersExample Parameters 5.5.1Add a new Parameter groupNo. Task 5.5.2The attributes of Parameters ParametersAttribute Description5.5.3Add a new Parameter 5.5.4Edit the attributes of a ParameterParameters Task5.6Variables 5.6.1The attributes of VariablesVariables Example5.6.2Add a new Variable 5.6.3Edit the attributes of a VariableVariables Task5.7Lists ListsShort summary of the Data lists Short summary of FiltersThe attributes of Data lists The child nodes of the node Data listsChild node ListsThe attributes of data elements colorLists Attribute5.7.2Add a new Data list 5.7.3Edit the attributes of a Data listLists Task5.7.4Add a new data element 5.7.5Edit the attributes of a data elementLists TaskThe attributes of Filters ListsAttribute DescriptionThe child nodes of the node Filters The attributes of ID rangesLists Child nodeThe attributes of Included IDs The attributes of excluded IDsLists AttributeLists The Elements of a DCO-ScriptExample 5.7.7Add a new Filter 5.7.8Edit the attributes of a FilterLists Task5.7.9Add an ID range 5.7.10Edit the attributes of an ID rangeLists Task5.7.11Add an Included ID 5.7.12Edit the attributes of an Included IDLists Task5.7.13Add an Excluded ID 5.7.14Edit the attributes of an Excluded IDLists Task5.8Frames FramesThe attributes of Frames AttributeAttribute FramesDescription bool or boolFrames Attribute„On_Timer“ The child nodes of the node FramesOn_Load“ „On_Message“5.8.2Add a new Frame 5.8.3Edit the attributes of a FrameFrames No. TaskFrames The Elements of a DCO-ScriptTask Frames 5.8.5Add a new Control through the Layout windowTask Frames 5.8.6Edit the attributes of a ControlNo. Task 5.8.7OScAR-Procommand templates Global attributesFrames AttributeThe Elements of a DCO-Script FramesAttribute DescriptionAdditional attributes of the type BDC stringbyte, or bytebool, or FramesAttribute DescriptionFrames AttributeDescription stringChild nodes of the node BDC bdc_idmsg_id FramesAdditional attributes of the OScAR-Procommand ITL Additional attributes of the type CONcon_id itl_idAdditional attributes of the OScAR-Procommand SCN phone_numberFrames AttributeFrames AttributeDescription boolAdditional attributes of the Command KILLPRC uintFrames AttributeAdditional attributes of the Command KILLBDC FramesAttribute DescriptionAdditional attributes of the Command KILLCON FramesAttribute DescriptionFrames 5.8.8Add a new OScAR-Procommand templateTask Frames The Elements of a DCO-ScriptTask 5.8.10Add a new Function to a Frame „On_Load“„User“ „On_Timer“„On_Timer“ FramesNo. Task „On_Load“5.9Controls 5.9.1The use of ControlsControls AttributeThe Elements of a DCO-Script ControlsAttribute Description5.9.2References to Controls Declaration and descriptionEDIT <Name of the Edit field > CHECKBOX <Name of the Checkbox>5.9.3Attributes shared by all Controls ControlsAttribute DescriptionThe Elements of a DCO-Script ControlsAttribute DescriptionThe Elements of a DCO-Script ControlsAttribute DescriptionSpecial attributes of Static elements ControlsAttribute DescriptionThe child nodes of Static elements ControlsAttribute DescriptionThe Elements of a DCO-Script ControlsAttribute DescriptionThe Elements of a DCO-Script ControlsAttribute DescriptionControls AttributeDescription colorAttribute Position FontControls Description5.9.5Special attributes of Edit fields ControlsAttribute DescriptionThe Elements of a DCO-Script ControlsAttribute DescriptionSpecial attributes of Buttons ControlsAttribute DescriptionControls AttributeDescription colorThe child nodes of Buttons ControlsChild node DescriptionControls 5.9.7Add Functions to a ButtonTask Controls The Elements of a DCO-ScriptTask Controls 5.9.9Add Static elements to a ButtonTask Controls The Elements of a DCO-ScriptTask 5.9.11Special attributes of Checkboxes ControlsAttribute DescriptionControls AttributeDescription stringThe Elements of a DCO-Script ControlsAttribute DescriptionSpecial attributes of the type process ControlsAttribute DescriptionThe child nodes of Listboxes For the type processFor all other types ControlsThe attributes of Process filters ControlsChild node DescriptionFor the types PROCESS_BDC and PROCESS_CON For the ROCESS_BDCMBRControls Child node5.9.13Double-clickevents of Listboxes For the type PROCESS_CONMBRControls Child nodeControls 5.9.14Add new Process filters to ListboxesTask Controls 5.9.15Edit the attributes of Process filtersTask The child nodes of Comboboxes ControlsAttribute Description5.9.17Selection events of Comboboxes Controls5.10Functions 5.10.1The attributes and child nodes of FunctionsFunctions Attributes of FunctionsThe child nodes of the node Functions FunctionsAttribute Description5.10.2Setup and syntax of conditions GeneralSyntax OperatorsFunctions Example of a condition with several elementsExample 5.11Instructions 5.11.1Arguments of Instructions5.11.2Overview of Instructions InstructionsInstructions to set Variables Instructions to change the attributes of FramesInstructions for Static elements InstructionsInstructions for Edit fields Instructions for ButtonsInstructions InstructionInstructions for Checkboxes InstructionsInstruction DescriptionInstructions for Listboxes Instructions for ComboboxesInstructions Instruction5.11.3Add a new Instruction InstructionsInstruction Description5.11.4Edit Instructions InstructionsTask No. TaskInstructions The Elements of a DCO-ScriptTask Instructions The Elements of a DCO-ScriptTask 5.11.6The Instruction AddListToComboBox ArgumentsInstructions Description5.11.7The Instruction Call InstructionsDescription Arguments5.11.8The Instruction BroadcastMessage InstructionsDescription Arguments5.11.9The Instruction ClearComboBox InstructionsDescription Arguments5.11.10The Instruction Execute InstructionsDescription Arguments5.11.11The Instruction GetBroadcasts InstructionsDescription Arguments5.11.12The Instruction GetConferences InstructionsDescription Arguments5.11.13The Instruction GetComboBoxSelText InstructionsDescription Arguments5.11.14The Instruction GetInfotelephones InstructionsDescription Arguments5.11.15The Instruction GetListBoxSelText InstructionsDescription Arguments5.11.16The Instruction GetMessages InstructionsDescription Arguments5.11.17The Instruction GetScenarios InstructionsDescription Arguments5.11.18The Instruction GotoFrame 5.11.19The Instruction OffAllListBoxItemBlinkInstructions Description5.11.20The Instruction OffButtonBlink 5.11.21The Instruction OffEditBackColorBlinkInstructions Description5.11.22The Instruction OffEditTextColorBlink InstructionsDescription Arguments5.11.23The Instruction OffListBoxItemBlink InstructionsDescription Arguments5.11.24The Instruction SetButtonBlink color, orInstructions DescriptionThe Elements of a DCO-Script Instructions5.11.25The Instruction SetButtonColor InstructionsDescription Arguments5.11.26The Instruction SetButtonPicture string, orInstructions Description5.11.27The Instruction SetButtonPictureScal floatInstructions Description5.11.28The Instruction SetButtonRect InstructionsDescription Arguments5.11.29The Instruction SetButtonStaticBackColor InstructionsDescription Arguments5.11.30The Instruction SetButtonStaticBorderColor InstructionsDescription Arguments5.11.31The Instruction SetButtonStaticPictureName InstructionsDescription Arguments5.11.32The Instruction SetButtonStaticPicturePos choose from left, top, h-center,top, right, topInstructions DescriptionInstructions DescriptionArguments Arguments5.11.34The Instruction SetButtonStaticRect InstructionsDescription Arguments5.11.35The Instruction SetButtonStaticStatus uint, orInstructions Description5.11.36The Instruction SetButtonStaticText InstructionsDescription Arguments5.11.37The Instruction SetButtonStaticTextColor InstructionsDescription ArgumentsInstructions DescriptionArguments Arguments5.11.39The Instruction SetButtonStatus InstructionsDescription Arguments5.11.40The Instruction SetButtonText InstructionsDescription Arguments5.11.41The Instruction SetButtonTextColor InstructionsDescription Arguments5.11.42The Instruction SetCheckBoxBackColor InstructionsDescription Arguments5.11.43The Instruction SetCheckBoxCaption InstructionsDescription Arguments5.11.44The Instruction SetCheckBoxRect InstructionsDescription Arguments5.11.45The Instruction SetCheckBoxState InstructionsDescription Arguments5.11.46The Instruction SetCheckBoxStatus InstructionsDescription Arguments5.11.47The Instruction SetCheckBoxTextColor InstructionsDescription Arguments5.11.48The Instruction SetCheckBoxToVariable InstructionsDescription Arguments5.11.49The Instruction SetComboBoxBackColor InstructionsDescription Arguments5.11.50The Instruction SetComboBoxList InstructionsDescription Arguments5.11.51The Instruction SetComboBoxRect InstructionsDescription Arguments5.11.52The Instruction SetComboBoxStatus InstructionsDescription Arguments5.11.53The Instruction SetComboBoxTextColor InstructionsDescription Arguments5.11.54The Instruction SetComboToVariable InstructionsDescription Arguments5.11.55The Instructions SetEditBackColor InstructionsDescription Arguments5.11.56The Instruction SetEditBackColorBlink InstructionsDescription ArgumentsArguments InstructionsDescription 5.11.57The Instruction SetEditRect InstructionsDescription Arguments5.11.58The Instruction SetEditStatus InstructionsDescription Arguments5.11.59The Instruction SetEditText InstructionsDescription Arguments5.11.60The Instruction SetEditTextColor InstructionsDescription Arguments5.11.61The Instruction SetEditTextColorBlink InstructionsDescription ArgumentsArguments InstructionsDescription 5.11.62The Instruction SetEditToVariable InstructionsDescription Arguments5.11.63The Instruction SetFrameColor InstructionsDescription Arguments5.11.64The Instruction SetListBoxBackColor InstructionsDescription Arguments5.11.65The Instruction SetListBoxBlinkTime InstructionsDescription Arguments5.11.66The Instruction SetListBoxItemBlink InstructionsDescription Arguments5.11.67The Instruction SetListBoxItemColor InstructionsDescription Arguments5.11.68The Instruction SetListBoxList InstructionsDescription Arguments5.11.69The Instruction SetListBoxRect InstructionsDescription ArgumentsInstructions DescriptionArguments Arguments5.11.71The Instructions SetListBoxStatus InstructionsDescription Arguments5.11.72The Instruction SetListBoxTextColor InstructionsDescription Arguments5.11.73The Instruction SetListBoxToVariable InstructionsDescription Arguments5.11.74The Instruction SetStaticBackColor InstructionsDescription Arguments5.11.75The Instruction SetStaticBorderColor InstructionsDescription Arguments5.11.76The Instruction SetStaticPictureName InstructionsDescription Arguments5.11.77The Instruction SetStaticPicturePos InstructionsDescription Arguments5.11.78The Instruction SetStaticPictureScale InstructionsDescription Arguments5.11.79The Instruction SetStaticRect InstructionsDescription Arguments5.11.80The Instruction SetStaticStatus InstructionsDescription Arguments5.11.81The Instruction SetStaticText InstructionsDescription Arguments5.11.82The Instruction SetStaticTextColor InstructionsDescription Arguments5.11.83The Instruction SetStaticTextPosition InstructionsDescription Arguments5.11.84The Instruction SetVariable InstructionsDescription Arguments5.11.85The Instruction StartProgram InstructionsDescription ArgumentsThe planning and implementation of a DCO Project ContentsOverview 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 projectThe case study project 6.1.2Case study plant map The case study project6.1.3Objects administrated in OScAR-Pro NameSubscribers Announcements6.1.4How to implement the case study BroadcastsThe structure of the case study user interface The case study projectThe Functions of the Main page Global objectsThe case study project The planning and implementation of a DCO Project The case study project6.2Project administration 6.2.1Create the project Project administrationReferences Task6.2.2Open an existing project Project administrationTask References6.3Create Frames and Controls 6.3.1Create and customize the FramesCreate Frames and Controls Create the Main pagenouncement selection Create Frames and ControlsTask References6.3.2Add a background image to the Main page Plant map1280 10246.3.3Add visual separators to the Main page Horizontal Line1080 simple6.3.4Add Captions to the Main page EventEvents Microsoft Sans SerifEvent name Hintsleft, v-center ItalicsNote text 1. Select event\n2. Select area\n 3. Invoke6.3.5Add Buttons to the Main page Insert Event ButtonsFire alert FIRE.GIFDeflagration EXPLOSION.GIFLeakage ACID.GIFCreate Area Buttons ManagementRING_FILES.GIF Create Frames and ControlsAdminTechnics Admin &&TechnicsTECHNICS.GIF Production2 disabled Create an Invoke ButtonInvoke start.GIFDialog title Please select announcement Announcement listCancel CANCEL.GIFOk.GIF Cancel6.3.7Screenshot of the final interface Screenshot of the Structure windowCreate Frames and Controls 6-26Screenshot of the Main page The planning and implementation of a DCO ProjectCreate Frames and Controls Image 6-3Screenshot of the final Main pageScreenshot of the page Announcement selection The planning and implementation of a DCO ProjectCreate Frames and Controls 6-286.4Create the global objects 6.4.1Create ConstantsCreate the global objects Value6.4.2Create the Parameters Create the global objectsName Data type6.4.3Create the Variables Create the global objectsName Data type6.4.4Create the Lists Create the Data listCreate the Filter 1000Attributes Broadcast IDsAnnouncement IDs Create the global objects6.5Create the Functions of the Main page 6.5.1The User Function: Fire alert blink onCreate the Functions of the Main page Instructions6.5.2The User Function: Deflagration blink on 6.5.3The User Function: Leakage blink onCreate the Functions of the Main page Description6.5.4The User Function: Short circuit blink on 6.5.5The User Function: More blink onCreate the Functions of the Main page Description6.5.7The User Function: AdminTechnics blink on 6.5.6The User Function: Management blink onCreate the Functions of the Main page Description6.5.8The User Function: Production 1 blink on 6.5.9The User Function: Production 2 blink onCreate the Functions of the Main page Description6.5.10The User Function: Disable invoke 6.5.11The User Function: Enable invokeCreate the Functions of the Main page Description6.5.12The User Function: Activate invoke ContentsContents Create the Functions of the Main page6.5.13The User Function: Blink Buttons ContentsContents Create the Functions of the Main pageContents Create the Functions of the Main pageInstruction Arguments6.5.14The User Function: Reset areas ContentsContents Create the Functions of the Main page6.5.15The User Function: Reset events ContentsContents Create the Functions of the Main page6.5.17The User Function: Invoke AdminTechnics 6.5.16The User Function: Invoke ManagementCreate the Functions of the Main page Description6.5.18The User Function: Invoke Production 6.5.19The User Function: Invoke ProductionContents Contents6.5.20On_Load Function: Set Buttons 6.5.21The Functions of the Button Fire alert6.5.21.1The Function: Delete Description Create the Functions of the Main page6.5.21.2The Function: Set Description Create the Functions of the Main pageAttributes Instructions6.5.22The Functions of the Button Deflagration 6.5.22.1The Function: Delete DescriptionCreate the Functions of the Main page Attributes6.5.22.2The Function: Set Description Create the Functions of the Main pageAttributes Instructions6.5.23The Functions of the Button Leakage 6.5.23.1The Function: Delete DescriptionCreate the Functions of the Main page Attributes6.5.23.2The Function: Set Description Create the Functions of the Main pageAttributes Instructions6.5.24The Functions of the Button Short circuit 6.5.24.1The Function: Delete DescriptionCreate the Functions of the Main page Attributes6.5.24.2The Function: Set Description ContentsContents Create the Functions of the Main pageContents ContentsCreate the Functions of the Main page Description6.5.26The Functions of the Button Management 6.5.26.1The Function: Delete Description6.5.26.2The Function: Set Description Create the Functions of the Main page6.5.27The Functions of the Button AdminTechnics 6.5.27.1The Function: Delete Description6.5.27.2The Function: Set Description Create the Functions of the Main page6.5.28The Functions of the Button Production 6.5.28.1The Function: Delete Description6.5.28.2The Function: Set Description Create the Functions of the Main page6.5.29The Functions of the Button Production 6.5.29.1The Function: Delete Description6.5.29.2The Function: Set Description Create the Functions of the Main pageContents ContentsCreate the Functions of the Main page Description6.6.1The User Function: On cancel DescriptionAttributes Instructions6.6.2On_Load Functions: Fill announcement list DescriptionAttributes InstructionsContents ContentsDescription Attributes6.6.4The Functions of the Button Ok 6.6.4.1The Function: With selection DescriptionAttributes Instructions6.6.4.2The Function: Without selection DescriptionAttributes InstructionsTest the DCO-Script 6.7Test the DCO-ScriptTask Contents 7 The DCO in the OScAR-Pro-TT Operator-ToolOverview 7.2Layout in the OScAR-Pro-TT Operator-ToolNote 7.1Publication of the DCO ScriptPublication of the DCO Script 7.2.1The DCO in the child window Layout in the OScAR-Pro-TT Operator-Tool7.2.2The DCO in the toolbar Layout in the OScAR-Pro-TT Operator-ToolMenu item Description7.3Operation of the DCO-Window Operation of the DCO-WindowThe menu bar and buttons Loading DCO-ScriptThe DCO in the OScAR-Pro-TT Operator-Tool Operation of the DCO-WindowOperation of the DCO-Window The DCO in the OScAR-Pro-TT Operator-ToolTask Operation of the DCO-Window The DCO in the OScAR-Pro-TT Operator-ToolNo. Task 7.4The DCO Parameter Editor The DCO Parameter EditorDescription of the window DCO parameter editor Edit field7.5Special registry entries for the DCO Special registry entries for the DCOEntry DescriptionIndex SymboleIndex Index Index Index Index Index Index Index Index Z-10 Index07/2010 OScAR-ProCustomized Operator, User Manual