TECHNICAL DOCUMENT FRONT PAGE DOCUMENT TYPE:

Transcription

1 TECHNICAL DOCUMENT FRONT PAGE DOCUMENT TYPE: DOC. NAME : PROJECT: DESCRIPTION: CUSTOMER: ORDER NUMBER: - DATE: TAG NUMBER: - SERIAL NUMBER: - PAGES: 17 Camera to Client Event User Manual FOR CUSTOMER CODE X ACCEPTANCE STATUS A Accepted. B Accepted, implement comments in next revision. C Accepted, implement comments. Revise and resubmit. D Not accepted, revise and resubmit. E X For information only. DATE: SIGN.: FOR TRATEC NORCON Added information of federated setup and use SRG Added information of log file reduction issues SRG Issued for use SRG REV DATE DESCRIPTION CRE CHK ACC NOTES:

2 Table of Contents 1 Introduction Definitions Brief overview Installation Installation prerequisites Determining the installation path Change log settings for Milestone Event Server Configuration General information Initial configuration Audit logging Federated setup Querying items Matrix integration Event integration Rule/SmartWall integration Commissioning Practical use Fault finding...17 Camera_to_Client_Event_User_Manual.docx Side 2 av 17

3 1 Introduction This document will describe installation, configuration, commissioning and fault finding in TRATEC Norcon Camera to Client event plug-in for Milestone. 1.1 Definitions The following abbreviations are used in this document: Abbreviation MIP VMS Description Milestone Integration Protocol Video Management System 1.2 Brief overview If you need externally trigged camera view change in Milestone, it would require quite some work to achieve. The traditional solution would be to create numerous events in Milestone, create numerous rules linked to each event which would perform the actual camera change, and finally find some method for external trigging of these events: Matrixes Cameras Rules Events The purpose of the TRATEC Norcon Camera to Client event is to provide a mechanism for activating/changing camera view in Milestone Matrix objects from an external system without the need of creating numerous events and rules. The event provided by TRATEC Norcon provide s a simple UDP protocol which allows changing camera view based on camera name and matrix name: Camera_to_Client_Event_User_Manual.docx Side 3 av 17

4 Matrixes UDP Cameras TRATEC Norcon Generic Event Another possibility is to use this generic event with Milestone's product SmartWall. This is an option, but requires more configuration to work. 2 Installation Installing the plug-in requires some minor preparations: 1. Prerequisites must be fulfilled. See chapter 2.1 for more information. 2. Determine installation path of Milestone software. This varies depending on versions and products installed. The plug-in must be available for both the Milestone Event Server service and the administration application. Default path is [PROGRAMFILES]\Milestone\MIPPlugins. See chapter 2.2 for further information. 3. If the TRATEC Norcon activation manager is not installed already, this must be installed as well (separate installer file). Once the installation path is determined, the installation may start. When prompted for an installation path, ensure the correct path is referred. When installation is fininshed, restart Milestone Event Server service. 2.1 Installation prerequisites A few prerequisites must be met prior to installation: Milestone XProtect must be installed. Fully supported versions are (see comment below): o 2016 Corporate, Expert (including R3) o 2014 Corporate, Expert A Basic User must be added to the Milestone application with the foll owing attributes: o Username: TNUser o Password: TN@dministr@tor o Access: Administrator A UDP port must be opened for telegrams. In case of federated system, installation of all sites must be done in accordance with Milestone guidelines. In addition, logon credentials for common administrator user must be available. Camera_to_Client_Event_User_Manual.docx Side 4 av 17

5 In a federated system ALL cameras, events and matrixes must be given unique names. Be aware that some functionality in this plugin would be functional also for other versions of Milestone VMS. E.g. querying objects and firing events would be available for other versions as well, and opens for using this plugin for as an easy to use event triggering mechanism. Known limitations, and the reason for the limited support list above, is full functionality with SmartWall, Matrix, Rules and Bookmark creation from plugin. 2.2 Determining the installation path Below is an extract from Milestone provided documentation: The folders used for loading the plug-ins are named MIPPlugins. The folders are placed as follows: For 32-bit applications (Administrator application and Smart Client installed as 32-bit): Executing folder of the starting application o ".\MIPPlugins". A common place that all application load from: o C:\Program Files (x86)\milestone\mipplugins For 64-bit applications (Event Server, Management Client and Smart Client installed as 64-bit): Executing folder of the starting application o ".\MIPPlugins". A common place that all application load from: o C:\Program Files\Milestone\MIPPlugins 2.3 Change log settings for Milestone Event Server It is highly recommended to change the log settings for the Event Server. This will prevent log files from being filled with potentially great amounts of log data, and in the worst case fill up the disk. Log files will be stored in C:\ProgramData\Milestone\XProtect Event Server\logs\MIPLogs\. To change the log settings for the Event Server, follow the steps below: 1. Open Milestone Event Server configuration file "C:\Program Files\Milestone\XProtect Event Server\VideoOS.Event.Server.exe.config" in a text editor. 2. Search for a line containing this text: <MIPLoggerSettings level="info" /> 3. Replace the info text with error, making it look like this: <MIPLoggerSettings level="error" /> 4. Restart the Event Server service. Camera_to_Client_Event_User_Manual.docx Side 5 av 17

6 3 Configuration 3.1 General information The Encoding must be identical to the transmitting process' encoding. Consider the below figure: TRATEC Norcon Camera to Client Event Encoding Request Reply UDP Encoding 3. party software (SCADA/PLC ) A third party software, this could be either SCADA or PLC, sends a UDP package in a specific encoding to the Generic Event. The Generic event processes the request and replies to the sending port, using the configured encoding. When configuring the Response, a few choices is available: None no response is sent. Echo All the telegram is sent in return without modifications. Statistics this is probably the most used choice, and the response telegram is built up with information indicating success or failure executing the requested command. For more information, see chapter 5. Note! Availability of certain options depends on installed version of Milestone. Camera_to_Client_Event_User_Manual.docx Side 6 av 17

7 3.2 Initial configuration If successfully installed, you should see the following configuration group in the Milestone Management Client site navigation tree (navigation could differ slightly depending on Milestone version): Right click the Camera to Client event row and select Add New Give the event a name of your choice. A setup window similar to the one below should be available: The fields are: Event setup o Name the event name o Enabled must be checked for event to function. o Audit logging if switched on, the event will insert log messages in Audit Log when trigged. See below for further information. UDP setup o Port no the UDP port to listen for telegrams o Encoding UDP telegram encoding o Response determines the response sent to the client issuing the UDP telegram. o Allowed external IP addresses list of allowed UDP client IP addresses. Telegrams sent from other addresses than listed here will be ignored. Federated setup o It is possible to use this event in a federated system. o The list must be filled with sub-sites to be made available for this event. Added sites will expose some of its objects (like cameras) to the top-level system, making it possible to integrate camera names from sub sites when trigging the event. Test o Test telegram a possibility of manually sending telegrams to the system. Be aware that response may vary from actual UDP telegram main point is to see and check feedback from system visually. Several events might be configured, but in most cases one single event would suffice. Note! UDP port numbers must be unique for each TRATEC Norcon Camera to Client event! Camera_to_Client_Event_User_Manual.docx Side 7 av 17

8 3.3 Audit logging It is possible to make the Camera to Client Event create log entries when the event is fired. This could prove useful for operators to identify specific incidents or for simple fault finding. If the Audit logging check box is ticked off, the following events may be found in the Audit log (accessible from Management client): The Resource Name filter may be set to TNCameraToClientEvent for display of relevant entries only. The Description field is filled with the following information: [Event name] < SUCCESS or FAILURE depending on function return value> <Description> The event name is the name as configured for the event. SUCCESS is displayed if the function executed without error, and indicates event fired without error. FAILURE indicates some sort of error (e.g. requested camera name not found). The description varies depending on requested action, but it should be possible to read out in clear text what was done. The Category field indicates what sort of action was requested from the event. May be used as filter criteria. The resource name always indicates TNCameraToClientEvent, and may be used as filter. Camera_to_Client_Event_User_Manual.docx Side 8 av 17

9 3.4 Federated setup It is possible to use the Tratec Norcon Camera to Client event in a federated setup. The point with this possibility is to make objects in federated sub-sites available from top level system. One reason to do this is to make cameras from sub-sites available to top level systems, opening for using cameras from sub-sites in top level events. Consider the following illustration: Cameras from both Mother and Child sites are available for the Camera to Client event to display in either Matrix or SmartWall. Mother site Cameras, events and matrixes are available from Mother site Events and matrixes may be fired/ manipulated in Child sites. The Child may only fire/manipulate its own events/matrixes. Child sites It is also possible to fire events and manipulate matrixes configured in child sites from mother site. In standalone systems using the federated setup is completely irrelevant. It is only relevant for top level systems in need of accessing sub site objects. When configuring a Camera to Client Event for use in a federated system, make note of the following: All sites, including the top-level site, must be added to the list of federated systems. It is only relevant to configure Federated setup on the top-level site. Note! The information of Federated setup as displayed for Tratec Norcon Camera to Client Event is common for all events in this system. This means that all events in a federated system will have this setup. This is also noticeable when navigating the Management Client all Camera to Client Events share one common federated configuration setup. For configuring the Federated setup, do as follows: 1. In the Federated setup, click Add. Camera_to_Client_Event_User_Manual.docx Side 9 av 17

10 2. A popup appears. Enter the Server URL for the server to add. If a mother server with configured children in a federated setup is entered, all children will appear in the Available Servers list. 3. Enter valid credentials. Remember that there are limitations when using credentials in either a workgroup setup or a domain setup. 4. Select credential type and click Check. The list of available servers will be filled accordingly. Tick off servers you would like to include and click OK. 5. The ticked off servers will appear in the Federated setup list in the main window. You may add more servers at a later stage by repeating this procedure. All configurations of federated system are common for all Tratec Norcon Camera to Client Events (per server). Remember to add ALL servers you would like to access, even the current computer. Otherwise the system will not work properly. Do NOT configure federated system at all in a standalone system, it will only create confusion. In that case, remove all entries in the Federated setup list and restart Milestone Event server service. 3.5 Querying items It is possible to use the TRATEC Norcon Camera to Client event for reading out available cameras and events from the Milestone configuration, including configured sub sites in a federated setup. Procedure is indicated in screenshot in section 3.2. Be aware that changes in Milestone configuration will require a refresh of the configuration due to information being cached for reduced response time. Camera_to_Client_Event_User_Manual.docx Side 10 av 17

11 3.6 Matrix integration For integration with Milestone matrixes, a matrix must be configured and integrated in a smart client display. Cameras must be available as well. For changing camera on matrix, simply send a telegram with syntax a specified in screenshot in section 3.2. Insert correct matrix name and camera name in the telegram, and it should work. Below is an example of Matrix configuration in Milestone management client: 1. Setup of matrixes is beyond the scope of this manual. See Milestone documentation for more information. 2. A similar configuration must be done in the Smart Client for proper functionality. Cameras from configured sub sites in a federated system is available in the same way. 3.7 Event integration It is possible to fire User Defined events configured in Milestone VMS using the plug-in. The syntax for firing events is illustrated in the screenshot in section 3.2. In a federated system, it is possible to fire events in sub sites using the plug-in configured and running on mother site. The syntax is the same as for standalone systems, and the event will be fired on the sub site where the event is configured. 3.8 Rule/SmartWall integration The TRATEC Norcon Camera to Client event may be used as a trigger condition for rules as it appears to be an event like other events in Milestone. In addition, it can pass a camera name as metadata information, making it suitable for SmartWall integration. It is in other words possible to use this event with SmartWalls as well as matrixes, or in any configuration requiring rule integration. Regarding SmartWall integration, the configuration is slightly more cumbersome due to a limitation in Milestone Management client changing SmartWall views is only possible via Rules. Hence, this Camera to Client Event must be used in combination with Rules to achieve SmartWall integration. This means that you would need one event per position available in the SmartWall. Setup of TRATEC Norcon Camera to Client event is otherwise identical to the above description. Each event would respond correctly to all commands as described above. Camera_to_Client_Event_User_Manual.docx Side 11 av 17

12 Typical example of Rule setup procedure (screenshots might vary with installed version of Milestone): 1. Go to the Rules section in Milestone Management Client and add new rule. Select the TRATEC Norcon Camera to client event. 2. Select the actual trigger event in the next step. 3. Setup the rest of the Rule as shown. The important part is to use devices from metadata. This opens for dynamic camera change to fixed SmartWalls and displays. Camera_to_Client_Event_User_Manual.docx Side 12 av 17

13 It is also possible to create Rules for removing camera from SmartWall as well. To give an indication of procedure, consider the below image: 4. The example to the left would open for removing a camera of your choice from a specified SmartWall display. 4 Commissioning The TRATEC Norcon Camera to Client event utilizes a separate process for proper communication with the Milestone Event Server. This process' name is TNMIPSDKAccess.exe, and it should be visible in the Windows task manager when the system is running. When required services and processes are running, perform a test from the Management client. Type the Camera to Client event's name in the Test telegram field and click Test it! After a short delay, the event should answer with: [Event name] 0 When this test succeeds, there is communication between all required partners. Note: There is a 5 second timeout for telegram responses if no response is received within this time frame, there will be an error and the telegram is not correctly processed. In this case the telegram will be: [Event name] 0 FAILED Optionally perform tests on more commands to verify full compatibility. When all is OK, move on to next chapter. Camera_to_Client_Event_User_Manual.docx Side 13 av 17

14 5 Practical use The TRATEC Norcon Camera to Client event provides numerous possibilities in addition to displaying camera views on matrix clients. Below is a full overview of all requests and replies available in the plug-in. Request Reply Description Example request Example response [Event name] [Event name] [Rolling counter] A mechanism for external process to check if the system is responding and working. Could be used for communication alarm or similar. [Event name] Cameras [Event name] Matrixes [Event name] Events [Event name] [Number of cameras] [Camera 1] [Camera 2] [Camera n] [Event name] [Number of matrixes] [Matrix 1] [Matrix 2] [Matrix n] [Event name] [Number of User defined events] [ User defined event 1] [ User defined event 2] [ User defined event n] Request: "MyEventName" Response: "MyEventName 1" Provides a list of configured cameras in Milestone. The listed cameras would be a list of valid arguments when attempting to change camera view in a matrix object. Request: "MyEventName Cameras" Response: "MyEventName 3 Camera 1 Camera 2 Camera 3" Provides a list of configured matrixes in Milestone. The listed matrixes would be a list of valid arguments when attempting to change camera view in a matrix object. Request: "MyEventName Matrixes" Response: "MyEventName 2 Matrix 1 Matrix 2" Provides a list of configured User defined events in Milestone. This plug in also provides the possibility of firing such events in addition to changing camera view on matrixes. The purpose is to open for rule management from this system as well. Request: "MyEventName Events" Response: "MyEventName 3 Event A Event B Event C" Camera_to_Client_Event_User_Manual.docx Side 14 av 17

15 Request Reply Description Example request Example response [Event name] RefreshConfig [EventName] RefreshConfig [True/False] This function would reload and refresh the configuration in Milestone. If a camera, matrix or event object is added, the config must be refreshed for the system to see it and be able to handle it. [Event name] [Matrix name] [Camera name] [Event name] [Matrix name] [Camera name] [Bookmark name] [Event name] [Rolling counter] [Matrix name] [Camera name] [Event name] [Rolling counter] [Matrix name] [Camera name] [Bookmark name] Request: "MyEventName RefreshConfig" Response: "MyEventName RefreshConfig True The actual command to change view on a matrix. This command would tell the identified matrix to display the identified camera in position 1. In addition, the rolling counter is returned. If any of the fields are empty in the reply, the function failed due to missing camera/event. Request: "MyEventName Matrix 1 Camera 2" Response (success): MyEventName 2 Matrix 1 Camera 2" Response (failure camera nonexisting): "MyEventName 2 Matrix 1 " Response (failure matrix nonexisting): "MyEventName 2 Camera 1" An optional parameter containing a bookmark name could be passed. This would result in a bookmark being created on the named camera, including ±30sec of recording. Request: "MyEventName Matrix 1 Camera 2 BM" Response (success): MyEventName 2 Matrix 1 Camera 2 BM" Response (failure camera nonexisting): "MyEventName 2 Matrix 1 " Response (failure matrix nonexisting): "MyEventName 2 Camera 1" Camera_to_Client_Event_User_Manual.docx Side 15 av 17

16 Request [Event name] FireEvent [User defined event name] [Event name] FireRule [Camera name] Reply [Event name] [Rolling counter] FireEvent [ User defined event name] [Event name] [Rolling counter] FireRule [Camera name] Description Example request Example response Firing of User defined event for optional rule management. Request: "MyEventName FireEvent Event A" Response (success): MyEventName 4 FireEvent Event A" Response (failure event nonexisting): "MyEventName 2 FireEvent " Trigging of camera change in SmartWall client using rules. Request: "MyEventName FireRule Camera 2" Response (success): MyEventName 8 FireRule Camera 2" Response (failure camera nonexisting): "MyEventName 8 FireRule " Camera_to_Client_Event_User_Manual.docx Side 16 av 17

17 6 Fault finding Error/problem 1. The configuration group does not show up. 2. The event does not answer UDP telegrams. 3. I do not get the expected response from the system. 4. I am unable to control SmartWall objects. 5. Disk space is being reduced rapidly after installing plug-in. 6. The plug-in does not answer with anticipated objects when querying items (cameras, events, matrixes). Proposed solution Restart management client and check again. The plugin is not available for the management client. Check if the plugin needs to be copied to another location to be available for the management client. Verify that the sending IP address is included in the list of allowed IP addresses. Localhost is included by default. Verify that there is a running process named TNMIPSDKAccess.exe. If not: o Restart Milestone Event Server service. o Check installation path of TRATEC Norcon Camera to Client event is accessible from Event Server. o Verify required Basic User is available. Check firewall settings, the required UDP port(s) must be opened. Try refreshing the configuration and try again. Optionally restart the Milestone Event Server. Check installed version and licensing of Milestone to verify you can use SmartWalls. Check installed version and licensing of Milestone to verify you are able to use Rules. The log files for Milestone Integration Protocol integrations with Milestone Event Server are found in C:\ProgramData\Milestone\XProtect Event Server\logs\MIPLogs\. Check if these are the files growing and eating disk space. This is a part of Milestone event subscription handling, and not in the scope of the plugin to handle. If so, follow the procedure as described in chapter 2.3 Change log settings for Milestone Event Server. If federated, check that all relevant sub sites are configured and accessible. Try RefreshConfig command (note: it may take some seconds for configuration to be updated across sites). Make sure object naming is unique across sites in a federated system. Make sure defined login credentials are correct. Make sure the process TNMIPSDKAccess.exe is running. Try issuing a telegram with only the event name. If no answer, check firewall. Camera_to_Client_Event_User_Manual.docx Side 17 av 17