Access Control

SiPass® Explorer MP2.6

Operation Manual

MP2.6 SP1

A6V10265087 Siemens AB
20.04.2012 Security Products
 Copyright

Copyright
Technical specifications and availability subject to change without notice.
© Copyright Siemens AB
We reserve all rights in this document and in the subject thereof. By acceptance of
the document the recipient acknowledges these rights and undertakes not to
publish the document nor the subject thereof in full or in part, nor to make them
available to any third party without our prior express written authorization, nor to
use it for any purpose other than for which it was delivered to him.
Edition: 20.04.2012
Document ID: A6V10265087

2
Siemens AB A6V10265087
Security Products 20.04.2012
 Table of Contents

1 Introduction.........................................................................................................7
1.1 Installation ............................................................................................................7
1.2 Navigating the Interface .......................................................................................7
2 Advanced Security Programming (ASP)..........................................................8
2.1 Overview of the ASP Designer.............................................................................8
2.2 The ASP Data-grid, Toolbar and Buttons.............................................................9
2.3 Activity Designer.................................................................................................10
2.4 Configuring ASP activities ..................................................................................10
2.4.1 Configuring a Single Trigger/Effect Activity ........................................10
2.4.2 Configuring Multiple Trigger / Effect Activities ....................................12
2.4.3 Configuring Virtual Flags as Triggers .................................................13
2.4.4 Configuring Virtual Flags as Effects....................................................13
2.4.5 Configuring a Trigger Branch/s in a Flow ...........................................14
2.4.5.1 Creating a Nested Branch...................................................................15
2.4.5.2 Joining Branch Endpoints ...................................................................15
2.4.5.3 Creating Parallel Branches .................................................................15
2.4.5.4 Disjoining Branch Ends.......................................................................15
2.4.5.5 Deleting a Branch ...............................................................................15
2.4.6 Creating a Sequence of Effects ..........................................................16
2.4.7 Creating Multiple Flows within an Activity...........................................16
2.4.7.1 Reordering / Deleting Flows ...............................................................17
2.4.8 Configuring an Alternative Effect for an Activity..................................17
2.4.9 Stateless Effects .................................................................................18
2.5 Creating Copies of ASP Activities ......................................................................18
2.6 Location Management........................................................................................19
2.6.1 Locating Points that share Common Locations ..................................19
2.6.2 Modifying Point Locations in Location Management ..........................19
2.7 ASP Partitioning .................................................................................................20
2.8 Virtual Components ............................................................................................20
2.8.1 Flags ...................................................................................................21
2.8.1.1 Configuring a New Flag ......................................................................21
2.8.2 Counters..............................................................................................22
2.8.2.1 Configuring a New Counter.................................................................22
2.8.3 Timers .................................................................................................22
2.8.3.1 Configuring a New Timer ....................................................................23
2.8.4 Editing Virtual Components ................................................................23
2.8.5 Runtime Mode Support for Virtual Components .................................24
2.9 Programmable Authorization for an access point through an ASP Activity .......24
2.9.1 Programmable Host Authorization Criteria Configuration...................25
2.9.2 Configuring Programmable Authorization...........................................25
3 T&A Calculation................................................................................................27
3.1 Configuring a T&A Calculation ...........................................................................27

3
Siemens AB A6V10265087
Security Products 20.04.2012
 3.2 Configuring a Time & Attendance Event Task ...................................................28
4 Custom Transaction Logs ...............................................................................29
4.1 Multiple Custom Transaction Logs .....................................................................29
4.1.1 Assigning Operator Privileges for Custom Transaction Logs .............30
4.1.2 Saving and Sharing Custom Transaction Logs ..................................30
4.1.3 Applying Direct Commands from Each Audit Trail..............................31
4.2 Customizing Custom Transaction Logs..............................................................31
4.2.1 Highlighting Custom Transaction Logs with Colors ............................31
4.3 Printing Custom Transaction Logs .....................................................................32
4.4 Snapshot Capture of Custom Transaction Logs ................................................32
5 Custom Pages...................................................................................................33
5.1 Adding / Deleting a Custom Page ......................................................................33
5.1.1 To Title a Custom Page ......................................................................34
5.1.2 Choosing Between the 'Cardholder' and 'Visitor' Custom Page View 34
5.1.3 Refreshing a Custom Page.................................................................34
5.1.4 Choosing between the Cardholder or Visitor Custom Page View ......34
5.1.5 Refreshing a Custom Page.................................................................35
5.1.6 Arranging the Order of Custom Pages................................................35
5.1.6.1 Customizing the Appearance and Display of Views ...........................35
5.2 Designing a Custom Page..................................................................................35
5.2.1 Custom Fields .....................................................................................35
5.2.2 Customizing the BUTTON Custom Field ............................................37
5.2.3 Customizing the ATTACHMENT Custom Field ..................................37
5.2.4 Populating the DROP DOWN LIST Custom Field ..............................38
5.2.4.1 Dynamic Insertion of Drop-down Items...............................................38
5.2.4.2 Custom Field Properties .....................................................................39
5.2.4.3 Resizing Custom Fields ......................................................................41
5.3 Custom Page Partitioning...................................................................................41
5.3.1 Operator Privileges for Custom Fields in the Cardholder / Visitor
Dialog ..................................................................................................42
5.3.2 Operator Privileges for Custom Pages in SiPass Explorer.................42
5.4 Importing / Exporting Custom Pages..................................................................42
5.4.1 Importing Custom Pages ....................................................................42
5.4.2 Exporting Custom Pages ....................................................................43
6 Customized & Predefined Reports .................................................................44
6.1 Getting Started ...................................................................................................44
6.1.1 Creating a New Report .......................................................................44
6.1.2 Customizing Views..............................................................................45
6.1.2.1 Display Fields......................................................................................45
6.1.2.2 Filter Conditions ..................................................................................45
6.1.2.3 Available Actions.................................................................................46
6.1.2.4 Group By .............................................................................................47
6.1.2.5 Sort Order ...........................................................................................48
6.1.2.6 Appearance.........................................................................................48
6.1.2.7 Automatic Formatting ..........................................................................49
6.1.2.8 Advanced ............................................................................................49

4
Siemens AB A6V10265087
Security Products 20.04.2012
 6.1.3 Searching Reports for Data ................................................................50
6.1.3.1 Search Criteria ....................................................................................51
6.1.4 Page Setup .........................................................................................52
6.1.5 Exporting Data ....................................................................................52
6.2 Generating Reports ............................................................................................53
6.2.1 Components........................................................................................53
6.2.1.1 Units Report Fields .............................................................................53
6.2.1.2 Devices Report Fields.........................................................................54
6.2.1.3 Points Reports Fields..........................................................................54
6.2.2 Time Schedule ....................................................................................55
6.2.2.1 Time Schedule Details Report Fields .................................................56
6.2.3 Component Groups.............................................................................56
6.2.3.1 Point Group Report Fields ..................................................................56
6.2.3.2 Unit Group Report Fields ....................................................................57
6.2.3.3 FLN Group Report Fields....................................................................57
6.2.3.4 Device Group Report Fields ...............................................................57
6.2.4 Access Levels .....................................................................................58
6.2.4.1 Access Level Report Fields ................................................................58
6.2.5 Access Groups....................................................................................59
6.2.5.1 Access Group Report Fields ...............................................................59
6.2.6 Workgroups.........................................................................................60
6.2.6.1 Workgroup Report Fields ....................................................................60
6.2.7 Cardholder ..........................................................................................61
6.2.7.1 Cardholder Reports.............................................................................61
6.2.7.2 Cardholder Report Fields....................................................................62
6.2.7.3 Visitor Reports Fields..........................................................................63
6.2.8 Audit Trail ............................................................................................64
6.2.8.1 Audit Trail Reports ..............................................................................64
6.2.8.2 Audit Trail Columns.............................................................................65
6.2.9 APB Areas ..........................................................................................66
6.2.9.1 APB Areas Columns ...........................................................................66
6.2.10 Intrusion Areas ....................................................................................67
6.2.10.1 Intrusion Areas Report Fields .............................................................67
6.2.11 Alarms .................................................................................................68
6.2.11.1 Alarms Class Report Fields ................................................................68
6.2.11.2 Alarms Events Outstanding Report Fields..........................................69
6.2.12 Site Plans ............................................................................................69
6.2.13 Event Tasks ........................................................................................69
6.2.13.1 Controller Event Tasks Report Fields .................................................69
6.2.13.2 Host Event Tasks Report Fields .........................................................69
6.2.14 CCTV ..................................................................................................69
6.2.14.1 CCTV Report Fields............................................................................69
6.2.15 Guard Tour..........................................................................................69
6.2.15.1 Guard Tour Report Fields ...................................................................69
6.2.16 Holidays ..............................................................................................69
6.2.16.1 Holidays Report Fields........................................................................69

5
Siemens AB A6V10265087
Security Products 20.04.2012
 6.2.17 Elevators .............................................................................................69
6.2.17.1 Elevators Report Fields.......................................................................69
6.2.18 Operators ............................................................................................69
6.2.18.1 Operators Reports...............................................................................69
6.2.18.2 Operators Report Fields......................................................................69
6.2.19 Database Analysis ..............................................................................69
6.2.19.1 Database Analysis Report Fields........................................................69
6.2.20 Mustering ............................................................................................69
6.2.20.1 Mustering Report Fields ......................................................................69
6.2.21 Credential Profile.................................................................................69
6.2.21.1 Credential Profile Report Fields ..........................................................69
6.2.22 Advanced Security Programming .......................................................69
6.2.22.1 ASP Reports .......................................................................................69
6.2.22.2 ASP Components Profile Report Fields..............................................69
6.2.23 Synchronization...................................................................................69
6.2.23.1 Synchronization Report Fields ............................................................69
7 Import Data........................................................................................................69
7.1 Watchlists ...........................................................................................................69
7.1.1 'Warn User' Configuration ...................................................................69
7.1.1.1 Creating Watchlist Reports in SiPass Explorer...................................69
7.1.1.2 Field Mapping a Watchlist Report .......................................................69
7.1.1.3 Modifying Existing Watchlist Data.......................................................69
7.1.2 Creating Watchlist-linked Customized Reports ..................................69
7.1.3 Void Cardholder/Card using Customized Reports..............................69
7.1.3.1 Void Cardholder/Card using Reporting Actions ..................................69
7.1.3.2 Void Cardholder/Card using Host Event Tasks ..................................69
7.2 Lookup Data .......................................................................................................69
7.2.1 Importing a Lookup File ......................................................................69
7.2.2 Creating a New Lookup File................................................................69
8 Interactive Reports ...........................................................................................69
8.1 How Does an Interactive Report Work ...............................................................69
8.2 Configuring an Interactive Report.......................................................................69
8.3 Removing an Interactive Report.........................................................................69
8.4 Creating an Interactive Report during Watchlist Report Creation ......................69
Index 69

6
Siemens AB A6V10265087
Security Products 20.04.2012
 Introduction
Installation 1

1 Introduction
SiPass Explorer is an innovative new tool that comes pre-installed with SiPass
integrated.
Presented with an intuitive visual interface, SiPass Explorer combines the following
new and enhanced features of SiPass integrated:
T&A Calculation
Custom Transaction Logs
Custom Pages
Customized Reports
Pre-defined Reports
Import Data and
Interactive Reports
Users of SiPass Explorer can navigate easily within the interface to customize each
feature to their requirement. When saved, all changes made within SiPass Explorer
are immediately updated to SiPass integrated.

1.1 Installation
SiPass Explorer is automatically installed with SiPass integrated MP2.5 and higher.
No additional installation steps or licenses are required.

1.2 Navigating the Interface

The operator can access the SiPass Explorer from SiPass integrated by selecting
SiPass Explorer from the main menu, and then selecting an individual SiPass
Explorer feature. This action will open up the SiPass Explorer application.

The SiPass Explorer Graphical User Interface (GUI)

The SiPass Explorer’s GUI consists of three separate panels and a toolbar.
Horizontal Tool Bars:
The application displays five main menubars: File, Edit, View, Window and
Help.
Depending upon the features selected, SiPass Explorer displays several Drop-
down Menus, and Buttons on its horizontal tool bars.
Navigation Panel:
Found on the left of the SiPass Explorer user interface, this panel contains the
tree structure of the SiPass Explorer categories.
Main Panel: This panel is used to view data.
Custom Pages, Live Audit Trail Windows, Reports, etc, can be arranged and
grouped here.

7
Siemens AB A6V10265087
Security Products 20.04.2012
 Advanced Security Programming (ASP)
2 Overview of the ASP Designer

2 Advanced Security Programming (ASP)

The Advanced Security Programming (ASP) functionality operates like a
programming logic engine running in the controller. Presented through the user-
friendly SiPass Explorer interface, this feature gives operators the unique ability to
construct their own logical activities using the ASP graphical user interface. With
the help of the graphical designer, operators can now customize ‘Activities’ for
multiple triggers, and resulting effects/changes.
ASP supports a variety of SiPass integrated entities like Access, Input and
Output point, Access Events, Intrusion Areas, Anti-Passback areas,
Workgroups, Floors, etc.
Virtual Components (Flags / Timers / Counters) can be incorporated into
activities as Triggers and Effects.

Representation of an Activity
ASP presents the logical relationship graphically, and they are referred to as
‘Flows’.
Each Flow has a flexible structure and may contain multiple triggers, and
effects.
Multiple Flows can be added to one ‘Activity’.
An activity is enabled or disabled by the Time Schedules configured to it.
The flows within an activity are executed from top to bottom.
ASP supports multiple activities.

2.1 Overview of the ASP Designer

In this section, you’ll find information regarding the user-friendly ASP designer.

Data Grid, Menus and Toolbars

The ASP menus and toolbars are context-sensitive. This means that they may
change depending on the selection that has been made. The ASP -specific buttons
and menu options are explained in the section The ASP Data-grid, Toolbar and
Buttons [➙ 9].

The ASP Activity Design Workspace

On creating a new activity, SiPass Explorer displays a ASP Activity Design
Workspace. This workspace will contain a few ASP elements by default.
The workspace also contains a Toolbar and a Property Grid.
The Toolbar
The tools contained in the toolbar are explained in the table below.

Tool Description
Pointer This tool is used to select ASP objects on the workspace.
Flow This tool is used to add a new flow above or below an existing flow. For
details, refer the section Creating Multiple Flows within an Activity [➙ 16].
Trigger This tool is used to add a new Trigger object to an existing flow. For
details, refer the section Configuring Multiple Trigger / Effect Activities [➙
12].
Branch This tool is used to add a branch to an existing flow. For details, refer the
section Configuring a Trigger Branch/s in a Flow [➙ 14].
Sequence This tool is used to add an effect to the existing flow. For details, refer the
section Creating a Sequence of Effects [➙ 16]

8
Siemens AB A6V10265087
Security Products 20.04.2012
 Advanced Security Programming (ASP)
The ASP Data-grid, Toolbar and Buttons 2

The Property Grid

The property grid has the ability to display all the properties of the selected
ASP activity, a flow, or individual objects.
Operators can configure various properties of the ASP activity and its individual
objects on the Property Grid.

2.2 The ASP Data-grid, Toolbar and Buttons

The ASP Data-grid
The Data-grid is a general navigation control used by ASP and the Virtual
Components. It lists all the ASP activities that are saved in SiPass Explorer.
To display the data grid, click the ASP tree node on the SiPass Explorer Navigation
pane.

ASP Data-grid Field Column Description

Column Description

Name This field displays the name of the activity, and is limited to 128 characters.
Unit This field displays the unit on which the activity resides.
Time Schedule The Time Schedule controls whether the activity is running on the ACC or not.
The default value of this field is Always (point unsecure).
Description This field displays a short description of the ASP activity.

How to Use the Data-Grid

The data-grid can be used in the following manner:
To Find or Filter ASP activities in the data-grid:
Click the Find button on the tool bar. Or, right-click and select Find from the
context menu.
To Open ASP activities from the data-grid:
Double-click the arrow adjacent to each of the listed activities. Or, right-click an
activity and select Open from the context menu.
To Edit ASP activity parameters inline, within the data-grid:
1. Double-click within a cell of an activity to highlight it. The parameters of this cell
can now be edited inline by typing into it, or by making selections from drop-
boxes where available.
2. Click the Save button on the tool bar to save the data-grid.
To Delete ASP activities from the data-grid:
1. Select the ASP activity to be deleted.
2. Click the Delete button on the toolbar. Or, click Edit > Delete on the main
menu of SiPass Explorer. Or, right-click an activity and select Delete from the
context menu.

9
Siemens AB A6V10265087
Security Products 20.04.2012
 Advanced Security Programming (ASP)
2 Activity Designer

The Delete function can also be used to delete multiple activities that are selected
together. To select multiple activities together, hold down the Shift key and click
all the activities you want selected together.

To Group ASP activities in the data-grid:

1. Click the Group button on the task bar.
An area appears above the data grid.
2. Drag and drop a grid column header to the new area that has appeared above
the grid.
The ASP activities will be grouped based on the column head that was
selected.
To Filter and Sort activities in the data-grid:
Click on the column headers of the data grid.
The activities are sorted based on the column header chosen.

2.3 Activity Designer

The Activity Design work space is an area that is used to design and display an
activity. There exists a flow within an activity. By default a single flow is present
when a new activity is created.
An Activity has an Activity Description field that is used to type the description of
the activity.
A flow consists of the following objects
Trigger – To configure a Trigger, click the trigger box and set its various properties
under the Properties Grid.
Effect – To configure an Effect, click the effect box and set its various properties
from the Properties Grid.
The flow also contains the Start of flow and the End of flow which marks the
beginning and the ending of the flow respectively. The arrows within the flow
represent the nature of flow. There is a Flow Description field in Activity Designer
workspace that can be used to type the description of the flow.

2.4 Configuring ASP activities

This section explains the basic ASP Objects and Object Properties. It also explains
the configurations required for creating various kinds of activities.

2.4.1 Configuring a Single Trigger/Effect Activity

This section details the steps required to configure a single effect activity in SiPass
Explorer.
As a prerequisite, ensure that an ACC and a RIM device have been configured
in the Components dialog.
Right-click ASP on the SiPass Explorer navigation tree, and then select New
Activity.
A new ASP workspace will be loaded. By default, a single Flow containing
a Trigger and Effect object will be displayed here.

Configuring a Flow and its Properties:

10
Siemens AB A6V10265087
Security Products 20.04.2012
 Advanced Security Programming (ASP)
Configuring ASP activities 2

1. Click on the ASP design workspace, outside the Flow displayed.

This action displays the ASP activity properties in the Properties grid.
Please refer the SiPass integrated Reference Manual for details on
property options.
2. Specify a Time Schedule. The time schedule controls whether the activity is
running on the ACC or not.
3. In the cell adjacent to Description, enter a description of the Activity being
configured.
4. In the cell adjacent to Name, enter a name for the activity. This field is limited
to 128 characters.
5. In the cell adjacent to Unit, select a unit on which this activity will run.

Configuring a Trigger and its Properties:

A Trigger represents a set of parameters that must be met as a result of an event,
for a configured effect to be triggered.
The displayed Flow already contains a Trigger object
Click the trigger object and configure the trigger properties in the Properties
section of this dialog. Please refer the SiPass integrated Reference Manual for
details on property options.

Configuring an Effect and its Properties:

An Effect represents an action to the object
The displayed Flow already contains an Effect object.
Click the effect object and configure the effect properties in the Properties
section of this dialog. Please refer the SiPass integrated Reference Manual for
details on property options.

Saving an Activity
1. After the Trigger and Effect object/s properties are configured, the ASP activity
can now be saved.
2. The ASP activity can be saved in two ways by clicking either Save Only or
Save and Download.
The Save Only button saves the activity to the SiPass database and does not
send any data to ACC.
The Save and Download button saves the activity to the SiPass database and
also downloads data to the ACC.
The progress dialog will be displayed with any one of the following messages
(described in the table below) when the activity is being saved into SiPass
integrated database and also sent to the ACC. The messages displayed are
described in the table below:

Message Description
Saving and downloading activity This means the activity has been saved and sent to the
ACC but yet no status has been received from the
ACC.
The server was unable to receive a response from the This means there was no response from the ACC. This
controller. The request times out usually happens when the ACC is offline and cannot be
contacted.
Activity was saved successfully but no activity data was This means the activity was saved in the SiPass

11
Siemens AB A6V10265087
Security Products 20.04.2012
 Advanced Security Programming (ASP)
2 Configuring ASP activities

loaded in the ACC. database but data was not loaded in ACC.
Activity saved waiting for download file This means the ACC received the initial activity
configuration command and is waiting to receive the
activity’s data.
Download in progress This means the ACC has started receiving the activity’s
data.
Error occurred while downloading the activity This means the activity was not saved properly.
Activity downloaded successfully validating contents This means that the ACC has received the activity and
its contents and is validating the activity.
Activity downloaded and validated successfully This means that the ACC has received and validated
the activity.
There was an error when validating the activity. The This means the activity’s data was not validated in the
activity was not enabled or run. database.
Activity not loaded This means that the activity data was not received.
Initializing activity This means that the activity downloaded to the ACC
and was validated successfully and is now being
initialized successfully.
Activity is currently disabled This means that the activity is not currently running on
the ACC.
Activity is enabled and running. This means the activity is currently running on the
ACC.
Activity saved successfully This means that the activity was saved in the SiPass
integrated database. (applicable only for ‘Save Only’
command)

Further, this saved ASP activity will be displayed in the ASP data-grid.

If Save Only is selected, the revision number of the activity will be incremented
only in SiPass, whereas the ACC will still contain the old revision number. This
revision number mismatch is notified to the user by appending a caption
Download required along with the activity name. This caption can be viewed
when the activity is opened after Save Only. The caption can also be viewed
when the activity does not exist in ACC.
If the activity is assigned to an offline unit then SiPass integrated cannot
determine whether the activity requires downloading or not, so SiPass integrated
appends the Unit Offline caption instead of Download required.

See also
The ASP Data-grid, Toolbar and Buttons [➙ 9]

2.4.2 Configuring Multiple Trigger / Effect Activities

Configuring multiple triggers and trigger properties:
The displayed Flow will already contain a Trigger object. The operator can add
to and modify event objects as described below:
1. Drag and drop a Trigger object from the Toolbox onto a link in the flow
activity. You can drop the trigger object on links that turn red when the object
hovers above it.
2. Configure the Trigger properties in the Properties section of this dialog. Please
refer the SiPass integrated Reference Manual for details on property options.

12
Siemens AB A6V10265087
Security Products 20.04.2012
 Advanced Security Programming (ASP)
Configuring ASP activities 2

Configuring multiple effects and effect properties:

The displayed Flow already contains an Effect object. The operator can add to
and modify Effect objects as described below:
1. Drag and drop a Sequence object from the Toolbox onto a link in the flow
activity. You can drop the Sequence object on links that turn red when the
object hovers above it.
2. Configure the Sequence properties in the Properties section of this dialog.
Please refer the SiPass integrated Reference Manual for details on property
options.

You can delete a Trigger or Effect object by selecting the objecting and pressing
Delete. Or, by right-clicking the object, and selecting Delete from the context
menu. You can also move the location of the existing effect by drag and drop to
another available link (available links will appear red on mouse-over.)

2.4.3 Configuring Virtual Flags as Triggers

This section introduces the functionality that allows Virtual Flags to be configured
as Triggers within an ASP activity. The configuration required for this functionality
is explained below.
Ensure that an appropriate Flag is configured within the Virtual Components.
For more information on Virtual Flags, please refer the section Flags [➙ 21] of
this manual.
1. Create a new ASP activity, or open an existing activity.
2. Select the Trigger object that you want to configure as a Flag Trigger.
3. In the Property grid, click the Category drop down list.
4. Select Flag from this list.
5. Select the ACC Unit where the flag belongs to, from the Unit drop down list. If
the ACC Unit is not selected all the flags configured in the system will be
displayed in the next step.
6. Select the Location of the flag by clicking the … button and select the flag from
the pop-up window.
7. Select the property for the flag from the Property download field.
8. Configure the Operations field.
This specifies whether this Trigger is for a Trigger change or an Effect
change.
9. Set the Next State field.
10. Click Save.

2.4.4 Configuring Virtual Flags as Effects

This section explains the functionality that allows Virtual Flags to be configured as
Effects in a ASP activity. The configuration required for this functionality is
explained below.

13
Siemens AB A6V10265087
Security Products 20.04.2012
 Advanced Security Programming (ASP)
2 Configuring ASP activities

Ensure that an appropriate Flag is configured within the Virtual Components.

For more information on Virtual Flags, please refer the section Flags [➙ 21] of
this manual.
1. Create new ASP activity or open an existing activity.
2. Select the Effect object that you want to configure as a Flag Effect.
3. In the property grid, click the Category drop down list.
4. Select Flag from this list.
5. Select the ACC unit where the flag belongs, from the Unit drop down list. If the
ACC unit is not selected, all the flags configured in the system will be displayed
in the next step.
6. Select the flag for this activity by clicking the … button of the Location field and
select the flag from the pop-up window.
7. Select the property for the flag from the Property drop down list.
8. Configure the Condition True Value field to specify the state of the flag when
the event conditions are met.
9. Configure the Condition False Value field to specify the state of the flag when
the event conditions are NOT met. This is an optional field.
10. Click Save.

2.4.5 Configuring a Trigger Branch/s in a Flow

ASP allows the user to create trigger branches in a flow activity. This section
details the steps required to create a branch/s in a flow.
To create a branch, the flow activity must have at least one Trigger and one
Effect object.
1. Drag the Branch object from the toolbox, and drop it on the link where the
branch should begin. You can drop the Branch object only on links that turn red
when the object hovers over it.
The Start-Point of the Branch will appear at the dropped point on the line.
2. Next, specify the End-Point of the Branch by clicking on the link where the
branch should end. You can place the End-Point only on links that turn red
when the object hovers over it.
The Branch has now been created in the flow.

If the end-point is not specified by clicking on a valid location, the branch will
disappear.

Trigger AND/OR Logical Operations

1. When placing multiple Triggers side by side on a single branch, the Trigger
result for that branch is calculated by applying ‘AND’ logical operation for every
trigger. In other words, the Effects at the End-Point as the first branch or the
second branch will only be executed if all the Triggers are true.
2. If a new branch created is leading to the same End-Point as the first branch,
the Effects will be executed if either the Trigger result in the first branch or the
second branch are true. This is because the Trigger result in the first branch is

14
Siemens AB A6V10265087
Security Products 20.04.2012
 Advanced Security Programming (ASP)
Configuring ASP activities 2

OR’d with the Trigger result in the second branch, leading to the final Trigger
result to determine whether the Effects will be executed.

2.4.5.1 Creating a Nested Branch

Nested Branches can be configured by creating a branch that contains or nests
another branch.

2.4.5.2 Joining Branch Endpoints

Operators can choose to merge different branches within a workflow. To do this,
simply drag and drop the Start-Point of one branch next to the Start-Point of
another branch. The start point of the dropped branch will merge with the existing
start-point. The same can be done with the End of branch.

Start and End points of a branch can be moved:

- Drag & drop the Start or End Point of the object onto an available red link
- Delete existing links to or from Start/End Point, and specify the new location by
pointing to an available red link

2.4.5.3 Creating Parallel Branches

Parallel Branches in a ASP flow use the same Start-Point and End-Point. They can
be created in the following manner:
1. Created a complete branch (containing a start-point and end-point) in a flow.
2. Drag and drop another Branch object onto the start-point of the flow.
3. Click the link next to the existing end-point to end the branch.
A Parallel Branch that shares the start and end-point of the first branch has
been created.
It is possible to create multiple parallel branches in the same manner.

2.4.5.4 Disjoining Branch Ends

Operators can diverse a parallel branch by deleting a link to an existing end-point,
and creating a new end-point on a different link. This can be done in the following
manner:
1. Identify the parallel branch that you wish to diverse .
2. Click the end-point link of this branch and press Delete.
3. Next, click on a link where you wish to place the new end-point for the branch.
You can place the end-point only on links that turn red on mouse-over.
A Branch Diverse will be created.

2.4.5.5 Deleting a Branch

A Branch can be removed or deleted by deleting the start-point of the branch.

15
Siemens AB A6V10265087
Security Products 20.04.2012
 Advanced Security Programming (ASP)
2 Configuring ASP activities

1. Select the start-point of a branch.

2. Press Delete.
The entire branch will be deleted from the flow.

Important: Please note that if multiple branches share the same start-point, all
these branches will be deleted when the start-point is deleted.

2.4.6 Creating a Sequence of Effects

If there are multiple effects to be configured, this can be done by creating a
Sequence. The Sequence tool adds an effect to the flow by default.
This section explains how this can be done.
1. Create a new flow, or open an existing one within an activity.
2. Click and drag the Sequence tool from the Toolbox.
3. Drop the Sequence tool onto a link before an Effect object. The link where the
tool can be dropped will be highlighted in red on mouse-over with the
Sequence tool.
This will create a new Sequence with a new effect object being created, with a
new node, below the existing effect.

To delete a Sequence object

Right-click a sequence object, and select Delete from the context menu. Or,
select a sequence object and press Delete.
The sequence object will be deleted.

NOTICE

When multiple branches share the same sequence node, all these branches will
be deleted when the sequence object is deleted.
Alternatively, when the last effect of the sequence node is deleted, the sequence
object will also be automatically deleted.

2.4.7 Creating Multiple Flows within an Activity

An operator can configure a single activity with multiple flows within it. This section
explains the steps required to do this.
1. Locate the Flow object in the adjacent toolbox.
2. As you drag it to the ASP workspace, a green plus sign (+) will appear above,
below and between the existing flow. Drop it on the plus sign above or below
the existing flow depending on where you it to be placed.
3. Proceed to configure the Trigger and Effect object properties within the flow as
explained in the section Configuring a Single Activity Flow.

Creating Duplicate Flows

16
Siemens AB A6V10265087
Security Products 20.04.2012
 Advanced Security Programming (ASP)
Configuring ASP activities 2

A Flow that is already present in the activity can be duplicated by using the
Duplicate Flow button. To duplicate a flow:
Select the flow to be duplicated and press the Duplicate Flow button. Or, right-
click the flow and select Duplicate Flow.

See also
Configuring a Single Trigger/Effect Activity [➙ 10]

2.4.7.1 Reordering / Deleting Flows

Re-ordering Flows in an Activity
To reorder flows, select, drag and drop them on the green plus signs that will
appear above and below the other unselected flows on the workspace.

Deleting a Flow
Select the flow to be deleted and press the Delete button. Or, right-click the
flow and select Delete.

Note that the last remaining flow on the ASP workspace cannot be deleted.

2.4.8 Configuring an Alternative Effect for an Activity

This section explains the ASP functionality that allows operators to configure an
Alternative Effect when Event conditions have NOT been met.
1. Create a new ASP activity, or open an existing activity.
2. Configure the properties of the Trigger object.
3. Click the Trigger object.
4. Configure the Category and Controller fields for this effect object within the
property grid.
5. Click the drop down list of the Condition True Value field.
This configures the effect that is to be produced when any branch of the
triggers’ condition is met.
6. Click the drop down list of the Condition False Value field.
This configures the alternative effect that is to be produced when no branch
of triggers’ condition is met.
7. Click Save.

NOTICE

Alternative effect is not supported in the following cases:

● When an event is configured as a trigger in the flow.
● When certain types of effects such as Execute only is configured in the flow.

17
Siemens AB A6V10265087
Security Products 20.04.2012
 Advanced Security Programming (ASP)
2 Creating Copies of ASP Activities

2.4.9 Stateless Effects

Stateless effect and Stateful effect differs in the following way:
1. Repeated execution of the same Stateless effect produces visible outcome for
each execution
2. Repeated execution of the same Stateful effect produces visible outcome only
for the first execution

Event Driven Flow

Event driven flow starts with an event or a combination of events and may have
zero or more conditions and one or more effects. Event driven flow is executed
when a matching event occurs.

State Driven Flow

State driven flow starts with a condition or a combination of conditions and does
not contain events and one or more effects. State driven flow is executed whenever
any of conditions in the flow changes its state. State driven flow can also be in a
mixed flow state that starts with an OR-combination of an event and condition.

Event driven flow does not execute if the condition has changed but event did not
occur.

Configuring Trigger with Stateless Effect

While configuring a trigger when there is an existing Stateless Effect in the
flow, under the Type property only Event type is visible as the Condition type is
invalid.

When a Condition Trigger co-exists with Stateless effect (eg: adding a new
branch or deleting an event trigger) an error icon appears in the property grid of
stateless effect to indicate trigger is not compatible with stateless effect. The
saving process is interrupted with an error message box.

2.5 Creating Copies of ASP Activities

This explains the Copy ASP functionality that allows operators to use an existing
activity as template to create a new activity.
The configuration required for this is explained below:
1. Navigate to the ASP data-grid. For more information, please refer the section
The ASP Data-grid, Toolbar and Buttons [➙ 9].
2. Select an ASP activity to be copied.
3. Right-click and select Copy Activity from the context-menu. Alternatively, click
File > Copy Activity from the File menu of SiPass Explorer.
The ASP designer will now display a Copy of the selected activity in the
ASP designer, leaving all Events and Effect object properties unchanged.
4. Enter a unique name for this activity in the Name field of the Properties grid.
Please refer the SiPass integrated Reference Manual for details on property
options.

18
Siemens AB A6V10265087
Security Products 20.04.2012
 Advanced Security Programming (ASP)
Location Management 2

By default, the Time Schedule field of the Properties grid is set to Never
(point always secure). This can be modified as required.

5. Click the Location Manager to change the locations configured in the activity.
6. Click Save to save the activity.

2.6 Location Management

The Location Management functionality of ASP allows users to locate all triggers
and effects that share the same location and optionally define a new location. This
functionality becomes available in the toolbar when any activity is opened and
displayed in the ASP workspace.
1. Open an existing ASP activity.
2. Click the Location Management button on the toolbar.
3. This action displays the Location Management dialog. A description of the
fields of this dialog is provided in the table below.

Field Name Description

Type This field lists of the types of various points
that have been configured in the activity.
Old Location This field displays the previous location of
the chosen point.
New Location This field displays the new location of the
chosen point.

Field Property Description

2.6.1 Locating Points that share Common Locations

To locate points that share common locations:
Select any row on the Location Management dialog.
All the triggers and effects that share the same location as the one selected will
be highlighted in red on the ASP activity workspace.

2.6.2 Modifying Point Locations in Location Management

To modify point locations using Location Management:
1. Open the Location Management dialog.
2. Double-click the point that requires a location change.
This action displays an address picker dialog that lists all the available
locations that can be newly configured to the point.
3. Double-click on a location in the list to configure it as the new location for the
point.
The Location Management dialog will now display the new location in the
New Location field. The previous location that was configured is displayed
in the Old location field.
4. Click OK.

19
Siemens AB A6V10265087
Security Products 20.04.2012
 Advanced Security Programming (ASP)
2 ASP Partitioning

All the location changes will be applied to the respective triggers / events.

2.7 ASP Partitioning

An Advanced Security Programming System Function is available in the
Operator Group dialog.
Operators can set three types of operator permissions for this system function:
1. [c] create
2. [e] edit
3. [v] view
The details of the privileges available for each operator permission is explained
below.

[c] create Operator Permission Privileges

If operators have [c] privileges assigned, they are granted full access to the
Advanced Security Programming feature.

[e] edit Operator Permission Privileges

If the operators have [e] privileges assigned, the following permissions and
restrictions apply:
The operator will not be able to create or delete Activities, Timers, Counters or
Flags in SiPass Explorer.
The operator will not be able to create Copies of activities.
The operator will be allowed to change Trigger or Effect property values in the
PropertyGrid of the ASP workspace.
The operator will not be able to edit entities in the activity layout designer; e.g.,
deleting existing events/effects, addition of new events/effects, addition of new
flows, etc. will not be possible.

[v] view Operator Permission Privileges

If the operators have [v] privileges assigned, the following restrictions apply:
The operator will not be able to save Activities, Counters, Timers or Flags.
The operator will not be able to edit the Trigger/Effect property values in the
PropertyGrid of the ASP workspace.

While the above ‘Advanced Security Programming’ system functions can define
operator permissions on all Activities, Counters, Timers and Flags. Individual
create/edit/view partitioning of these objects can be achieved through the use of
Component Groups assignment. Operators should have permissions for
Component Group(s) containing the necessary Activities, Counters, Timers and
Flags, in order to use them. For more information refer the SiPass integrated User
Manual. If there is a difference in the privilege level between the system function
and the Component Group assignment, the lower privilege will apply.

2.8 Virtual Components

This chapter details various aspects about three main Virtual Components:

20
Siemens AB A6V10265087
Security Products 20.04.2012
 Advanced Security Programming (ASP)
Virtual Components 2

1. Flags
2. Counters and
3. Timers

To open a new Flag / Counter / Timer dialog:

1. In the SiPass Explorer tree menu, navigate to Virtual Components > Flags or
Counter or Timer.
2. Right-click Flags or Counter or Timer, and select New Flag or New Counter
or New Timer.
A new dialog for the respective virtual component will be displayed.

OR
1. Click the New button on the SiPass Explorer toolbar.
2. Make the required selection of a virtual component from the dialog that
appears.

2.8.1 Flags
A Flag can behave as a virtual digital point. Flags can be linked to other
functionalities like ASP in SiPass integrated.
The section that follows provides the steps required to configure a flag.

2.8.1.1 Configuring a New Flag

This section explains the steps required to configure a new virtual flag.
1. Open a new flag dialog (Refer the section Virtual Components [➙ 20] for more
information.)
2. Enter a name for the Flag in the Name field.
3. Select an option from the Default Value drop down list.
4. Select an option from the Message Priority drop down list.
5. Select a Unit.
6. Select an Alarm Class.
7. Click OK.
All saved flags can be viewed by clicking the Flags item in the Navigation
panel of SiPass Explorer.

Field Properties of Virtual Flag

Field Name Field Property
Name This field is limited to 128 characters.
Default Value This field displays the initial value of the flag, as well as the value it
is set to when it is sent a Reset command.
Message Priority This field specifies whether flag event information is sent to SiPass
integrated.
Unit This field specifies the unit on which the flag resides.
Alarm Class This field allows the operator to specify an alarm class.

21
Siemens AB A6V10265087
Security Products 20.04.2012
 Advanced Security Programming (ASP)
2 Virtual Components

2.8.2 Counters
The Counter Functionality of SiPass Explorer enables the operator to configure a
program that counts / stores and displays the number of times a particular event or
process has occurred. The counter value can either be incremented or
decremented during ASP activity execution. Counters can be linked to other
functionalities like ASP in SiPass integrated.
The section that follows provides the steps required to configure a counter.

2.8.2.1 Configuring a New Counter

This section explains the steps required to configure a new virtual counter
1. Open a New Counter dialog (Refer the section Virtual Components [➙ 20] for
more information).
2. Enter a name for the counter in the Name field.
3. Select an option from the Default Value drop down list.
4. Select an option from the Message Priority drop down list.
5. Select a Unit.
6. Click OK.
All saved counters can be viewed by clicking the Counters item in the
Navigation panel of SiPass Explorer.

Field Properties of Virtual Counters

Field Name Field Property
Name This field is limited to 128 characters.
Default Value This field displays the initial value of the
counter.
Preset Value When the value set in this field is reached,
the counter sends an event.
Max Value This field displays the value beyond which
the counter cannot proceed further.
Count Mode This field specifies Wrap Around - The
the behavior the timer value
counter should changes to 0.
produce when the
max value is End Limit – The
reached. timer value remains
at the max value.
Audit Trail Reporting This field specifies No Audit Trail
whether counter
event information is Report to Audit
sent to SiPass Trail
integrated.
Unit This field specifies the unit on which the
counter resides.

2.8.3 Timers
Timers can be linked to other functionalities like ASP in SiPass integrated. The
section that follows provides the steps required to o configure a timer.

22
Siemens AB A6V10265087
Security Products 20.04.2012
 Advanced Security Programming (ASP)
Virtual Components 2

2.8.3.1 Configuring a New Timer

This section explains the steps required to configure a new virtual timer.
1. Open a New Timer dialog (Refer the section Virtual Components [➙ 20] for
more information).
2. Enter a name for the timer in the Name field.
3. Configure a Period (sec) for the timer.
4. Select a Timer Mode.
5. Select an option from the Message Priority field.
6. Select a Unit.
7. Click OK.
All saved timers can be viewed by clicking the Timers item in the Navigation
panel of SiPass Explorer.

Field Properties of Virtual Timers

Field Name Field Property
Name This field is limited to 128 characters.
Period (sec) This field displays the time period (in seconds) that the timer will count
up to. It is limited to 2,147,483.6 seconds.
Timer Mode This field On-Delay Timer - The timer value increases when
specifies the the timer is enabled, but disabling the timer causes
behavior of the the timer value to return to 0. The timer value stops
timer. increasing when it reaches the Period value.
Retentive On-Delay Timer - The timer value begins
increasing when the timer is enables. When the timer
is disabled the timer value is retained, and proceeds
to increase when the timer is enabled. The timer
value stops increasing when it reaches the Period
value.
Periodic Timer – When the value of the enabled
timer reaches the Period value, it automatically
begins to increase again, beginning at 0. Disabling
the timer causes the timer value to return to 0.
Message This field specifies whether timer event information is sent to SiPass
Priority integrated.
Unit This field specifies the unit on which the timer resides.

2.8.4 Editing Virtual Components

There are two ways to edit configured virtual components:
By clicking the required component (Flags / Counters / Timers) under the
Virtual Components tree hierarchy.
The configured virtual component/s will appear in a data grid, which can be
edited by clicking on the required cells, and saving changes.
Alternatively, select a specific virtual component in the data grid, and click
Open on the SiPass Explorer main menu. A dialog for the specific virtual
component will be displayed, which can then be edited and saved.

23
Siemens AB A6V10265087
Security Products 20.04.2012
 Advanced Security Programming (ASP)
2 Programmable Authorization for an access point through an ASP Activity

If changes made to a virtual component dialog are not saved, the respective
dialog will indicate this with an asterisk (*) symbol in the dialog’s title.
Multiple rows of a data grid can be selected and deleted by clicking the Delete
button on the main menu. This action will not be possible if one of the
components is already part of an activity.

2.8.5 Runtime Mode Support for Virtual Components

The virtual component data grid views can be operated in two modes: Design
mode and Runtime mode.
1. Design mode is used by the operator to configure the virtual components. This
is the initial mode whenever the data grid is first opened.
2. Runtime mode is used by the operator to monitor and edit the runtime value of
virtual components. While in this mode, changes can only be made to the
runtime value. The virtual component cannot be deleted, and its other
properties cannot be changed.
After opening the virtual components in the data-grid view, click the Mode button to
switch between design mode and runtime mode.
If the runtime mode us selected, a runtime Criteria dialog appears which displays
all the ACCs present in SiPass. The operator can select any ACC before entering
the runtime mode, the intention being to filter the virtual components the operator
wants to display in runtime mode. Only the virtual components that exist under the
selected ACCs are listed in the resulting data grid view.

When a controller is initialized, SiPass integrated will re-download all virtual

components for that controller. This means all virtual components residing on that
controller are reset to their default value, potentially affecting ASP activities that
include these virtual components.

NOTICE

Offline ACC’s appear greyed-out and disabled in the runtime Criteria dialog.

2.9 Programmable Authorization for an access

point through an ASP Activity
Programmable Authorization is a type of access mode that grants/denies access to
an access point through an ASP activity. There are two types of Programmable
Authorization modes:
1. Programmable Authorization-Card only
2. Programmable Authorization-Card and PIN
When a card is badged at an access point in any of the above modes, the following
steps occur:
1. Standard card access validation is performed.

24
Siemens AB A6V10265087
Security Products 20.04.2012
 Advanced Security Programming (ASP)
Programmable Authorization for an access point through an ASP Activity 2

2. If the cardholder has access privilege to the door, then the system generates a
‘Programmable Authorization’ event that can be used to trigger ASP activity.
3. The outcome of the access attempt will depend on which ASP effect is
executed:
- Access at the door will be granted only when ASP effect category = Access
Point and Programmable Authorization Granted Property = True is
executed.
- Access at the door will be denied when ASP Effect Category = ‘Access
Point’ and Programmable Authorization Granted Property = ‘False’ is
executed.
- Access at the door will also be denied in the case when the ASP effect
setting Programmable Authorization Granted Property of ‘True’ or ‘False’ is
NOT executed during the Programmable Authorization Timeout period
(Configured in the Components dialog).

2.9.1 Programmable Host Authorization Criteria

Configuration
You can create new Host Authorization Criteria or edit/delete existing criteria.
To Create New Host Authorization Criteria:
1. Click SiPass Explorer > Advanced Security Programming.
2. In the left-hand Navigation pane right-click on Host Authorization Criteria
under the Advanced Security Programming tree and select New Host
Authorization Criteria. The New Host Authorization Criteria Dialog will
appear.
3. Enter a name for the criteria into the Name field.
4. Enter a description for the criteria into the Description Field
5. Click Click here to add filter criterion. Here you can add and remove filter
criteria and when done click OK.

If the selected filter criteria column is of Date Type it is possible to:

Compare it to a configured date; or
Compare it to number of days from the Current Date.
Current Date will appear as the last operator command available for selection. If
Current Date is selected, the DateTime field will be replaced by a textbox in which
number of days can be entered. The number can be positive or negative. If a digit
value of 1 is entered for example, this would equal to Current Date +1

2.9.2 Configuring Programmable Authorization

Perform the following steps to configure Programmable Authorization:
1. In the Components dialog, Set the Reader’s operation mode to one of the
following modes:
Programmable Authorization – Card Only
Programmable Authorization – Card and Pin
2. Create Host Authorization Criteria, if required.

25
Siemens AB A6V10265087
Security Products 20.04.2012
 Advanced Security Programming (ASP)
2 Programmable Authorization for an access point through an ASP Activity

3. Create an ASP Activities that contain Programmable Authorization Triggers

and Effects (See Tables Below) and optional additional triggers, conditions and
effects.
The Programmable Authorization Event Triggers are listed in the following table:

Type Category Host Criteria Event Category Event Comment

Reason
Event Programmable <None> Programmable Requested Triggered when valid card
Authorization Authorization is presented at the door.
Access Event Status
Event Programmable Name of Host Programmable Host Triggered when valid card
Authorization Authorization Authorization Criteria is presented at door and
Access Event Criteria Status Passed Host Authorization Criteria
has Passed.
Event Programmable Name of Host Programmable Host Triggered when valid card
Authorization Authorization Authorization Criteria is presented at door and
Access Event Criteria Status Failed Host Authorization Criteria
has Failed.
Event Programmable Name of Host Programmable Host Triggered when valid card
Authorization Authorization Authorization Timeout is presented at the door
Access Event Criteria Status and Host failed to respond
within the configured
Timeout Period.

Host Authorization Timeouts are expected only in case Host is offline. Host
Authorization Timeouts may also occur time to time in case of heavy network
traffic – try increasing “Programmable Authorization Timeout” configured in the
components dialog if Timeouts occur regularly.

Maximum of 255 different Host Authorization Criteria can be configured with any
single access point.

The Programmable Authorization Event Effects are listed in the following table:

Category Property Value Comment

Access Point Programmable Authorization True Results in Programmable
Granted Authorization Access
Granted.
Access Point Programmable Authorization False Results in Programmable
Granted Authorization Access Denied.

26
Siemens AB A6V10265087
Security Products 20.04.2012
 T&A Calculation
Configuring a T&A Calculation 3

3 T&A Calculation
SiPass integrated offers a utility for exporting cardholder “clock-on” and “clock-off”
data. This kind of data can be used in Human Resources applications to collect
hours worked, for example. The data is exported to an external text file, and you
can choose exactly which cardholder and card data to save to file.
The T&A Calculation Interface exports all of the data you nominate for each valid
card badge at entry and exit readers for the Clock-on and Clock-off areas you have
selected.
SiPass Explorer allows operators to configure multiple T&A Calculation Interfaces.

Before you begin:

The T&A Calculation Interface relies on SiPass “Areas” to collect card badging
data. An area is a location that can be entered and exited through one or more
secure doors. Before you can configure the T&A Calculation Interface, you must
first:
Ensure that all the areas, sub-areas and access points to which the cardholder
will require access have been defined.
Establish the Time Schedules during which the cardholders will require access.

3.1 Configuring a T&A Calculation

An operator can configure multiple T&A Calculation Interfaces with SiPass
Explorer. The steps required to configure an interface are as follows:
1. Select T&A Calculation from the Navigation panel of SiPass Explorer.
2. Enter a name for the interface in the Name field.
3. The Clock-on field indicates the area for which cardholder details should be
recorded for the first valid card badge of the day.
4. The Clock-off field indicates the area for which cardholder details should be
recorded for the last valid card badge of the day. A default area already exists,
“Global Outside”, which means any location that is not inside your facility.
The Time Period for the attendance can be configured in the Period section of this
dialog.
1. Select Absolute if wish to specify the exact Time and Date for which
attendance data should be collected. This period can be specified using the
Begin Time: and the End Time: drop down lists that appear on selecting
Absolute.
2. Select Relative if you wish to specify a relative time period for which
attendance data should be collected. This period can be specified using the
Begin Time: (days) (hours before) and the End Time: (days) (hours before)
drop down lists that appear on selecting Relative.
3. If you tick the Use Begin/End time as CLOCK ON/OFF for single records
checkbox, data will be collected only for the time-period specified. For example,
An Area A might be configured for T&A Calculation until the End Time: 12:33
pm on a particular day. If a cardholder in the area exists at 1:30 pm on that
day, his last hour of presence in Area A will not be recorded. His attendance
will be marked only up to 12:33pm.
4. If you tick the Use Date as output prefix checkbox, a Host Event Task
configured for the Target: T&A Calculation Calc and Command: Save As will
be affected in the following manner:

27
Siemens AB A6V10265087
Security Products 20.04.2012
 T&A Calculation
3 Configuring a Time & Attendance Event Task

If this checkbox is left unticked, any older T&A Calculation event tasks files
created with the same file name will be overwritten.
If this checkbox is ticked, the same file name will be prefixed with the date
specified in the T&A Calculation Configuration dialog.
5. Click Save and Close.

3.2 Configuring a Time & Attendance Event Task

The steps required to configure a Time & Attendance Event Task are as follows:
1. Configure the Event Name, Time Schedule and Trigger fields on the Host
Event Task dialog. Note: This event task can be configured with any trigger.
2. From the Target drop down list, select T&A Calculation.
3. From the Report field, select the required T&A Calculation report from the drop
down list.
4. The following selections can be made from the Command drop down list:
- Print:
This command will print the selected T&A Calculation report.
- SaveAs:
This command will save the selected T&A Calculation report. From the
Type drop down list, select if the file should be saved in the CSV, TXT or
XML format.
- Email Forwarding:
This command will forward the selected T&A Calculation report to a
specified cardholder’s email address. After selecting the Email Forwarding
command, click the + button on this dialog.
This will bring up the Search Cardholder dialog from where you can select
cardholders. The email will be forwarded to all the selected cardholders.
Note: To ensure that the event task forwards the email to the selected cardholders,
tick the Use E-mail Address in Message Forwarding checkbox on the Personal
tab of the Cardholder dialog, and click Save.

28
Siemens AB A6V10265087
Security Products 20.04.2012
 Custom Transaction Logs
Multiple Custom Transaction Logs 4

4 Custom Transaction Logs

With the intention to provide operators with a greater level of flexibility of Audit Trail
views, SiPass Explorer has been equipped with the innovative feature of Custom
Transaction Logs. Operators can choose fully utilize this feature by:
Customizing audit trails by applying filters for the information displayed, and
share these views with other operators
Opening multiple Custom Transaction Logs
Applying operator privileges at various levels for each Custom Transaction Log
Print and take Snapshots of Custom Transaction Logs
These features, along with a few others, have been detailed in the sections that
follow.

4.1 Multiple Custom Transaction Logs

As one of the most innovative features of SiPass Explorer, it allows the operator to
configure multiple windows for Custom Transaction Logs. This feature will give the
operator a great amount of flexibility and versatility in the way he / she monitors the
security system through the audit trails.
Each Custom Transaction Log can be customized to display audit trails with
specific filters. For example, in one log, the operator can choose to view only Card
Transactions, or only Anti-Passback Area related Audit Trails. Therefore, SiPass
Explorer gives the operator the flexibility to view multiple Custom Transaction Log
windows, each with a filtered set of audit trail fields.

Configuring multiple Custom Transaction Logs

1. Select and right-click Custom Transaction Logs from the Navigation panel.
2. Select New Custom Transaction Logs. This action will open the Report
Wizard.
3. Click Next.
4. In the Name field, enter a name for the new Audit Trail view. Click Next.
5. From Available Fields, select the fields that you want displayed in the Custom
Transaction Log. Click Next.
6. In the next screen, specify the filter conditions for the Custom Transaction Log.
For more information on setting filter conditions, refer the section Filter
Conditions [➙ 45] of this manual.
7. Click Finish.
The new Custom Transaction Log, with the specified fields and filter conditions,
will be displayed on SiPass Explorer.

Note: SiPass Explorer has a limit of 20 views (which include Custom Transaction
Logs and Report Views) that can be displayed at the same time. If new views are
to be displayed, older views will need to be closed.

29
Siemens AB A6V10265087
Security Products 20.04.2012
 Custom Transaction Logs
4 Multiple Custom Transaction Logs

4.1.1 Assigning Operator Privileges for Custom Transaction

Logs
Operator Privileges for Custom Transaction Logs can be assigned through the
Operator Group dialog.
This is done at two levels:

Assigning Operator Privileges to access the Custom

Transaction Log feature in SiPass Explorer
To allow an operator to access the Custom Transaction Logs feature of SiPass
Explorer, the Audit Trail System Function should be added to his set of selected
functions.
Privilege [c] allows the operator to create and delete Audit Trails
Privilege [e] allows the operator to edit, rename or change the configuration of
Audit Trails.
Privilege [v] only allows the operator to view the Audit Trails.
An operator without any of these privileges assigned will not be able to access any
of the Custom Transaction Logs in SiPass Explorer.

Assigning Operator Privileges to view individual Custom

Transaction Logs in SiPass Explorer
1. Select Program > Operator Group.
2. From the Partition Functions section, select SiPass Explorer Items.
3. From the Available section, select and expand Custom Transaction Log.
This action will display all the Custom Transaction Logs configured in SiPass
Explorer.
4. Select the individual Custom Transaction Log that you wish to assign to the
operator and click Add.
These individual Custom Transaction Logs can be configured to the operator with
[c], [e] or [v] privileges.

4.1.2 Saving and Sharing Custom Transaction Logs

When a Level 1 Operator creates or edits a Custom Transaction Log, he can
assign View, Create or Edit privileges for it to all the Level 2 Operators under him.

Note: For the purpose of understanding, the term Level 1 Operator refers to a
person at the highest level of hierarchy.
Level 2 Operators refer to operators under the Level 1 Operator.
Level 3 Operators refer to operators under Level 2 Operators.

The level of permission a Level 2 Operator can assign to a Level 3 Operator

depends on the kind of privileges assigned to him.
For example, a Level 2 Operator with Edit privileges can assign only Edit or View
privileges to a Level 3 Operator. He cannot assign Create privileges.
Further, a Level 2 operator can configure privileges for Custom Transaction Logs to
a Level 3 operator under him. But, he cannot assign privileges for Custom
Transaction Logs to another Level 2 operator. This can only be done by a Level 1
Operator.

30
Siemens AB A6V10265087
Security Products 20.04.2012
 Custom Transaction Logs
Customizing Custom Transaction Logs 4

4.1.3 Applying Direct Commands from Each Audit Trail

A number of direct commands can be given by right-clicking on any audit trail in a
view.
The following are the options available to the operator on right-click:
Point:
This action displays the Points dialog.
Cardholder:
This action displays the respective Cardholder dialog.
Visitor:
This action displays the respective Visitor dialog.
Forgive:
This action “Forgives” a cardholder in an Anti-Passback area, and permits them
to exit or enter an area, where normally this would produce an Anti-Passback
violation. A forgive feature permits access for the first use of a card at either an
Entry or Exit reader.
Remove From Anti-Passback:
This action removes the card from the Anti-pass back system.
View Image:
This action displays the image of the cardholder that has been saved on the
Cardholder dialog.
View Snapshot:
This action displays the Image Verification snapshot that was taken.
Playback (DVR):
This action plays back the respective DVR recording from the audit trail.

4.2 Customizing Custom Transaction Logs

The appearance of Custom Transaction Logs and individual audit trails can be
customized in a number of ways. This sections that follow will detail how this can
be done.

4.2.1 Highlighting Custom Transaction Logs with Colors

A SiPass Explorer operator may want certain filtered audit trails to be highlighted,
to help differentiate them from the rest of the Custom Transaction Logs on the
screen.

To configure Custom Transaction Log highlights:

1. Under the Custom Transaction Logs tree in SiPass Explorer, right-click on a
selected custom transaction log report.
2. Select Customize View to open its dialog window.
3. When the Customize View dialog appears, select Automatic Formatting from
the Views panel.
4. Use the Condition and Appearance panel to set the conditions and
appearance formats to customize the audit trail.
For more information on how to use this dialog for customization, refer the section
Automatic Formatting [➙ 49] of this manual.

31
Siemens AB A6V10265087
Security Products 20.04.2012
 Custom Transaction Logs
4 Printing Custom Transaction Logs

4.3 Printing Custom Transaction Logs

An operator can now print a selected Custom Transaction Log screen from SiPass
Explorer.

To print a Custom Transaction Log:

1. Select the Custom Transaction Log screen that you would like to print.
2. Select the Print Preview button on the horizontal menu bar.
3. In the dialog that appears, click the Print button.

4.4 Snapshot Capture of Custom Transaction Logs

The Snapshot Capture feature allows the operator to capture a snapshot of the
Custom Transaction Log.
This feature is particularly useful in cases where a large number of Audit Trails
appear at a fast pace on the screen. In such a situation, it may be difficult for the
operator to study a particular section of the Custom Transaction Log, if he / she
wishes to do so. Taking a snapshot allows the operator to save the custom
transaction log for reference or analysis.

To take a Snapshot of the Custom Transaction Log:

1. Select the Custom Transaction Log screen for which a snapshot is to be taken.
2. Select the Snapshot button from the horizontal menu bar on the top.
A capture screen of the snapshot appears at the bottom of that particular
Custom Transaction Log.

32
Siemens AB A6V10265087
Security Products 20.04.2012
 Custom Pages
Adding / Deleting a Custom Page 5

5 Custom Pages
Some sites require minimal information concerning their cardholders, while others
require very detailed information. SiPass integrated allows you customize
cardholder records to suit your requirements by adding additional pages to the
Cardholder or Visitor dialogs.
These additional pages are called Custom Pages.
Access to this function is normally for use by database administrators, and is
controlled by the access privileges of Operator Groups.
Pre-existing page titles in the Cardholder and Visitor dialogs are listed in the table
below:

Cardholder Dialog Visitor Dialog

Definition Visitor Definition

Advanced Advanced
Personal Personal
Vehicle Visitor Managment
Imaging Imaging
Tracking Visitor Details
Control

The custom fields of the or Details page of the Visitor Dialog can be edited.
Further, the Siemens Corporate Card custom page will appear if you have the
Siemens Corporate Card license option selected.

5.1 Adding / Deleting a Custom Page

1. Select Custom Pages from the Navigation panel of SiPass Explorer.
2. A new Custom Page can be added or deleted (as required) in 4 different ways:
- From the upper-most toolbar of the SiPass Explorer screen, select Edit >
Add New Custom Page, or Edit > Delete; or
- From the 3rd toolbar from the top of the SiPass Explorer screen, select the
Add New Custom Page button, or the Delete button; or
- Right-click on the centre panel of the SiPass Explorer screen, and select
the Add New Custom Page option, or the Delete button; or
- Select the Add New Custom Page link, or the Delete link that appears at
the bottom right corner of the screen.
Any of the options mentioned above will add or delete a new custom page to /
from the SiPass Explorer screen.

Note: The functions of the Delete button will take affect on SiPass integrated only
after using the Save button to save any changes made on SiPass Explorer.

33
Siemens AB A6V10265087
Security Products 20.04.2012
 Custom Pages
5 Adding / Deleting a Custom Page

5.1.1 To Title a Custom Page

1. Add a new Custom Page.
2. From the Properties panel, select the cell adjacent to Label (under
Appearance).
3. Click this cell, and type in a desired title for the new custom page.
On clicking outside this cell, the tab of the new custom page will be re-titled
with the new label text.

5.1.2 Choosing Between the 'Cardholder' and 'Visitor'

Custom Page View
The operator can select whether he wishes to view / edit the custom pages of
either the Cardholder or Visitor dialog, or both. This can be done using the
following steps:
1. Select the Custom Page View button on the 3rd horizontal bar of SiPass
Explorer. This option can also be found under the View menu.
2. From the drop-down menu that appears, select All Pages to view all the
custom pages.
3. From the drop-down menu that appears, select Cardholder to view custom
pages of the Cardholder dialog.
4. Select Visitor to view custom pages of the Visitor dialog.
5. Select None to view pages that have not been assigned.

5.1.3 Refreshing a Custom Page

Click the Refresh button to refresh the current view of the SiPass Explorer screen.
This action will refresh the page and remove any information that was not saved.
Any updates that were made by other operators will also be displayed on refresh.

5.1.4 Choosing between the Cardholder or Visitor Custom

Page View
The cardholder can select whether he wishes to view / edit the custom pages of
either the Cardholder dialog, Visitor dialog or both.
This can be done in the using the following steps:
1. Select the Custom Page Viewer button on the 3rd horizontal toolbar of SiPass
Explorer.
2. Select All Pages to view custom pages of both the Cardholder and Visitor
dialogs.
3. From the drop down menu that appears, select Cardholder to view custom
pages of the Cardholder dialog.
4. Select Visitor to view custom pages of the Visitor dialog.
5. Select None to view a blank panel.

34
Siemens AB A6V10265087
Security Products 20.04.2012
 Custom Pages
Designing a Custom Page 5

5.1.5 Refreshing a Custom Page

Select the Refresh button to refresh the current view of the SiPass Explorer
screen.
This action will refresh the screen and remove any information that was not saved.

5.1.6 Arranging the Order of Custom Pages

If more than one custom page is added, the user has the option of rearranging the
order of the custom pages in any of the following ways:
Right-click on the custom page, and select the Move Page Left or Move Page
Right options, as required; or
Select Edit > Move > Move Page Left / Move Page Right; or
From the bottom of the right hand panel, select the Move Page Left or Move
Page Right options.

5.1.6.1 Customizing the Appearance and Display of Views

Multiple Custom Transaction Logs can be arranged and customized in a number of
ways on the central display panel of SiPass Explorer.

Configuring the arrangement of Custom Transaction Logs:

1. Select Window from the horizontal menu bar.
2. Select Cascade to display multiple audit trail views in the cascading style.
3. Select Tile Horizontal to display multiple audit trail views as horizontal tiles.
4. Select Tile Vertical to display multiple audit trail views as vertical tiles.

Configuring the appearance of Custom Transaction Logs:

Select View > Visual Style.
The user can choose between the Standard and Classic style to customize the
appearance of SiPass Explorer. Further, he / she can choose between various
colours in the same menu.

5.2 Designing a Custom Page

SiPass Explorer is equipped with a number of handy tools and custom fields to
enable you to design your own custom page. The sections that follow discuss
these options, and how they can be applied to Custom Pages.

5.2.1 Custom Fields

The Custom Fields available in the Toolbox allow the user to design their own
Custom Pages for both the Cardholder and Visitor dialogs. They can also
customize the appearance of the page by altering the position and sizes of the
chosen custom fields.
A brief description of the Custom Fields and Tools available in the Toolbox are
contained in the following table:

35
Siemens AB A6V10265087
Security Products 20.04.2012
 Custom Pages
5 Designing a Custom Page

Tool Name Tool Tool Function Description

Initial

Pointer P This tool can be used to select a custom field While the other way of applying custom fields on
from the Toolbox, and place it on desired to a custom page is by selecting the field and
location on the custom page. dragging it onto the page; the user can also
apply a custom field in the following way:
1. Select the Pointer tool with a mouse-click
2. Select a desired custom field from the
toolbox with a mouse-click
3. Hover over the custom page to choose a
location for the selected custom field
(hovering displays a + pointer)
4. Mouse-click on a desired location to
display the selected custom field.
Label L This custom field can be used to add a ‘Labels’ Select this custom field and apply it onto the
on a custom page. custom page. For details on how to modify the
sub-properties relevant to this custom field, (L),
refer the table in the section Custom Field
Properties [➙ 39].
Textbox TB This custom field can be used to add a Text box Select this custom field and apply it onto the
to the custom page. custom page. For details on how to modify the
can be used to add text or numeric data sub-properties relevant to this custom field (TB),
refer the table in the section Custom Field
Formats and Data Types can be specified. Properties [➙ 39].
Drop-down DDL This custom field can be used to add a Drop- Select this custom field, and apply it onto the
List down list to the custom page. custom page. For details on how to modify the
sub-properties relevant to this custom field
(DDL), refer the table in the section Custom
Field Properties [➙ 39].
Populating Drop-Down Lists:
For instructions on how populate drop-down
lists, refer the sections Populating a Drop-down
Lis [➙ 38]t and Dynamic Insertion of Drop-down
Items [➙ 38] of this manual.
Date Picker DP This custom field can be used to add a Date Select this custom field, and apply it to the
Picker to the custom page. custom page. For details on how to modify the
sub-properties relevant to this custom field (DP),
refer the table in the section Custom Field
Properties [➙ 39].
Checkbox CB This custom field can be used to add a Select this custom field, and apply it to the
Checkbox to the custom page. custom page. For details on how to modify the
sub-properties relevant to this custom field
(CB), refer the table in the section Custom Field
Properties [➙ 39].
Button B This custom field can be used to add a Button to Select this custom field, and apply it to the
the custom page. This field allows you to custom page.
execute a command line when the button is Command Line feature:
clicked.
For further information on this feature, please
refer the section Customizing the Button
Custom Field [➙ 37] of this manual.
Attachment A This custom field can be used to add an Select this custom field, and apply it to the
Attachment field to the custom page. This file custom page.
can be used to save a file, like an image / Add Attachment feature:
document, etc. that can be opened from the
custom page. For further information on this feature, please
refer section Customizing the Attachment
Custom Field [➙ 37] of this manual.
Groupbox GB This custom field can be used to add a Select this custom field, and apply it to the
Groupbox to the custom page. A group box can custom page. For details on how to modify the
be designed to group other custom fields under sub-properties relevant to this custom field
(GB), refer the table in the section Custom Field

36
Siemens AB A6V10265087
Security Products 20.04.2012
 Custom Pages
Designing a Custom Page 5

Tool Name Tool Tool Function Description

Initial
a single box. Properties [➙ 39].

5.2.2 Customizing the BUTTON Custom Field

The user can configure the Button custom field to invoke a Command Line when
the button is clicked.

Invoking a Command Line:

1. From the Toolbox, select the Button custom field.
2. Drag this custom field to the custom page, or use the pointer tool to apply it
onto the custom page.
3. From the Properties panel, select the cell adjacent to the Command sub-
property (under Behavior).
4. In this cell, specify the command to be executed when a user clicks this button
on the custom page.
For details on how to further modify this custom field, refer all the sub-properties in
the table in the section Custom Field Properties [➙ 39], corresponding to the
custom field (B).

5.2.3 Customizing the ATTACHMENT Custom Field

Adding an Attachment:
This custom field can be used to add an attachment to the custom page.
When applied to the custom page, it consists of the following:
‘Select’ button:
This button will display an ‘Open File’ dialog. The user can select a file from
this dialog that they want to add to the cardholder or visitor. The file that is
selected can be a file of any type.
Picture Box:
When the file is selected, a preview of the selected file will be displayed in the
picture box of this custom field. This preview will consist of a thumbnail image
of the file, or an icon associated with the attached file.
When the user saves the cardholder or visitor after selecting an image/ file, the
file will be saved as part of the cardholder’s custom data.
On clicking on the image displayed in the picture box of this custom field, an
enlarged attachment associated with this custom field will be displayed in a
separate window.
‘Clear’ button:
This button removes the image in the picture box, and leaves it blank. When
the user saves the cardholder/visitor after clearing the file, no files will be saved
as part of the cardholder’s custom data. Any existing files that have been
uploaded will also be removed.
Optional custom fields that can be linked to the attachment
The Dropdown List, Text box and Date Picker are the three optional custom fields
that can be added to the Attachment custom field.

37
Siemens AB A6V10265087
Security Products 20.04.2012
 Custom Pages
5 Designing a Custom Page

Note: Any number of instances of these three custom fields can be added to the
attachment.

For details on how to modify the sub-properties relevant to this custom field (A),
refer the section Custom Field Properties [➙ 39].

5.2.4 Populating the DROP DOWN LIST Custom Field

Rather than typing text into various fields, the options displayed on a drop-down list
can be imported using a tool called the Look-Up Table. This tool gives the
operator the flexibility to create a new look-up table, or edit / delete an existing
look-up table. The following steps describe how a Drop-down list can be populated:
1. From the Toolbox, select the Drop Down List custom field.
2. Drag this field to the custom page, or apply it onto the page using the Pointer
tool.
3. From the Properties panel, select the drop down list in the cell adjacent to
Lookup Table.
4. Select a Look-up Table from the available list to populate the drop-down list.

5.2.4.1 Dynamic Insertion of Drop-down Items

The Drop-down list custom field can be configured to allow an operator who uses
this custom page to insert list items in three different ways. It is up to the custom
page designer to decide on which populating option he wishes to grant to the
operator.
The following options that can be used to allow operators to fill a drop-down list in
three different ways:
Insert On Save
Don’t Insert on Save
Drop Down Only
These three options have been discussed in detail in the sections that follow.

Insert on Save
With the ‘Insert on Save’ option, the operator is given the choice of adding items to
the drop-down list on the Cardholder dialog itself. When the items added are
saved, they get automatically inserted into a previously selected Look-up Data file.
This will happen only if these don’t previously exist in the Look-up Table.
The Custom Page Configuration instructions for this option are as follows:
1. Add the Drop-Down List custom field to the custom page.
2. From the Properties panel, click the drop down list in the cell adjacent to
Look-up Table, and select a required Look-Up table from the list that appears.
3. From the Properties panel, click the drop down list in the cell adjacent to
Behavior.
4. Select Insert On Save.
5. Click the Save button in SiPass Explorer.
Usability:
1. Return to the Cardholder / Visitor dialog. You will find the drop down list on the
custom page that was added.

38
Siemens AB A6V10265087
Security Products 20.04.2012
 Custom Pages
Designing a Custom Page 5

2. Select the drop-down list and type in a new value for the list.
3. Save the changes made to the cardholder dialog, and return to SiPass
Explorer.
4. From the Navigation panel, select Import Data > Lookup Data
5. From the Look-up Data list, select the Look-Up Table that was selected for this
drop-down list (in step 2 of Custom Page Design Configuration).
6. The new items that were typed into the drop-down list have been inserted into
this Look-Up Table.

In order to allow operators to use this function on a Cardholder / Visitor dialog,

they need to be given Edit (e) or Complete (c) privileges for the Look-Up Table
through the Operator Group dialog.

Don’t Insert on Save

The Custom Page Design Configuration for this option is the same as that for
Insert On Save. In this case, the value that is typed into the drop-down list and
saved will not be inserted into the Look-up Data table.

Drop Down Only

With the ‘Drop Down Only’ option, once the custom page has been designed, the
operators can only choose drop-down items from those given on the drop-down
list. They cannot insert or type-in new items to the drop-down list.
That is, the operators will have to make a selection from the items provided in the
drop-down list.

Note: If an operator is not given Edit (e) or Complete (c) privileges for the Look-up
Table through the Operator Group dialog, the Behavior property for the Drop-
Down List custom field will default to Drop Down Only.

For more information on how to import Look-up Table, or create new Look-up Data
or edit existing lists, refer the section Lookup Data [➙ 69].

5.2.4.2 Custom Field Properties

The Custom Fields Properties can be customized by modifying the sub-properties
of each of the custom fields, in the Properties panel.
While the cell is selected and active, there are three methods of altering the
content of the cell.
Double-click in the centre of the cell to highlight the cell and then overwrite its
contents (some properties like Label, don’t need to be highlighted); or
For drop-downs, select from the drop down list, or double-click the right-hand-
side of the cell to toggle between “Yes” and “No”.
The properties can be arranged by using either of the following buttons:
– Categorized button – Clicking the is button categorizes / groups the
properties based on whether they determine the Appearance, Behavior or
Database of the Custom Field.
– Alphabetical button – This button arranges the properties alphabetically
A brief summary of the properties and sub-properties displayed in this panel of
each field is contained in the following table:

39
Siemens AB A6V10265087
Security Products 20.04.2012
 Custom Pages
5 Designing a Custom Page

Properties Sub-Properties Description

Appearance Attachment This sub-property is specific to the ‘Attachment’ custom field. On clicking on the
Properties … button of this cell, a Control Collection Editor dialog is displayed.
Select the Add button, and choose any of the three custom fields displayed in
the drop-down list.
The properties of the selected custom field can be modified in the adjacent
Properties panel.
Select the Remove button to delete a custom field from the list.
Select the OK button to add all the selected custom fields and their properties to
the Attachment custom field.
Sub-property for the following custom fields: Attachment
Clear Button Text The text entered in this field defines the text that appears on the ‘Clear’ button.
Sub-property for the following custom fields: Attachment
Field Enabled This field defines whether or not a control is accessible to the user. If this field is
disabled by setting it to FALSE, it will not be visible to the operator.
Sub-property for the following custom fields: Label, Drop-down List, Date
Picker, Button, Attachment, Group Box
Format A format can only be specified for a text box, with the text data type selected.
Refer to Data Type below.
Sub-property for the following custom fields: Date Picker, Text Box
Label The name entered in this field is displayed in the Cardholder or Visitor dialog as
the name of the particular custom page. This name may or may not be the same
as that contained in DBField Name.
Sub-property for the following custom fields: Label, Drop-down list, Text Box,
Date Picker, Check Box, Button, Attachment, Group Box
Location This field has two sub-fields – ‘X’ and ‘Y’ – that determine the coordinates of this
field from the top-left of the custom page.
Sub-property for the following custom fields: Label, Drop-down List, Date
Picker, Check Box, Button, Attachment, Group Box
Select Button Text The text entered in this field defines the text that appears on the ‘Select’ button.
Sub-property for the following custom fields: Attachment
Size This field has two sub-fields – ‘Width’ and ‘Height’ and determines the total size
of the custom field. The numbers entered in these subfields define the size of all
the custom fields that can be used from the toolbox.
Sub-property for the following custom fields: Label, Drop down List, Date
Picker, Check Box, Button, Attachment, Group Box
Behaviour Behaviour This is the dynamic insertion of drop-downs.
Sub-property for the following custom fields: Drop- down List
Command This is where the command line is typed in for a button control.
Sub-property for the following custom fields: Button
Lookup Table This field allows the operator to select a look up table that will be displayed as a
list on the cardholder dialog. Its values can be selected from the drop-down list
in the Cardholder dialog.
Sub-property for the following custom fields: Drop-down List
Max. File Size This field defines the maximum size of the file that can be uploaded for a
cardholder.
Sub-property for the following custom fields: Attachment
Page Number This field displays the current custom page number.
Sub-property for the following custom fields: Text Box
Pages Used This field displays whether the custom page displayed is for the Cardholder or
Visitor dialog.
Sub-property for the following custom fields: Text Box

40
Siemens AB A6V10265087
Security Products 20.04.2012
 Custom Pages
Custom Page Partitioning 5

Properties Sub-Properties Description

Database Compulsory This field defines whether or not the presence of data in this field is required.
Data must be entered before the cardholder record can be saved in the system.
Discretion should be used when establishing whether or not a field is
compulsory.
Sub-property for the following custom fields: Drop down List, Date Picker,
Check Box, Attachment
Data Type This field defines the data type of the field. It is used for information related to
saving the field in the database and the control that is displayed. The type must
be chosen from those shown in the drop-down list. Once saved in the system,
this field cannot be altered; so, care should be exercised when using this
property. Primarily, the data types selected are either Numeric or Text.
Sub-property for the following custom fields: Text Box
Field Name The name entered in this field is used to identify the field in the database. It can
be chosen from a list of potential database names or a new name can be
created. Duplication of database field names is not permitted. Once saved in the
system, this field cannot be altered; so, care should be exercised when using
this property. This name does not appear in any dialog.
Sub-property for the following custom fields: Drop-down List, Date Picker,
Check Box, Button, Attachment
Max. Length This field defines the maximum number of characters that can be entered within
this field.
Sub-property for the following custom fields: Drop-down List, Text Box
Unique If this field is set to “Yes”, SiPass integrated will check that the value in this field
is unique to the cardholder. For example, Social Security Numbers or Tax File
Numbers are considered to be unique. Once saved in the system, this field
cannot be changed. Exercise care when using this property.
This field can be set to true only if existing values on the custom page are
already unique.
Sub-property for the following custom fields: Drop-down List, Date Picker

5.2.4.3 Resizing Custom Fields

Custom Fields can be resized in two different ways:
By clicking on the edge of the applied custom field and dragging it to the
desired size, or
In the Properties panel, maximize the Size sub-property. The custom field can
be resized by editing the field values of the X and Y coordinates.

5.3 Custom Page Partitioning

Setting Operator Privileges for Custom Pages takes place at two levels:
Operator Privileges to view or edit custom fields in the Cardholder / Visitor
dialog.
This can be set by selecting Operator Functions > Cardholder Fields, and
selecting the custom pages and fields for which appropriate privilege should be
granted.
Operator Privileges to view or edit custom pages in SiPass Explorer. This sort
of privilege would generally be granted to a Custom Page Designer.
This can be set by selecting Operator Functions > System Functions.
Next, select Custom Pages from the Available panel, and click Add.
For more information on Operator Partitioning, refer the section Operator Groups of
the SiPass integrated MP2.5 User Manual.

41
Siemens AB A6V10265087
Security Products 20.04.2012
 Custom Pages
5 Importing / Exporting Custom Pages

5.3.1 Operator Privileges for Custom Fields in the

Cardholder / Visitor Dialog
If the operator does not have any privileges for the custom field, they will not be
able to view the data in that field, nor edit it. The following are the kinds of
privileges that can be assigned:
VIEW (v) Privileges Assigned: If the operator has been assigned only VIEW (v)
privileges for a custom field, they will only be able to view the cardholder/visitor
data, and not edit it.
EDIT (e) Privileges Assigned: If the operator has been assigned EDIT (e) or
Complete privileges for a custom field, they will be able to both view and edit the
cardholder / visitor data in that field.
No Privileges Assigned For a Certain Custom Field: If an operator does not
have any privileges for ANY of the custom fields on a particular page, they will not
be able to view the page in the Cardholder / Visitor dialog at all. It will be missing
from all the tab pages.

5.3.2 Operator Privileges for Custom Pages in SiPass

Explorer
The Custom Page privileges assigned to an operator group, will define whether the
Custom Page Designer can design / edit the page using SiPass Explorer.
The following are the operator privileges that are available:
VIEW (v) Privileges Assigned: If the designer has been assigned view privileges
for a custom pages, they will only be able to view the custom fields in SiPass
Explorer, and also view it’s properties in the Properties panel.
EDIT (e) Privileges Assigned: If the designer has been assigned edit privileges
for custom pages, they will have the ability to edit all properties of the custom
fields, and move the custom fields. They will NOT be able to delete the fields.
COMPLETE (c) Privileges Assigned: If the designer has been assigned complete
privileges for a custom pages, they will have the ability to edit field properties,
move and delete the custom fields.
No Privileges Assigned: If a designer does not have any privileges assigned for a
Custom Field, they will still be able to see the field in SiPass Explorer. However,
they will not be able to view or edit the properties of the custom field in the
Properties panel.
No Privileges Assigned For a Certain Custom Field: If the designer does not
have any privileges for any of the Custom Fields on a page, they will not be able to
view the custom page in SiPass Explorer.

5.4 Importing / Exporting Custom Pages

SiPass Explorer allows the custom page designer to Import and Export custom
pages as XML files.

5.4.1 Importing Custom Pages

The Custom Page Designer will need to select an XML file that was previously
exported from SiPass integrated.
1. Select the Import Pages button on SiPass Explorer.
2. From the Open dialog that appears, select an XML file and click Open.

42
Siemens AB A6V10265087
Security Products 20.04.2012
 Custom Pages
Importing / Exporting Custom Pages 5

3. From the Import dialog that appears, select the custom page/s to import. Click
Import.
The selected custom pages will be imported.

More than one custom page can be imported into SiPass Explorer.

5.4.2 Exporting Custom Pages

The Custom Page Designer will need to select an XML file to export from SiPass
integrated.
1. Select the Export Pages button on SiPass Explorer.
2. From the Export dialog that appears, select a Custom Page. One or more
Custom Pages can be selected.
3. Click Export.
4. Using the Save As dialog that appears, save the file to be exported in a
suitable location.

43
Siemens AB A6V10265087
Security Products 20.04.2012
 Customized & Predefined Reports
6 Getting Started

6 Customized & Predefined Reports

SiPass Explorer allows you to browse and generate reports easily. This tool
combines a powerful database and audit trail reports from SiPass integrated, with
an intuitive visual interface called the SiPass Reporting Wizard to speed-up and
streamline your reports.
It is also possible to arrange how the data is presented and customize reports even
further than before. Reports come with a standard selection of data columns which
can be removed or reordered, as well as a set of additional columns that can be
inserted. Custom views can be added to change how the data in a report is
displayed and these views are saved for future use.
There are two types of reports that an operator can create:
Customized Reports
Pre-defined Reports
This section provides detailed information on Customized Reports.

6.1 Getting Started

6.1.1 Creating a New Report

SiPass Explorer allows you to create your own reports to customize the information
you receive, and the way in which it is received. Custom reports are based on pre-
defined data sets such as Cardholder or Points, and can be saved under
Customized Reports in the Navigation pane of SiPass Explorer.
There are two ways to create a new report: Create a new report by itself or create a
new report based on an existing report.

Creating a new report

1. Select New > New Report from the File menu.
If the welcome screen is displayed, click Next to continue.
2. Enter a name for your report and select a place in the Navigation tree for it to
be saved.
3. Click Next to continue.
4. Select a Record Type and then the fields to include in your report.
Use the left and right buttons to move fields in and out of the report.
5. Click Next to continue.
6. Specify filter conditions for your report. For more details please refer to the
section Filter Conditions [➙ 45].
7. Click Finish to complete your report.

Creating a new report from an existing report

1. From the File menu, select New > New Report.
If the welcome screen is displayed, click Next to continue.
2. Enter a name for your report and select a place in the Navigation tree for it to
be saved.
3. Select the option Create from an existing report, and click Next.
4. Select a report to base your new report on, and click Next .
5. Select a Record Type and then the fields to include in your report.
Use the left and right buttons to move fields in and out of the report.
6. Click Next to continue.

44
Siemens AB A6V10265087
Security Products 20.04.2012
 Customized & Predefined Reports
Getting Started 6

7. Specify filter conditions for your report. For more details please refer to the
section Filter Conditions [➙ 45].
8. Click Finish to complete your report.

6.1.2 Customizing Views

Customizing views ensures your report is easy to read and contains the information
you required. Available views are required in a list in the Current View pane. To
begin, perform the following operations:
1. Launch SiPass Reporting.
2. Use the Tree in the Navigation Pane to locate the component you wish to
build a report on.
3. Right click the report you wish to customize and select Customize View.
4. Select a view to customize or create a new view.
The operator can customize a report view using the following options:
Display Fields
Filter Conditions
Available Actions
Group By
Sort Order
Appearance
Automatic Formatting
Advanced
The sections that follow explain each of these options, and how you can use them
to customize your views.

6.1.2.1 Display Fields

The Modify Fields section defines which fields are included in your view, and the
order in which they are displayed.

Modifying display fields

1. Select Display Fields. Two columns of fields will be displayed.
2. Select a field and use the left and right buttons to move the field in and out of
the report.
- The left hand column lists all the fields not being used, and the right hand
column lists all those that will be displayed in the report.
3. Select a field in the right hand column and use the Up and Down buttons to
modify the order of the field in the report.
- Fields at the top of the list are displayed first, and will appear on the left
hand side of the report.
4. Click OK or Apply to save your changes.

6.1.2.2 Filter Conditions

Filter conditions allow you to restrict the report to only display certain data. This is
useful when you need only particular records, and not everything. SiPass allows

45
Siemens AB A6V10265087
Security Products 20.04.2012
 Customized & Predefined Reports
6 Getting Started

you to add several filters to narrow down the results and provide even more precise
data.

Modifying filter conditions

1. Select Filter Conditions.
2. Click on the labeled filter button to create a filter.
3. Select a field to filter with and an operator for your filter action.
Filter Condition Operators are explained in the section that follows.
4. Enter in the data that you wish to filter with and click the Add Criterium button.
The data you can enter into the filter section.
5. Repeat steps 3-4 for any additional filters that are required.
6. Click OK or Apply to save your changes.

Filter condition operators

The available filter condition operators are explained in the table below:

Operator Explanation

Equal to Returns all records that exactly match the specified field value
Not equal to Returns all records that do not match the specified field value
Greater than Returns all records that are greater than the specified field value
Less than Returns all records that are less than the specified field value
Less than or equal to Returns all records that are lesser than or equal to the specified value
Greater than or equal to Returns all records that greater than or equal to the specified field value
Between Returns all records that are between the specified field values
Not between Returns all records that are not between the specified field values
Contains Returns all records that contain the specified field value
Does not contain Returns all records that do not contain the specified field value
Begins with Returns all records that begin with the specified field value
Ends with Returns all records that end with the specified field value
Is null Returns all records that have a null value for that field
Is not null Returns all records that do not have a null value for that field
Is empty Returns all records that have a value for that field, and are not empty
Is not empty Returns all records that do not have a value for that field, and are empty
Any of Returns all records that have a value that matches any of the specified values.
None of Returns all records that have a value that matches none of the specified values.
*As Parameter Returns all records that have a value that matches the parameter specified.

*Parameterized Reports
If a report was created with at least one As Parameter filter condition, it is
considered to be a Parameterized Report.

6.1.2.3 Available Actions

Operators can configure any of the following actions to a report, to create
Actionable Reports:

46
Siemens AB A6V10265087
Security Products 20.04.2012
 Customized & Predefined Reports
Getting Started 6

Void Card
Voids the particular card in the SiPass integrated system.
Void Cardholder
Voids the cardholder in the SiPass integrated system.
*Resolve by Deleting
The synchronization issue is resolved by deleting the entity/entities in concern.
*Resolve by taking external system version
The synchronization issue is resolved by accepting the external system version.
Warn User
When applied, this action will warn the operator when the details of the cardholder
in concern is either updated or newly created in the Cardholder dialog.
*Resolve by taking SiPass version
The synchronization issue is resolved by accepting the SiPass integrated version
of the entity/entities in concern.
*Ignore Conflict
The synchronization report entry is actioned to be ignored.

*The operator does not have to customize actions for the 4 synchronization
resolution actions described above. These actions will be available by default on
the synchronization report, by right-clicking an entry in the report.

Setting an Available Action:

1. Select Available Actions.
2. Tick the checkboxes for the options that you want to customize for the report.
3. Select Set as default.
4. Click OK or Apply.

6.1.2.4 Group By
Group By allows you to arrange how the records returned by the report are
organized. The records are sorted into groups with a common field value as
specified by the user.

Setting a Group By condition

1. Select Group By.
2. Select a field to group by from the first drop down list
3. Select whether to sort the grouped items Ascending or Descending by
clicking the appropriate option
4. Select any additional grouping in the other drop down lists, going from top to
bottom.
5. Hide or display the name of the column that is used for grouping by toggling the
checkbox labeled Hide columns when grouped.
6. Click OK or Apply to save your changes.

47
Siemens AB A6V10265087
Security Products 20.04.2012
 Customized & Predefined Reports
6 Getting Started

6.1.2.5 Sort Order

Sort Order allows you to sort the records by multiple fields. The sorting is done in
order, with the top field that is selected being sorted first, and the bottom field being
sorted last.

Setting a Sort Order

1. Select Sort Order.
2. Select a field to sort from the first drop down list.
3. Select whether to sort Ascending or Descending by clicking the appropriate
option.
4. Select any additional sorting in the other drop down lists, going from top to
bottom.
5. Click OK or Apply to save your changes.

6.1.2.6 Appearance
Making changes to the Appearance section lets you customize how the data is
presented by modifying fonts, grid lines, icons and column size distribution.

Customizing Appearances
1. Select Appearance.
2. Select a font to use for the column headings by clicking the Font button in the
Column Headings section.
3. Enable or disable Automatic Column Sizing by clicking the checkbox.
- Automatic Column Sizing automatically fits all selected fields in the
viewable area. It attempts to use an even distribution of column sizes.
4. Select a font to use for the row text by clicking the Font button in the Rows
section.
5. Enable or disable row icons by clicking the Show Icon checkbox.
- An icon is displayed next to each row by default. You can even select a
different icon to display by clicking the icon graphic and picking one from
the list.
6. Select a grid line type and style from the drop down lists in the Grid lines
section.
- Grid lines define what lines are shown and Grid line style defines whether
the line is solid or dotted.
7. Enable or disable Shade Group Headings by clicking the checkbox.
- This option will color the Group By headings grey in your printed report to
help distinguish them.
8. Click OK or Apply to save your changes.

48
Siemens AB A6V10265087
Security Products 20.04.2012
 Customized & Predefined Reports
Getting Started 6

6.1.2.7 Automatic Formatting

Automatic Formatting allows you to create rules that automatically format text
depending on specific criteria. This means that you can visually highlight specific
data to make it easily visible without filtering out all other data.
For example, you may want to easily see which Units are online and which are
offline. By using automatic formatting you can have all Units that are online
displayed in the report with a green background, and all the offline ones displayed
with a red background.

Setting up Automatic Formatting:

1. Select Automatic Formatting.
2. Click New to create a new Format Condition.
3. Enter a Condition name.
4. Enter a filter condition for when the formatting will be applied. This is a
combination of a Field, a Condition and a Value. For more details on
configuring filters please refer to the section Filter Conditions [➙ 45].
5. Select formatting to make the filtered data stand out.
- Select a font modifier, or a combination of them by ticking the checkbox
next to Bold, Italic or Underline.
- Click Colors and select a text and or background color to highlight the text.
6. Click OK or Apply to save your changes.

6.1.2.8 Advanced
The Advanced section allows you to set column properties. These properties
control the behavior and display of the column in the report.

Multiple Page feature for all reports

SiPass integrated now implements the Multiple Page feature for all reports, if the
configured row-limit per page has been exceeded. This presents operators with the
advantage of viewing entire large reports.
When customizing the view of a report, the number of rows to be displayed per
report is set to 100,000 by default. This value can be configured to a maximum limit
of 300,000 rows per page.
For large reports that contain more than 300,000 rows, the rows that follow will be
displayed in additional pages of the report.
This allows enables operators to view large reports, without limiting the number of
report pages that can be displayed.

Configuring Advanced properties

1. Select Advanced.
2. Select a column.
3. Adjust the properties of the column as required.
4. Repeat steps 2 and 3 for each column that needs to be modified.
5. In the Page Size field, select the number of rows to appear per page, for the
entire report.

49
Siemens AB A6V10265087
Security Products 20.04.2012
 Customized & Predefined Reports
6 Getting Started

By default, this value is set to 100,000. The maximum limit is 300,000 rows per
page.

6. Click OK or Apply to save your changes.

Advanced fields
The available fields are explained in the table below:

Field Explanation

Allow Drag Determines whether the selected column can be dragged and repositioned within the
report.
Allow Size Determines whether the selected column can be resized within the report.
Allow Sort Determines whether the selected column can be sorted within the report.
Caption Sets the title of the column.
Image Size Sets the dimensions of the image, in pixels, if one is in the column. The first number is the
image width , and the second is the image height.
Width Sets the width of the column in pixels.
Mode Determines whether the sorting and filtering is done on the server or the client. We
recommend the Server mode as it will be faster and transfer less data over the network.
Limit Sets the maximum number of records that can be returned after a sort or filter operation.

6.1.3 Searching Reports for Data

SiPass Explorer also makes it possible to search for specific data within a report.
This feature is embedded in every report, via the interface, and can be easily
enabled or disabled.
Before you begin, ensure that all the columns you want to include in your
search are added to the report.
1. Open the report you wish to search within.
2. Click the Find button on the Tool Bar. A filter row will appear.
3. Type your search term(s) into the appropriate columns on the filter row and hit
the Enter key. Rows matching your search criteria will be displayed below.
- Use the * character as a wildcard to fill in parts of the search you are
unsure of.
- Multiple keywords can be used in multiple columns to narrow your search.
4. Click the Find button again to make the filter row disappear and return to the
regular report view.

For single reports containing multiple pages:

Using the Find button will only search through the report page currently
displayed. All additional pages of the report should be displayed and searched
through individually.

50
Siemens AB A6V10265087
Security Products 20.04.2012
 Customized & Predefined Reports
Getting Started 6

6.1.3.1 Search Criteria

This section details the search criteria that can be used to search for specific
information within reports.

Search Search Criteria Description Example

Symbols

= Equal To = 7.
This search criteria can find only numeric data. This search will return all the rows with the value 7.
!= Not Equal To !=7
This search criteria can find data that is not This search will return rows with all values except 7.
equal to the numeric or strings entered after it.
> Greater Than >7
This search criteria can find data that is greater This search will return rows with all values greater than 7.
than the numeric or strings entered after it. >B
This search will return rows with all strings that begin with
alphabets that come after B. It will not return rows that
contain strings beginning with the alphabet A.
< Less Than <7
This search criteria can find data that is less This search will return rows with values less than 7.
than the numeric or strings entered after it. <B
This search will return rows with all strings that begin with
alphabet A alone, as it comes before B. This search will
not return strings that begin with alphabets that come after
B.
>= Greater Than or Equal To >=2
This search criteria can find numeric or strings This search will return rows with all values greater than or
that are greater than or equal to the value equal to 2.
entered after it. >= B
This search will return rows with all strings that begin with
the alphabet B, and all the following alphabets. It will not
return rows starting with the alphabet A.
<= Less Than or Equal To <=2
This search criteria can find numeric or strings This search will return rows with values less than or equal
that are less than or equal to the value entered to 2.
after it. <=C
This search will return rows with all strings that begin with
alphabet C, and also rows that begin with the alphabets B
and A. It will not return rows beginning with alphabets that
come after C.
** Contains *20*
This search criteria can find numeric or strings This search will return rows that contain the value 20.
that are entered between both the asterix *pin*
symbols.
This search will return rows that contain the word „pin“.
* Ends With *2
This search criteria will find numeric and strings This search will return rows that end with the value 2.
that end with value entered after the asterix. *pin
This search will return rows that end with the word pin
* Begins With 2*
This search criteria will find numeric and strings This search will return rows that begin with the value 2.
that start with the value entered before the System*
asterix.
This search will return rows that begin with the word
System.

51
Siemens AB A6V10265087
Security Products 20.04.2012
 Customized & Predefined Reports
6 Getting Started

Search Search Criteria Description Example

Symbols

No If search data is entered into the search field Pin

Symbols without any accompanying symbols, this search This search will return rows that contain the word Pin.
Used will be treated as using the Equal To symbol.

6.1.4 Page Setup

Before printing or generating a print preview, you should configure your Page
Setup. This is important to ensure that any reports you generate are properly
formatted. This will need to be done once per session. If you close and open
SiPass Reporting, you will need to configure these settings again.

Adjusting the Page Setup

1. Select File > Page Setup.
2. Select a paper Size and Source using the drop down boxes.
3. Select an Orientation of Portrait or Landscape.
4. Set the printing Margins for your report. The default setting is 1 inch.
5. Click the Printer… button to select your report printer.
6. Click OK to finish the Page Setup process.

For single reports containing multiple pages:

Using the Print button from the menu bar to print a report, will only print the report
page currently displayed. All additional pages of the report should be displayed
and printed individually.

6.1.5 Exporting Data

Once you have configured the data for your report, you can easily export it to four
different formats:
Tab delimited text file
Excel file
XML file
CSV text file (Comma Separated Values)

Exporting a report
1. Generate the report you wish to export. For more details, refer the section
Generating Reports [➙ 53].
2. Customize the report columns (for more details refer the section Customizing
Views [➙ 45]).
3. Select File > Save As from the menu.
4. Select a location to export the file.
5. Enter a name for the exported file.
6. Select a format.
7. Click Save to finish exporting the report.

52
Siemens AB A6V10265087
Security Products 20.04.2012
 Customized & Predefined Reports
Generating Reports 6

For single reports containing multiple pages:

Using the File > Save As functions from the menu, will save and export only the
page of the report that is currently displayed on SiPass Explorer. All additional
pages should be saved and exported individually.

6.2 Generating Reports

Unlike customized reports, the filters, view and other related information are
already pre-defined for Predefined Reports. However, if any available pre-defined
report needs to be customized, this can still be done by right-clicking the specific
report and selecting Customize View.
This report can then be customized as described in the section Customizing Views
[➙ 45].

6.2.1 Components
The components category handles the physical components of your system. This
includes Controllers (Units), Devices and Points.

Generating a Components report

View the section Customizing Views [➙ 45] for more detail on formatting your
report.
1. Expand the Components item from the Navigation pane.
2. Select either Units, Devices or Points.
- If selecting points choose either All Points, Access Points, Input Points
or Output Points.
3. Customize the view of your report:
- Right Click and select Customize View.
- Suggested modifications include changing the columns, adding filters and
grouping data.
4. Click Print Preview.
- If the report looks fine click the Print button at the top left corner of the
screen.
- To make further modifications to the report, click the Close Print Preview
button and return to step 4.

6.2.1.1 Units Report Fields

These are the available fields for the Units report. If all the fields are not visible on
the report, click the Field Chooser button.
To add these fields to the report, select a field and drag it to the field bar of the
report.

Colum Description

Unit Name Name of the controller \ unit

Number Unique number of the controller \ unit

53
Siemens AB A6V10265087
Security Products 20.04.2012
 Customized & Predefined Reports
6 Generating Reports

Colum Description

Type Type of unit (e.g. ACC, CCTV)

Status Status of the controller \ unit
Enabled Whether the controller \ unit is enabled or disabled
Bus Name Bus that the controller \ unit is connected to.
Version Controller \ unit firmware version or revision.
Server Name Server name where the controller \ unit is connected
Equipment Description Field can be used to described the equipment being configured
Serial Number Serial number of the unit

6.2.1.2 Devices Report Fields

These are the available field columns for the Devices report.

Colum Description

Device Name Name of the device.

Device Number Number of the device on the FLN.
Type Type of the device
Unit Name Name of the ACC the device is attached to.
Fln Name Name of the FLN that the device is on.
Fln Number Number of the FLN the device is on.
Unit Number Number of the ACC the device is attached to.
External Device Number External number used to identify the device on APOGEE.
Equipment Description Field can be used to describe the equipment being configured

6.2.1.3 Points Reports Fields

These are the available field columns for Point reports.

Colum Description

Point Name Name of the point.

Point Number Point number of the point.
Point Status The last reported status of the point
Time Schedule Time schedule associated with the point.
Point Type Type of point (e.g. Access, Input, Output)
Unit Number Number of the ACC that the point is attached to.
Unit Type The type of Unit that the point is on.
FLN Number Number of the FLN the point is on.
Device Number Number of the device that the point is on.
Unit Name Name of the ACC the point is on.
FLN Name Name of the FLN the point is on.
Device Name Name of the device the point is on.

54
Siemens AB A6V10265087
Security Products 20.04.2012
 Customized & Predefined Reports
Generating Reports 6

Colum Description

Bus Name The name of the bus the point is on

Server The SiPass integrated server the ACC is communicating with
Alarm Class The alarm class assigned to the point
Normal Task 1 Command Internal Controller event task (NT hardware only)
Normal Task 1 Data Internal Controller event task (NT hardware only)
Normal Task 2 Command Internal Controller event task (NT hardware only)
Normal Task 2 Data Internal Controller event task (NT hardware only)
Alarm Task 1 Command Internal Controller event task (NT hardware only)
Alarm Task 1 Data Internal Controller event task (NT hardware only)
Alarm Task 2 Command Internal Controller event task (NT hardware only)
Alarm Task 2 Data Internal Controller event task (NT hardware only)
Timer1 The setting of the first timer on the point, for output points this is delay 1
Timer2 The setting of the second timer on the point for output points this is delay 2
Operation The operation mode of the point
External ID The external ID of the point used by OPC systems.

6.2.2 Time Schedule

This category provides reports for time schedules and contains all the details of the
time schedules including the start and end of the time periods.

Generating a Time Schedule report

View the section Customizing Views [➙ 45] for more detail on formatting your
report.
1. Expand the Time Schedule item from the Navigation Pane.
2. Select either Time Schedules or Time Schedule Details.
- Time Schedules is an overview of the time schedule names.
- Time Schedule Details shows all the details of each time schedule. The
default view includes all time schedules that have valid time periods.
3. Double click the time schedules you want from the Available Time Schedules
box and click Display Selected to show the details of only a few time
schedules.
4. Customize the view of your report:
- Right Click and select Customize View.
- Suggested modifications include changing the columns, adding filters and
grouping data.
5. Click Print Preview.
- If the report looks fine click the Print button at the top left corner of the
screen.
- To make further modifications to the report click the Close Print Preview
button and return to step 5.

55
Siemens AB A6V10265087
Security Products 20.04.2012
 Customized & Predefined Reports
6 Generating Reports

6.2.2.1 Time Schedule Details Report Fields

These are the available field columns when building reports on Time Schedule
Details.

Column Description

Start Date Day when the time schedule starts.

Stop Date Day when the time schedule stops.
Start Time Time when the time schedule starts.
Stop Time Time when the time schedule stops.
Time Schedule ID Number associated with the time schedule.
Time Schedule Name of the time schedule.

6.2.3 Component Groups

The Component Groups category displays reports which show the component
point groups that are defined in SiPass and the points they contain.

Generating a Component Groups report

View the section Customizing Views [➙ 45] for more details on formatting your
report.
1. Expand the Components Group item from the Navigation Pane.
2. Select a group report from the list. The types of reports are explained below.
- Groups displays an overview of the groups and what types they are.
- Points / Units / FLNs / Devices displays the details of each group and the
objects it contains.
3. Customize the view of your report:
- Right Click and select Customize View.
- Suggested modifications include changing the columns, adding filters and
grouping data.
4. Click Print Preview.
- If the report looks fine click the Print button at the top left corner of the
screen.
- To make further modifications to the report click the Close Print Preview
button and return to step 4.

6.2.3.1 Point Group Report Fields

These are the field columns that are available when building reports on Point
Group details.

Column Description

Point Group Name Name of the point group.

Point Group Type The type of the point group (e.g. Access, Input, Output)
Point Name Name of a point within the group.

56
Siemens AB A6V10265087
Security Products 20.04.2012
 Customized & Predefined Reports
Generating Reports 6

Column Description

Unit Name Name of the ACC a point belongs to.

Unit Number Number of the ACC a point belongs to.
FLN Number Number of the FLN associated with the point.
Device Number Number of the device that the point is on
Point Number Number of the point
Clearance Required Action Whether the Clearance Required flag is set for the point group.
Isolate Group Action Whether the Isolate Group flag is set for the point group.
Group Alarm Timer How long the number of alarms must be active to trigger the group alarm.
Group Alarm Count How many points in the group must go into alarm before the group alarm is triggered.
Alarm Class Name Name of the Alarm Class assigned to the group

6.2.3.2 Unit Group Report Fields

These are the field columns that are available when building reports on Unit Group
details.

Column Description

Unit Group Name Name of the Unit Group.

Unit Name Name of the Unit inside the group.
Unit Number Number of the Unit inside the group.
Alarm Class Name Name of the Alarm Class assigned to the group

6.2.3.3 FLN Group Report Fields

These are the field columns that are available when building reports on FLN Group
details.

Column Description

FLN Group Name Name of the FLN Group.

FLN Name Name of the FLN inside the group.
FLN Number Number of the FLN inside the group.
Parent Unit Unit the FLN is connected to.
Alarm Class Name Name of the Alarm Class assigned to the group

6.2.3.4 Device Group Report Fields

These are the field columns that are available when building reports on Device
Group details.

Column Description

Device Group Name Name of the Device Group.

Alarm Class Name Name of the Alarm Class assigned to the group.

57
Siemens AB A6V10265087
Security Products 20.04.2012
 Customized & Predefined Reports
6 Generating Reports

Column Description

Device Name Name of the Device inside the group.

Device Number Number of the Device inside the group.
Parent FLN The FLN the Device is connected to.
Parent Unit The Unit the Device is connected to.

6.2.4 Access Levels

The Access Level category displays reports based on the access levels configured
in SiPass integrated and the points they contain.

Generating an Access Levels report

View the section Customizing Views [➙ 45] for more details on formatting your
report.
1. Expand the Access Levels item from the Navigation Pane.
2. Select either All Access Levels, Access Level Points or Access Level Point
Groups.
- All Access Levels displays an overview of the access levels and what
types they are.
- Access Level Points displays the details of each access level and the
points it contains. The default view shows all the access levels.
- Access Level Point Groups display the point groups which contain
access points.
3. Customize the view of your report:
- Modifications include changing the columns, adding filters and grouping
data.
4. Click Print Preview.
- If the report looks fine click the Print button at the top left corner of the
screen
- To make further modifications to the report click the Close Print Preview
button and return to step 4.

6.2.4.1 Access Level Report Fields

These are the field columns that are available when building reports on Access
level points.

Column Description

Point Name Name of a point within the access level

Time Schedule Time schedule for the access level
Point Type Type of point (e.g. Access)
Access Level Name Name of the access level
Point Number Number of a point within the access level
Unit Number Number of the ACC the point belongs to
FLN Number Number of the FLN the point is on

58
Siemens AB A6V10265087
Security Products 20.04.2012
 Customized & Predefined Reports
Generating Reports 6

Column Description

Device Number Number of the device the point belongs to

Unit Name Name of the ACC the point belongs to
FLN Name The Name of the FLN the point is on
Device Name The Name of the device the point belongs to

6.2.5 Access Groups

The Access Groups category displays the details of access groups as either points
or levels.

Generating an Access Groups report

View the section Customizing Views [➙ 45] for more details on formatting your
report.
1. Expand the Access Groups item from the Navigation Pane.
2. Choose either All Access Groups, Access Group Points, or Access Group
Levels.
- All Access Groups displays a list of the access group names.
- Access Group Points displays the details of each access group and the
points it contains. The default view shows all access groups.
- Access Group Levels displays the access groups and the access levels
they contain. The default view shows all the access groups.
3. Customize the view of your report:
- Right Click and select Customize View,
- Suggested modifications include changing the columns, adding filters and
grouping data.
4. Click Print Preview.
- If the report looks fine, click the Print button at the top left corner of the
screen.
- To make further modifications to the report click the Close Print Preview
button and return to step 4.

6.2.5.1 Access Group Report Fields

These are the field columns that are available when building reports on Access
level points.

Column Description

Point Name Name of a point within the access group

Point Type Type of point (e.g. Access)
Access Group Name Name of the access group
Point Number Number of a point within the access group
Unit Number Number of the ACC the point belongs to
FLN Number Number of the FLN the point is on
Device Number Number of the device the point belongs to

59
Siemens AB A6V10265087
Security Products 20.04.2012
 Customized & Predefined Reports
6 Generating Reports

Column Description

Unit Name Name of the ACC the point belongs to

FLN Name Name of the FLN the point is on
Device Name Name of the device the point belongs to

6.2.6 Workgroups
The Workgroups category generates reports that display all the current work
groups and any additional details about those workgroups that you need.

Generating a Workgroups report

View the section Customizing Views [➙ 45] for more details on formatting your
report.
1. Expand the Workgroups item from the Navigation Pane.
2. Select Workgroup Details.
3. Customize the view of your report:
- Right Click and select Customize View.
- Suggested modifications include changing the columns, adding filters and
grouping data.
4. Click Print Preview.
- If the report looks fine, click the Print button at the top left corner of the
screen.
- To make further modifications to the report, click the Close Print Preview
button and return to step 4.

6.2.6.1 Workgroup Report Fields

These are the field columns that are available when building reports on Work
Groups.

Column Description

Workgroup Name Name of the work group.

Workgroup Type Type of the work group (e.g. Visitor, Department, Contractor)
Workgroup Status The status of the work group (e.g. Void, Valid)
Primary Contact Name Name of the primary contact for the work group
Primary Contact Title Title of the primary contact for the work group
Primary Contact Address Address of the primary contact for the work group
Primary Contact Phone Phone number of the primary contact for the work group
Primary Contact Fax Fax number of the primary contact for the work group
Primary Contact Pager Pager number of the primary contact for the work group
Secondary Contact Name Name of the secondary contact for the work group
Secondary Contact Title Title of the secondary contact for the work group
Secondary Contact Address Address of the secondary contact for the work group
Secondary Contact Phone Phone number of the secondary contact for the work group

60
Siemens AB A6V10265087
Security Products 20.04.2012
 Customized & Predefined Reports
Generating Reports 6

Column Description

Secondary Contact Fax Fax number of the secondary contact for the work group
Secondary Contact Pager Pager number of the secondary contact for the work group
Access Privileges Access privileges assigned to the workgroup
Partition Group Determines whether the workgroup is a Partition group

6.2.7 Cardholder
The cardholder category handles all the card related reports. It has some default
views that filter out visitors and different types of card status.

Generating a Cardholder report

View the section Customizing Views [➙ 45] for more details on formatting your
report.
1. Expand the Cardholders item from the Navigation pane.
2. Select one of the Cardholder, Visitor or Cardholder access reports.
3. Customize the view of your report:
- Right Click and select Customize View.
- Suggested modifications include changing the columns, adding filters and
grouping data.
4. Click Print Preview.
- If the report looks fine, click the Print button at the top left corner of the
screen.
- To make further modifications to the report, click the Close Print Preview
button and return to step 4.

6.2.7.1 Cardholder Reports

These are the field columns that are available for reports in the Cardholder
category.

Report Description

All Cardholders All cardholders who are not visitors.

Valid Cardholders Valid cardholders who are not visitors.
Invalid Cardholders Void or expired cardholders who are not visitors.
All Visitors All visitors in the system.
Valid Visitors All valid visitors.
Invalid Visitors Void or expired visitors.
Cardholders Point Access Listing of cardholder access and individual points they have access to.
Cardholders Point Group Listing of cardholder access and point groups they have access to.
Access
Cardholders Personalized Listing of cardholders with personalized access and the individual points they have access
Point Access to.
Cardholders Personalized Listing of cardholders with personalized access and the point groups they have access to.
Point Group Access

61
Siemens AB A6V10265087
Security Products 20.04.2012
 Customized & Predefined Reports
6 Generating Reports

Report Description

Cardholders Access Groups List of cardholders grouped by the access group they are assigned to.
Cardholders Last Known List of all cardholders and their last known location.
Location
Cardholder Temporary List of cardholders grouped by the temporary access group they are assigned to.
Access Details
Cardholders Access Levels List of cardholders grouped by the access level they have been assigned.
Cardholders Offline Access List of the cardholders configured with Offline Access privileges and their details
Details
Cardholders with images Lists all cardholders that have an image.
Cardholders with no images Lists all cardholders that don’t have an image.
All Cards Lists all the cards configured to a cardholder
Cardholders Work Groups Lists all the cardholders assigned to workgroups
Inactive Cards – 30-Day Lists all the inactive cards in within a 30-day threshold
Threshold
Card – Last Used Day Lists all cardholders and displays their last location and when they last used their card.
Cardholders Custom Fields Lists cardholders with custom field data and displays that data.
All Cardholders and Visitors Lists all the cardholders and visitors

6.2.7.2 Cardholder Report Fields

These fields are available when building reports on Cardholders.
To view these fields, select a report under Cardholders and then click the Field
Chooser button on the top horizontal menu bar.

Column Description

Card Number Card number of the cardholder. The leading 0 of the Card Number is not displayed in the
report.
First Name First name of the cardholder
Last Name Last name of the cardholder
Access Group Name Access group assigned to the cardholder
Start Date Defines the first day the card can be used.
End Date Defines the last day the card can be used.
Card Status Current status of the card (e.g. Void, Valid)
Work Group Name Work group the cardholder is a part of
Workgroup Description The description of the workgroup.
Workgroup Status The status of the workgroup, either Void or Valid
Employee Number Employee number of the cardholder
Title Title of the cardholder; for example Mr or Mrs.
Date Of Birth Cardholder’s date of birth
Address Address of the cardholder
Payroll Number A number for the cardholder that corresponds to your Payroll system.
Phone Telephone number for the cardholder
Mobile Mobile telephone number for the cardholder

62
Siemens AB A6V10265087
Security Products 20.04.2012
 Customized & Predefined Reports
Generating Reports 6

Column Description

Mobile Service Provider Mobile service provider used for the cardholder
Pager Pager number for the cardholder.
Pager Service Provider Pager service provider used for the cardholder
Email Cardholder’s email address
Use Email Checkbox that determines whether the cardholder appears in the list of possible recipients
for a Message Forwarding task
Car Rego 1 Registration number of the cardholder’s primary car.
Car Model 1 Model number of the cardholder’s primary car.
Car Color 1 Color of the cardholder’s primary car.
Car Rego 2 Registration number of the cardholder’s second car.
Car Model 2 Model number of the cardholder’s second car.
Car Color 2 Color of the cardholder’s second car.
Temp Access Group Name Temporary access group assigned to the cardholder
Credential Profile Credential Profile of the card/s assigned to the cardholder

6.2.7.3 Visitor Reports Fields

These are the field columns that are available when building reports on Visitors. To
view these fields, select a visitor report under Cardholders and then click the Field
Chooser button on the top horizontal menu bar.

Column Description

Card Number Card number of the visitor

First Name First name of the visitor
Last Name Last name of the visitor
Start Date Defines the first day the card can be used.
End Date Defines the last day the card can be used.
Issue Time The time when the visitor card was issued
Return Time Time when the visitor card was returned
Sponsor First Name First name of the visitor’s sponsor
Sponsor Last Name Last name of the visitor’s sponsor
Company Company that the visitor is from
Visitor Card Status Status of the visitor card (e.g. Void, Issued)
Card Status Current status of the card (e.g. Void, Valid)
Work Group Name Work group of the visitor
Workgroup Description The description of the workgroup.
Workgroup Status The status of the workgroup, either Void or Valid
Access Group Name Access group assigned to the visitor
Employee Number Employee number of the visitor
Title Title of the visitor; for example Mr. or Mrs.
Date Of Birth Visitor’s date of birth
Address Address of the visitor

63
Siemens AB A6V10265087
Security Products 20.04.2012
 Customized & Predefined Reports
6 Generating Reports

Column Description

Payroll Number A number for the visitor that corresponds to your Payroll system.
Phone Telephone number for the visitor
Mobile Mobile telephone number for the visitor
Mobile Service Provider Mobile service provider used for the visitor r
Pager Pager number for the visitor.
Pager Service Provider Pager service provider used for the visitor
Email Visitor’s email address.
Use Email This checkbox determines whether the visitor appears in the list of possible recipients for a
Message Forwarding task.
Temp Access Group Name Temporary access group assigned to the visitor
Credential Profile Credential Profile of the card/s assigned to the visitor

6.2.8 Audit Trail

The audit trail category displays all the possible audit trail reports.

Generating an Audit Trail report

View the section Customizing Views [➙ 45] for more details on formatting your
report.
1. Expand the Audit Trail item from the Navigation pane.
2. Select a type of audit trail report.
3. Select the date range of audit trail you wish to view and click Display.
4. Customize the view of your report:
- Right Click and select Customize View.
- Suggested modifications include changing the columns, adding filters and
grouping data.
5. Click Print Preview.
- If the report looks fine, click the Print button at the top left corner of the
screen
- To make further modifications to the report click the Close Print Preview
button and return to step 5.

6.2.8.1 Audit Trail Reports

The following Audit Trail reports are available.

Report Description

Audit Trail - All Report containing all audit trail messages.

Audit Trail - Access Report containing only audit trail concerning access events.
Audit Trail - Operator Log Report containing only audit trail concerning operator actions.
Audit Trail - Cardholder Report containing only audit trail that involves cardholders entering doors.
Door Access

64
Siemens AB A6V10265087
Security Products 20.04.2012
 Customized & Predefined Reports
Generating Reports 6

Report Description

Audit Trail - Concise Similar to All Audit Trail report but has fewer columns.
Audit Trail - Database Report containing only audit trail concerning database changes.
Change
Audit Trail – Image Report containing only audit trail concerning image verification events.
Verification
Audit Trail – Visitor Access Report containing only audit trail concerning visitor access events.
Audit Trail – Visitor Card Report containing only audit trail concerning visitor card changes.
History
Audit Trail – Time & Report containing only audit trail concerning Time & Attendance access.
Attendance Access
Audit Trail – Earliest and Report containing only audit trail concerning the earliest and latest access.
Latest Access

6.2.8.2 Audit Trail Columns

These are the field columns that are available when building reports on Audit Trail.

Column Description

Date Occurred Date the event occurred at the Unit

Time Occurred Time the event occurred at the Unit
Date Recorded Date when SiPass recorded the message.
Time Recorded Time when SiPass recorded the message.
Point Name Name of the point involved in the event
Location Location where the event occurred
First Name First name of the cardholder or operator involved in the event
Last Name Last name of the cardholder or operator involved in the event
Message Message containing the details of the event
Server Name Name of the server where the event originated
Bus Name of the bus where the event originated
Workgroup Workgroup associated with the cardholder in the event
Card Number The card number of the cardholder involved in the event
Anti Passback Area Anti Passback area involved in the event
Intrusion Area The intrusion area involved in the event
Unit Number The number of the Unit involved in the event
Point Number Number of the point involved in the event
Type Type of the point involved in the event
Category Category of the event message
State Id Id number of the state reported by the event
Point Id Database Id of the point.
Audit Trail Type Type of audit trail event
Date Occurred Server Date when SiPass received the audit message from the ACC
Time Occurred Server Time when SiPass received the audit message from the ACC
FLN Number The number of the FLN involved in the event

65
Siemens AB A6V10265087
Security Products 20.04.2012
 Customized & Predefined Reports
6 Generating Reports

Column Description

Device Number The number of the Device involved in the event

Card Facility Facility number associated with the card event
Card Technology Card technology associated with the card event
Employee Number Employee number of the cardholder
Audit Trail Type A field that is indicative of the type of Audit trail displayed

6.2.9 APB Areas

The APB Areas category generates reports that display all the current Anti-
Passback areas and any additional details that you need.

Generating an APB Area report

View the section Customizing Views [➙ 45] for more details on formatting your
report.
1. Expand the APB Area item from the Navigation pane.
2. Select All APB Areas or APB Area Details.
3. Customize the view of your report:
- Right Click and select Customize View.
- Suggested modifications include changing the columns, adding filters and
grouping data.
4. Click Print Preview.
- If the report looks fine, click the Print button at the top left corner of the
screen.
- To make further modifications to the report, click the Close Print Preview
button and return to step 4.

6.2.9.1 APB Areas Columns

These are the field columns that are available when building reports based on APB
areas.

Column Description

Area No The number of the APB area

Cluster The cluster the APB area is attached to
Name The name of the APB area
Mode The mode of the APB area, e.g. Soft Anti-Passback
Capacity The maximum capacity of the area.
Enforce Capacity Whether or not the maximum capacity is forced.
Mustering APB Area Whether this area is a mustering APB area.
Enable Four Eyes Whether Four Eyes mode is enabled on this area.
Include Cardholder in Sub Whether a cardholder in a sub area counts for Four Eyes mode.
area
Four Eyes Timer The timer set for Four Eyes enabled mode.

66
Siemens AB A6V10265087
Security Products 20.04.2012
 Customized & Predefined Reports
Generating Reports 6

Column Description

Alarm If No Cardholder Whether this area raises an alarm when there are no cardholders. This is a Four Eyes
option.
Re-Entry Timeout The timeout delay to allow cardholders to re-enter the area.
Type The type of point in the APB area.
Point Name The name of the point inside the APB area.
Unit Name The name of the unit that the point is on.
Area Name The name of the ABP area.

6.2.10 Intrusion Areas

The Intrusion Areas category generates reports that display all the current Intrusion
areas and any additional details that you need.

Generating an Intrusion Area report

View the section Customizing Views [➙ 45] for more details on formatting your
report.
1. Expand the Intrusion Areas item from the Navigation pane.
2. Select Intrusion Area General Details or Intrusion Area Point Details.
- General Details shows basic information about the Intrusion Area.
- Point Details shows the points in the Intrusion Area.
3. Customize the view of your report:
- Right Click and select Customize View.
- Suggested modifications include changing the columns, adding filters and
grouping data.
4. Click Print Preview.
- If the report looks fine, click the Print button at the top left corner of the
screen
- To make further modifications to the report, click the Close Print Preview
button and return to step 4.

6.2.10.1 Intrusion Areas Report Fields

These are the field columns are available when building reports based on Intrusion
areas.

Column Description

Intrusion Area Name The name of the Intrusion Area

Short Name The short name of the Intrusion Area, used for intrusion terminals
Point Number The point number of a point in the Intrusion Area
Time Schedule The Time Schedule associated with the Intrusion Area
Entry Delay The delay used when entering the area before raising an alarm. This is so that the user
has enough time to disarm the area.
Exit Delay The delay used when exiting the area before raising an alarm. This allows the user to exit
when arming the area.

67
Siemens AB A6V10265087
Security Products 20.04.2012
 Customized & Predefined Reports
6 Generating Reports

Column Description

Type Type of point included in the Intrusion Area

6.2.11 Alarms
The Alarms category contains reports to both display alarm classes and
outstanding alarms.

Generating an Alarms report

View the section Customizing Views [➙ 45] for more details on formatting your
report.
1. Expand the Alarms item from the Navigation pane.
2. Select the Alarm Classes or Alarm Events Outstanding type of report:
- Alarm Classes shows all alarm classes and their details
- Alarm Events Outstanding shows outstanding alarms of different types
3. Customize the view of your report:
- Right Click and select Customize View
- Suggested modifications include changing the columns, adding filters and
grouping data.
4. Click Print Preview.
- If the report looks fine, click the Print button at the top left corner of the
screen
- To make further modifications to the report, click the Close Print Preview
button and return to step 4.

6.2.11.1 Alarms Class Report Fields

These are the field columns that are available when building reports based on
Alarms.

Column Description

Alarm Class Name Name of the Alarm Class

Type Type of Alarm Class
Priority The priority assigned to the Alarm Class
Restorable Alarm Whether the Alarm Class is Restorable or not
Timeout The timeout of the Alarm Class before it re-alarms
Alarm Instruction File The instruction file associated with the Alarm Class
Siren Sound File The siren sound file that will play when this Alarm Class is triggered
Status The status of the alarm state included in the Alarm Class
Description The description of the alarm state included in the Alarm Class
Alarm or Restore Lists whether the state included in the Alarm Class is an alarm or restore type
Symbol The symbol associated with the alarm state included in the Alarm Class.

68
Siemens AB A6V10265087
Security Products 20.04.2012
 Customized & Predefined Reports
Generating Reports 6

6.2.11.2 Alarms Events Outstanding Report Fields

These are the field columns that are available when building reports based on
Alarms Events Outstanding.

Column Description

Alarm on Bus The Bus that is under alarm.

Alarm on Point Group The Point Group that is under alarm.
Alarm on Point The Point that is under alarm.
Alarm on Unit The Unit that is under alarm.
Date Occurred The date that the alarm occurred
Time Occurred The time when the alarm occurred
Count The number of times the alarm has occurred
Priority The priority of the alarm that has occurred
Status The current status of the alarm

6.2.12 Site Plans

The Site Plans report gives a list of all available site plans.

Generating a Site Plan report

1. View the section Customizing Views [➙ 45] for more details on formatting your
report.
2. Expand the Site Plans item from the Navigation pane.
3. Select the Site Plans report.
4. Customize the view of your report:
- Right Click and select Customize View.
- Suggested modifications include changing the columns, adding filters and
grouping data.
5. Click Print Preview.
- If the report looks fine, click the Print button at the top left corner of the
screen.
- To make further modifications to the report, click the Close Print Preview
button and return to step 4.

6.2.13 Event Tasks

The Event Tasks category contains reports to both display controller based and
host based event tasks.

Generating an Event Task report

View the section Customizing Views [➙ 45] for more details on formatting your
report.
1. Expand the Event Tasks item from the Navigation pane.
2. Select Controller Event Tasks or Host Event Tasks.
3. Customize the view of your report:

69
Siemens AB A6V10265087
Security Products 20.04.2012
 Customized & Predefined Reports
6 Generating Reports

- Right Click and select Customize View.

- Suggested modifications include changing the columns, adding filters and
grouping data.
4. Click Print Preview.
- If the report looks fine, click the Print button at the top left corner of the
screen
- To make further modifications to the report, click the Close button and
return to step 4.

6.2.13.1 Controller Event Tasks Report Fields

These are the field columns that are available when building reports based on
Controller Event Tasks.

Column Description

Event Task The name of the Event Task

Time Schedule Time Schedule associated with the Event Task
Trigger Number Number of triggers used in the Event Task
Trigger Type The type of trigger used in the Event Task
Trigger Controller The Controller associated with the trigger used in the Event Task
Trigger Source The source of the trigger used in the Event Task
Trigger State The state of the trigger used in the Event Task
Trigger Data The data used for the trigger in the Event Task
Logical Operator The logical operator joining the two triggers
Effect Type The type of effect as a result of the Event Task
Effect Controller The controller associated with the effect of the Event Task
Effect Target The target associated with the effect of the Event Task
Effect Message The AT Message specified with the effect of the Event Task
Effect Command The command used by the effect of the Event Task
Effect Data The data required by the effect of the Event Task
Effect Delay The delay before the effect happens

6.2.13.2 Host Event Tasks Report Fields

These are the field columns that are available when building reports based on Host
Event Tasks.

Column Description

Event Task The name of the Event Task

Time Schedule Time Schedule associated with the Event Task
Trigger Source The source type of the Event Task trigger
Trigger Location The location of the Event Task trigger
Trigger State The required state of the Event Task trigger
Trigger Date Occurred The required date of the Event Task trigger

70
Siemens AB A6V10265087
Security Products 20.04.2012
 Customized & Predefined Reports
Generating Reports 6

Column Description

Trigger Time Occurred The required time of the Event Task trigger
Additional Criteria Source The source of an additional Event Task trigger
Additional Criteria Value The required value of an additional Event Task trigger
Effect Target The target type of the Event Task effect
Effect Location The location of the Event Task effect
Effect Command The command used in the Event Task effect
Effect Data The required data for the Event Task effect
Message The message displayed in the Audit Trail

6.2.14 CCTV
The CCTV category contains reports to both CCTV points and control patterns.

Generating a CCTV report

View the section Customizing Views [➙ 45] for more details on formatting your
report.
1. Expand the CCTV item from the Navigation pane.
2. Select a report for either Points, Patterns, Sequences or Presets.
3. Customize the view of your report:
- Right Click and select Customize View.
- Suggested modifications include changing the columns, adding filters and
grouping data.
4. Click Print Preview.
- If the report looks fine, click the Print button at the top left corner of the
screen.
- To make further modifications to the report click the Close Print Preview
button and return to step 4.

6.2.14.1 CCTV Report Fields

These are the field columns that are available when building reports based on
CCTV objects.

Column Description

CCTV Point Name Name of the CCTV point

Patten Name Name of the CCTV pattern
Bus Name Name of the Bus associated with the CCTV action
Unit Name Name of the CCTV Unit
Unit Type Type of the CCTV Unit
CCTV Point Number Point number of the CCTV point
Point Type Type of the CCTV point
Camera Name Name of the CCTV Camera
Preset Name Name of the CCTV preset

71
Siemens AB A6V10265087
Security Products 20.04.2012
 Customized & Predefined Reports
6 Generating Reports

Column Description

Sequence Name Name of the CCTV Sequence

Action Action included in the CCTV Sequence
Sequence Order Order of the action in the CCTV Sequence
Type Type of action in the CCTV Sequence
Delay Seconds How long a delay is in the CCTV sequence

6.2.15 Guard Tour

This category contains reports about Guard Tours.

Generating a Guard Tour report

View the section Customizing Views [➙ 45] for more details on formatting your
report.
1. Expand the Guard Tour item from the Navigation pane.
2. Select a report for either Active Tours or Normal Tours.
3. Customize the view of your report:
- Right Click and select Customize View.
- Suggested modifications include changing the columns, adding filters and
grouping data.
4. Click Print Preview.
- If the report looks fine, click the Print button at the top left corner of the
screen.
- To make further modifications to the report, click the Close Print Preview
button and return to step 4.

6.2.15.1 Guard Tour Report Fields

These are the field columns that are available when building reports based on
Guard Tours.

Column Description

Tour Name Name of the Guard Tour

Guard Name Guard assigned to the tour
Tour Type The type of tour, Ordered or Unordered
Total Expected Time The total time expected for the tour
Total Tolerance Time The total tolerance time allowed for the tour
Tour Stop Name The name of a stop in the tour
Point Number The number of a point included in the tour
Interval Time The time expected between points in the tour
Tolerance Time The tolerance time allowed between points in the tour
Sequence The order of points in the tour
Enabled Whether the tour is enabled or not

72
Siemens AB A6V10265087
Security Products 20.04.2012
 Customized & Predefined Reports
Generating Reports 6

6.2.16 Holidays
The Holidays category contains reports about the defined Holidays in the system.

Generating a Holidays report

1. View the section Customizing Views [➙ 45] for more details on formatting your
report.
2. Expand the Holidays item from the Navigation pane.
3. Select System Defined Holidays.
4. Customize the view of your report:
- Right Click and select Customize View.
- Suggested modifications include changing the columns, adding filters and
grouping data.
5. Click Print Preview.
- If the report looks fine, click the Print button at the top left corner of the
screen.
- To make further modifications to the report, click the Close button and
return to step 4.

6.2.16.1 Holidays Report Fields

These are the field columns that are available when building reports based on
Holidays.

Column Description

Holiday Name Name of the Holiday

Holiday Date The date when the Holiday occurs
Applicable Unit The Unit that the Holiday affects

6.2.17 Elevators
The Elevators category contains reports about the defined floors and banks in the
system.

Generating an Elevator report

View the section Customizing Views [➙ 45] for more details on formatting your
report.
1. Expand the Elevators item from the Navigation pane.
2. Select Elevator Floor Details or Elevator Bank Details.
3. Customize the view of your report:
- Right Click and select Customize View.
- Suggested modifications include changing the columns, adding filters and
grouping data.
4. Click Print Preview.
- If the report looks fine, click the Print button at the top left corner of the
screen.

73
Siemens AB A6V10265087
Security Products 20.04.2012
 Customized & Predefined Reports
6 Generating Reports

- To make further modifications to the report, click the Close Print Preview
button and return to step 4.

6.2.17.1 Elevators Report Fields

These are the field columns that are available when building reports based on
Elevators.

Column Description

Elevator Name Name of the Elevator

Bank Name The name of the elevator Bank
Reader Name The name of the reader assigned to the elevator
Floor Name The name of the floor
Rise Number The rise number of the floor
Input Point Name The input point assigned to the floor
Output Point Name The output point assigned to the floor
Unit Name The name of the unit the bank is attached to
Time Schedule The time schedule for the floor
Alarm Class The alarm class assigned to the floor

6.2.18 Operators
The Operators category contains reports about the operators and operator groups
in the system.

Generating an Operator report

View the section Customizing Views [➙ 45] for more details on formatting your
report.
1. Expand the Operators item from the Navigation pane.
2. Select a report from the list.
3. Customize the view of your report:
- Right Click and select Customize View.
4. Suggested modifications include changing the columns, adding filters and
grouping data.
5. Click Print Preview.
- If the report looks fine, click the Print button at the top left corner of the
screen.
- To make further modifications to the report, click the Close Print Preview
button and return to step 4.

6.2.18.1 Operators Reports

These are the reports available for operators.

74
Siemens AB A6V10265087
Security Products 20.04.2012
 Customized & Predefined Reports
Generating Reports 6

Column Description

Operator Details Shows details about the operators in the system

Operators – System Lists the operators and their System Function access
Function Access
Operators – Point Group Lists the operators and their Point Group access
Access
Operators – Unit Group Lists the operators and their Unit group access
Access
Operators – FLN Group Lists the operators and their FLN group access
Access
Operators – Device Group Lists the operators and their Device Group access
Access
Operators – Work Group Lists the operators and their Work Group access
Access
Operators – Floor Plans Lists the operators and their Floor Plans access
Access
Operator Groups – System Lists the operator groups and their System Function access
Function Access
Operator Groups – Point Lists the operator groups and their Point Group access
Group Access
Operator Groups – Unit Lists the operator groups and their Unit group access
Group Access
Operator Groups – FLN Lists the operator groups and their FLN group access
Group Access
Operator Groups – Device Lists the operator groups and their Device Group access
Group Access
Operator Groups – Work Lists the operator groups and their Work Group access
Group Access
Operator Groups – Floor Lists the operator groups and their Floor Plans access
Plans Access
Operator Groups – Lockout Lists the operator groups and whether they are locked out or not.
Status

6.2.18.2 Operators Report Fields

These are the field columns that are available when building reports based on
Operators.

Column Description

User Name User Name of the operator

Last Name Last name of the operator
First Name First name of the operator
Expiry Date Expiry date of the operator
Operator Group The operator group being referred to
Lockout Status Whether the operator or operator group is locked out
System Function The available system functions
Accessible
Privilege The privilege assigned to the function, for example create, edit, delete.

75
Siemens AB A6V10265087
Security Products 20.04.2012
 Customized & Predefined Reports
6 Generating Reports

Column Description

Group Accessible The group that is accessible, can be a point group, unit group etc depending on the report
Workgroup Accessible The workgroup that is accessible
Accessible Plans Site Plans that are accessible

6.2.19 Database Analysis

The Database Analysis category contains reports that display additional data about
the database.

Generating a Database Analysis report

View the section Customizing Views [➙ 45] for more details on formatting your
report.
1. Expand the Database Analysis item from the Navigation pane.
2. Select the General or Bus report.
3. Customize the view of your report:
- Right Click and select Customize View.
- Suggested modifications include changing the columns, adding filters and
grouping data.
4. Click Print Preview.
- If the report looks fine, click the Print button at the top left corner of the
screen.
- To make further modifications to the report, click the Close Print Preview
button and return to step 4.

6.2.19.1 Database Analysis Report Fields

These are the field columns that are available when building reports based on
Database Analysis.

Column Description

SiPass Version The version of SiPass integrated installed

SiPass Build The build number of the SiPass integrated installation
SiPass Description A brief date and description of the build
Employee Count Total number of cardholders
Operator Count Total number of operators
Minimum Card Number Lowest card number used
Maximum Card Number Highest card number used
Time Schedule Count Total number of time schedules
Event Task Count Total number of event tasks
Area Count Total number of anti Passback areas
Alarm Class Count Total number of alarm classes
Holiday Count Total number of holidays
Unit Count Total number of units

76
Siemens AB A6V10265087
Security Products 20.04.2012
 Customized & Predefined Reports
Generating Reports 6

Column Description

Bus Count Total number of buses

Bus Name Name of the bus
Bus Type Type of bus
Number of Units Number of units connected to the bus
Com Port The com port in use by the bus

6.2.20 Mustering
The Mustering category contains the mustering report.

Generating a Mustering report

View the section Customizing Views [➙ 45] for more details on formatting your
report.
1. Expand the Mustering item from the Navigation pane.
2. Select Mustering Report.
3. Customize the view of your report.
4. Right Click and select Customize View.
- Suggested modifications include changing the columns, adding filters and
grouping data.
5. Click Print Preview.
- If the report looks fine, click the Print button at the top left corner of the
screen.
- To make further modifications to the report, click the Close Print Preview
button and return to step 4.

6.2.20.1 Mustering Report Fields

These are the field columns that are available when building a mustering report.

Column Description

Workgroup Name The name of the workgroup

Area Name The Anti-passback area the cardholder is in
Last Name The last name of the cardholder
First Name The first name of the cardholder
Card Number The card number of the cardholder
Employee Number The employee number of the cardholder
Visitor Indicates whether the cardholder is a visitor or not
Point Name The name of the point the cardholder was last at

6.2.21 Credential Profile

The Credential Profile category contains the Credential Profile report.

77
Siemens AB A6V10265087
Security Products 20.04.2012
 Customized & Predefined Reports
6 Generating Reports

Generating a Credential Profile report

View the section Customizing Views [➙ 45] for more details on formatting your
report.
1. Expand the Credential Profile item from the Navigation pane.
2. Select a Credential Profile report.
3. Customize the view of your report:
- Right Click and select Customize View.
- Suggested modifications include changing the columns, adding filters and
grouping data.
4. Click Print Preview.
- If the report looks fine, click the Print button at the top left corner of the
screen
- To make further modifications to the report, click the Close Print Preview
button and return to step 4.

6.2.21.1 Credential Profile Report Fields

These are the field columns that are available when building a Credential Profile
report.

Column Description

Credential Profile The Credential Profile of the card

Facility Code The Facility Code of the card
Card Technology The Card Technology of the card
Pin Mode The PIN operation mode configured for the card
Pin Digits The number of digits for the PIN of the card
Base Profile The Base Profile of the card

6.2.22 Advanced Security Programming

The Virtual Components category contains the Virtual Components report.

Generating a Virtual Components report

View the section Customizing Views [➙ 45] for more details on formatting your
report.
1. Expand the Advanced Security Programming item from the Navigation
pane.
2. Select a report from the list.
3. Customize the view of your report:
- Right-click and select Customize View.
4. Suggested modifications include changing the columns, adding filters and
grouping data.
5. Click Print Preview.

78
Siemens AB A6V10265087
Security Products 20.04.2012
 Customized & Predefined Reports
Generating Reports 6

- If the report looks fine, click the Print button at the top left corner of the
screen.
- To make further modifications to the report, click the Close Print Preview
button and return to step 4.

6.2.22.1 ASP Reports

These are the reports available for operators.

Column Description
Flags Displays details about virtual flags in the system
Counters Displays details about virtual components in the system
Timers Displays details about virtual timers in the system
Activity List Displays all activities in the system
Activity Detais Displays details about all activities in the system

6.2.22.2 ASP Components Profile Report Fields

These are field columns that are available when building reports based on Virtual
Components.

Column Description
Virtual Flags Name Displays the name of the virtual flag
Unit Displays the name of the unit configured for
the virtual flag
Default Value Displays the default value of the flag
Audit Trail Reporting Specifies the Audit Trail for the flag
Alarm Class Specifies the alarm class configured
Virtual Name Displays the name of the Virtual Counter
Counters
Unit Displays the unit configured for the virtual
counter
Default Value Displays the default value of the counter
Preset Value Displays the preset value of the counter
Max. Value Displays the maximum value of the counter
Count Mode Displays the count mode
Audit Trail Reporting Specifies the Audit Trail for the counter
Virtual Timers Name Displays the name of the Virtual Timer
Unit Displays the unit configured for the virtual
timer
Period Displays the period for which the timer is
configured
Timer Mode Displays the mode of the timer
Audit Trail Reporting Specifies the Audit Trail for the timer
Activity List Name Displays the name of the activity
Unit Displays the unit configured for the activity

79
Siemens AB A6V10265087
Security Products 20.04.2012
 Customized & Predefined Reports
6 Generating Reports

Time Schedule Displays the type of Time Schedule

Description Description of the activity
Activity Details Type Displays the type of flow
Point Category Displays the category configured for the flow
Point Unit Displays the point on which the flow is
configured
Point Location Displays the location of the point
Activity Name Displays the name of activity the flow
belongs to
Activity Unit Displays the unit configured for the flow
Activity Time Schedule Displays the type of time schedule of the
activity that the flow belongs to

6.2.23 Synchronization
The Synchronization category contains the Synchronization report.

Generating a Synchronization report

View the section Customizing Views [➙ 45] for more details on formatting your
report.
1. Expand the Synchronization item from the Navigation pane.
2. Select Synchronization Report.
3. Customize the view of your report.
4. Right Click and select Customize View.
- Suggested modifications include changing the columns, adding filters and
grouping data.
5. Click Print Preview.
- If the report looks fine, click the Print button at the top left corner of the
screen.
- To make further modifications to the report, click the Close Print Preview
button and return to step 4.

6.2.23.1 Synchronization Report Fields

These are the field columns that are available when building a Synchronization
report.

Column Description

External System The External system being synchronized with SiPass integrated. (For example, SALTO)
SiPass Object Entity from SiPass integrated (For example, ‘Cardholder’ or ‘Access Level’)
External Object Entity from the external system (For example, ‘Door’ in the SALTO system)
SiPass Description Description of the SiPass integrated object
External Description Description of the external system’s object
Conflict Description Description of the conflict arising at the time of synchronization with the external system
Correlation ID Details the ID of the object in the conflict

80
Siemens AB A6V10265087
Security Products 20.04.2012
 Customized & Predefined Reports
Generating Reports 6

81
Siemens AB A6V10265087
Security Products 20.04.2012
 Import Data
7 Watchlists

7 Import Data
The Import Data feature of SiPass Explorer has two main options in its tree view:

Watchlists
This innovative feature allows the operator to create a new watchlist, or import an
existing source of data (a csv. or text file) into the SiPass integrated system.
An operator can create / import a set of cardholder details as a Watchlist. These
details will be linked to the SiPass integrated system, and the operator can
configure SiPass to alert operators if cardholders with matching or similar details
are saved within, or already exist within the SiPass system.

Lookup Data
The Lookup Data feature is basically used for file import or export, to and from
SiPass integrated. Files present under Lookup Data can be used to populate the
‘Drop-down List’ custom field for Custom Pages. (Refer the sections under
Importing / Exporting Custom Pages [➙ 42] of this manual for more information on
File Import / Export, and the sections under Populating the Drop Down List Custom
Field [➙ 38] for information on the the Drop-down list custom field.)

7.1 Watchlists
Watchlists that are created in SiPass integrated, or imported from an external
location, can be configured for two primary purposes:

A. To Perform a Warn User Configuration

When an operator adds a new cardholder, or updates the details of an existing
cardholder, whose details match those provided in a watchlist, a warning message
will be displayed.
The operator can then choose whether to proceed with the cardholder creation /
update.
Please refer the section Warn User Configuration [➙ 69] for more details.

B. To Generate Watchlist-linked Customized Reports

The operator can generate a Customized Report based on the data of a specific
Watchlist Report. This Customized Report can be configured to perform the
following functions:
To trigger specific Reporting Actions
To be used as an Actionable Report for Event Tasks.
Please refer the section Creating Watchlist-linked Customized Reports [➙ 69].

7.1.1 'Warn User' Configuration

Overview of configuration stages
To configure the Warn User feature, an operator must follow the procedures
mentioned below.
1. Create a new Watchlist report. (Refer the section Creating Watchlist Reports in
SiPass Explorer [➙ 69].)
2. Map the fields of the Watchlist report to the fields of the Cardholder dialog.
(Refer the section Field-Mapping a Watchlist Report [➙ 69].)

Conditions triggering the warning message

82
Siemens AB A6V10265087
Security Products 20.04.2012
 Import Data
Watchlists 7

Once configured the warning message is triggered and displayed when an

operator does the following:
Uses the Cardholder dialog to create a new cardholder, whose details match
those that exist in a Watchlist report;
Uses the Cardholder dialog to update the details of an existing cardholder,
whose details match those that exist in a Watchlist report

Warning message displayed

Once this configuration is complete, an operator will be presented with the
following warning message:
“Action happened on Trigger Effect Entry: xyz
A watchlist breach has occurred. Are you sure you want to continue?”;
where xyz represents the name of the watchlist report that contains the
cardholder’s details.

7.1.1.1 Creating Watchlist Reports in SiPass Explorer

Watchlist Reports can be created in SiPass Explorer in two ways:
Create a new Watchlist Report within SiPass Explorer; OR
Import an existing watchlist from an external location, to create a new Watchlist
Report
Both these options have been discussed in the sections that follow.

Creating a new Watchlist Report

1. Select Imported Data > Watchlists from the Navigation panel of SiPass
Explorer.
2. Right-click Watchlists and select New Watchlist Report. This action will
display the Report Wizard.
3. Enter a name for the watchlist in the Name field.
4. Select External Data from the Create from data source field.
5. Click Next.
6. In the next dialog, you can leave the External File field blank.
7. In the file columns and rows below, right-click on the cell NoName.
8. Select Change Column.
This will display the Customize Column dialog.
9. Specify the column name in the Column Name: field.

The following words/terms should not be used as Column Names: rownumber,

revision, instance, type. Further, a column name should not start with the
underscore symbol ( _ ).

10. Select the Column Type: to be either Text or Integer.

11. Select the maximum length of characters in the column in the Max Length:
field.
12. Click OK.

83
Siemens AB A6V10265087
Security Products 20.04.2012
 Import Data
7 Watchlists

13. To add additional rows or delete rows from this file, right-click the first cell of
the last row and select Insert Row or Remove Row as required.
14. To change, insert or remove columns, right-click any of the top-most cells and
select Change Column / Insert Column / Remove Column as appropriate.
15. In the available cells, type in the information required for the watchlist. For
example, if you want the watchlist to be based on the First Name and Last
Name of cardholders, change 2 column names to First Name and Last Name.
And then add the respective list of first and last names in the cells under the
respective columns.
16. Click Next.
17. All the dialogs in the next field are selected by default. The operator can
change the display fields if necessary.
18. Click Next.
19. All the fields selected in the next dialog are Filter Conditions. The operator can
change the filter condition if necessary.
20. Click Next.
21. In the next dialog, map the Parameter field (which will appear in the Watchlist
report) to the adjacent Cardholder dialog fields.

The operator can choose to skip this step, and proceed to click Finish. The field
mapping can then be done on the Interactive Reports dialog. For more
information on how to configure this mapping, refer the section Configuring an
Interactive Report through Field-Mapping.

22. Click Finish.

This new watchlist will now be added and under Watchlists in the Navigation
panel.

Importing Files to Create Watchlist Reports

The following steps detail how an operator can import a watchlist into SiPass
Explorer:
1. Select Imported Data > Watchlists from the Navigation panel of SiPass
Explorer.
2. Right-click Watchlists and select New Watchlist Import. This action will
display the Report Wizard.
3. Click Next.
4. Enter a name for this watchlist in the Name field.
5. Select External Data from the Create from data source field.
6. Click Next.
7. In the next dialog, select the … button to select the external file from where the
data should be imported.

The following words/terms should not be used as Column Names: rownumber,

revision, instance, type. Further, a column name should not start with the
underscore symbol ( _ ).

84
Siemens AB A6V10265087
Security Products 20.04.2012
 Import Data
Watchlists 7

8. Click Next.
9. All the fields in the next dialog are selected by default. The operator can
change the display fields if necessary.
10. Click Next.
11. The fields selected in the next dialog are all Filter Conditions. The operator can
change the filter condition if necessary.
12. Click Next.
13. In the next dialog, map the Parameter field (which will appear in the Watchlist
report) to the adjacent Cardholder dialog fields.
14. Click Finish.

In some cases, the operator may import information to an existing watchlist. In

such cases, ticking the Overwrite existing ones checkbox will overwrite any
information that was present on the watchlist earlier. If this checkbox is left
unticked, the list from the imported file will be added to the end of the existing
watchlist.

This new watchlist will now be added and displayed under Watchlists in the
Navigation panel.

7.1.1.2 Field Mapping a Watchlist Report

There are three ways in which Field Mapping can be performed for a Watchlist
report:

Field Mapping performed during Watchlist report creation

1. After setting the Filter Conditions while creating the Watchlist report, click Next.
2. In the next dialog, map the Parameter fields (which will appear in the Watchlist
report) to the adjacent fields of the Cardholder dialog.
3. Click Finish.

Field Mapping option chosen by selecting a Watchlist report

1. Expand the Watchist tree hierarchy of the Navigation panel.
2. Select and right-click a Watchlist report for which field mapping is to be done.
3. Select Field Mapping. This action displays the Field Mapping dialog.
4. Map the Parameter fields (which will appear in the Watchlist report) to the
adjacent fields of the Cardholder dialog.
5. Click Save and Close.

Field Mapping performed on the Interactive Reports dialog

For detailed instructions on how to perform this configuration, refer the section
Configuring an Interactive Report [➙ 69] of this manual.
Once field mapping is complete, the watchlist has been configured for the Warn
User feature. When operators create or update details of a cardholder matching the
watchlist, a watchlist breach message will be displayed.

85
Siemens AB A6V10265087
Security Products 20.04.2012
 Import Data
7 Watchlists

7.1.1.3 Modifying Existing Watchlist Data

1. From the Watchlist tree hierarchy, select a Watchlist report.
2. Right-click this report, and select Modify Watchlist Data to display the Modify
Watchlist Data dialog. The watchlist data can now be modified as required.

Modifying the existing watchlist with a new import: Ticking the Overwrite
existing data checkbox and then importing a new watchlist, will overwrite the
data of the existing watchlist. If this checkbox is left unticked, the imported
watchlist data will be added below the existing data.

7.1.2 Creating Watchlist-linked Customized Reports

1. Select Customized Reports from the Navigation panel.
2. Click Next when the Report Wizard appears.
3. Enter a Name for the Customized report.
4. Click Next.
5. Select a Report Type.

If the operator wishes to use this customized report to Void Cardholder/Card, the
Record Type chosen must have valid Cardholder details. Details on how to
Configure Void Cardholder / Card have been discussed in the sections under
Void Cardholder/Card using Customized Reports.

6. Click the Click here to add filter criterion button.

7. Click Choose Field.
8. Select [Parameter Report] from the drop down list. The adjacent field
automatically changes to Matches.
9. Click the adjacent empty field, and select the watchlist report that this
customized report should be linked to.
10. Right-click the cells highlighted in blue below.
11. Select a field from the list (the list displays fields of the Report Type selected),
to add to the Customized Report.
12. Click Finish.
13. The customized report will be displayed on the main panel of SiPass Explorer.

7.1.3 Void Cardholder/Card using Customized Reports

An operator can void cardholders or cards using Customized Reports.
This can be done in two ways:
By enabling Reporting Actions from a customized report, to either Void
Cardholder/Card
By using Actionable Reports for Event Tasks that Void
Cardholders/Cards
Both these options are detailed in the sections that follow.

86
Siemens AB A6V10265087
Security Products 20.04.2012
 Import Data
Lookup Data 7

7.1.3.1 Void Cardholder/Card using Reporting Actions

1. Expand Customized Reports from the Navigation panel.
2. Select and right-click the watchlist-linked Customized Report created.
3. Select Customize View.
4. Select Available Actions from the View panel.
5. Tick the checkboxes corresponding to Void Card and Void Cardholder.
6. Click OK.
7. Select and right-click on a cardholder entry in the Customized report displayed.
8. Select Reporting Actions > Void Cardholder / Void Card, as required.
The cardholder or card will now be made void in SiPass integrated. The result
of this action will be reflected in the Audit Trail, the Cardholder dialog and
Credential Profile of the cardholder in concern.

7.1.3.2 Void Cardholder/Card using Host Event Tasks

1. Repeat steps 1 to 4 of the previous section Void Cardholder / Card using
Reporting Actions [➙ 69].
2. Tick the checkbox corresponding to either Void Cardholder / Card (depending
on which action you want to configure), AND click on this action to highlight it.
3. The Set as default button now becomes enabled.
4. Click OK.
5. Next, select Program > Event Task > Host on the main SiPass integrated
user interface.
6. Configure the Trigger for this Host Event Task.
7. Select Actionable Report for the Effect Target field.
8. From the drop-down list of the Report field, select the Customized Report that
was configured earlier.
9. Click Save.
Upon meeting the Trigger criteria, the Host Event Task will perform the default
action that was configured for the customized report ; that being either Void
Cardholder or Void Card.

7.2 Lookup Data

The Lookup Data allows the operator to work with lists that can be linked to SiPass
integrated for a number of purposes and can be used to:
Import lists (in the row and column format)
Export file lists from SiPass Explorer to an external location
Create new lists (in the row and column format)
The lists that are saved into the Lookup Data can be utilized for a number of
purposes as follows:
To create options for custom cardholder fields of the Cardholder dialog (Refer
the section Populating the DROP DOWN LIST Custom Field [➙ 38] of this
manual for information on populating Drop-down lists.)

87
Siemens AB A6V10265087
Security Products 20.04.2012
 Import Data
7 Lookup Data

To create Visitor Profiles and Listed Company fields for the Visitor dialog

7.2.1 Importing a Lookup File

A Lookup file can be imported to Lookup Data as follows:
1. Select Import File from the top menu bar of SiPass Explorer.
This action will display the Open dialog.
2. Select an XML file that you want to import.
3. Click Open.
This file will be added under Lookup Data.

For files being imported, please note that only commas will be considered as
separators between entry items in the XML file.

7.2.2 Creating a New Lookup File

An operator can also create a new file, or customize existing files as follows:
1. Right-click Lookup Data from the Navigation panel of SiPass Explorer.
2. Select Lookup Data Import. This action will display the Lookup Data Import
dialog.
3. Enter a name for the new file in the Display Name field.
4. In the file columns and rows below, right-click on the cell NoName and select
Change Column.
The Customize Column dialog will be displayed.
5. Specify the column name in the Column Name: field.
6. Select the Column Type: to be either Text or Integer.
7. Select the maximum length of characters in the column in the Max Length:
field.
8. Click OK.
9. To add additional rows or delete rows from this file, right-click the first cell of
the last row and select Insert Row or Remove Row as required.
10. In the available cells, type in the required information. The information type
should be as specified in Step 6 (Text or Integer).

The operator can only add rows to this file. Columns cannot be added.

11. Click Save.

88
Siemens AB A6V10265087
Security Products 20.04.2012
 Interactive Reports
How Does an Interactive Report Work 8

8 Interactive Reports
Interactive Reports are run by the SiPass integrated system when the operator
conducts a specific operation. Interactive Reports can be configured to run when
adding and saving cardholders, and execute the report’s underlying action.

8.1 How Does an Interactive Report Work

An operator can create an Interactive Report based on a Watchlist Report. The
Watchlist Report should have an action assigned to it. This action will be triggered
when the Interactive Report returns a non-empty result after being run.

For the Interactive Reports to be selectable, they must contain at least one
parameter in the Filter Conditions. By default, when creating a report, it is
configured as a Parameterized Report (every Watchlist column will be added as a
parameter in the Filter Conditions by default).
A report that contains at least one As Parameter filter condition is considered to
be a Parameterized Report.

Basically, the Interactive Report maps fields of a selected Watchlist Report to the
fields of the Cardholder dialog. The Watchlist Report can have an action assigned
to it, like the default Warn User action, for example.
When the user saves a cardholder, the cardholder fields are presented as
parameters to the Interactive Report. The Interactive Report will then run using the
given cardholder parameters. If the report generates a cardholder/s that matches
the configured parameters, the configured action, like Warn User for example, will
be executed. This means that the operator can be warned if he/she is editing a
cardholder that exists on the Watchlist report.
Similarly, other actions assigned to the selected Watchlist Report can be triggered
when the Interactive Report is run.

8.2 Configuring an Interactive Report

This section explains how the operator can configure an Interactive Report based
on a Watchlist Report.
1. Select Interactive Report > Cardholder / Visitor dialog from the Navigation
pane.
2. From the Reports drop down list, select a specific Watchlist report.
3. From the Parameters section that appears below, map the parameters of the
existing report to the required fields of the Cardholder dialog.
4. Click Save.
The configured Watchlist appears under the Selected List section.
5. Click Close.
Once this configuration is saved, the report is run whenever the Cardholder dialog
creates a new cardholder, or updates an existing cardholder. During this process,
the existing parameter fields of the Watchlist Report are run against the mapped
Cardholder dialog fields to check if matches can be found.
For example, an Interactive Report can be created for a Watchlist Report that has
the default ‘Warn User’ action assigned to it.

89
Siemens AB A6V10265087
Security Products 20.04.2012
 Interactive Reports
8 Removing an Interactive Report

On running the report, if the Watchlist parameter First Name is mapped to the
First Name field of the Cardholder dialog, the Interactive Report checks for
matching first names. If matching first names are found, a Watchlist Breach
message will be generated when that particular cardholder is created, or their
card/s updated.

8.3 Removing an Interactive Report

An Interactive Report can be deleted by selecting the report from the Selected List
section, and clicking Remove.

If an operator wants to delete a Watchlist configured to an Interactive Report, the

specific Interactive Report itself must be deleted / removed first.

8.4 Creating an Interactive Report during Watchlist

Report Creation
The steps required to create an Interactive Report has been discussed in the
section Configuring an Interactive Report [➙ 69].
Alternatively, an Interactive Report can be generated while creating a new
Watchlist Report, as described in the section Field Mapping a Watchlist Report. [➙
69]

90
Siemens AB A6V10265087
Security Products 20.04.2012
 Index

Index
Color 2, 63
A Command, 40
Access Audit Trail, 64 Company, 63
Access Group, 59, 61, 62, 63 Compulsory, 41
Access Level, 58 Concise Audit Trail, 65
Add New Custom Page, 33 Custom Field Properties, 39
Address, 62, 63 Custom Fields, 35
Advanced, 8, 8, 49 Custom Fields Properties, 39
Advanced fields, 50 Custom Page Partitioning, 41
All Audit Trail, 64 Custom Pages, 33
All Cardholders, 61 Customized Reports, 44
All Visitors, 61
Anti Passback Area, 65 D
Appearance, 40, 40, 48 Data Type, 41
Area Name, 67 Database, 41
Area No, 66 Database Change Audit Trail, 65
Attachment, 36 Date Picker, 36
ATTACHMENT Custom Field, 37 Date Recorded, 65
Attachment Properties, 40 Designing a Custom Page, 35
Audit Trail Type, 65 Device Name, 54, 54, 59, 60
Automatic Formatting, 49, 49 Device Number, 54, 54, 57, 59, 59
Direct Commands, 31
B Display Fields, 45, 45
Behaviour, 40 DOB, 62, 63
Buss, 65 Drop-down List, 36
Buss Name, 54 Dynamic Insertion, 38
Button, 36
BUTTON Custom Field, 37 E
Email, 63, 64
C Employee Number, 62, 63
Capacity, 66 Enable Four Eyes, 66
Card Number, 62, 63 Enable/Disable, 54
Card Status, 62, 63 End Date, 62, 63
Card Technology, 66 Enforce Capacity, 66
Cardholder Access, 61 Export Pages, 43
Cardholder Access Group, 62 Exporting Custom Pages, 43
Cardholder Access Level, 62 External Device Number, 54
Cardholder Door Access, 64
Cardholder Temporary Access Group, 62 F
Category, 65 Facility, 66
Checkbox, 36 Field Enabled, 40
Clear Button Text, 40 Field Name, 41
Clock-off, 27 Filter Condition Operators, 46
Clock-on, 27 Filter condition operators, 46
Color 1, 63 filter condition operators, 46

91
Siemens AB A6V10265087
Security Products 20.04.2012
 Index

Filter conditions, 45 O
Filter Conditions, 46 Operator Log Audit Trail, 64
First Name, 62, 63, 65 Operator Privileges, 42
Fln Name, 54, 54, 59, 60
Fln Number, 54, 54, 57, 57, 57, 58, 59
P
Page Number, 40
Format, 40
Page Setup, 52
Four Eyes Timer, 66
Pager, 63, 64
G Pager SP, 63, 64
Generating Reports, 53 Pages Used, 40
Graphical User Interface, 7 Payroll Number, 62, 64
Group By, 47, 47 Phone, 62, 64
Groupbox, 36 Point Name, 54, 56, 57, 57, 58, 59, 67
Point Number, 54, 58, 59, 65
I Point Type, 58, 59, 65
Import Pages, 42
Pointer, 36
Importing Custom Pages, 42
Primary Contact Address, 60
Include Cardholder in Sub area, 66
Primary Contact Fax, 60
Insert On Save, 38
Primary Contact Name, 60
installation, 7
Primary Contact Pager, 60
Invalid Cardholders, 61
Primary Contact Phone, 60
Invalid Visitors, 61
Primary Contact Title, 60
Issue Time, 63
R
L ReEntry Timeout, 67
Label, 36, 40, 40
Rego 1, 63
Last Name, 62, 63, 65
Rego 2, 63
Live Audit Trail, 29
Resizing Custom Fields, 41
Location, 40, 65
Return Time, 63
Lookup Data, 39, 69, 69
Lookup Table, 40 S
Look-up Table, 38 search criteria, 51
Search criteria, 51
M Secondary Contact Address, 60
Max. File Size, 40
Secondary Contact Fax, 61
Max. Length, 41
Secondary Contact Name, 60
Message, 65
Secondary Contact Pager, 61
Mobile, 62, 64
Secondary Contact Phone, 60
Mobile SP, 63, 64
Secondary Contact Title, 60
Mode, 66
Select Button Text, 40
Model 1, 63
Server Name, 54, 65
Model 2, 63
Size, 40
Mustering APB Area, 66
Snapshots, 29
N Sort Order, 48, 48
Name, 66 Sponsor First Name, 63
No Cardholder Alarm, 67 Sponsor Last Name, 63
Number, 53 Start Date, 56, 62, 63

92
Siemens AB A6V10265087
Security Products 20.04.2012
 Index

Start Time, 56
State Id, 65
Status, 54, 60
Stop Date, 56
Stop Time, 56

T
Temp Access Group, 63, 64
Textbox, 36
Time and Attendance Interface, 27
Time Recorded, 65
Time Schedule, 54, 56, 58
Time Schedule ID, 56
Title, 62, 63
Type, 54, 54, 54, 56, 60, 67

U
Unique, 41
Unit Date Occurred, 65
Unit Name, 53, 54, 54, 57, 57, 57, 59, 60, 67
Unit Number, 54, 54, 57, 57, 57, 58, 59
Unit Time Occurred, 65
Use Email, 63, 64

V
Valid Cardholders, 61
Valid Visitors, 61
Version, 54
Visitor Card Status, 63

W
Watchlists, 69
Work Group, 60, 62, 63, 65

93
Siemens AB A6V10265087
Security Products 20.04.2012
Issued by © 2012 Copyright Siemens AB
Siemens AB Technical specifications and availability subject to change without notice.
Infrastructure & Cities Sector
Security Products
International Headquarters
Englundavägen 7
SE-171 24 Solna
Tel. +46 8 629 0300
www.siemens.com/securityproducts

Document ID A6V10265087
Edition 20.04.2012