Management Client

Welcome to the Radinium Fire Panel Integration Management Client documents where we will supply you with more details on the configuration of an environment.

Camera configuration

Milestone XProtect® primarily focuses on surveillance and serves as a video management system (VMS), allowing for the configuration of cameras out of the box. The Radinix Fire Panel Integration plugin allows those cameras to be associated with each of the Security Zones that you configure for your environment. This guide is intended only to show basic configuration of cameras, however, for further information you may view the Milestone XProtect® documentation.

In the Milestone XProtect® Management Client, in the site navigation on the left pane, select Servers -> Recording Servers.

In the Recording Server pane, expand the Recording Servers, right-click on your recording server and select Add Hardware.

At this point, you will be prompted by the Milestone XProtect®’s wizard to add hardware.

Use any of the provided methods to add your IP Cameras. All cameras that are configured will become available to you when setting up your Fire Devices.

Users & Security

The Radinix Fire Panel Integration plugin utilizes the built-in security of Milestone XProtect® and distinguishes between two types of users by exposing a new role: the Fire Supervisor. The Fire Supervisor role gains two permissions: Fire Panel Viewer and Fire Panel Supervisor.

Fire Panel Viewer

A fire panel viewer is given the ability to view alarms in the Milestone XProtect® Smart Client. This permission is intended for standard operators.

Fire Panel Supervisor

A fire panel supervisor is given the ability to close alarms in the Milestone XProtect® Smart Client. This permission is intended for staff allowed to monitor and manage the operators.

Configuration

To add/remove users to the Fire Supervisor role, in the the site navigation on the left pane, expand Security and select Roles.

In the Roles pane, select the Fire Supervisor role.

At the bottom of the Role settings pane, the right-most pane, select Users and Groups and click the Add button to add basic users or Windows users.

You are also able to add the Fire Panel Viewer and Fire Panel Supervisor permissions to existing roles by navigating to your desired role at the bottom of the Role settings pane and select MIP .

At the top of Role Settings pane, select Radinium Fire Panel Integration.

Now, check the checkboxes of the permissions you would like to add to your alternative role.

Plugin Configuration

When navigating to the Radinix Fire Panel Integration plugin overview, you will be able to configure the various parts of your plugin. For instance: report defaults, database credentials, licensing of panels and your workflow configuration.

Settings

You can add a company logo and disclaimer text that will appear in reports you generate using the cIntruder plugin. The company logo is intended for you to white-label the reports we provide in the plugin, and the disclaimer text will be placed in the footer of each page of your reports.

A list of default maintenance events for the maintenance report can be configured by clicking on the Default Maintenance Events button to allow you to personalise your favourite events to be listed in your maintenance report.

Database

The database tab allows one to set correctly their database credentials and test whether the credentials supplied allow the Radinix Fire Panel Integration plugin access to the database.

Upon supplying incorrect settings, the resulting error will be displayed in the box under the test status as follows:

License

The license tab allows one to keep their fire panel licences valid in an intuitive manner. We have dedicated a page to describe and assist with licensing. Click through to licensing.

Workflow

The workflow tab allows configuration of the workflow server and provides a process editor for altering your processes.

Click through to workflow

Fire Panel Environment Setup

Click on the Radinium Fire Panel Integration menu item and you will see an overview of the environment.

Scanning Radinixes

In the Site Navigation, expand Radinium Fire Panel Integration and click on Radinixes to find our Radinix scanning utility.

In the Network Address field, populate the IP range (first 3 parts of IP address e.g. 192.168.0 ) and then click on Scan Radinixes. This procedure may take a while depending on the network architecture and if your device is found before the scan has ended, you may click on Stop Scan. Once completed, select the Radinixes that you wish to have configured and then click on Add Configuration. If you are not using a Radinix Fire, right-click on Radinixes and manually configure the IP Address of your Fire Panel interface supported. Currently supported is Ziton ZP3 on Radinix interface, Edwards EST3 using BACNet or the Ziton ZP2 on the Modbus protocol.

Fire Panel Configuration

Click on Fire Panels nested under Radinixes in the left pane.

Expand Fire Panels in the secondary left pane and right-click on your newly added Radinix device and then click Add New. Populate the details of your Fire Panel, including its password for interfacing with the Fire Panel. For more information on any of the fields required, simply hover over the label of the field and a popup with more details regarding the field in question will be visible.

Once all the information has been completed, click OK and then click the Save icon in the top left of the management client. All Fire Panels are required to be licensed for our integration and you may be prompted with 2 messages regarding the state of your licence depending on whether you have available licenses. Offline checking is completed to verify whether you have an existing license within your setup and, if not, then an online check is completed to download any available licenses. Without a licence, parts of our plugin may not function as you expect.

Fire Device Configuration

In the Site Navigation expand Radinium Fire Panel Integration -> Radinix -> Fire Panels -> Fire Devices.  

In the secondary left pane, expand Fire Devices. Right-click on your Fire Panel, click Add New and the Add Fire Device window will appear.

Once all information has been completed, click OK and then click the Save icon in the top left of the management client. If you are uncertain of the meaning of any of the fields, hover over them and more details about them will appear.

Import Fire Panel Environment (CSV)

The manual setup of a large number of devices can be quite labour-intensive, so, for that case CSV, import functionality is ideal to add a number of Radinix devices, panels and fire devices simultaneously. See the CSV File Format page for details.

Workflow

Welcome to the Radinium Fire Integration Workflow documentation, where we will provide more details on the configuration of a workflow process.

BPMN 2.0

Business Process Model Notation (BPMN) has been developing over a number of years, releasing its first version in March of 2007. BPMN now sits on version 2.0, released in January of 2011, with one of its primary improvements facilitating the storage of process templates and data.

Radinium has included BPMN 2.0 in all our integration releases, thereby increasing efficient auditing, coordination and collaboration of business processes and their tasks. We want the user to have the ability to define how the security alarm processes within their premises are managed, as they see fit; an increasingly important capability when working within a mission-critical environment, where pressure can arise during the execution of a process, causing potential panic and mistakes. Radinium’s process engine is there to keep your processes executing with integrity.

Terminology

Supported Subset

As BPMN 2.0 has a wide array of notation to facilitate just about every kind of process, we have narrowed down a subset of the notation that is most commonly used. Upon request, we are able to extend this subset to include any part of BPMN 2.0 that you may require.

Start events

Name	Description	Notation
Start Event	Defines an entry point into your process model. At least 1 start point is required in your process.

Activities

Name	Description	Notation
User Task	Defines a task that requires a user’s input. This is usually accompanied by a form that captures data about the task to be used later within the process or for auditing/reporting purposes.
Service Task	Defines a task that is executed automatically as software in the background when this task becomes active. An example would be to automatically silence a panel without further human intervention.

Gateways

Name	Description	Notation
Exclusive Gateway	Is used for conditional flow where only 1 path may be followed, depending on which path’s conditions are met. This gateway is also used to consolidate multiple execution paths from an exclusive gateway into one path.
Inclusive Gateway	Is used for conditional flow where multiple paths may be followed, depending on whether the conditions for each path are met. This gateway is also used to consolidate multiple execution paths into one path.
Parallel Gateway	Is used for allowing 2 or more tasks to be active simultaneously, whereby multiple users can claim and complete those tasks in any order. This is synonymous to an AND logical gate. This is also used to consolidate multiple executions’ paths into one path.

End events

Name	Description	Notation
End Event	Defines a point within your process that terminates the process instance. This will make further tasks within the process unclaimable and incompletable.

Process Editor

Creating your workflow

To fully harness the power of BPMN 2.0, we’ve included the ability for you to alter and illustrate workflows directly from within Milestone XProtect® Management Client.

In the Site Navigator, expand MIP Plugins and click on Radinium Fire Integration menu item.

Click on the workflow tab in the Radinium Fire Integration panel.

Click on Process Editor.

An initial canvas that has not yet been altered will look as follows. Click on the canvas to display it at the bottom of the property menu for the workflow process.

Add a new notation to your BPMN 2.0 workflow simply by clicking and dragging any of the items from the toolbox on the left onto the canvas.

Upon releasing the item on the canvas, a representation of the notation will appear in that position. You can drag these objects around the canvas freely.

To link one object to the next, click on the source object, now click and drag the Sequence flow icon  onto the center of your destination object.

Upon dropping the arrow icon on the destination object, a sequence flow will be created between the source and destination.

Adding forms to user tasks

First, create a form by clicking on the Referenced Form text at the bottom of the page when a user task is selected.

Click the New Form button to create a new form, or select a form that needs to be modified and click Open.

Fill in the name and form key. Please remember that the form key should not contain spaces or special characters.

A new form looks like the below image:

You can drag and drop fields on the form from the left-hand menu.

The field appears after drag-and-drop completes.

If you hover over the field, you have options to either modify settings or to delete the field.

Each field has different settings which you can modify. The Required label means that the field needs to be filled in for the form to be completed.

You can add additional fields to the form as needed.

Remember to save the form when done. Click on the save button on the top-left of the window.

Each form element has different options, for example the dropdown has options that can be pre-set so that they are available to select.

Object Properties

Gateways

Exclusive Gateway

Accessed by clicking on any exclusive gateway object on the canvas.

Inclusive Gateway

Accessed by clicking on any inclusive gateway object on the canvas.

Parallel Gateway

Accessed by clicking on any parallel gateway object on the canvas.

Sequence Flow (the arrows between the elements)

Accessed by clicking on any sequence flow object on the canvas.

How to use conditional flows and gateways

Form outcomes

To create an outcome for a form, when the form has been completed, select the Outcomes tab at the top of the form. Add outcomes to the form to be able to access it from the process flow.

Click on Add Outcome until the different outcomes are added. Remember that an outgoing flow can only have a single outcome. 

Sequence conditions

To select the necessary task to be run, use the Flow Condition field on the sequence flow that goes out from the gateway. Assuming the previous entry was a form that has outcomes, the outcome will have a text value.

Note that the text is shortened in the bottom block. The condition selector will appear when the above has been clicked.

Select the form outcomes with the dropdown to set the flow conditions.

To combine multiple flows into a single flow, use the appropriate gateway.

• To wait for all incoming tasks until they all have completed, use a Parallel Gateway. This ensures that all incoming tasks have completed before continuing with the process after the gateway. This is similar to the incoming behavior of the inclusive gateway.
• To wait for any incoming task until it has completed, use an Exclusive Gateway. This assumes that a single task will have completed before continuing the process flow path.

Process Definition (Workflow)

Accessed by clicking on any piece of blank canvas.

Service Task

Accessed by clicking on any service task object on the canvas.

We have provided different preset service tasks for use: Security Panel Accept, Security Panel Silence and Security Panel Reset. To implement the accept, use as Class the words “radinium.workflow.fpi.Accept”, for silence, “radinium.workflow.fpi.Silence”, and for reset, “radinium.workflow.fpi.Reset”. The panel will only reset when all workflows associated with the panel have been completed. Please note that an indemnity form will need to be filled out before remote management functionality will be exposed (silence/reset/accept). Email: info@radinium.com for further information.

User Task

Accessed by clicking on any user task object on the canvas.