Access control properties

You can adjust the properties of your access control system integration using the tabs on the Access Control node.

General Settings tab (Access Control)

Name

Description

Enable

Enable or disable the integrated access control system.

If you disable this property, your XProtect system will no longer receive access control events. Integrated access control systems are enabled and visible in XProtect Smart Client by default for users with sufficient permissions.

Sometimes, you might need to disable access control events, such as during maintenance, to avoid generating unnecessary alarms.

Name

Add or edit the name of the access control system integration shown in the Management Client and other clients.

Description

Add a description of the access control integration (optional).

Integration plug-in

Displays the type of access control system selected during the initial integration.

Last configuration refresh

Displays the date and time when the configuration was last imported from the access control system.

Refresh configuration

Click this button when you have made configuration changes in the integrated access control system and want to reflect them in XProtect, such as adding or deleting a door.

After you click the button, a summary of the configuration changes from the access control system is displayed. Review the list to ensure your access control system is correctly reflected before applying the new configuration.

Operator login required

If the access control system supports differentiated user permissions, enable an additional login for the client users. If you enable this option, the access control system will not be available in XProtect Mobile client.

This property is only visible if the integration plug-in supports differentiated user permissions.

Potential properties

The following examples of properties might be displayed, depending on your access control system plug-in. Their names and content are imported from it.

Name

Description

Address

Enter the address of the server that hosts the integrated access control system.

Port

Specify the port number on the server the access control system is connected to.

User name

Enter the name of the user from the access control system who should be the administrator of the integrated system in XProtect.

Password

Enter your password for the access control system to save your configuration.

Doors and Associated Cameras tab (Access Control)

Use this tab to link door access points with cameras, microphones, and speakers.

  • You must assign cameras to door access points during the integration setup, but you can change them later.

  • Microphones and speakers are automatically linked through their associated cameras.

Name

Description

Doors

Lists the available door access points defined in the access control system, grouped by door.

For an easier navigation to the relevant doors, you can filter on the doors in your access control system with the dropdown list box at the top.

Enabled: Licensed doors are enabled by default. You can disable a door to free up a license.

License: Shows if a door is licensed or if the license has expired. The field is empty when the door is disabled.

Remove: Click Remove to remove a camera from an access point. If you remove all cameras, the check box for associated cameras is automatically cleared.

Cameras

Lists the cameras configured in the XProtect system.

Select a camera from the list and drag and drop it at the relevant access point to associate the access point with the camera.

Access Control Events tab (Access Control)

Event categories organize events and influence access control behavior. For example, you can set one alarm to trigger for multiple event types.

Name

Description

Access Control Event

Lists the access control events imported from the access control system. The integration plug-in controls default enabling and disabling of events. You can disable or enable events at any time after the integration.

When an event is enabled, it is stored in the event database, and users can filter for it in the XProtect Smart Client.

Source Type

Shows the access control unit that can trigger the access control event.

Event Category

Assign event categories to the access control events. You can add multiple categories.

The XProtect system automatically maps relevant event categories to the events during integration and creates a default setup. You can change the mapping at any time.

Built-in event categories are:

  • Access denied
  • Access granted
  • Access request
  • Alarm
  • Error
  • Warning.

The integration plug-in's own events and event categories might be displayed, and you can also define your own event categories.

If you change the event categories in XProtect Corporate, ensure that the existing access control rules still work.

User-defined Categories

Allows you to create, modify, or delete user-defined event categories.

You might want to create event categories when the built-in categories do not meet your requirements, such as when you define triggering events for access control actions.

The categories apply to all integration systems added to the XProtect system. They enable you to set up cross-system handling, such as on alarm definitions.

If you delete a user-defined event category, you will receive a warning if it is in use with any of your integrations. If you still delete it, all configurations made with this category, such as access control actions, will no longer work.

Access Request Notification tab (Access Control)

You can customize how your access request notifications are displayed in XProtect Smart Client when a given event is triggered.

Name

Description

Name

Enter a name for the access request notification.

Add Access Request Notification

Click to add and define access request notifications.

To delete a notification, click X on the right-hand side.

If you log into the parent site using XProtect Smart Client in a Milestone Federated Architecture, you also see access request notifications from the child sites.

Access request notification details

Specify the cameras, microphones, or speakers that are displayed in the access request notifications when a given event occurs. You can also specify the sound you want to use to alert the user when the notification is displayed.

Add command

Select the commands to display as buttons in access request notification windows in XProtect Smart Client.

  • Related access request commands: enables all commands related to access request operations available on the source unit. For example Open door.

  • All related commands: enables all commands on the source unit.

  • Access control command: enables a selected access control command.

  • System command: Enables a command predefined in the XProtect system

To delete a command, click X on the right-hand side.

Cardholders tab (Access Control)

Use the Cardholders tab to review available information about cardholders in the access control system.

Name

Description

Search cardholder

Type a cardholder's name. If the name exists in the system, it will appear in the list.

Name

Lists the names of the cardholders retrieved from the access control system.

Type

Lists the type of cardholder, for example:

  • Employee
  • Guard
  • Guest.

If your access control system integration allows adding and deleting image files in XProtect, you can upload images to cardholder profiles. This functionality is useful if the access control system integration does not store any existing cardholder images already.

Not all access control systems support adding cardholder pictures through XProtect.

Name

Description

Select picture

Specify a path to a file with an image of the cardholder. This button is hidden if the integrated access control system manages the images and does not allow image changes in XProtect.

  • You can use files in the .bmp, .png, and .jpg formats.

  • Images are resized to maximize the view.

  • Milestone recommends that you use a square image.

Delete picture

Click to delete the picture. If the cardholder also had a picture the integrated access control system, this picture will be shown instead.