Milestone XProtect

Setup

See the Data Servers page for information on configuring driver communication.

Note: Asset Multi-Select is not available for this integrated system.

Compatibility

The Milestone XProtect integrated system is compatible with:

XProtect 2017 (R3)
XProtect 2018 (R1/R2/R3)

Prerequisites


Software	Minimum Version
IPFusion — Milestone XProtect	1.7
.NET Framework	4.7.2

When completing your setup, be sure to have the Milestone XProtect documentation available for reference.

Ports

These ports must be open in your network firewall for the integration to work.


Purpose	Default Value	Configurable
Milestone XProtect Server Connection	7563	No
Dataserver	9030	Yes
Debug Tools	9530	No

Communication Configuration

In the integrated system configuration panel, you will find the Communication Settings. The below information is required.


Server Address	The host name or IP address of the Milestone server.
Username	The username for logging into the Milestone server. This is usually a user created specifically for the Runtime connection.
Password	The password for logging into the Milestone server.
Domain	If using Windows authentication and the user is part of a Domain, the Domain field is required.
Authentication Type	The type of authentication used for the login. Windows — This is used if a Windows user that has been added to the Milestone server settings. Windows Default — If Milestone is set up to use Windows default, use this setting. A username and password will not be required in the Designer configuration. Basic — This is used if a user has been set up and configured in Milestone only and was not imported from Windows.
Reconnect Time	The time in milliseconds for how frequently Runtime will try to reconnect to the Milestone server.
Receive Timeout	The time in milliseconds the viewer will wait to get a video feed from the Milestone server. If it does not get a feed within this time, the video playback will fail.
Sending Timeout	The time in milliseconds the viewer will wait to get a acknowledgement from the Milestone server. If it does not get an acknowledgement within this amount of time, the video playback will fail.
Receive video via Multicast	Check this option if you want the Milestone system to receive a video feed via multicast.
Maintain video aspect ratio	Check this option if you want the video feed to display in the same aspect ratio as the camera that is recording.

Warning: Only configure one Milestone server per data server. More than one per data server is unsupported.

Note: Red X indicates an invalid or out of range value given for field.

Assets

Camera

The camera asset is designed to represent a camera in the Milestone system.

Important: Only H264 encoding is currently supported for Milestone cameras.

Required Property Grid Fields


Joystick Control	If joysticks are enabled for this camera system, this checkbox gives the options of enabling and disabling a camera from joystick control.
Milestone Guid	The unique identifier in the Milestone system for this camera asset.
Stream Guid	The unique identifier for a camera stream. You can find this on the Milestone server. Leaving this blank will default to the cameras default stream. Note: This is only applicable for streams viewed through Video Viewers. VideoFusion will always get the default stream.

View all properties

Supported States


Normal	The asset is online and in its default state.
Fault	An issue has been detected in a connected asset.
Masked	The asset has been masked over its true state.
Acknowledged	An asset alarm has been acknowledged.
No Communication	Communication has been lost with the driver, camera, or recording server. This can also occur when the camera has been disabled. Note: This status is required in all status tables.
Offline	Milestone is reporting that the asset is no longer connected.
Recording	The camera asset is in recording mode.

See the Configure a Status Table page for more information on configuring status tables.

Supported Commands


Mask	Mask the asset's true state.
Acknowledge	Acknowledge an asset alarm.
Reset	Resets the asset to its true hardware state.
Cancel	Deselects all selected assets.
Bookmark	Creates a bookmark in the Milestone system for the selected camera. It will be a Quick bookmark in that it will be a forty second range and called IPFusion bookmark.

Table 1. For PTZ Capable Cameras
Name	Parameters	Description
PTZ Down	PTZ Speed — How quickly the camera moves.	Tilts the camera downward.
PTZ Up	PTZ Speed — How quickly the camera moves.	Tilts the camera upward.
PTZ Left	PTZ Speed — How quickly the camera moves.	Pans the camera left.
PTZ Right	PTZ Speed — How quickly the camera moves.	Pans the camera right.
Zoom In	PTZ Speed — How quickly the camera zooms.	Zooms the camera in.
Zoom Out	PTZ Speed — How quickly the camera zooms.	Zooms the camera out.
Stop PTZ		Stops any currently running PTZ commands on the camera.
PTZ Preset	Preset Number — The number for the PTZ command.	Uses a preset PTZ command.
Aux Set	Aux Number — The auxiliary number on the Milestone camera.	If the selected camera is a PTZ camera with configured auxiliary commands, then this command will be sent to the Milestone camera and set the aux number.
Aux Clear	Aux Number — The auxiliary number on the Milestone camera.	If the selected camera is a PTZ camera with configured auxiliary commands, then this command will be sent to the Milestone camera and clear the aux number.
PTZ Up-Right	PTZ Speed — How quickly the camera moves.	Tilts the camera up, and pans to the right.
PTZ Up-Left	PTZ Speed — How quickly the camera moves.	Tilts the camera up, and pans to the left.
PTZ Down-Right	PTZ Speed — How quickly the camera moves.	Tilts the camera down, and pans to the right.
PTZ Down-Left	PTZ Speed — How quickly the camera moves.	Tilts the camera down, and pans to the left.

See the Command Tables page for more information on configuring command tables.

Input

These assets are used to reflect the state of inputs in the Milestone system.

Required Property Grid Fields


Milestone Guid	The unique identifier for this input in the Milestone system.

View all properties

Supported States


Normal	The asset is online and in its default state.
Fault	An issue has been detected in a connected asset.
Masked	The asset has been masked over its true state.
Acknowledged	An asset alarm has been acknowledged.
No Communication	Communication has been lost with the driver or asset. This status can also occur if the communication configuration for the system or asset is invalid. Note: This status is required in all status tables.
Active	Milestone is reporting that the input is on.
Inactive	Milestone is reporting that the input is off.

See the Configure a Status Table page for more information on configuring status tables.

Supported Commands


Mask	Mask the asset's true state.
Acknowledge	Acknowledge an asset alarm.
Reset	Resets the asset to its true hardware state.
Cancel	Deselects all selected assets.

See the Command Tables page for more information on configuring command tables.

Output

These assets are used to reflect the state of outputs in the Milestone system.

Required Property Grid Fields


Milestone Guid	The unique identifier for the output in the Milestone system.

View all properties

Supported States


Normal	The asset is online and in its default state.
Fault	An issue has been detected in a connected asset.
Masked	The asset has been masked over its true state.
Acknowledged	An asset alarm has been acknowledged.
No Communication	Communication has been lost with the driver or asset. This status can also occur if the communication configuration for the system or asset is invalid. Note: This status is required in all status tables.
Active	Milestone is reporting that the output is on.
Inactive	Milestone is reporting that the output is off.

See the Configure a Status Table page for more information on configuring status tables.

Supported Commands


Mask	Mask the asset's true state.
Acknowledge	Acknowledge an asset alarm.
Reset	Resets the asset to its true hardware state.
Cancel	Deselects all selected assets.
Output Active	Sends an activate command to the asset.
Output Inactive	Sends a deactivate command to the asset.

See the Command Tables page for more information on configuring command tables.

System

This asset represents the connection to the Milestone XProtect system.

Required Property Grid Fields


Milestone Guid	The unique identifier for the asset in the Milestone system.

View all properties

Supported States


Acknowledged	An asset alarm has been acknowledged.
Fault	An issue has been detected in a connected asset.
Masked	The asset has been masked over its true state.
No Communication	Communication has been lost with the driver or asset. This status can also occur if the communication configuration for the system or asset is invalid. Note: This status is required in all status tables.
Normal	The asset is online and in its default state.

See the Configure a Status Table page for more information on configuring status tables.

Supported Commands


Acknowledge	Acknowledge an asset alarm.
Cancel	Deselects all selected assets.
Mask	Mask the asset's true state.
Reset	Resets the asset to its true hardware state.

See the Command Tables page for more information on configuring command tables.

Workflow Integration

System Commands

System commands are commands executed through Workflows at the system level. For more information about Workflows, see the Workflows section.

Event Trigger

Triggers the event in the Milestone system. Actions can be configured in the Milestone System to take place when this event is triggered.

Callup Live Camera to Milestone Monitor

Displays a camera stream to a specified monitor.

Table 2. Parameters
Camera Asset ID	The ID of the camera to display the video for.
Monitor ID	The ID of the Milestone monitor to display the video feed on.
Preset	The ID of a PTZ preset command. Only integer values can be used. This parameter is optional, and may be left blank if you do not want to move the camera.
Tile ID	The ID of the video tile to display the video stream to.

Trigger Camera Preset

Table 3. Parameters
Preset ID	The ID of the preset command. Note: This command only accepts integer values. If a string value is required, please use the camera asset PTZ preset command instead.
Asset ID	The ID of the camera asset to execute the PTZ command on.

Troubleshooting

Logs from the driver and Runtime can be viewed in the Debug Tools client. These messages contain information which can provide further context for issues during initialization, or while actively running. This can help diagnose problems.