System settings (Options dialog box)

Select the maximum number of thumbnail images displayed in the Preview pane. Default is 64 thumbnail images.

Select Action > Refresh from the menu for the change to take effect.

A large number of thumbnail images in combination with a high frame rate may slow the system down.

Select the check box to enable motion detection on new cameras, when you add them to the system with the Add Hardware wizard.

This setting does not affect motion detection settings on existing cameras.

You enable and disable motion detection for a camera on the Motion tab for the camera device.

Generation of motion data for smart search requires that motion detection is enabled for the camera.

Select the check box to enable generation of smart search motion data on new cameras, when you add them to the system with the Add Hardware wizard.

This setting does not affect motion detection settings on existing cameras.

You enable and disable the generation of smart search motion data for a camera on the Motion tab for the camera device.

Select the check box to enable multicast on new cameras when you add them with the Add Hardware wizard.

This setting does not affect multicast settings on existing cameras.

You enable and disable live multicasting for a camera on the Client tab for the camera device.

Select the language of the Management Client.

Restart the Management Client to use the new language.

Select the check box to allow non-secure server connection by HTTP protocol. (No users are prompted to allow non-secure server connection).

Restart the Management Client to use this setting.

Client users with the necessary user permissions can manually interrupt the patrolling of PTZ cameras. Select how much time should pass before regular patrolling is resumed after a manual interruption. The setting applies for all PTZ cameras on your system. Default setting is 15 seconds.

If you want individual timeouts on the cameras, you specify this on the Presets tab for the camera.

Client users with a sufficient PTZ priority can pause patrolling on PTZ cameras. Select how much time should pass before regular patrolling is resumed after a pause. The setting applies for all PTZ cameras on your system. Default setting is 10 minutes.

If you want individual timeouts on the cameras, you specify this on the Presets tab for the camera.

Set the default timeout period for reserved PTZ sessions. When a user runs a reserved PTZ session, the PTZ camera cannot be used by others before it is released either manually or when the period has timed out. Default setting is 1 hour.

If you want individual timeouts on the cameras, you specify this on the Presets tab for the camera.

Select this check box to use the default preset position instead of the home position of PTZ cameras when activating the Home button in a client.

A default preset position must be defined for the camera. If a default preset position is not defined, nothing will happen when activating the Home button in a client.

By default, this check box is cleared.

To assign a default preset position, see Assign a camera's preset position as default

The system logs all communication errors on hardware and devices, but here you select for how long a communication error must exist before the rule engine triggers the Communication Error event.

Select the log type that you want to configure:

• System logs
• Audit logs
• Rule-triggered logs

Disable or enable the logs and specify the retention period.

Allow 2018 R2 and earlier components to write logs. For more information, see Allow 2018 R2 and earlier components to write logs.

For System logs, specify the level of messages that you want to log:

• All (includes undefined messages)
• Information, warnings, and errors
• Warnings and errors
• Errors (default setting)

For Audit logs, enable user access logging if you want the system to log all user actions in XProtect Smart Client. These are, for example, exports, activating outputs, and viewing cameras live or in playback.

Specify:

• The length of a playback sequence

  This means that as long as the user plays back within this period, the system only generates one log entry. When playing back outside the period, the system creates a new log entry.

• The number of records (frames) a user has seen before the system creates a log entry

Enter the email address that you want to appear as the sender of email notifications for all notification profiles. Example: sender@organization.org.

If you want to secure the communication between the management server and the SMTP mail server, select this check box.

The connection is secured using the STARTTLS email protocol command. In this mode, the session begins on an unencrypted connectcion, then a STARTTLS command is issued by the SMTP mail server to the management server to switch to secure communication using SSL.

If enabled, you must specify a user name and password for the users to log in to the mail server.

Select the codec (compression/decompression technology) that you want to apply. To have more codecs available in the list, install them on the management server.
Not all cameras support all codecs.

(Not available for all codecs). Use the slider to select the degree of compression (0-100) to be performed by the codec.

0 means no compression, generally resulting in high image quality and large file size. 100 means maximum compression, generally resulting in low image quality and small file size.

If the slider is not available, the compression quality is determined entirely by the selected codec.

(Not available for all codecs). If you want to use keyframes, select the check box and specify the required number of frames between keyframes.

A keyframe is a single frame stored at specified intervals. The keyframe contains the entire view of the camera, whereas the following frames contain only the pixels that change. This helps greatly reduce the size of files.

If the check box is not available, or not selected, every frame contains the entire view of the camera.

(Not available for all codecs). If you want to use a particular data rate, select the check box and specify the number of kilobytes per second.

The data rate specifies the size of the attached AVI file.

If the check box is not available, or not selected, the data rate is determined by the selected codec.

Specify a prefix for all the bookmarks that is made by the users of XProtect Smart Client.

Specify the default start and end time of a bookmark is set in XProtect Smart Client.

This setting needs to be aligned with:

• The default bookmark rule, see Rules (Rules and Events node).
• The pre-buffer period for each camera, see Manage pre-buffering.

The external IDP is by default enabled.

The name for the external IDP. The name appears in the Authentication field in the log-in window of your client.

Remove the external IDP configuration.

If you remove an external IDP configuration, the users that are authenticated via this external IDP will not be able to log in to the XProtect VMS. If you add the external IDP again, new users will be created on log in because the ID of the external IDP has changed.

Part of a URL for the authentication redirect flow to sign in users.

The user sign-in flow is initiated in the XProtect VMS. A browser is launched with a sign-in page that is hosted by the external IDP. When the authentication process is completed, the callback path (XProtect login address + /idp/ + callback path), is invoked and the user is redirected to the XProtect VMS.

The default value is “/signin-oidc”.

_{The redirect format}

The callback path is constructed by the login address entered in the client + /idp/ + the callback path configured on the external IDP. The URI is client specific so URIs for, for example, Smart Client and XProtect Web Client will be different.

The management server address is the address that you enter in the login dialog box in Smart Client or XProtect Management Client. For the XProtect Web Client and the XProtect Mobile, the redirect address is the entered address + port + /idp/ + callback path.

Specify to the external IDP if the user should stay logged in or if a verification of the user is required. Depending on the external IDP, the verification can include a password verification or a full log-in.

Optionally, specify which claim from the external IDP that should be used to generate a unique user name for the auto-provisioned user in the VMS. For more information about unique user names crated by claims, see Unique user names for external IDP users.

Name of the claim as it was defined in the external IDP. In this field, the claim name must be entered exactly as it is set in the external IDP. The claim name does not appear anywhere else in the Management Client.

Indicates whether the value of a claim is case sensitive.

Examples of values that are typically case sensitive:

- Textual representations of IDs such as a guid: F951B1F0-2FED-48F7-88D3-49EB5999C923 or OadFgrDesdFesff=

Examples of values that are typically not case sensitive:

- E-mail addresses
- Role names
- Group names

.

Register and maintain claims.

If you modify a claim at the external IDP web site, a new log in to the XProtect client is required by the users. Say, that a user, Bob, needs to be, for example, Operator. The claim is then added to Bob at the external IDP web site, but if Bob is already logged in to XProtect, he must complete a new login for the change to take effect.

A list with defined evidence lock profiles.

You can add and remove existing evidence lock profiles. You cannot remove the default evidence lock profile, but you can change its time options and its name.

The duration the client users can select to lock evidence.

Available time options are hour(s), day(s), week(s), month(s), year(s), indefinite or user-defined.

Provides the name of a message. You enter the name when you add a message. To upload a message to the system, click Add.

Provides a description of the message.

You enter the description when you add a message. You can use the description field to describe the purpose or the actual message.

Lets you upload audio messages to the system.

Supported formats are standard Windows audio file formats:

• .wav
• .wma
• .flac

Lets you modify the name and description, or you can replace the actual file.

Delete the audio message from the list.

Click this button to listen to the audio message from the computer that runs the Management Client.

If selected, additional developer information appears for Access Control > General Settings.

This setting is only meant to be used by developers of access control system integrations.

Specify if you want to use analytics events. As default, the feature is disabled.

Specify the port used by this feature. The default port is 9090.

Make sure that relevant VCA tool providers also use this port number. If you change the port number, remember to change the port number of the providers.

Specify if events from all IP addresses/hostnames are allowed, or only events from IP addresses/hostnames that are specified in the Address list (see below).

Specify a list of trusted IP addresses/hostnames. The list filters incoming data so that only events from certain IP addresses/hostnames are allowed. You can use both Domain Name System (DNS), IPv4 and IPv6 address formats.

You can add addresses to your list by manually entering each IP address or host name, or by importing an external list of addresses.

• Manual entering: Enter the IP address/hostname in the address list. Repeat for each required address
• Import: Click Import to browse for the external list of addresses. The external list must be a .txt file and each IP address or host name must be on a separate line

Specify the number of days for storing alarms with the state Closed in the database. If you set the value to 0, the alarm is deleted after it has been closed.

Alarms always have timestamps. If the alarm is triggered by a camera, the timestamp has an image from the time of the alarm. The alarm information itself is stored on the event server, while the video recordings corresponding to the attached image are stored on the relevant surveillance system server.

To be able to see the images of your alarms, keep video recordings for at least as long as you intend to keep alarms on the event server.

Specify the number of days for storing alarms with the state New, In progress, or On hold. If you set the value to 0, the alarm appears in the system, but will not be stored.

Alarms always have timestamps. If the alarm is triggered by a camera, the timestamp has an image from the time of the alarm. The alarm information itself is stored on the event server, while the video recordings corresponding to the attached image are stored on the relevant surveillance system server.

To be able to see the images of your alarms, keep video recordings for at least as long as you intend to keep alarms on the event server.

To keep a more detailed log for event server communication, select the check box. It will be stored for the number of days specified in the Keep logs for field.

Specify the number of days for storing events in the database. There are two ways of doing this:

• You can specify the retention time for an entire event group. Event types with the value Follow group will inherit the value of the event group
• Even if you set a value for an event group, you can specify the retention time for individual event types.

You can choose between two default data sources and define a custom data source. What to choose depends on your third party program and/or the hard- or software you want to interface from:

Compatible: Factory default settings are enabled, echoes all bytes, TCP and UDP, IPv4 only, port 1234, no separator, local host only, current code page encoding (ANSI).

International: Factory default settings are enabled, echoes statistics only, TCP only, IPv4+6, port 1235, <CR><LF> as separator, local host only, UTF-8 encoding. (<CR><LF> = 13,10).

[Data source A]

[Data source B]

and so on.

Click to define a new data source.

Name of the data source.

Data sources are by default disabled. Select the check box to enable the data source.

Click to reset all settings for the selected data source. The entered name in the Name field remains.

The port number of the data source.

Protocols which the system should listen for, and analyze, in order to detect generic events:

Any: TCP as well as UDP.

TCP: TCP only.

UDP: UDP only.

TCP and UDP packages used for generic events may contain special characters, such as @, #, +, ~, and more.

Selectable IP address types: IPv4, IPv6 or both.

Select the separator bytes used to separate individual generic event records. Default for data source type International (see Data sources earlier) is 13,10. (13,10 = <CR><IF>).

Available echo return formats:

• Echo statistics: Echoes the following format: [X],[Y],[Z],[Name of generic event]

  [X] = request number.

  [Y] = number of characters.

  [Z] = number of matches with a generic event.

  [Name of generic event] = name entered in the Name field.

• Echo all bytes: Echoes all bytes
• No echo: Suppresses all echoing

By default, the list only shows the most relevant options. Select the Show all check box to display all available encodings.

Specify the IP addresses, that the management server must be able to communicate with in order to manage external events. You can also use this to exclude IP addresses that you do not want data from.

Specify the IP addresses, that the management server must be able to communicate with in order to manage external events. You can also use this to exclude IP addresses that you do not want data from.