Bosch DCN-SWSMD-E User Manual

Download

Page 1

DCN SWSMD

en Interface Manual

Streaming Meeting Data

Bosch Security Systems | 2013 July

Page 2

DCN-SWSMD Streaming Meeting Data

en | 2

Bosch Security Systems | 2013 July

Page 3

DCN-SWSMD Streaming Meeting Data

Table of Contents

en | 3

1. Introduction.............................................................................................................................................. 4

1.1 Purpose ......................................................................................................................................... 4

1.2 Scope ............................................................................................................................................ 4

1.3 Definitions, Acronyms and Abbreviations ..................................................................................... 4

2. Streaming Meeting Data (DCN-SWSMD) ............................................................................................... 5

2.1 Issues to know: ............................................................................................................................. 5

3. Configuration ........................................................................................................................................... 6

3.1 Description .................................................................................................................................... 6

3.2 Registering a TcpIpActivityTraceListener(s) ................................................................................. 6

3.3 Defining the TcpIpActivityTraceListener ....................................................................................... 7

3.3.1 IPAddress ........................................................................................................................ 7

3.3.2 ConnectionPort ................................................................................................................ 7

3.3.3 AllowedClients ................................................................................................................. 7

3.3.4 TopicFilter ........................................................................................................................ 7

3.3.5 ActivityTypeFilter.............................................................................................................. 8

3.3.6 MaxQueuedItems............................................................................................................. 9

3.4 Multiple TcpIpActivityTraceListeners ............................................................................................ 9

4. Activities ................................................................................................................................................. 10

4.1 Activity details ............................................................................................................................. 10

4.2 Activity containers ....................................................................................................................... 13

4.2.1 Translation from activity data into XML ......................................................................... 17

5. Creating a customized client................................................................................................................ 19

5.1 Connecting with the TcpIpActivityTraceListener ......................................................................... 19

5.2 Receiving the data ...................................................................................................................... 19

5.3 Deserializing the received activities ............................................................................................ 20

5.4 Lists ............................................................................................................................................. 22

Appe n dix A. ADDI T IONAL INFO ............................................................................................................... 24

A.1. Enumerations ............................................................................................................................. 24

A.2. Example XML Strings ................................................................................................................ 26

A.2.1. SeatUpdated ................................................................................................................. 26

A.2.2. InterpretationTranslationStarted ................................................................................... 26

A.2.3. MeetingStarted ............................................................................................................. 27

A.2.4. MeetingStopped ........................................................................................................... 28

A.2.5. VotingStopped .............................................................................................................. 28

A.2.6. MicrophoneTestStopped .............................................................................................. 28

Bosch Security Systems | 2013 July

Page 4

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.

TcpIpActivityTraceListener

Standard Windows activity listener

DCN-SWSMD Streaming Meeting Data

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 The code examples within this document are based on C# from framework 3.5.

1.3 Definitions, Acronyms and Abbreviations

party software developers.

en | 4

Bosch Security Systems | 2013 July

Page 5

DCN-SWSMD Streaming Meeting Data

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 the license key in the CCU does not contain DCN-SWSMD then activities are not queued.

• 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.

• 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.

en | 5

o The activity queue will hold queued acti vities eve n whe n no clients are connec t ed. 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.

• Performance On a typical system, running without any problems, meeting data is communicated to the connected clients within 1 second after 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

Page 6

Client 1

Client 2

Client n

DCN-SWSMD Streaming Meeting Data

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 TcpIpActivityTraceListeners 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 connected with the same TcpIpActivityTraceListener. The communication between server and custom clients is only one way as depicted by the arrow.

en | 6

Custom

TcpIpActivityTraceLis te ner #1

Custom

TcpIpActivityTraceLis te ner #n

3.2 Registering a TcpIpActivityTraceListener(s)

DCN-SW Server

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 <sources> region:

<source name="ActivityCategory" switchName="ActivitySwitch"

switchType="System.Diagnostics.SourceSwitch"> <listeners> <remove name="Default"/> <add name="[ListenerName]"/> </listeners> </source>

Bosch Security Systems | 2013 July

Page 7

DCN-SWSMD Streaming Meeting Data

Where [ListenerName] can be any name for the TcpIpActivityTraceListener

3.3 Defining the TcpIpActivityTraceListener

The server configuration file needs to be extended so that the following is added within the <sharedlisteners> region:

<add name="[ListenerName]"

type="Bosch.Dcn.Ecpc.Server.Services.TraceListeners.TcpIpActivityTraceListener, Bosch.Dcn.Ecpc.Server.Services" IpAddress="192.168.1.1" ConnectionPort="20000" AllowedClients="BD AZ1063, localh os t, 192.168.10. 3" TopicFilter="Meeting, Session" ActivityTypeFilter="MeetingSta rted, Session Started" MaxQueuedItems="50, 100"/>

Where the [ListenerName] is set to the [ListenerName] as configured in the paragraph “Registering a TcpIpActivityTraceListener”.

A new activity logger is created with the name [ListenerName]. The type defines the type and the namespace of the trace listener that is instantiated when an activity is traced.

en | 7

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 connect.

Usage

AllowedClient s="[Client] [, [Client]]"

Where [Client] 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

TopicFilter=" [Topic][, [Top ic]]"

Where [Topic] can contain one of the following values:

• System

• Meeting

• Session

• Discussion

Bosch Security Systems | 2013 July

Page 8

DCN-SWSMD Streaming Meeting Data

• Participant

• Seat

• Voting

• Interpretation

• ServiceCall

• Booth

• Desk

• 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="[ActivityTy pe][, [ActivityType]]"

en | 8

Where [ActivityType] can contain one of the following values:

• SystemStarted

• SystemStopped

• MeetingDataUpdated

• MeetingStarted

• MeetingStopped

• ParticipantAdded

• AttendanceRegistrationStarted

• AttendanceRegistrationStopped

• SessionDataUpdated

• SessionStarted

• SessionStopped

• SessionSuspended

• SessionResumed

• DiscussionDataUpdated

• RequestListUpdated

• ResponseListUpdated

• ActiveListUpdated

• ActiveResponseListUpdated

• SpecialEquipmentListUpdated

• VotingDataUpdated

• VotingStarted

• VotingStopped

• VotingOnHold

• VotingResumed

• VotingSelected

• VotingInterimResults

• SeatAdded

• SeatUpdated

• SeatRemoved

• SeatPriorityButtonActivated

• SeatPriorityButtonDeactivated

• ParticipantUpdated

• InterpretationTranslationStarted

• InterpretationTranslationStopped

• ServiceCallStarted

• ServiceCallIsBeingServiced

Bosch Security Systems | 2013 July

Page 9

DCN-SWSMD Streaming Meeting Data

• ServiceCallHandled

• ServiceCallCanceled

• BoothInUse

• BoothNotInUse

• DeskAdded

• DeskUpdated

• DeskRemoved

• ChannelTestStarted

• ChannelTestStopped

• MicrophoneTestStarted

• MicrophoneTestEnded

• MicrophoneTestCanceled

• MicrophoneTestFailed

3.3.6 MaxQueuedItems

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 queue to be removed. This activity will not be sent to the external clients, it will however be logged in the Windows event log.

en | 9

When setting the MaxQueuedItems 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 recei ve new a ctiv iti es.

This field is not mandatory, when it is set, it replaces the default queue size of 50.500 activities. Usage

MaxQueuedI tems="MaxIte msInDisconnectedMode, MaxItemsInConnec tedMode"

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 TcpIpActivityTraceListeners

It is possible to define more then one TcpIpActivityTraceListener. The advantage is that each trace listener can have their own specific filter settings. To do this create and register another TcpIpActivityTraceListener. Note that the name of the new created listener must be different then the first defined listener.

Bosch Security Systems | 2013 July This is send when the DCN-SW server is started and it is send only once.

Page 10

This is send when the DCN-SW server is stopped and it is send only once.

This is send when the meeting data of the

date/time at which the meeting is scheduled.

This is send when a meeting is started. The meeting are sent.

This is send when a meeting is stopped. Only the meeting identifier is sent.

This is send when a participant is added to the running meeting.

This is send when attendance registration is started .

This is send when attendance registration is stopped .

This is send when the data of the running session data container are sent.

This is send when a session is started. The votings is send.

This is send when a session is stopped. Only the session identifier is sent.

This is send when a session is suspended. Only the session identifier is sent.

This is send when a session is resumed. Only the session identifier is sent.

This is send when the data of the running the discussion data are sent.

This is send when the request list is upd ated . sent.

This is send when the response list is updated. sent.

This is send when the active list is updated. sent.

This is send when the active response list is list are sent.

This is send when the special equipment list is list are sent.

This is send when the data of a voting is container are sent.

This is send when the voting is started. The answers are sent.

DCN-SWSMD Streaming Meeting Data

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.

Topic Activity Description

System SystemStarted SystemStopped

en | 10

Meeting MeetingDataUpdated

MeetingStarted

MeetingStopped ParticipantAdded

AttendanceRegistrationStarted AttendanceRegistrationStopped

Session SessionDataUpdated

SessionStarted

SessionStopped SessionSuspended SessionResumed

running meeting is updated. The concerning data is the subject, the description and the

available sessions and particip ants for this

session is updated. Only the identifier and the

information regarding the se ssion inc ludi ng the

Discussion DiscussionDataUpdated

RequestListUpdated

ResponseListUpdated

ActiveListUpdated

ActiveResponseListUpdated

SpecialEquipmentListUpdated

Voting VotingDataUpdated

VotingStarted

discussion is updated. Only the identifier and

Only the discussion identifier and the list are

updated. Only the discussion identifier and the

updated. Only the identifier and the voting data

identifier, the voting data and the possible

Bosch Security Systems | 2013 July

Page 11

This is send when the running voting is held. are sent.

This is send when the held voting is resumed. are sent.

This is send when the running voting is voting data are sent.

This is send when another voting is selected. are sent.

This is send when interim voting results are

VotingInterimResult activities.

This is send when a seat is added on the DCNSW server.

This is send when the data regarding a seat is updated.

This is send when a seat is removed from the DCN-SW server.

This is send when the priority button is pressed and the seated participant.

This is send when the priority button is seat data and the seated participant.

This is send when the data regarding a

available.

This is send when the translation is started.

This is send when the translation is stopped.

This is send when the usher is called.

This is send when the usher starts servicing the call.

This is send when the usher has handled the call.

This is send when the call is canceled.

This is send when the booth is in use.

This is send when the booth is no longer in use.

This is send when a desk is added on the DCN-SW server.

This is send when the data regarding a desk is updated.

This is send when a desk is removed on the DCN-SW server.

This is send when the channel test is started.

This is send when the channel test is stopped.

This is send when the microphone test is started.

This is send when the microphone test is ended.

This is send when the microphone test is canceled.

DCN-SWSMD Streaming Meeting Data

Topic Activity Description

en | 11

VotingOnHold

VotingResumed

VotingStopped

VotingSelected

VotingInterimResult

Seat SeatAdded SeatUpdated SeatRemoved SeatPriorityButtonActivated

SeatPriorityButtonDeactivated

Only the voting identifier and the voting data

stopped. Only the voting identifier and the

Only the voting identifier and the voting data

enabled. These interim results contain the changed values compared to the previous

on a chairman unit. It includes the seat data

released on a chairman unit. It includes the

Participant ParticipantUpdated

Interpretation InterpretationTranslationStarted InterpretationTranslationStopped ServiceCall ServiceCallStarted ServiceCallIsBeingServiced ServiceCallHandled ServiceCallCanceled Booth BoothInUse BoothNotInUse

Desk DeskAdded DeskUpdated DeskRemoved

TestSystem ChannelTestStarted

participant is updated. It includes the participant data, the seat and the group if

ChannelTestStopped MicrophoneTestStarted MicrophoneTestEnded MicrophoneTestCanceled

Bosch Security Systems | 2013 July

Page 12

This is send when the microphone test is failed.

regarding the test results.

SystemStarted

SystemStopped

MeetingDataUpdated

MeetingStarted

MeetingStopped

ParticipantAdded

AttendanceRegistrationStarted

AttendanceRegistrationStopped

SessionDataUpdated

SessionStarted

SessionStopped

SessionSuspended

SessionResumed

DiscussionDataUpdated

RequestListUpdated

ResponseListUpdated

ActiveListUpdated

ActiveResponseListUpdated

SpecialEquipmentListUpdated

VotingDataUpdated

VotingStarted

VotingOnHold

VotingResumed

VotingStopped

VotingSelected

VotingInterimResult

SeatAdded

SeatUpdated

SeatRemoved

SeatPriorityButtonActivated

SeatPriorityButtonDeactivated

ParticipantUpdated

InterpretationTranslationStarted

InterpretationTranslationStopped

ServiceCallStarted

ServiceCallIsBeingServiced

ServiceCallHandled

ServiceCallCanceled

BoothInUse

BoothNotInUse

DeskAdded

DeskUpdated

DeskRemoved

ChannelTestStarted

ChannelTestStopped

MicrophoneTestStarted

MicrophoneTestEnded

MicrophoneTestCanceled

MicrophoneTestFailed

DCN-SWSMD Streaming Meeting Data

Topic Activity Description

en | 12

MicrophoneTestFailed

Microphone test is considered as failed when user does not get any response from CCU

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>

All items within seat are filled in if possible. If no participant is seated then the

<Participant> field within seat is not filled in. <Seat(Id)>



Only the identifier within seat is filled in. The rest of the fields are not set even if

a participant is seated.

Activity Data

Bosch Security Systems | 2013 July

Page 13

DCN-SWSMD Streaming Meeting Data

4.2 Activity containers

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 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 <> 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:

en | 13

The next diagram shows the relations of the containers for the interpretation activity:

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

Page 14

Version (Int32)

The version of the data definition for this activity. This will only development.

Timestamp (DateTime)

The date/time at which this activity occurred.

Topic (string from EnumTopic)

Defines the topic of this activity.

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 <Channel>]

The channels for this meeting.

[List of <Booth>]

The booths with their desks for this meeting.

Subject (String)

The subject of this meeting.

DateTime (DateTime)

The date/time at which this meeting should start.

Description (String)

The description for this meeting.

Id (Int32)

Unique identifier for this session.

[<SessionData>]

The data that belongs to this session.

[<Discussion>]

The discussion that runs within this session.

[List of <Voting>]

The votings for this session.

[List of <Groups>]

This contains a list of groups.

[List of <Particpants>}

The participants in this list.

Subject (String)

The subject of this session.

Description (String)

The description of this session.

Done (bool)

Indicates if this session is done.

Id (Int32)

The unique identifier for this discussion.

DCN-SWSMD Streaming Meeting Data

• 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-27T 13: 00: 51.2 126 576 +0 2:0 0” where 13:0 0:51 is accord ing the U TC 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.

• EnumDestinationOutput 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.

en | 14

• StopWatchState A Custom enumerator defined for Group Speech time. This is serialized as a string in the XML string.

change when updates take place on the data definition during

Bosch Security Systems | 2013 July

Page 15

[<DiscussionData>]

The data for this discussion.

[<RequestList>]

This contains the participants who are currently requesting to speak.

[<ResponseList>]

This contains the participants who are currently requesting to respond to an active speaker.

[<ActiveList>]

This contains the participants who are currently speaking.

[<ActiveResponseList>]

This contains the participants who are currently responding to a previously active speaker.

[<SpecialEquipmentList>]

This contains a list of special equipment (e.g. notebooks).

[List of <ActiveGroups>]

This contains a list of Active groups.

NumberOfActiveMicrophones (Int32)

The number of microphones which are currently active.

List of <Participant>

The participants in this list.

List of <Participant>

The participants in this list.

List of <Participant>

The participants in this list.

List of <Participant>

The participants in this list.

List of <Participant>

The participants in this list.

Id (Int32)

The unique identifier for this voting.

[<VotingData>]

The data which belongs to this voting.

[<VotingResults>]

The results that belong to this voting.

[List of <VotingAnswers>]

The possible answers for this voting.

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.

[List of <VotingIndividualResult>]

A list that contains the individual results for each participant for this voting.

[<VotingTotalResults>]

The total results for this voting.

[List of <VotingGroupResult>]

A list that contains the individual results for each group for this voting.

The participant which is responsiblefor these voting results.

AnswerId (Int32)

The identifier for the answer given for this voting by this participant. <voting> container.

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.

DCN-SWSMD Streaming Meeting Data

en | 15

This identifier can be mapped on the answers present in the

Bosch Security Systems | 2013 July

Page 16

RequiredMajority (Int32)

The required majority.

ActualMajority (Int32)

The actual majority.

MaximumMajority (Int32)

The maximum majority.

NumberOfAuthorizedPresentPartici pants (Int32)

The number of authorized participant s which are present for the voting.

NumberOfAuthorizedPresentPartici pantsWithoutVote (Int32)

The number of authorized participants which are present and did not vote.

List of <VotingAnswerResult>

The list of answers and the related information for this voting.

List of <VotingAnswerResult>

The list of answers given within this group.

<Group>

The group responsible for these results.

NumberOfAuthorizedPresentPartici pants (Int32)

The number of authorized participants which were present within this group for the voting.

NumberOfAuthorizedParticipantsWi thout Vote (Int32)

The number of authorized participants which were present and did not vote.

NumberOfCasts (Int32)

The number of casts for this answer.

Percentage (double)

The percentage of participants that voted this answer.

AnswerId

The identifier of the answer for which the results are meant. This container.

Id (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.

<Seat>

Id (Int32)

The unique identifier for this seat.

[<SeatData>]

The data which belongs to this seat.

[<Participant>]

The participant which is seated at this seat.

Name (String)

The name of this seat

MicrophoneActive (bool)

Indicates if the microphone is active or not.

SeatType (Sting)

The type of this seat.

• Unknown (unassigned seat)

<Group>

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 enum[StopWatchState])

Indicates the state of the stopwatch of the group. <Participant>

Id (Int32)

The unique identifier for this participant.

[<ParticipantData>]

The data which belongs to this participant.

[<Seat>]

The seat at which this participant is seated.

[<Group>]

The group in which this participant is located.

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.

DCN-SWSMD Streaming Meeting Data

en | 16

identifier can be mapped on the answers present in the <voting>

• Chairman

• Delegate

• Interpreter

• Operator

Bosch Security Systems | 2013 July

Page 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 voice activated or Push-To-Talk this value is always -1).

SpeechTimerOnHold (bool)

Indicates that the speech timer is (or is not) on hold.

Id (Int32)

The unique identifier for this service call.

[<Seat>]

The seat at which this service call is initiated.

<Booth>

Number (Int32)

The number of the booth.

[List of <Desk>]

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.

[<Booth>]

Booth information of the desk.

[<Seat>]

Seat information of the desk

[<Source>]

The source channel used for translation.

[<Destination>]

The destination channel used for translation.

[<Channel>]

The channel used as source at the desk.

Output (EnumDestinationOutput)

The desk output used for the translations.

[<Channel>]

The channel used for the destination.

List of <MicrophoneTestResult >

The corresponding microphone test result.

<Seat>

The seat which is tested.

Passed (bool)

Test is passed (or not) and the microphone is works correctly.

DCN-SWSMD Streaming Meeting Data

en | 17

1 when no end time is present (In case the microphone mode is

4.2.1 Translation from activity data into XML

The described activity data is translated into XML by using the following guideline:

• The data inside a container is added as attributes; e.g. <Seat id=”1”> where id is the attribute

• References to other containers are added as elements;

e.g. :

<Seat>

</Seat>

Bosch Security Systems | 2013 July

Page 18

DCN-SWSMD Streaming Meeting Data

Where SeatData is the element.

en | 18

Bosch Security Systems | 2013 July

Page 19

DCN-SWSMD Streaming Meeting Data

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 TcpIpActivityTraceListener

Normally the default configuration does not need any changes.

en | 19

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 TcpIpActivityTraceListener:

Socket clien tSocket = new Socket(AddressFa mily.InterNetwork, SocketType.Stream, Pr ot ocolType.Tcp );

try { // 20000 is the value that was set for Co nnectionPort when defining the // TcpIpActivityTraceListener. The IP addre ss that is used can only be // used in the situation that the cli ent and server are // running on the same computer. IPEndPoint ipEn dPoint = new IPEnd Point(IPAddr ess.Parse(“127.0.0.1”), 20 000); clientSocket.Connect(ipEndPoint); } catch (SocketException e) { // A problem occurred … Check what ha ppened. } finally { clientSocket.Close(); }

A connection should 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:

• Header The header is binary and contains the topic that is contained in the activity and the length of the message that follows

• 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

Message length

After the connection is succesfully made with the TcpIpActivityTraceListener one could do the following to retrieve the complete message:

While (!quit) {

4 The topic of the activity that is present in the message, this is

4 The length of the message that is located in the received data

in little-endian format. This is an Int32 and can be mapped onto the enum EnumTopic as described in

after this header, this is in little-endian format.

Additional Info.

Bosch Security Systems | 2013 July

Page 20

DCN-SWSMD Streaming Meeting Data

// For each message a header is sent th at contains 8 byte s. if (clientSocket.Available > 8) { // First we read the header. byte[] heade r = new byte[8]; int numberOf ReceivedBytes = clientSocket .Receive(header, 8, 0);

if (numberOfReceivedBytes != 8) throw new Inte rnalOperationException(" Header receival problem");

// The header contains 2 integers , th e first 4 bytes contains the topic // and the remaining 4 bytes contai n the length of the me ssage that follows. Int32 topic = Bi tConverter.ToInt32(heade r, 0); Int32 messag eLength = BitConverter.ToInt 32(header, 4); byte[] buffer = new byte[messageLength]; byte[] recei vedData = new byte[messageLeng th]; Int32 totalNumb erOfBytesRec eived = 0; StringBuilder receivedString = new StringBu ilder();

// It is possible that we do not receiv e the complete mes sage in // one read. So expect multiple rea ds. while (total NumberOfBytesReceived < mess ageLength) { numberOfRecei vedBytes = clien tSocket.Rece ive(buffer, messageLength - totalNumberOfBytesReceiv ed, 0);

// Add the received data to the buffer. Array.Copy(buffer, 0, receivedData, totalNumberOfBytesReceived, numberOfReceivedBytes);

totalNumberOf BytesReceiv ed += numberOfRec eivedBytes; } receivedString.Append(System.Text.Encoding.Unicode.GetString(receivedData)); } }

en | 20

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 deserialization 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

Page 21

DCN-SWSMD Streaming Meeting Data

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:

[XmlRootAt tribute(Elem entName = "Activity", IsNullable = false)] public abstr act class Activity { protected Ac tivity(){}

/// <summary>The version of thi s ac tivity. This can be used to check if the /// activity matches the expected version.</summary> [XmlAttribute] public Int32 Vers ion { get; set; }

/// <summary >The date/time at which the activity occurred.</summary> [XmlAttribute] public DateTime TimeStamp { get; set; }

/// <summary>The topic of this ac ti vity.</summa ry> [XmlAttribute] public EnumTopi c Topic { get; set; }

/// <summary >The type of this activity.</summary> [XmlAttribute] public EnumActi vityType Type { ge t; set; } }

en | 21

The specific activities are derived from this base class. As an example the participant activity is displayed:

[XmlRootAt tribute(Elem entName = "ParticipantActivity", IsNullable = false)] public class Part icipantActiv ity : Activity { public Particip antActivity( ) {}

public Parti cipantContainer Participan t { get; set ; } }

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:

[XmlRootAt tribute(Elem entName = "ParticipantContainer", IsNullable = false)] public class Part icipantContainer { public Particip antContainer () {}

/// <summary>The unique ident if ier for this part icipant.</summary> [XmlAttribute] public Int32 Id { get ; s et }

/// <summary>The data for this participant.</summary> public Particip antDataConta iner Participa ntData { get; set }

/// <summary>The seat at which th is participant is lo cated.</summ ar y> public SeatCont ainer Seat { get; se t }

/// <summary >The group in which this participant is located.</ summary> public GroupCon tainer Group { get ; set } }

The ParticipantDataContainer should be defined as follows:

[XmlRootAt tribute(Elem entName = "ParticipantDataContainer", IsNullable = false)] public class Part icipantDataC ontainer { public Particip antDataConta iner() {}

/// <summary >Indicates that the current participant is present or not.</summary> [XmlAttribute] public bool Present { get; set ; }

Bosch Security Systems | 2013 July

Page 22

DCN-SWSMD Streaming Meeting Data

/// <summary>The voting weigh t fo r this particip ant.</summary> [XmlAttribute] public Int32 VotingWeigh t { ge t; set; }

/// <summary>Is this participant authorized to vote.</summary> [XmlAttribute] public bool VotingAuthorisation { get; set; }

/// <summary>Is this participant authorized to use the micropho ne .</summary> [XmlAttribute] public bool MicrophoneAu th orisation { get; set; }

/// <summary>The first name of this participant.</summary> [XmlAttribute] public string FirstName { ge t; set; }

/// <summary>The middle name of thi s participant .</summary> [XmlAttribute] public string MiddleName { get; set; }

/// <summary>The last name of this participant.</summary> [XmlAttribute] public string LastName { get; set; }

/// <summary>The title of this pa rt icipant.</su mmary> [XmlAttribute] public string Title { get; set ; }

/// <summary>The country set fo r th is participan t.</summary> [XmlAttribute] public string Country { get; set; }

/// <summary>The remaining speech time in seconds for this participant.</summary> [XmlAttribute] public Int32 RemainingSpeechT ime { get; set; } }

en | 22

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 string 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:

/// <summary >Converts the String to UTF8 Byte array and is used in deserialization.</summary> private stat ic Byte[] StringToUTF8ByteArray(string pXmlString) { UTF8Encoding en coding = new UTF8E ncoding(); byte[] byteArra y = encoding.Get Bytes(pXmlSt ri ng); return byteArra y; }

/// <summary>Reconstruct an object from an XML string</summary> public T Deserial izeObject<T>(string xml) { XmlSerializer xs = new XmlSeriali zer(typeof(T )); MemoryStre am memoryStream = new MemoryStream(StringToUTF8ByteArray(xml)); XmlTextWri ter xmlTextWrit er = new XmlTextWriter(memoryStream, Encoding.UTF8); return (T)xs.De serialize(me moryStream); }

The deserializing of the ParticipantActivity can be done as follows:

Participan tActivity participantActiv ity = 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 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

Page 23

DCN-SWSMD Streaming Meeting Data

[XmlRootAttribute(ElementName = "MeetingContainer ", IsNullable = false)] public class Meet ingContainer { ...

/// <summary>The collection of participants within this meeting.</summary> public List<Par ticipantCont ainer> Partici pa nts { get; set; }

... }

en | 23

Bosch Security Systems | 2013 July

Page 24

DCN-SWSMD Streaming Meeting Data

APPENDIX A. ADDITIONAL INFO

A.1. Enumerations

The enumerations EnumTopic and EnumActivityType should be defined as follows:

public enum EnumT opic { System = 0, Meeting = 1, Session = 2, Discussion = 3, Participan t = 4, Seat = 5, Voting = 6 Interpretatio n = 7, ServiceCall = 8, Booth = 9, Desk = 10 TestSystem = 11 }

public enum EnumA ctivityType { // System topic

SystemStarted,

SystemStopped,

// Meeting topic

MeetingDataUpdated,

MeetingStarted, MeetingStopped,

AttendanceRegistrationStarted, AttendanceRegistrationStopped,

ParticipantAdded,

// Session topic

SessionDataUpdated,

SessionStarted, SessionStopped, SessionSuspended, SessionResumed,

// Discussion topic

DiscussionDataUpdated,

RequestListUpdated, ResponseListUpdated, ActiveListUpdated, ActiveResponseListUpdated, SpecialEquipmentListUpdated,

// Seat topic

SeatAdded,

SeatUpdated, SeatRemoved, SeatPriorityButtonActivated, SeatPriorityButtonDeactivated,

// Participant topic

ParticipantUpdated,

// Voting topic

VotingDataUpdated,

VotingStarted, VotingStopped, VotingOnHold, VotingResumed, VotingSelected, VotingInterimResult,

en | 24

Bosch Security Systems | 2013 July

Page 25

DCN-SWSMD Streaming Meeting Data

// Interpretation topic

InterpretationTranslationStarted,

InterpretationTranslationStopped,

// ServiceCall topic ServiceCallStarted,

ServiceCallIsBeingServiced, ServiceCallHandled,

// Booth topic BoothInUse,

BoothNotInUse,

// Desk topic DeskAdded

}

public enum EnumD estinationOu tput { A = 0, B = 1 }

public enum StopWatchState {

/// <summary>Idle state of the st opwatch</summary>

STOPWATCH_IDLE = 0, /// <summary>Running state of the stopwatch</summary> STOPWATCH_RUNNING, /// <summary >Interrupted state of the stopwa tch</summary> STOPWATCH_INTERRUPTED }

en | 25

Bosch Security Systems | 2013 July

Page 26

SeatUpdated

DCN-SWSMD Streaming Meeting Data

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 SeatUpdated. Based on the table we should expect this:

The xml string received:

<?xml version="1.0" encoding="utf-8"?> <SeatActivity xmlns:xsi=http://www.w3.org/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"> <SeatData Name="0006" MicrophoneActive="true" /> <Participant Id="7"> <ParticipantData Present="false" VotingWeight="1" VotingAuthorisation="true" MicrophoneAuthorisation="true" FirstName="0007" MiddleName="" LastName="" Title="" Country="" RemainingSpeechTime="-1" /> </Participant> </Seat>

</SeatActivity>

en | 26

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. InterpretationTranslationStarted

<?xml version="1.0" encoding="utf-8"?> <InterpretationActivity xmlns:xsi=http://www.w3.org/2001/XMLSchema-instance

xmlns:xsd="http://www.w3.o rg/2001/XMLSchema" Version="1" TimeStamp="2008-08-27T13:00:51.2126576+02:00" Topic="Interpretation" Type="InterpretationTranslationStarted">

</Booth> <Seat Id=”25”> <SeatData Name=”1:1” MicrophoneActive=”true” /> </Seat> <Source> <Channel Number=”0” />

</Source> <Destination Output=”A”> <Channel Number=”2” />

<Language Abbreviation=”NLD” Name=”Dutch” /> </Channel

</Destination> </Desk>

</InterpretationActivity>

Bosch Security Systems | 2013 July

Page 27

DCN-SWSMD Streaming Meeting Data

A.2.3. MeetingStarted

<?xml version="1.0" encoding="utf-8"?> <MeetingActivity xmlns:xsi=http://www.w3.org/2001/XMLSchema-instance

xmlns:xsd="http://www.w3.org/2001/XMLSchema" Version="1" TimeStamp="2008-08-27T13:33:18.4660052+02:00" Topic="Meeting"

Type="MeetingStarted">

<Language Abbreviation=”NLD” Name=”Dutch” /> </Channel

</Channels> <Booths>

</Meeting>

</MeetingActivity>

en | 27

Bosch Security Systems | 2013 July

Page 28

DCN-SWSMD Streaming Meeting Data

A.2.4. MeetingStopped

<?xml version="1.0" encoding="utf-8"?> <MeetingActivity xmlns:xsi=http://www.w3.org/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="MeetingStopped">

</MeetingActivity>

A.2.5. VotingStopped

<?xml version="1.0" encoding="utf-8"?> <VotingActivity xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"

xmlns:xsd="http://www.w3.org/2001/XMLSchema" Version="1" TimeStamp="2008-08-27T13:50:36.0042872+02:00" Topic="Voting"

Type="VotingStopped">

<Voting Id="0"> <VotingResults> <IndividualResults> <VotingIndividualResultContainer AnswerId="1"> <Participant Id="2"> <ParticipantData Present="false" VotingWeight="1"

VotingAuthorisation="true"

MicrophoneAuthorisation="true" FirstName="Carl" MiddleName="the" LastName="Coder" Title="Sir" Country="Spain" RemainingSpeechTime="-1"

<Seat Id="3"> <SeatData Name="0003" MicrophoneActive="false" /> </Seat> <Group Name="-" /> </Participant> </VotingIndividualResultContainer> </IndividualResults> <VotingTotalResults Approved="true" RequiredQuorum="0" ActualQuorum="0" MaximumQuorum="1" RequiredMajority="0" ActualMajority="0"

MaximumMajority="1"

NumberOfAuthorizedPresentParticipants="1" NumberOfAuthorizedPresentParticipantsWithoutVote="0"> <VotingAnswerResults> <VotingAnswerResultContainer AnswerId=”1” NumberOfCasts="1"

Percentage="100"/>

<VotingAnswerResultContainer AnswerId=”2” NumberOfCasts="0"

Percentage="0"/>

</VotingAnswerResults> </VotingTotalResults> <VotingGroupResults> <VotingGroupResultContainer NumberOfAuthorizedPresentParticipants="0" NumberOfAuthorizedPresentParticipantsWithoutVote="0"> <VotingAnswerResults> <VotingAnswerResultContainer AnswerId=”1” NumberOfCasts="1"

Percentage="100"/>

<VotingAnswerResultContainer AnswerId=”2” NumberOfCasts="0"

Percentage="0"/>

</VotingAnswerResults> <Group Name="-" /> </VotingGroupResultContainer> </VotingGroupResults> </VotingResults> </Voting>

</VotingActivity>

en | 28

A.2.6. MicrophoneTestStopped

<?xml version="1.0" encoding="utf-8"?> <TestSystemActivity xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"

xmlns:xsd="http://www.w3.org/2001/XMLSchema" Version="1" TimeStamp="2011-02-

14T10:38:29.1421121+01:00" Topic="TestSystem" Type="MicrophoneTestEnded"> <MicrophoneTestResults> <MicrophoneTestResultContainer Passed="true"> <Seat> <SeatContainer Id="16"> <SeatData Name="0002"/> </SeatContainer>

Bosch Security Systems | 2013 July

Page 29

DCN-SWSMD Streaming Meeting Data

en | 29

Bosch Security Systems | 2013 July

Page 30

DCN-SWSMD Streaming Meeting Data

en | 30

Data subject to change without notice

Bosch Security Systems | 2013 July

Bosch DCN-SWSMD-E User Manual

Specifications and Main Features

Frequently Asked Questions

User Manual

1. INTRODUCTION

1.1 Purpose

1.2 Scope

1.3 Definitions, Acronyms and Abbreviations

2. STREAMING MEETING DATA (DCN-SWSMD)

2.1 Issues to know:

3. CONFIGURATION

3.1 Description

3.2 Registering a TcpIpActivityTraceListener(s)

3.3 Defining the TcpIpActivityTraceListener

3.3.1 IPAddress

3.3.2 ConnectionPort

3.3.3 AllowedClients

3.3.4 TopicFilter

3.3.5 ActivityTypeFilter

3.3.6 MaxQueuedItems

3.4 Multiple TcpIpActivityTraceListeners

4. ACTIVITIES

4.1 Activity details

4.2 Activity containers

4.2.1 Translation from activity data into XML

5. CREATING A CUSTOMIZED CLIENT

5.1 Connecting with the TcpIpActivityTraceListener

5.2 Receiving the data

5.3 Deserializing the received activities

5.4 Lists

APPENDIX A. ADDITIONAL INFO

A.1. Enumerations

A.2. Example XML Strings

A.2.1. SeatUpdated

A.2.2. InterpretationTranslationStarted

A.2.3. MeetingStarted

A.2.4. MeetingStopped

A.2.5. VotingStopped

A.2.6. MicrophoneTestStopped