Installation Manual - Bosch Security Systems
Contents
1. lt SessionData gt The data that belongs to this session lt Discussion gt The discussion that runs within this session List of lt Voting gt The votings for this session List of lt Groups gt This contains a list of groups List of lt Particpants gt lt SessionData gt Subject String The participants in this list The subject of this session Description String The description of this session Done bool lt Discussion gt Id Int32 Indicates if this session is done The unique identifier for this discussion Bosch Security Systems 2013 July Discussion lt DiscussionData gt The data for this discussion lt RequestList gt This contains the participants who are currently requesting to speak lt ResponseList gt This contains the participants who are currently requesting to respond to an active speaker lt ActiveList gt lt ActiveResponseList gt This contains the participants who are currently speaking This contains the participants who are currently responding to a previously active speaker lt SpecialEquipmentList gt This contains a list of special equipment e g notebooks List of lt ActiveGroups gt This contains a list of Active groups lt DiscussionData gt NumberOfActiveMicrophones Int32 The number of microphones which are currently active lt Re2. 1 INTRODUCTION 1 1 Purpose This document is the DCN SWSMD user manual The user manual describes how to configure the DCN NG server to send the activities and how to create a Client that can receive these activities 1 2 Scope This document provides information for the customer that wants to create a Client application showing meeting data This document is intended for 3 party software developers The code examples within this document are based on C from framework 3 5 1 3 Definitions Acronyms and Abbreviations Activity An activity that happens in the server e g MeetingStarted Topic A Topic defines a category in which a group of related activities is located An object oriented programming language developed by Microsoft as part of the NET initiative TcplpActivityTraceListener Standard Windows activity listener Bosch Security Systems 2013 July en 5 2 STREAMING MEETING DATA DCN SWSMD Streaming Meeting Data can be used to create customizable videoscreens contain meeting data Streaming Meeting Data unlike other modules does not require any user action to operate it is a software stream from the Bosch DCN Conference Software Server over an Ethernet connection The stream consists of XML data which can be received by any number of custom made PC software clients 2 1 Issues to know License Key The stream is only available when the License key in the CCU contains DCN SWSMD When
3. Language Abbreviation NLD Name Dutch lt Channel lt Channels gt lt Booths gt Booth Number 1 Desks Desk Number 1 Seat Id 25 lt SeatData Name 1 1 MicrophoneActive false gt Seat lt Desk gt lt Desks gt lt Booth gt lt Booths gt lt Meeting gt lt MeetingActivity gt Bosch Security Systems 2013 July DCN SWSMD Streaming Meeting Data en 28 A 2 4 MeetingStopped lt xml version 1 0 encoding utf 8 lt MeetingActivity xmlns xsi http www w3 0rg 2001 XMLSchema instance xmlns xsd http www w3 org 2001 XMLSchema Version 1 TimeStamp 2008 08 27T13 17 26 0182056 02 00 Topic Meeting Type Meet ingStopped gt lt Meeting Id 1 gt lt MeetingActivity gt A 2 5 VotingStopped lt xml version 1 0 encoding utf 8 VotingActivity xmlns xsi http www w3 0rg 2001 XMLSchema instance xmlns xsd http www w3 org 2001 XMLSchema Version 1 TimeStamp 2008 08 27T13 50 36 0042872402 00 Topic Voting Type VotingStopped gt lt Voting Id 0 gt lt VotingResults gt lt IndividualResults gt VotingIndividualResultContainer AnswerId 1 gt Participant Id 2 gt lt ParticipantData Present false VotingWeight 1 VotingAuthorisation true MicrophoneAuthorisation true FirstName Carl MiddleName the LastName Coder Title Sir Country Spain RemainingSpeechTime 1 gt lt Seat Id 3 gt lt SeatData
4. lt ParticipantData gt The data which belongs to this participant lt Seat gt The seat at which this participant is seated lt Group gt The group in which this participant is located lt ParticipantData gt Present bool Indicates that the participant is or is not present for the meeting VotingAuthorisation bool Indicates that the participant is or is not authorized to vote Bosch Security Systems 2013 July 17 VotingWeight Int32 The voting weight of the participant MicrophoneAuthorisation bool Indicates that the participant is or is not authorized to use the microphone FirstName string The first name of the participant MiddleName string The middle name of the participant LastName string The last name of the participant Title string The title of the participant Country string The country of the participant RemainingSpeechTime Int32 The remaining speech time for this participant in seconds Contains 1 when no end time is present In case the microphone mode is voice activated or Push To Talk this value is always 1 SpeechTimerOnHold bool Indicates that the speech timer is or is not on hold lt ServiceCall gt Id Int32 The unique identifier for this service call lt Seat gt The seat at which this service call is initiated lt Booth gt Number Int32 The number of the booth List of lt Desk gt
5. these optional fields are not present in the XML string when an activity occurs A container may contain references to other containers These referenced containers are embraces with the lt gt characters When there can be reference to a list of containers of the same type we use the List of before the container The next diagram shows the relations of the containers for the meeting activity Activityinfo Version Int32 eTimeStamp DateTime e Topic EnumTopic e Type EnumActivityType MeetingData Channel 0 31 Meeting 0 1 eSubject String Number Int32 gld Int32 Date DateTime 7 Description String V4 Language eid Int32 Abbrivation String Name String A ServiceCall K A _ SessionData eld Int32 Participant Session eSubjed String eld Int32 eld Int32 eDescription String EN 7 X Done Bool 04 01 oa V X NN Seat ParticipantData Voting Discussion ld Int32 Present Bool Name String eld Int32 eld 1 132 VotingAuthorization Bool VotingWeight Int32 eMcrophoneAuthorization Bool eFirstName String 01 String String SeatData qn Title String eName Smng Country String MicrophoneActive Bool RemainingSpeech
6. Systems 2013 July DCN SWSMD Streaming Meeting Data en 18 Where SeatData is the element Bosch Security Systems 2013 July en 19 5 CREATING A CUSTOMIZED CLIENT This describes the necessary actions to create a custom client in Microsoft Visual C to receive and decode the XML stream of the Bosch DCN Conference Software Server See also the DCN SWSMD example code on the DVD 5 1 Connecting with the TcplpActivityTraceListener Normally the default configuration does not need any changes If you did make changes to the Configuration you need to restart the DCN SW server The default port to connect to is 20000 If you do not use Net framework to create the custom client it is recommended to use Microsoft XML library to deserialize the XML stream The following C code can be used to connect with the TcplpActivityTraceListener Socket clientSocket new Socket AddressFamily InterNetwork SocketType Stream ProtocolType Tcp 20000 is the value that was set for ConnectionPort when defining the TcpIpActivityTraceListener The IP address that is used can only be used in the situation that the client and server are running on the same computer IPEndPoint ipEndPoint new IPEndPoint IPAddress Parse 127 0 0 1 20000 ciltientsocker connect 7 catch SocketException e A problem occurred Check what happened finally CIE OS CLOSE A connection sh
7. connected with the same TcplpActivityTraceListener The communication between server and custom clients is only one way as depicted by the arrow Custom Client 1 Custom Client 2 TcplpActivityTraceListener 1 TcplpActivityTraceListener n Custom Client n 3 2 Registering a TcplpActivityTraceListener s The configuration of the DCN SWSMD is done via the configuration file of the server Program Files Bosch Digital Congress Network DCN SW Server exe config In this file multiple activity loggers can be defined each with their own filter settings An activity logger can be set up to listen at a certain TCP IP port for custom clients that want to connect The filters are used to pass through only specific data The following example is taken from the server configuration file where it was added within the lt sources gt region lt source name ActivityCategory switchName ActivitySwitch switchType System Diagnostics SourceSwitch gt lt listeners gt lt remove name Default gt lt add name ListenerName gt lt listeners gt lt source gt Bosch Security Systems 2013 July en 7 Where ListenerName can be any name for the TcplpActivityTraceListener 3 3 Defining the TcplpActivityTraceListener The server configuration file needs to be extended so that the following is added within the sharedlisteners region add name ListenerName Eype UuBsschebenunsRepedsemversenmv
8. these also need to be deserialized 5 4 Lists In some occasions a list of items is send within a container The way to handle this will be explained by describing the meeting container since this contains a list of ParticipantContainers Bosch Security Systems 2013 July DCN SWSMD Streaming Meeting Data en 23 XmlRootAttribute ElementName MeetingContainer IsNullable false public class MeetingContainer lt summary gt The collection of participants within this meeting lt summary gt public List lt ParticipantContainer gt Participants get set Bosch Security Systems 2013 July DCN SWSMD Streaming Meeting Data APPENDIX A ADDITIONAL INFO 1 Enumerations The enumerations EnumTopic and EnumActivityT ype should be defined as follows public enum EnumTopic en 24 System 0 Meeting 1 Session 2 Discussion 3 Participant 4 Seat 5 Voting 6 Interpretation 7 ServiceCall 8 Booth 9 Desk 10 TestSystem 11 public enum EnumActivityType System topic SystemStarted SystemStopped Meeting topic Meet ingDataUpdated MeetingStarted Meet ingStopped AttendanceRegistrationStarted AttendanceRegistrationStopped ParticipantAdded Session topic SessionDataUpdated SessionStarted SessionStopped SessionSuspended SessionResumed Discussion topic DiscussionDataUpdated RequestListUpdated Respons
9. vote NumberOfCasts Int32 The number of casts for this answer Percentage double The percentage of participants that voted this answer Answerld The identifier of the answer for which the results are meant This identifier can be mapped on the answers present in the voting container 1 Int32 The unique identifier for this answer AnswerText String The description for this answer LegendText String The translated text for this answer Currently not yet available Correct bool Indicates that this answer is the correct one or not Score Int32 When multiple answers are correct then this score will indicate which answer has the preference Id Int32 The unique identifier for this seat lt SeatData gt The data which belongs to this seat lt Participant gt The participant which is seated at this seat lt SeatData gt Name String The name of this seat MicrophoneActive bool Indicates if the microphone is active or not SeatType Sting The type of this seat e Chairman Delegate Interpreter Operator lt Group gt Name String The name for this group RemainingGroupSpeechTime Int32 The remaining speech time for this group in seconds Contains 1 when no end time is present StopWatchState String from Indicates the state of the stopwatch of the group enum StopWatchState Participant Id Int32 The unique identifier for this participant
10. DCN SWSMD Streaming Meeting Data BOSCH en Interface Manual Bosch Security Systems 2013 July DCN SWSMD Streaming Meeting Data en 2 Bosch Security Systems 2013 July en 3 Table of Contents 1 gt E M 4 Ted EOUMO Dro eerden 4 255 eene a a cest eti 4 1 3 Definitions Acronyms and Abbreviations nuno nnneneeeerenenenneneen 4 2 Streaming Meeting Data 5 0 5 2 ASSUCS to RION Per reete e pae iita eee e tante tee Pera ite ts 5 3 oni P 6 31 EI 6 3 2 Registering a 2 22 44 0 6 3 3 Defining the TcplpActivityTraceListener 7 3 3 1 IPAAAMSSS mE 7 3 3 2 Connection OL iret dire pode dp ergo ba d e Ege ete ned E 7 7 Museo 7 3 3 5 Activity T ypeFilter ciis tanc nete nee ep dende dende 8 3 3 6 MaxQ edhte 9 3 4 Multiple TcplpActivityTraceListeners anneer eeen enneeeerenneneevenneneenen
11. Name 0003 MicrophoneActive false gt lt Seat gt Group Name gt Participant VotingIndividualResultContainer lt IndividualResults gt lt VotingTotalResults Approved true RequiredQuorum 0 ActualQuorum 0 MaximumQuorum 1 RequiredMajority 0 ActualMajority 0 MaximumMajority 1 NumberOfAuthorizedPresentParticipants 1 NumberOfAuthorizedPresentParticipantsWithoutVote 0 gt lt VotingAnswerResults gt lt VotingAnswerResultContainer AnswerId 1 NumberOfCasts 1 Percentage 100 gt VotingAnswerResultContainer AnswerId 2 NumberOfCasts 0 Percentage 0 VotingAnswerResults lt VotingTotalResults gt lt VotingGroupResults gt lt VotingGroupResultContainer NumberOfAuthorizedPresentParticipants 0 NumberOfAuthorizedPresentParticipantsWithoutVote 0 gt lt VotingAnswerResults gt VotingAnswerResultContainer AnswerId 1 NumberOfCasts 1 Percentage 100 VotingAnswerResultContainer AnswerId 2 NumberOfCasts 0 Percentage 0 lt VotingAnswerResults gt Group Name gt lt VotingGroupResultContainer gt lt VotingGroupResults gt lt VotingResults gt lt Voting gt lt VotingActivity gt A 2 6 MicrophoneTestStopped lt xml version 1 0 encoding utf 8 gt TestSystemActivity xmlns xsi http www w3 0rg 2001 XMLSchema instance xmlns xsd http www w3 org 2001 XMLSchema Version 1 TimeStamp 2011 02 14T10 38 29 1421121 01 00 Topic TestSyst
12. Security Systems 2013 July en 10 4 ACTIVITIES 4 1 Activity details The activities are divided in categories we call these categories Topics The following table describes the topics with the corresponding activities Activity Description This is send when the DCN SW server is started and it is send only once This is send when the DCN SW server is stopped and it is send only once 5 This is send when the meeting data of the Meeting MeetingDataUpdated running meeting is updated The concerning data is the subject the description and the date time at which the meeting is scheduled This is send when a meeting is started The MeetingStarted available sessions and participants for this meeting are sent This is send when a meeting is stopped Only E MeetingStopped the meeting identifier is sent S This is send when a participant is added to the SystemStopped AttendanceRegistrationStarted send when attendance registration is This is send when attendance registration is stopped This is send when the data of the running session is updated Only the identifier and the session data container are sent This is send when a session is started The information regarding the session including the votings is send This is send when a session is stopped Only m pessionetopped the session identifier is sent This is send when a session is suspended E SessionSuspended Only the sessi
13. The desk suited in this booth Number int32 The channel number in the system Language The language which belongs to this channel Abbreviation string The abbreviation of the language Name string The name of the language Desk Id Int32 The unique identifier for this desk Number Int32 The desk number lt Booth gt Booth information of the desk lt Seat gt Seat information of the desk lt Source gt The source channel used for translation lt Destination gt The destination channel used for translation lt Source gt lt Channel gt The channel used as source at the desk lt Destination gt Output EnumDestinationOutput The desk output used for the translations lt Channel gt The channel used for the destination lt MicrophoneTestResults gt List of lt MicrophoneTestResult gt The corresponding microphone test result lt MicrophoneTestResult gt The seat which is tested Passed bool Test is passed or not and the microphone is works correctly 4 2 1 Translation from activity data into XML The described activity data is translated into XML by using the following guideline e The data inside a container is added as attributes e g Seat id 1 gt where id is the attribute e References to other containers are added as elements e g Seat lt SeatData Name Seatl MicrophoneActive True Seat Bosch Security
14. Time Int32 The next diagram shows the relations of the containers for the interpretation activity Booth SericeCall Number Int32 eld Int32 di Ja e Int 1 eld Int32 current cinenf 0 1 N SeatData Source Destination eName String Output EnumDestination Output MicrophoneActive Bool 1 1 Chann 1 Language z Abbrivation String EDES Name String The next tables describe the containers in more detail The first column contains the attributes in the container and the type while the second column describes the attribute in more detail The following types are recognized as attributes Bosch Security Systems 2013 July 14 Int32 An integer of 32 bits which can contain a number in the range from 2147483648 to 2147843647 This is serialized as a string into the XML string DateTime This type contains a time on a certain date This date time is serialized into the XML string in the format 2008 08 27 13 00 51 2126576 02 00 where 13 00 51 is according the UTC time zone The 02 00 indicates the zone offset so the actual time is 15 00 51 EnumTopic A custom enumerator defined in A 1 This is serialized as a string in the XML string EnumActivityType A custom enumerator defined in A 1 This is serialized as a string in the XML string EnumDestinationOutpu
15. e sent This is send when the held voting is resumed votinghesumeg Only the voting identifier and the voting data are sent This is send when the running voting is VotingStopped stopped Only the voting identifier and the voting data are sent VotingSelected This is send when another voting is selected 9 Only the voting identifier and the voting data are sent This is send when interim voting results are enabled These interim results contain the changed values compared to the previous VotinglnterimResult activities SeatAdded This is send when a seat is added on the DCN SW server SeatUpdated This is send when the data regarding a seat is updated This is send when a seat is removed from the SeatRemoved DCN SW server X This is send when the priority button is pressed SeatPriontyButtonAciiyated on a chairman unit It includes the seat data and the seated participant This is send when the priority button is released on a chairman unit It includes the seat data and the seated participant ar ea This is send when the data regarding a Participant ParticipantUpdated participant is updated It includes the participant data the seat and the group if available VotinglnterimResult SeatPriorityButtonDeactivated Interpretation InterpretationTranslationStarted the translation S started p interpretation Translation Stopped This is send when the translation is stopped ServiceCall ServiceCallStarted This is
16. e to be removed This activity will not be sent to the external clients it will however be logged in the Windows event log When setting the MaxQueuedltems one should pass 2 numbers The first number represent the queue size when no clients are connected and the second number is used when at least 1 external client is connected If the activity logger is running without any connected external clients then the activities that occur are queued and stored The connection of an external client triggers the activity logger and all queued activities are then sent to the external client NOTE If the queued activities are sent to the external client then they are removed from the queue So new external clients will only receive new activities This field is not mandatory when it is set it replaces the default queue size of 50 500 activities Usage MaxQueuedItems MaxItemsInDisconnectedMode MaxItemsInConnectedMode Where MaxItemsInDisconnectedMode can contain one of the following values 0 1000 Where MaxItemsInConnectedMode can contain one of the following values 0 1000 3 4 Multiple TcplpActivityTraceListeners It is possible to define more then one TcplpActivityTraceListener The advantage is that each trace listener can have their own specific filter settings To do this create and register another TcplpActivityTraceListener Note that the name of the new created listener must be different then the first defined listener Bosch
17. eListUpdated ActiveListUpdated ActiveResponseListUpdated SpecialEquipmentListUpdated Seat topic SeatAdded SeatUpdated SeatRemoved SeatPriorityButtonActivated SeatPriorityButtonDeactivated Participant topic ParticipantUpdated Noting topic VotingDataUpdated VotingStarted VotingStopped VotingOnHold VotingResumed VotingSelected VotingInterimResult Bosch Security Systems 2013 July DCN SWSMD Streaming Meeting Data en 25 Interpretation topic IMS reist oneens et boa Syene edi InterpretationTranslationStopped ServiceCall topic ServiceCallStarted ServiceCallIsBeingServiced ServiceCallHandled Booth topic BoothInUse BoothNotInUse Desk topic DeskAdded public enum EnumDestinationOutput 0 1 public enum StopWatchState summary Idle state of the stopwatch lt summary gt STOPWATCH IDLE 0 summary Running state of the stopwatch lt summary gt STOPWATCH RUNNING summary Interrupted state of the stopwatch lt summary gt STOPWATCH INTERRUPTED Bosch Security Systems 2013 July DCN SWSMD Streaming Meeting Data en 26 A 2 Example XML Strings To make things more understandable a few examples of XML strings are displayed here A 2 1 SeatUpdated When an update occurs on the seat then a string will be received in which the topic is set to Seat and the ActivityType is set to S
18. eatUpdated Based on the table we should expect this SeatUpdated activity info gt lt seat gt The xml string received lt xml version 1 0 encoding utf 8 lt SeatActivity xmlns xsi http www w3 0rg 2001 XMLSchema instance xmlns xsd http www w3 org 2001 XMLSchema Version 1 TimeStamp 2008 08 27T13 00 51 2126576 02 00 Topic Seat Type SeatUpdated Seat Id 6 lt SeatData Name 0006 MicrophoneActive true Participant Id 7 lt ParticipantData Present false VotingWeight 1 VotingAuthorisation true MicrophoneAuthorisation true FirstName 0007 MiddleName LastName Title Country RemainingSpeechTime 1 gt Participant Seat lt SeatActivity gt As one can see the participant node does not contain a tag for the group This means that this participant was not assigned to a group A 2 2 Interpretation TranslationStarted lt xml version 1 0 encoding utf 8 lt InterpretationActivity xmlns xsi http www w3 org 2001 XMLSchema instance xmlns xsd http www w3 o0rg 2001 XMLSchema Version 1 TimeStamp 2008 08 27T13 00 51 2126576 02 00 Topic Interpretation Type InterpretationTranslationStarted gt Desk Number 1 gt Booth Number 1 Booth Seat Id 25 lt SeatData Name 1 1 MicrophoneActive true Seat Source Channel Number 0 Language Abbreviation FLR Name Floor lt Channel gt lt Source g
19. ed AttendanceRegistrationStarted AttendanceRegistrationStopped SessionDataUpdated SessionStarted SessionStopped SessionSuspended SessionResumed DiscussionDataUpdated RequestListUpdated ResponseListUpdated ActiveListUpdated ActiveResponseListUpdated SpecialEquipmentListUpdated VotingDataUpdated VotingStarted VotingStopped VotingOnHold VotingResumed VotingSelected VotinglnterimResults SeatAdded SeatUpdated SeatRemoved SeatPriorityButtonActivated SeatPriorityButtonDeactivated ParticipantUpdated InterpretationTranslationStarted InterpretationTranslationStopped ServiceCallStarted ServiceCalllsBeingServiced Bosch Security Systems 2013 July en 9 ServiceCallHandled ServiceCallCanceled BoothInUse BoothNotInUse DeskAdded DeskUpdated DeskRemoved ChannelTestStarted ChannelTestStopped MicrophoneTestStarted MicrophoneTestEnded MicrophoneTestCanceled MicrophoneTestFailed 3 3 6 MaxQueuedltems The activities are placed in a queue when they occur After that they are handled sequentially onto a separate thread so that the oldest in the queue is handled first This ensures that in busy periods where a lot of activities occur the activities are still send in the correct sequence to the clients However to prevent the queue to fill up with too much activities it is possible to set the maximum number of activities that are queued When an activity is queued into a full queue it will cause the oldest activity in the queu
20. em Type MicrophoneTestEnded lt MicrophoneTestResults gt lt MicrophoneTestResultContainer Passed true gt lt Seat gt lt SeatContainer Id 16 gt lt SeatData Name 0002 gt lt SeatContainer gt Bosch Security Systems 2013 July DCN SWSMD Streaming Meeting Data en 29 Bosch Security Systems 2013 July DCN SWSMD Streaming Meeting Data en 30 2013 Bosch Security Systems Data subject to change without notice Bosch Security Systems 2013 July
21. er a change is initiated This response time does not include the processing time of the external client s Bidirectional The stream is not bidirectional any data send from a custom made client to Bosch DCN Conference Software Server is ignored Bosch Security Systems 2013 July en 6 3 CONFIGURATION 3 1 Description By default the DCN SWSMD functionality is enabled and does not need any configuration settings if advanced settings are not needed this chapter can be skipped DCN SWSMD can be used to receive activities from the Bosch DCN Conference Software Server As an example it is possible to receive an activity when a meeting is started With this activity the sessions for the meeting the participants etc will also be sent The DCN SWSMD functionality is only available when the License key in the CCU or NCO contains DCN SWSMD Without this correct License key no activities are communicated with the connected client s via TCP IP The configuration of the DCN SWSMD is done via the configuration file of the server Program Files Bosch Digital Congress Network DCN SW Server exe config In this file multiple activity loggers can be defined each with their own filter settings The following describes a possible setup with multiple TcplpActivityTraceListeners running at the server side These listeners are responsible for waiting for custom clients that want to connect It is possible that multiple custom clients are
22. g and the header that was send in front of it The message header that is received when an activity is received contains the topic of the activity When this topic indicates that the ParticipantActivity is present in the message we can deserialize it For this we need the next 2 methods lt summary gt Converts the String to UTF8 Byte array and is used in deserialization lt summary gt private static Byte StringToUTF8ByteArray string pXmlString UTF8Encoding encoding new UTF8Encoding byte byteArray encoding GetBytes pXmlString return byteArray lt summary gt Reconstruct an object from an XML string lt summary gt lode T Dese telimzedljedssthellsiemtbaer Sel XmlSerializer xs new XmlSerializer typeof T MemoryStream memoryStream new MemoryStream StringToUTF8ByteArray xml XmlTextWriter xmlTextWriter new XmlTextWriter memoryStream Encoding UTF8 weeen URSI C raiz eX memos mE The deserializing of the ParticipantActivity can be done as follows ParticipantActivity participantActivity DeserializeObject ParticipantActivity receivedString ToString After this statement the participantActivity will contain the data regarding this activity The related objects like the StationContainer will also be set if that data is available in the XML string This same mechanism could be used for all the other activities This process should be duplicated for the remaining activities when
23. iceseiitacseisibenenaseeppActave ilii acehag Bosch Dcn Ecpc Server Services IpAddress 192 168 1 1 ConnectionPort 20000 AllowedClients BDAZ1063 localhost 192 168 10 3 TopicFilter Meeting Session ACE ev SENS MSS NES Bere MES MaxQueuedItems 50 100 gt Where the ListenerName is set to the ListenerName as configured in the paragraph Registering a TcplpActivityTraceListener A new activity logger is created with the name ristenerName The type defines the type and the namespace of the trace listener that is instantiated when an activity is traced 3 3 1 IPAddress This defines the IP address on which the external clients should connect This is used when multiple IP addresses are available on the computer on which the server is running This field is not mandatory If it is not set then default the activity logger will accept the connection of external clients on all IP addresses available on the server 3 3 2 ConnectionPort This defines the port at which this specific activity logger should listen for new clients This field is mandatory This specific activity logger will not start when this is not set 3 3 3 AllowedClients This can be used to only allow certain clients to connect These clients can be defined by entering the computer name or by entering IP addresses This field is not mandatory if it is not present then default all external clients are allowed to con
24. ing results The identifier for the answer given for this voting by this participant This identifier can be mapped on the answers present in the lt voting gt container lt VotingTotalResults gt Approved bool Voting is approved or not based on the settings for quorum and majority RequiredQuorum Int32 The required quorum ActualQuorum Int32 The actual quorum MaximumQuorum Int32 The maximum quorum Bosch Security Systems 2013 July en 16 lt VotingTotalResults gt RequiredMajority Int32 The required majority ActualMajority Int32 The actual majority MaximumMajority Int32 The maximum majority NumberOfAuthorizedPresentPartici The number of authorized participants which are present for the pants Int32 voting NumberOfAuthorizedPresentPartici The number of authorized participants which are present and did not pantsWithoutVote Int32 vote List of lt VotingAnswerResult gt The list of answers and the related information for this voting List of lt VotingAnswerResult gt The list of answers given within this group Group The group responsible for these results NumberOfAuthorizedPresentPartici The number of authorized participants which were present within this pants Int32 group for the voting NumberOfAuthorizedParticipantsWi The number of authorized participants which were present and did thout Vote Int32 not
25. me ParticipantActivity IsNullable false public class ParticipantActivity Activity public ParticipantActivity gulle OON Bence Sei p The participant activity has one extra property next to the ones defined in the base activity This is the participant container which contains the data regarding the participant The ParticipantContainer should be defined as follows XmlRootAttribute ElementName ParticipantContainer IsNullable false public class ParticipantContainer public ParticipantContainer lt summary gt T XmlAttribute ationale 11442522 Wel eier Sem he unique identifier for this participant lt summary gt summary The data for this participant lt summary gt qoot edicti ito amisi ertede amit Srt ME t NES Ti summary The seat at which this participant is located summary public SeatContainer Seat get set lt summary gt The group in which this participant is located lt summary gt public GroupContainer Group get set The ParticipantDataContainer should be defined as follows XmlRootAttribute ElementName ParticipantDataContainer IsNullable false public class ParticipantDataContainer public ParticipantDataContainer lt summary gt Indicates that the current participant is present or not lt summary gt XmlAttribute public bool Prese
26. message that follows Int32 topic BitConverter ToInt32 header 0 Int32 messageLength BitConverter ToInt32 header 4 byte buffer new byte messageLength byte receivedData new byte messageLength Int32 totalNumberOfBytesReceived 0 StringBuilder receivedString new StringBuilder It is possible that we do not receive the complete message in one read So expect multiple reads while totalNumberOfBytesReceived lt messageLength numberOfReceivedBytes clientSocket Receive buffer messageLength totalNumberOfBytesReceived 0 Add the received data to the buffer Array Copy buffer 0 receivedData totalNumberOfBytesReceived numberOfReceivedBytes totalNumberOfBytesReceived numberOfReceivedBytes terim eA enclsvsienmde siihineosiimcsmmeodes6eussrmeliscee ec After the call receivedString Append is executed the received XML string is present in the StringBuilder 5 3 Deserializing the received activities The easiest way to convert the XML string received in the previous paragraph into a collection of objects is to use the XML deserializing mechanism from the Framework To do this one should define classes with public properties that correspond to the properties as defined in Activities Also ensure that the defined classes that are used to deserialize the XML data have a parameterless constructor since this is necessary for the deseriali
27. nect Usage AllowedClients Client Client Where ciient can either be a host name or a valid IP address 3 3 4 TopicFilter This allows filtering the activities at the topic level It is possible to filter on multiple topics This field is not mandatory when it is not set then default no filtering takes place and all activities are send to the custom clients NOTE This is only true when the ActivityTypeFilter is not set Else the activities will also be filtered by the activity type Usage topte lees Moje I Where Topic can contain one of the following values e System e Meeting e Session e Discussion Bosch Security Systems 2013 July en 8 e Participant Seat e Voting e Interpretation e ServiceCall e Booth e Desk e TestSystem 3 3 5 ActivityTypeFilter This allows filtering the activities based on their type It is possible to set up the filtering so that only one specific activity is send to the connected clients Pay attention that in most cases it does not make sense to combine the TopicFilter and the ActivityTypeFilter use either none or only one This field is not mandatory when it is not set then default no filtering takes place on activity types Usage ActivityTypeFilter ActivityType ActivityType Where ActivityType can contain one of the following values SystemStarted SystemStopped MeetingDataUpdated MeetingStarted MeetingStopped ParticipantAdd
28. ngSelected ActivityInfo Voting Id lt VotingData gt gt VotingInterimResult ActivityInfo Voting SeatAdded ActivityInfo Seat SeatUpdated ActivityInfo Seat SeatRemoved ActivityInfo Seat Id SeatPriorityButtonActivated ActivityInfo Seat SeatPriorityButtonDeactivated ActivityInfo Seat InterpretationTranslationStopped ActivityInfo Desk ActivityInfo ServiceCall Id lt Seat gt gt ServiceCalllsBeingServiced ActivityInfo ServiceCall Id lt Seat gt gt ServiceCallHandled ActivityInfo ServiceCall Id lt Seat gt gt ServiceCallCanceled ActivityInfo ServiceCall Id lt Seat gt gt BoothInUse lt ActivityInfo gt lt Booth BoothNumber gt lt ActivityInfo gt lt Booth BoothNumber gt DeskAdded lt ActivityInfo gt lt Desk gt lt ActivityInfo gt lt Desk gt lt ActivityInfo gt lt Desk Id gt lt ActivityInfo gt lt ActivityInfo gt lt ActivityInfo gt lt ActivityInfo gt lt MicrophoneTestResults gt lt ActivityInfo gt lt ActivityInfo gt Bosch Security Systems 2013 July DCN SWSMD Streaming Meeting Data 4 2 Activity containers en 13 This paragraph describes containers that are used to transfer the activity data onto the connected custom clients Some data within these containers is optional and will not always be available in the received XML string Optional fields are embraced with the characters It is possible that
29. nneenennnen nennen ennen 9 A ACUVILOGS tetro cime A nee debate rm e ILL c UM eee Le c D ELA abend 10 4 1 Activity detalls hg ete tie ped c Perd ete eat a annae endet eee Deren nn 10 4 2 ActVIty CONTAINS Ie eae hata ee pae ve Tap ee Ree en 13 4 2 1 Translation from activity data into enn 17 5 Creating a customized 19 5 1 Connecting with the TcplpActivityTraceListener unne neen 19 5 2 Receiving the datas itat cote ne tert 19 5 3 Deserializing the received 20 5 4 Listo roe ette oit onm im dpt es 22 Appendix A ADDITIONAL 24 Ad En meratiOriS manken ee e noten eee 24 A 2 Example XML Strings retten over d ro tite es 26 A 2 1 SeatUpdaled eterno breeds ed ELSE et 26 A 2 2 InterpretationTranslationStarted sse 26 2 3 M etingStarted e Lh db ED E e 27 A 2 4 MeetingStopped 28 2 5 5 chu eter enter ee atten 28 A 2 6 MicrophoneTestStopped 2 4 4 8 00000 28 Bosch Security Systems 2013 July DCN SWSMD Streaming Meeting Data en 4
30. nt get set Bosch Security Systems 2013 July en 22 summary The voting weight for this participant summary XmlAttribute public Int32 VotingWeight get set lt summary gt Is this participant authorized to vote lt summary gt XmlAttribute public bool VotingAuthorisation get set summary Is this participant authorized to use the microphone lt summary gt XmlAttribute public bool MicrophoneAuthorisation get set lt summary gt The first name of this participant summary XmlAttribute public string FirstName get set lt summary gt The middle name of this participant lt summary gt XmlAttribute public string MiddleName get set lt summary gt The last name of this participant lt summary gt XmlAttribute public string LastName get set summary The title of this participant summary XmlAttribute public string Title get set summary The country set for this participant lt summary gt XmlAttribute public string Country get set summary The remaining speech time in seconds for this participant lt summary gt XmlAttribute public Int32 RemainingSpeechTime get set After defining the StationContainer and the GroupContainer one is ready to deserialize the ParticipantActivity In one of the previous examples we had the receivedString that contained the XML strin
31. on identifier is sent AttendanceRegistrationStopped Session SessionDataUpdated SessionStarted This is send when a session is resumed Only the session identifier is sent I This is send when the data of the running Piscussion DiscussionDataUpoated discussion is updated Only the identifier and the discussion data are sent This is send when the request list is updated Only the discussion identifier and the list are sent This is send when the response list is updated Only the discussion identifier and the list are sent This is send when the active list is updated Only the discussion identifier and the list are sent This is send when the active response list is updated Only the discussion identifier and the list are sent This is send when the special equipment list is updated Only the discussion identifier and the list are sent This is send when the data of a voting is updated Only the identifier and the voting data container are sent This is send when the voting is started The identifier the voting data and the possible answers are sent SessionResumed RequestListUpdated ResponseListUpdated ActiveListUpdated ActiveResponseListUpdated SpecialEquipmentListUpdated VotingDataUpdated VotingStarted Bosch Security Systems 2013 July en 11 Activity Description This is send when the running voting is held VENO Only the voting identifier and the voting data ar
32. ould have been made successfully when the server was restarted and the configuration was successful 5 2 Receiving the data The data concerning an activity is received as follows e Header The header is binary and contains the topic that is contained in the activity and the length of the message that follows e Message This is a string in which the activity is streamed as XML The format of the header is as follows Content Size in bytes Description Topic 4 The topic of the activity that is present in the message this is in little endian format This is an Int32 and can be mapped onto the enum EnumTopic as described in Additional Info Message The length of the message that is located in the received data length after this header this is in little endian format After the connection is succesfully made with the TcplpActivityTraceListener one could do the following to retrieve the complete message While quit Bosch Security Systems 2013 July en 20 For each message a header is sent that contains 8 bytes if clientSocket Available 8 First we read the header byte header new byte 8 int numberOfReceivedBytes clientSocket Receive header 8 0 if numberOfReceivedBytes 8 throw new InternalOperationException Header receival problem The header contains 2 integers the first 4 bytes contains the topic and the remaining 4 bytes contain the length of the
33. questList gt List of lt Participant gt The participants in this list lt ResponseList gt List of lt Participant gt The participants in this list lt ActiveList gt List of lt Participant gt The participants in this list lt ActiveResponseList gt List of lt Participant gt lt SpecialEquipmentList 1 The participants in this list List of Participant The participants in this list Id 11132 The unique identifier for this voting lt VotingData gt The data which belongs to this voting lt VotingResults gt The results that belong to this voting List of lt VotingAnswers gt The possible answers for this voting lt VotingData gt Name String The name for this voting Subject String The subject of this voting VotingType String The type of this voting RemainingVotingTime Int32 The remaining voting time in seconds Contains 1 when no end time is present lt voting results gt List of lt VotingIndividualResult gt A list that contains the individual results for each participant for this voting lt VotingTotalResults gt The total results for this voting List of lt VotingGroupResult gt A list that contains the individual results for each group for this voting lt VotingIndividualResult gt lt Participant gt Answerld Int32 The participant which is responsiblefor these vot
34. send when the usher is called HERE ServiceCalllsBelngServiced TRUM when the usher starts servicing T ServiceCallHandled is send when the usher has handled the EE ServiceCallCanceled This is send when the call is canceled BoothInUse This is send when the booth is in use BoothNotlnUse 1 is send when the booth is no longer This is send when a desk is added on the DCN SW server DeskUpdated This is send when the data regarding a desk is updated Deskhemove This is send when a desk is removed on the DCN SW server TestSystem ChannelTestStarted This is send when the channel test is started p ChannelTestStopped This is send when the channel test is stopped MicrophoneTestStarted This is send when the microphone test is started MicrophoneTestEnded This is send when the microphone test is ended This is send when the microphone test is DEREN MicrophoneTestCanceled Bosch Security Systems 2013 July en 12 Activity Description This is send when the microphone test is failed Microphone test is considered as failed when user does not get any response from CCU regarding the test results MicrophoneTestFailed The following table describes the activities and the corresponding data in more detail To describe which data is send or not is described in the data column as follows Seat 2 Allitems within seat are filled in if possible If no participant is seated then the Par
35. t Destination Output A Channel Number 2 Language Abbreviation NLD Name Dutch lt Channel lt Destination gt lt Desk gt lt InterpretationActivity gt Bosch Security Systems 2013 July DCN SWSMD Streaming Meeting Data en 27 A 2 3 MeetingStarted lt xml version 1 0 encoding utf 8 lt MeetingActivity xmlns xsi http www w3 0rg 2001 XMLSchema instance xmlns xsd http www w3 o0rg 2001 XMLSchema Version 1 TimeStamp 2008 08 27T13 33 18 4660052402 00 Topic Meeting Type MeetingStarted gt lt Meeting Id 1 gt lt MeetingData Subject DefaultMeeting DateTime 2008 08 27T13 22 33 097 Description gt Sessions lt SessionContainer Id 1 gt lt SessionData Subject Session Description Description Done false gt lt SessionContainer gt lt Sessions gt lt Participants gt lt ParticipantContainer Id 2 gt lt ParticipantData Present false VotingWeight 1 VotingAuthorisation true MicrophoneAuthorisation true FirstName Carl MiddleName the LastName Coder Title Sir Country Spain RemainingSpeechTime 1 Seat Id 3 lt SeatData Name 0003 MicrophoneActive false gt Seat Group Name lt ParticipantContainer gt lt The next participants are located here gt Participants Channels Channel Number 1 Language Abbreviation ENG Name English Channel Channel Number 2
36. t A custom enumerator defined in A 1 This is serialized as a string in the XML string Bool Indicates that a flag is either true or false This is serialized as a string into the XML string as either True or False String Directly serialized into the XML string StopWatchState A Custom enumerator defined for Group Speech time This is serialized as a string in the XML string ActivityInfo Version Int32 The version of the data definition for this activity This will only change when updates take place on the data definition during development Timestamp DateTime The date time at which this activity occurred Defines the topic of this activity Topic string from EnumTopic Type string from EnumActivityType Defines the specific type of the activity Id Int32 The unique identifier for this meeting MeetingData The data for the meeting List of Session The corresponding sessions for this meeting List of Participant The participants for this meeting List of lt Channel gt The channels for this meeting List of Booth The booths with their desks for this meeting lt MeetingData gt Subject String The subject of this meeting DateTime DateTime The date time at which this meeting should start Description String Session Id Int32 The description for this meeting Unique identifier for this session
37. the license key in the CCU does not contain DCN SWSMD then activities are not queued e Configuration By default the DCN SWSMD functionality is enabled and does not need any configuration settings Access Control Access control for custom made clients is done via a list of allowed IP addresses When a client tries to connect from an IP address which is not present in the list then the connection is rejected This list of allowed IP addresses is optional and all clients are accepted when this list is not set e Filtering Filter options are available to define which type of activities are streamed Filtering is optional and when no filtering is configured all activities are streamed Queues o The size of the queue in which the activities are placed before they are streamed can be defined for both the connected at least one client is connected and the disconnected state o The activity queue will hold queued activities even when no clients are connected When a client connects it will cause the queue to start sending the queued activities after which they are removed from the queue o The activity queue has a limited size Queuing activities into a full queue will cause the oldest activities to be removed The activities which are removed from the queue will be logged as a warning into the event log e Performance On a typical system running without any problems meeting data is communicated to the connected clients within 1 second aft
38. ticipant field within seat is not filled in Seat Id gt gt Only the identifier within seat is filled in The rest of the fields are not set even if a participant is seated SystemStarted lt ActivityInfo gt lt ActivityInfo gt lt ActivityInfo gt lt Meeting Id lt MeetingData gt gt lt ActivityInfo gt lt Meeting gt MeetingStopped lt ActivityInfo gt lt Meeting Id gt lt ActivityInfo gt lt Meeting Id lt Participant gt gt lt ActivityInfo gt lt Meeting d gt lt ActivityInfo gt lt Meeting Id gt lt ActivityInfo gt lt Session Id lt SessionData gt gt SessionStarted lt ActivityInfo gt lt Session gt SessionStopped lt ActivityInfo gt lt Session Id gt lt ActivityInfo gt lt Session Id lt ActivityInfo gt lt Session Id lt ActivityInfo gt lt Discussion Id lt DiscussionData gt gt lt ActivityInfo gt lt Discussion Id lt RequestList gt gt lt ActivityInfo gt lt Discussion Id lt ResponseList gt gt lt ActivityInfo gt lt Discussion Id lt ActiveList gt gt lt ActivityInfo gt lt Discussion Id lt ActiveResponseList gt gt lt ActivityInfo gt lt Discussion Id lt SpecialEquipmentList gt gt VotingDataUpdated lt ActivityInfo gt lt Voting Id lt VotingData gt gt VotingStarted lt ActivityInfo gt lt Voting Id gt VotingOnHold lt ActivityInfo gt lt Voting Id gt VotingResumed lt Activitylnfo gt lt Voting Id gt VotingStopped ActivityInfo Voting Voti
39. zation process The following activities can be send from the DCN SW server when Streaming Meeting Data is enabled SystemActivity MeetingActivity SessionActivity DiscussionActivity VotingActivity SeatActivity ParticipantActivity InterpretationActivity ServiceCallActivity BoothActivity DeskActivity TestSystemActivity Bosch Security Systems 2013 July en 21 These activities have some corresponding properties so the best way to deserialize these is to have a generic base class that contains these properties The next code fragment describes a possible implementation for this base class XmlRootAttribute ElementName Activity IsNullable false PUIDI SIA MISSA CG ERVEN protected Activity summary The version of this activity This can be used to check if the activity matches the expected version lt summary gt XmlAttribute public Int32 Version get set summary T XmlAttribute public DateTime TimeStamp get set he date time at which the activity occurred lt summary gt lt summary gt 1 XmlAttribute public EnumTopic Topic get set he topic of this activity summary lt summary gt 1 XmlAttribute public EnumActivityType Type get set he type of this activity lt summary gt The specific activities are derived from this base class As an example the participant activity is displayed XmlRootAttribute ElementNa
Download Pdf Manuals
Related Search