Getting Started With the Cisco PAM Desktop Software
This chapter describes how to install the Cisco PAM desktop client software, log on to Cisco PAM, and begin configuring access control features and doors. This chapter also includes an overview of the Cisco PAM user interface.
Tip See Installation and Configuration Summary, page 1-3 for an overview of installation and configuration tasks.
•Before You Begin
•Installing or Updating the Cisco PAM Desktop Software
•Logging in to Cisco PAM
•Understanding the Start Page and Window Management
•Keeping a Module On Top
•User Interface Elements
–Revising the Column Display
–Using Group Edit
Before You Begin
Before you being using the Cisco PAM desktop software to configure Cisco Physical Access Control, do the following:
•Verify that your computer is connected to the Internet, including access to the Cisco PAM appliance Cisco Physical Access Control IP network.
•Verify that your PC meets the following requirements:
–Microsoft Windows XP or Vista
–Java 6.0 or higher (JDK 1.6 or higher). To download Java, go to http://www.java.com/en/download/manual.jsp.
–2.8 GHz Intel Pentium IV processor or higher.
–1GB RAM or more.
–100 MB hard disk space available for the application, and an additional 20 GB or more disk space for data storage.
•Obtain your username and password from your system administrator.
Installing or Updating the Cisco PAM Desktop Software
To install the desktop software, you must connect to the Cisco PAM Server Administration utility.
Always upgrade the Cisco PAM desktop client when the server software is upgraded. If the versions are not the same, an error occurs when launching the desktop client.
Step 1 Log on to the Cisco PAM Server Administration utility:
•To use a direct connection, see Connecting a PC to the Appliance, page 2-5.
•To use an Internet connection, open a web browser and enter the IP address used for the Cisco PAM Server Administration utility. See Understanding IP Addresses on the Cisco PAM Server, page 2-3, or ask your system administrator for assistance.
Step 2 Select Launch Cisco PAM Client from the Login window, as shown in Figure 3-1.
•If the correct version of the Cisco PAM desktop is already installed on your PC, the application launches.
•If the client is not installed, or is out of date, the software is installed or updated on your PC. The Java runtime environment software is also installed or updated.
•If the download fails, check your Java Web Start network settings. The Cisco PAM client launches using Java Web Start.
Figure 3-1 Cisco PAM Server Administration Utility: Login
Tip For additional methods to install or upgrade the Cisco PAM desktop software using the Cisco PAM Server Administration utility, See Using the Web Admin Menus, Commands and Options, page 2-16.
Logging in to Cisco PAM
Launch the Cisco PAM desktop client software to display the login prompt (Figure 3-2).
Figure 3-2 Login Screen
Step 1 Enter the server IP address of the Cisco PAM appliance. Click the arrow next to the field to select a previous entry (the system remembers the last five server addresses).
Step 2 Enter your username and password (both are case-sensitive).
Step 3 Choose a language, if available.
Step 4 (Optional) Select Dual-language mode to display both languages in the application.
Step 5 Click Log In.
If the username and password are valid, Cisco Physical Access Manager displays the Start Page, or the modules that were open during the operator's previous session.
Tip To change your password, log on to the Cisco PAM appliance and select Change Password from the Options menu.
Understanding the Start Page and Window Management
The Start Page is opened by default when you open the Cisco PAM desktop client for the first time, as shown in Figure 3-3. The main menus provide access to Cisco PAM features, and are also displayed in the main window for each feature.
Figure 3-3 Cisco PAM Start Page
Note The available modules vary depending on the software license purchased and the operator's access privileges. Some menus are activated only after the feature license is installed. See Obtaining and Installing Optional Feature Licenses, page 2-42 and Chapter 4, "Configuring User Access for the Cisco PAM Desktop Client".
Select a menu item to open the main window for that feature in a new window, as shown in Figure 3-4. You can open multiple module windows simultaneously and drag the windows across multiple monitors. The size and position of the open windows is restored when you log out and log back in.
Figure 3-4 Device Templates Main Window
Keeping a Module On Top
You can configure a Cisco PAM module to be always displayed on top. When Cisco PAM is open, the selected module always remains on top of other Cisco PAM windows, or any other applications.
To configure a window to always be on top:
Step 1 Select Always on Top from the Options menu, as shown in Figure 3-5.
Step 2 Click OK to close the confirmation message.
Step 3 Close the window and reopen it for changes to take effect.
Tip Before closing the window, be sure another Cisco PAM module is open or the application will quit.
Figure 3-5 Always on Top
Note When selected, Always on Top is displayed with a check (Figure 3-7). The setting remains in effect even if you close and then reopen the window.
Choosing Multiple Always on Top Windows
You can select more than one window to be on top. The windows remain on top of all other windows, except each other. Click an Always on Top window to bring it to the front.
When you select additional Always on Top windows, you must click the confirmation message (Figure 3-6), and then close and reopen the window.
Note If the confirmation message is hidden behind an existing Window on Top, rearrange the windows so you can clear the message.
Figure 3-6 Always on Top Conformation Message
Deselecting Always on Top
To deselect Always on Top, do the following:
Step 1 Deselect Always on Top to remove the check (Figure 3-7).
Step 2 Click OK to close the confirmation message (Figure 3-6). If the confirmation message is hidden behind an existing Window on Top, rearrange the windows so you can clear the message.
Step 3 Close the Cisco PAM window and reopen it for changes to take effect.
Step 4 Repeat these steps to deactivate Always on Top for additional windows.
Figure 3-7 Deselecting Always on Top
User Interface Elements
The user interface for most features includes the following elements:
Figure 3-8 User Interface Elements
The following items are shown in Figure 3-8:
Table 3-1 User Interface Elements
Window Title Bar
Shows the module and application name (for example: Events - Cisco Physical Access Manager).
Allows the operator to perform a number of functions, including open a new module, close a module or the application, and get help. The menu bar is the same for all modules.
Column visibility and order may be edited using the Columns... button. Column width may be adjusted by dragging the edge of the column header. Clicking the column header allows the list to be sorted by a particular column. A directional arrow shows the current sort column, as well as the direction. Clicking the column header a second time reverses the sort order. See Revising the Column Display.
Contains a set of button functions that are specific to the module being used. Typical buttons include:
•Scroll Lock: Disable or enable automatic scrolling of the list as new items are inserted.
•View... or Edit...: View or edit the selected item in a detail window.
•Add...: Add a new item.
•Disable or Delete: Disable or delete the selected item.
•Report...: Display the available data as a report, which may be printed or saved as a PDF. See Creating Reports.
•Filter: Select or edit a filter. This determines which items are visible in the table. See Using Filters.
•Columns...: Configure which columns are visible, and the order in which they appear. See Revising the Column Display.
•Group Edit: Make changes to all items displayed in a module table. See Using Group Edit.
•Quick Search: Quickly search results in the main module window. See Search.
Shows a list of items. Selecting an item within the table enables the use of certain buttons, and right-clicking an item brings up a menu of actions performable upon that item. Each module will have a different table.
Appears at the bottom of each module window. It is divided into 4 panes:
•Pane 1: If there are any uncleared alarms, this pane displays a colored and or blinking icon showing the alarm status. This pane is not pictured in the above figure.
•Pane 2: If there are any uncleared alarms, this pane displays text describing the number of alarms, as well as their state. This pane is not pictured in the above figure.
•Pane 3: Shows the number of items in the table.
•Pane 4: Displays the username of the logged-in operator, as well as the IP address or hostname they are logged in from.
The toolbar includes a common set of features used to sort and revise information and records. This section includes the following information:
•Revising the Column Display
•Using Group Edit
Many Cisco PAM modules include a Report feature. The following example describes how to create an Events report.
Step 1 Open the desired module (in this case the Events module) by selecting it from the Start Page or from the Module menu.
Step 2 Click the Report... button in the toolbar. This opens the Report Generation window (Figure 3-9).
Figure 3-9 Report Generation Window
The following items are shown in Figure 3-9:
The title of the report.
Include available details in report
Depending on the type of objects in the report (event, badge, personnel record, etc.), there may be additional details that are available to be included in the report. If so, these will be available as checkboxes. For example, in a report of personnel records, checking the Badges option will include a list of badges assigned to each person.
If this option is set to something other than [None], the items in the report will be grouped by the specified property, with a header for each group.
•Record-style: displays the data similarly to the layout of an address book, and in a portrait (vertical) view.
•Table-style: displays the data in a grid layout, similar to a spreadsheet, and in a landscape (horizontal) view.
•Open in report viewer: Opens the report with an integrated report viewer.
•Save as document: Saves the report as an HTML document.
•Open as document: Allows you to open the report in a number of formats, including PDF document, Excel spreadsheet, OpenDocument Text, Text (tab-deliminated), HTML, and OpenDocument Spreadsheet.
Step 3 Choose the desired options, and then click OK to save or open the report. This may take a moment, depending on the size and complexity of the report. Figure 3-10 shows a report in PDF format from the Events module.
Figure 3-10 Events Report in Report Viewer
Many Cisco PAM modules include a Filter button that provide the following options:
•No Filter: Show all items, without filtering.
•Default Filter: The default view of the table. Shows all enabled items.
•Presets: Select from preset filters. A check mark next to the filters displays which filter is currently in use, as shown in Figure 3-12.
•Preset Manager...: Manage the presets.
•Edit Filter...: View or edit the current filter.
•Max rows...: Specify the maximum number of items (rows) to be displayed. Some items, such as events, often exist in such large quantities that viewing them all simultaneously is impractical.
When editing or viewing a filter, the operator may select or enter the various criteria to filter by. In addition, the following actions are available:
•View Query...: View the filter as an SQL-like expression. This feature is intended for advanced operators.
•Save as Preset...: Save the current filter as a preset, which can be quickly accessed from the Filter button.
•Reset: Reset the filter to the default.
•OK: Apply the changes to the filter and close.
•Cancel: Cancel any changes to the filter and close.
To create a filter in the Events module, do the following:
Step 1 Select Events from the Events & Alarms menu, in the Monitoring sub-menu.
Step 2 Click Filter in the toolbar to open the filter window, as shown in Figure 3-11.
Figure 3-11 Filter - Event Window
Step 3 Specify the object filtering criteria:.
•The General, Personnel Record, Credential, Badge, Login, and Device tabs on the left specify the event criteria, such as the event's properties or associated objects.
•The View Query... button opens a window detailing the actual filter definition as an SQL-like expression string.
•The Save as Preset... button saves the filter criteria as a named preset for later use. Once a filter is saved as a preset, it can be selected from the Filter button drop-down menu, as shown in Figure 3-12.
•The Reset button clears the filter so that all enabled items will be displayed.
Figure 3-12 Filter Presets
Step 4 Choose the criteria to filter by, then click the OK button. This closes the window, and the table view is updated to reflect the filter criteria. Incoming events will also be filtered according to these criteria.
Revising the Column Display
The Columns... button in the toolbar allows you to change the order and visibility of columns.
Click the Columns... button to open the window shown in Figure 3-13.
•Select or deselect the checkboxes next to the column names to determine which columns are visible in the table view.
•Select a column name and click the Up and Down buttons to change the order that the columns appear.
•Click OK to save your changes and view them in the module.
Figure 3-13 Columns Window for the Event Manager
Tip Adjust column width by dragging the edge of the column header. Click on a column header to sort the table by that particular column. A directional arrow shows the currently sorted column, as well as its direction. Reverse the sort order by clicking on the column header a second time.
Using Group Edit
The Group Edit button allows you to make changes to all items in a list, or multiple selected items. Group Edit... is included in the Badges and Personnel modules.
Tip To limit the items in the list, filter the content as described in Using Filters before using group edit.
Right-click the Group Edit button in the Badges and Personnel and select Group Edit All Items or Group Edit Selected Items.
Group Edit Example
In the following example, a group edit is used to change all contractor issued badges to inactive.
Step 1 Select Badges from the User menu.
Step 2 Filter the list so it contains only the records to be changed.
a. Click the Filter button in the toolbar.
b. Select the Assigned to tab.
c. Select Contractor in the Personnel type field.
d. Click OK to filter the badges to contractor personnel types.
See Using Filters for more information.
Step 3 In the Badges window, click the Group Edit... button to open the Group Edit... window, as shown in Figure 3-14.
Figure 3-14 Group Edit - General Window
Step 4 Select the Validity checkbox, and then select Inactive from the drop-down menu.
Step 5 Click OK.
Step 6 All Contractor badges in the filtered list are now changed to Inactive.
Search allows operators to quickly search results in the main module window. Type in a search field and click the Search button or press the Enter key. To remove the search clear it out and click the Search button.
Use the drop down arrow to select the different methods of quick search. Options include:
•Quick search with filter: Search within the results of the current Filter set.
•Quick search instead of filter: Search without regard to any filter that is currently defined.