Avigilon Access Control Manager User Manual Collaboration
Collaboration Administrator Manual
Ver si on 5.0
AV04-0114, January 2, 2014
Version 5.0
Copyright© 2013 Avigilon Corporation
Avigilon Inc.
Box 378
#101-1001 West Broadway
Vancouver, British Columbia
V6H 4E4
Canada
Phone:888.281.5182
Web:www.avigilon.com
Collaboration Administrator Manual
ii
Collaboration Administrator Manual
Getting Help
If you encounter a problem that is not discussed in available Access Control Manager user guides
or on-line help files, and need technical support, please contact your local Value Added Reseller
(VAR) or Access Control Manager provider.
When contacting your VAR, please be sure to have your software version number available.
For future reference, record these numbers here.
Version Number: ________________________________
VAR: __________________________________________
VAR Phone #: __________________________________
iii
Table of Contents
Getting Help . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . iii
Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1
Collaboration Procedures . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
Adding a Collaboration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
Editing a Collaboration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
Deleting a Collaboration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
Assigning an Event Type to a Collaboration . . . . . . . . . . . . . . . . . . . . . . . . . 3
Assigning Events to a Collaboration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
Collaboration Add Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
Additional Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
Identity CSV One-Time Upload . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
Identity CSV Recurring Upload . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
Events Collaborations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
Pull Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
Collaboration Listing Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .10
Collaboration Edit Screen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
Collaboration Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .12
Running a Collaboration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .12
Previewing Records . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
Collaboration Administrator Manual
Collaboration Details. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
ArcSight CEF Edit Screen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
Arcsight CEF . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
CSV Recurring . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
CSV One-Time Upload Edit Screen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .16
CSV Uploads . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .16
Preparing the CSV File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .17
Uploading CSV Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
Avoiding Duplicate Identities and Errors . . . . . . . . . . . . . . . . . . . 17
Mandatory Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
Field List . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .17
CSV Upload Template . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .19
LDAP Edit Screen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
Milestone Video Edit Screen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
Oracle RDBMS Pull Edit Screen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .21
Pelco Digital Sentry Edit Screen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .21
Pelco Endura Edit Screen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
Pelco Endura Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
SNMP Edit Screen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
SNMP Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
Splunk Edit Screen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
Splunk Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
SQL Edit Screen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
Syslog Edit Screen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
Syslog Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
XML Edit Screen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
XML Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
Blob Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
Events Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
Identities Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28
Roles Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28
Schedule Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
iv
Collaboration Administrator Manual
Source Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
Tokens Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30
User Defined Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .31
v
Collaboration Administrator Manual
Overview
Collaboration provides the ability to exchange data between Access Control Manager software
and a large number of database types including:
•Events - ArcSight CEF
• Events - Generic XML
• Events - Milestone Video
• Events - Pelco Digital Sentry
•Events - Pelco Endura
•Events - SNMP
• Events - Splunk
• Events - Syslog
• Identity CSV One-Time Upload
•Identity CSV Recurring
• Identity LDAP Pull
• Identity Oracle RDBMS Pull
• Identity SQL Server Pull
For example, this enables Access Control Manager to pull personnel information from an existing
HR database to populate its own Identities definitions. This saves the time and cost of re-entering
the information and allows a simultaneous updating of information based on current employee or
security status.
To open this feature:
• From the Setup Links section of the main menu, select Collaboration. The Collaboration
Listing page appears.
To use this feature, refer to Collaboration Procedures on page 2.
For details on screens and pages that appear in the Collaboration feature, refer to Collaboration
Details on page 14.
1
Collaboration Administrator Manual
Collaboration Procedures
Collaboration is managed and maintained using these topics:
• Adding a collaboration (page 2)
• Editing an existing collaboration (page 2)
• Deleting an existing collaboration (page 3)
• Assigning the event type (page 3)
The main screens used during these procedures are shown in these topics:
• Collaboration Add page (page 4)
• Collaboration Listing page (page 10)
• Collaboration Edit page (page 11)
Adding a Collaboration
To add a collaboration:
1. At the Setup Links section of the home screen, click Collaboration.
The Collaboration Listing page appears (see page 10).
2. Click .
The Collaboration Add screen appears (see page 4).
3. Enter or supply the information as required for the fields including the 'Type' field.
4. Depending on the option you select in the 'Type' field, additional fields are added.
5. Enter values or select options for the additional fields.
6. When you're finished, click to confirm your selections.
The Collaboration Edit screen appears (see page 11). This screen often includes multiple
tabbed pages.
7. Make changes to the necessary fields on the required tabbed pages.
8. Click to save those changes.
Editing a Collaboration
To edit an existing collaboration:
1. At the Setup Links section of the home screen, click Collaboration.
The Collaboration Listing page appears (see page 10).
2. Click the name of the Collaboration you want to edit.
The Collaboration Edit screen appears (see page 11).
3. Select options and enter values to the requisite pages on this screen as required.
2
Not all tabbed pages for all types of collaborations are relevant. Those pages which are
not available for a specific store are not activated.
4. When you're finished, click .
You are returned to the Collaboration Listing page with a message indicating that the
update was successful.
Deleting a Collaboration
To delete an existing collaboration:
1. At the Setup Links section of the home screen, click Collaboration.
The Collaboration Listing page appears (see page 10).
2. Click to the right of the collaboration you want to delete.
A message appears asking you to confirm your deletion.
3. Click OK.
You are returned to the Collaboration Listing page. The deleted collaboration no longer
appears.
Collaboration Administrator Manual
Assigning an Event Type to a Collaboration
To assign an event type to a collaboration:
1. Create a new collaboration or access an existing collaboration by clicking the
Collaboration icon.
The Collaboration Listing page appears (see page 10).
2. Select the collaboration to which you want to add or edit the event type.
The Collaboration Add page appears (see page 4).
3. At the 'Type' pick list, select the collaboration event type you need.
4. Click OK.
Assigning Events to a Collaboration
Many types of collaborations enable the operator to specify which events are to be shared.
To assign an event to a collaboration:
1. At the Setup Links section of the home screen, click Collaboration.
The Collaboration Listing page appears (see page 10).
2. Do one of these:
• To edit an existing collaboration, select the collaboration whose type you want to
modify.The Collaboration Edit page appears.
• Create a new collaboration.The Collaboration Add page appears.
3
Collaboration Administrator Manual
3. Click the Events tab.
The Events page appears (see “Events Page” on page 27).
4. From the 'Available' window click to highlight each event type you want to share.
To pick multiple events, use Ctrl + right-click to select non-consecutive events, or use
Shift + right-click to select a range of events.
5. Click to move the selected events over to the 'Members' window.
6. Click .
The selected events will be shared between the database and this application.
Collaboration Add Page
When you add a collaboration from the Listing page, a screen like this appears:
The fields on this page are:
Name Enter the name of this collaboration.
Installed Click to check this box if this collaboration is currently enabled.
Appliance Select from the drop-down pick list one of the existing appliances as the main
connection to this collaboration type. Only those appliances previously defined for this
application appear in this list.
Type Select the collaboration type from the drop-down pick list. Depending on the type of
collaboration you select, additional files are added as shown below.
For more information on these options, see Collaboration Types on page 12.
Partitions If required, select the partitions to which this collaboration will belong.
Only those partitions currently defined for this system appear in this field. If no partitions
are defined, this window will not appear.
Click this icon to save changes made to this form. The new collaboration is added to the
Collaboration Listing page.
Click this icon to ignore any changes made to this form during the current session and
return to the Collaboration Listing page.
Additional Fields
Depending on the option you select in the 'Type' field, the following additional fields can appear:
• Identity CSV One-Time Upload (see page 5)
• Identity CSV Recurring Upload (see page 6)
4
Collaboration Administrator Manual
• Identity LDAP (see page 20)
• Identity Milestone Video (see page 20)
• Oracle RDBMS (see page 21)
• Identity SQL Server Pull (see page 24)
• Pelco Digital Sentry (see page 21)
• Pelco Endura (see page 22)
• SNMP (see page 23)
• Events – ArcSight CEF (see page 14)
• Events – Splunk (see page 23)
• Events – Syslog (see page 24)
• Events – Generic XML (see page 25)
Identity CSV One-Time Upload
This collaboration type is supported in two formats: short and long.
If you select Identity CSV One-Time Short format as your collaboration type, an additional field
like this appears:
The additional field is:
CSV File
Click the button and select the flat file with the CSV extension for this database.
Once you have selected a CSV file, click the button and the upload process
commences.
If you select Identity CSV One-Time Long format as your collaboration type, several fields appear
as shown in this example:
The additional field is:
Delimiter From the pick list, select the character that is used in this file as the delimiter.
5
Collaboration Administrator Manual
Text Qualifier From the pick list, select the punctuation used to specify text for this data upload.
Date Format From the pick list, select the format used in this file for the date.
CSV File
Click the button and select the flat file with the CSV extension for this database.
Once you have selected a CSV file, click the button and the upload process
commences.
If you select Identity CSV One-Time Upload as your collaboration type, an additional field like this
appears:
For more information on this collaboration type, refer to CSV One-Time Upload Edit Screen on
page 16 and Uploading CSV Files on page 17.
Identity CSV Recurring Upload
If you select either Identity CSV Recurring Upload as your collaboration type, an additional field
like this appears:
The additional field is:
Location Type From the drop-down list, select the location type this CSV upload requires. The options
are:
• SFTP – A frequently used backup technique
• Windows Share – the MS Windows share technique (in a Windows environment,
most people will use this)
Host If you are using Windows Share, enter the IP address of the computer on which the
share file will appear and the directory separated by a forward slash (/).
If you are using SFTP, enter just the host name (which can be just the IP address) without
the directory.
User Name Enter the user name allowing access to this location.
Password Enter the password allowing access to this location.
6
Loading...