Integration for configuration automation

Transcription

1 White paper Integration for configuration automation Integration Decision Guide Prepared by: Anders B. Christensen, Chief Architect Ole Lennert, Product Owner SDK & Verticals Jasleen Kaur Rehal, Strategic Alliance Manager, Global Milestone Systems Date: June 15, 2016

2 Table of Contents 1. Target audience Integration overview Terminology Common features Integration of configuration automation... 4 Page 2 of 6

3 1. Target audience This document is intended to assist decision makers and solution architects who are evaluating what type of integration to choose when integrating an application that performs configuration of Milestone XProtect VMS. 2. Integration overview The Configuration API is available for XProtect Corporate and XProtect Expert. It is possible for XProtect Corporate and XProtect Expert customers to change their configuration via an API. This API covers a large part of the normal day-to-day changes, though not all configurations can be done via this API. Use the API to have more programmatic control and less human interface for keeping the configuration up to date. It enables applications to perform automated configuration tasks and thereby offload human interaction. 3. Terminology Configuration API is a SOAP service located on the XProtect Management Server. Integration methods To provide maximum flexibility and enable optimal integration of different types of systems and applications, the Milestone Integration Platform offers three main integration options: Protocol Integration: A basic integration method particularly suited for integration of applications running in non-windows environments. Component Integration: Lets you integrate MIP components into your application, which is useful when you want to use libraries provided by Milestone in your Windows-based application. Page 3 of 6

4 Plug-in Integration: The most refined integration method. This allows you to embed your Milestone Solution Partner plug-in in the Milestone XProtect application environment, and run your plug-in as an integrated part of the XProtect software and its client applications. Only the Protocol Integration is available for the Configuration API, but it can also be used by any component or plug-in solution. 4. Common features This document describes the Configuration API and some of the options available. There are different ways to access a complete set to read the configuration via SOAP,.Net Component, as a MIP plug-in and Web xml documents. 5. Integration of configuration automation Adding new devices to the system Use the Configuration API in integrations to add new hardware devices, for example cameras, microphones, speakers and metadata devices. When these are added, default values for all settings will be assigned. Afterwards, the settings of each of these devices can be modified, for example resolution or frames per second. Examples of typical applications: Migration of already installed cameras to XProtect VMS Daily additions of cameras done from an alternative user interface More documentation: In MIP SDK: Introduction to Configuration API In MIP SDK: Component sample ConfigAPIClient, ConfigAPIBatch, ConfigAPIImport Page 4 of 6

5 Updating specific parameters Use the Configuration API in integrations to modify settings on a camera or the storage definition used for the video coming from the camera. Information about the current and the historic storage usage can be obtained via the Configuration API. Examples of typical applications: Ensuring that storage is used without overflow Changes of streams as a result of external events or changes More documentation: In MIP SDK: Introduction to Configuration API In MIP SDK: Component sample ConfigAPIClient, ConfigAPIBatch, ConfigAPIImport Verifying parameters Use the Configuration API in integrations to check that parameters are set correctly, or set to default values. This can be useful in a large installation, where you request that a set of parameters must have specific values. This application could read current parameters, compare to a pre-defined set of values, report changes or reset values to the predefined setting. Examples of typical applications: Control of specific configurations and settings System documentation and verification More documentation: In MIP SDK: Introduction to Configuration API In MIP SDK: Component sample ConfigAPIClient, ConfigAPIBatch, ConfigAPIImport Page 5 of 6

6 About Milestone Systems Founded in 1998, Milestone Systems is the global industry leader in open platform IP video management software. The XProtect platform delivers powerful surveillance that is easy to manage, reliable and proven in thousands of customer installations around the world. With support for the widest choice in network hardware and integration with other systems, XProtect provides best-in-class solutions to video enable organizations managing risks, protecting people and assets, optimizing processes and reducing costs. Milestone software is sold through authorized and certified partners. For more information, visit Milestone Systems Headquarters, DK Tel: Milestone Systems US Tel: Page 6 of 6