Collaboration Administrator Manual Version 5.
Collaboration Administrator Manual 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.
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.
Collaboration Administrator Manual Table of Contents Getting Help . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . iii Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1 Collaboration Procedures . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2 Adding a Collaboration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2 Editing a Collaboration . . . . . . . . . . .
Collaboration Administrator Manual Source Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29 Tokens Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30 User Defined Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
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 exampl
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 collaboratio
Collaboration Administrator Manual 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).
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 6. Click to move the selected events over to the 'Members' window. . The selected events will be shared between the database and this application.
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.
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 commences.
Collaboration Administrator Manual Location Enter the name of the subdirectory where the backup files are stored on the host computer as shown in the above example. If the file is to be located in a subdirectory of the share, use this format: /directory_name/ Notice that the directory name needs both a leading slash and a trailing slash. If the file is to be located in the top level of the share (no subdirectory), use this format: /directory_name Notice that there is only one leading slash required.
Collaboration Administrator Manual • • SNMP Edit Screen (see page 23) XML Edit Screen (see page 25) Pull Types If you select the database Identity LDAP pull, additional fields appear like these examples: The additional fields are: Host Enter the name of the host database server where this database resides. Include the domain and computer name where appropriate.
Collaboration Administrator Manual Database From the drop-down list, select the SQL database you want to share. For more on this type, refer to SQL Edit Screen on page 24. If you select the identity database Oracle RDBMS, additional fields like this example appear: The additional fields are: Host Enter the name of the host database server where this database resides. Include the domain and computer name where appropriate.
Collaboration Administrator Manual Collaboration Listing Page When you select the Collaboration icon, the Collaboration Listing page appears like the following example: This page displays the following buttons and fields: Name Name of the collaboration. Click this name to bring up the Collaboration Edit page. Installed if this collaboration is enabled; if this collaboration is currently disabled. Click this link to change the state of this installation.
Collaboration Administrator Manual Collaboration Edit Screen Depending on the type of collaboration you selected on the add page, this screen can consist of anywhere from one to seven tabbed pages as shown in the following examples: All editable pages include the following fields and buttons: Name Enter the name of this collaboration. Installed Click to check this box if this collaboration is currently enabled.
Collaboration Administrator Manual Collaboration Types The types of collaboration available in this application include: Option Explanation Identity CSV OneTime Upload Upload identities, tokens, groups, roles from an uploaded CSV file and keep the Access Control Manager identity database in sync with changes. For more on using this collaboration type, see CSV Uploads on page 16.
Collaboration Administrator Manual To perform this operation: 1. If not already done, define one of the collaborations supported by this feature. 2. From the Collaboration Listing page, click the green check mark, column. , from the ‘Run’ You are asked to confirm this operation. 3. Select Yes. The operation, whether it is a pull or an upload, is performed.
Collaboration Administrator Manual Collaboration Details The chapter discusses the various fields available on the Collaboration pages as well as details the fields contained on the various Collaboration pages.
Collaboration Administrator Manual The fields on this page include: Name If required, modify 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 This read-only field indicates the type of collaboration this is.
Collaboration Administrator Manual CSV One-Time Upload Edit Screen 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.
Collaboration Administrator Manual Preparing the CSV File To properly upload a CSV file into the application, it is important that the data be formatted correctly and the CSV created properly. Use the CSV upload example template on page 19 to aid in creating an identity CSV file. The very first row of the CSV file is reserved for column headers. Make sure that the data in the rows reflects the column names. Moving a date or name to a different column will cause the identity CSV upload to fail.
Collaboration Administrator Manual First Name The user ID's first name and is a required value. The first name is a string and will accept alphanumeric characters as well as hyphens, underscores, etc. Last Name The user ID's last name and is a required value. The last name is a string and will accept alphanumeric characters as well as hyphens, underscores, etc. Middle Name The user ID's middle name.
Collaboration Administrator Manual Site Location The user ID's site location and can be any title the user needs. Default site locations currently are: North, South, East, West. Any value entered here that is not on the option list must be defined in the Settings > User Lists option of the main application in order for the pick list to display the value properly. The entered value is a string match with the corresponding User List value, be sure to spell properly and remember the value is case sensitive.
Collaboration Administrator Manual LDAP Edit Screen If you create an Identity LDAP Pull collaboration type, a multi-page edit screen like this example appears: This screen includes the following pages: • • • • • • • Blob (see page 26) Identities (see page 28) Roles (see page 28) Schedule (see page 29) Source (see page 29) Tokens (see page 30) User Defined (see page 31) Milestone Video Edit Screen If you select the Events - Milestone video collaboration type from the collaboration add page, a screen like
Collaboration Administrator Manual Require TCP Check this box to indicate that the transfer of data between the designated host server that contains the database and this application is being conducted over the network.
Collaboration Administrator Manual Type Indicates the device type. Host Enter the name of the host computer where this database resides. Include the domain and computer name where appropriate. Port Number Enter the port number at the host computer that should be used for extracting the database information from the specified host.
Collaboration Administrator Manual SNMP Edit Screen If you edit an Events - SNMP collaboration type, a screen like this example appears: These editable pages appear: • • SNMP Events (see page 27) For a description of each page and the type-specific fields that appear on them, see below. SNMP Page This page includes these type-specific fields: Host Enter the name of the host computer where this database resides. Include the domain and computer name where appropriate.
Collaboration Administrator Manual Splunk Page This page includes these type-specific fields: Host Enter the name of the host computer where this database resides. Include the domain and computer name where appropriate. Port Number Enter the port number at the host computer that should be used for extracting the database information to the specified host.
Collaboration Administrator Manual This screen includes these tabbed pages: • • Syslog Events (see page 27) These editable pages and the type-specific fields on them are described below. Syslog Page This page includes these type-specific fields: Host Enter the name of the host computer where this database resides. Include the domain and computer name where appropriate.
Collaboration Administrator Manual Blob Page When you click the Blob tab from the LDAP, Oracle RDBMS Pull, or SQL edit screen, a page like these examples appear: The Blob page includes the following type-specific fields: Table Select the database table from which the data will be extracted. Base DN Enter the distinguished name for this database source from which the data will be extracted.
Collaboration Administrator Manual Events Page If you select the Events tab from the ArcSight CEF, Splunk Edit, Milestone, Pelco Digital Sentry, Pelco Endura, SNMP, SysLog, or XML edit screen, a page like one of these examples appears: The type-specific fields on this page include: Schedule Select from the drop-down list the schedule during which this collaboration is operative. Only those schedules previously defined by the system or the operator are shown in this list.
Collaboration Administrator Manual Identities Page When you click the Identities tab from the LDAP, Oracle RDBMS Pull, or SQL edit screen, a page like this example appears: The Identities page includes the following type-specific fields: Table Select the database table from which the data will be extracted. Filter Enter the criteria to use in selecting elements within the scope of available identities. Attributes Specify each field type to be extracted.
Collaboration Administrator Manual Schedule Page When you click the Schedule tab from the LDAP, Oracle RDBMS Pull, or SQL edit screen, a page like this example appears: The Schedule page includes the following type-specific fields: Every Enter the interval required during the active period that a transfer can take place. Specify both the value and select the appropriate unit (seconds, minutes, hours).
Collaboration Administrator Manual Connection Options Enter the options required for the connection between the database server and the Access Control Manager engine. This is SQL or Oracle only. Database Enter the name of the database within the database server to transfer to the Access Control Manager engine. This is SQL or Oracle only. Instance Enter the instance within the database to which to connect. This is SQL or Oracle only.
Collaboration Administrator Manual User Defined Page When you click the User Defined tab from the LDAP, Oracle RDBMS Pull, or SQL edit screens, a page like this example appears: The User Defined page includes the following type-specific fields: Table Select the database table from which the data will be extracted. Filter Enter the criteria to use in selecting elements within the scope of available user definitions. Attributes Specify each field type to be extracted.
