Configuring IPICS Integration Module
Release 5.1
About the IPICS Integration Module for PSOM
The Cisco IP Interoperability and Collaboration System (Cisco IPICS) portfolio of products and
applications streamlines daily operations and allows organizations to rapidly respond to incidents or
emergencies. It dissolves communications silos between disparate Land Mobile Radio systems and
devices such as mobile phones, landline phones, IP phones, and PC clients-users can communicate with
whatever device they have, from wherever they are. Users can be paged or e-mailed with the status of an
event, and can be automatically called and invited to join a virtual conference, further improving
situation awareness and reducing response time.
The IPICS Integration Module communicates with Cisco IPICS Server to dispatch PSOM alerts to IPICS
and execute IPICS Policies from the PSOM Operation Console.
Version Mapping
Table 1 shows the Cisco IPICS version and how it maps to the version of the IPICS Integration Module
that should be used for integration.
Table 1
Cisco IPICS and IPICS Integration Module Version Mapping
Cisco IPICS version
IPICS Integration Module Version
4.0
4.0
Permissions Required
To configure Cisco IPICS to integrate with PSOM, you must belong to the local Administrators group.
Americas Headquarters:
Cisco Systems, Inc., 170 West Tasman Drive, San Jose, CA 95134-1706 USA
Using the Integration Module Wizard to Set Up the IPICS Integration Module
Prerequisites
Before configuring the IPICS Integration Module, the following actions must be taken:
•
Install Cisco IPICS 4.0.
•
PSOM Connector Web Service must be properly set up and configured on the Connector Web
Service.
Configuring the IPICS Integration Module
There are two methods of configuring the IPICS Integration Module, as covered by the remaining
sections in this guide:
•
Using the Integration Module Wizard. See the “Using the Integration Module Wizard to Set Up the
IPICS Integration Module” section on page 2.
•
Using Connector Web Service and the Plugin Pages. See the “Using Connector Web Service and the
Plugin Pages to Set Up the IPICS Integration Module” section on page 8.
Using the Integration Module Wizard to Set Up the IPICS
Integration Module
Running the Integration Module Wizard creates a configuration file defining your settings for the IPICS
Integration Module, and saves it in the [wwwrootDirectory]\PxConnectorWS\App_Data directory
(normally C:\inetpub\wwwroot\PxConnectorWS\App_Data). You can view the finished configuration
by examining the file which is typically named config[INSTANCENAME_VERSION_IPICS].xml.
To run the Integration Module Wizard:
Step 1
Click the Event Integration icon in the Administration Console.
Click the
Event
Integration
icon.
Step 2
Click the Integration Modules icon in the Administration Console.
Configuring IPICS Integration Module
2
OL-24238-01
Using the Integration Module Wizard to Set Up the IPICS Integration Module
Click the
Integration
Modules icon.
The General Integration Module Configuration window appears.
Select IPICS (4.0) and
click Add Instance.
Step 3
Select IPICS (4.0) and click Add Instance.
The Configure General Integration Module window appears.
Configuring IPICS Integration Module
OL-24238-01
3
Using the Integration Module Wizard to Set Up the IPICS Integration Module
Step 4
Enter an alpha-numeric descriptor for this specific instance of IPICS Integration Module in the Enter
instance name field. Once the sensors are put into PSOM environment, they are referenced by the
instance name specified in this field. This makes it possible for the Connector Web Service to be moved,
or the IPICS Server to be reconfigured, without affecting existing PSOM sensors as long as the instance
name remains the same.
Step 5
In the Enter a description for the instance field, enter a short description that can be viewed in relevant
PSOM Consoles.
Step 6
Select the version of IPICS with which you are integrating from the Select the proper version field.
There is only one version available.
Step 7
Click Next.
The IPICS WebService Info window appears.
Configuring IPICS Integration Module
4
OL-24238-01
Using the Integration Module Wizard to Set Up the IPICS Integration Module
Step 8
Provide the IP address or server name where the IPICS Server is running in the IPICS Server Name
field.
Step 9
Enter the account that the IPICS Integration Module will use to communicate with the IPICS Server in
the IPICS User Name field. This account should have dispatch privileges in IPICS.
Step 10
Enter the password for the IPICS user name in the IPICS Password field.
Step 11
If you want to enable SSL communication between the IPICS Server and the IPICS Integration Module,
check the Enable Encrypted Communication option.
Note
Step 12
The IPICS Server needs to be enabled for SSL communications if this option is checked.
Click Next.
The IPICS WebService Info window appears.
Configuring IPICS Integration Module
OL-24238-01
5
Using the Integration Module Wizard to Set Up the IPICS Integration Module
Step 13
Provide the IP address or server name where the Connector Web Service is running and the IPICS
Integration Module is hosted in the Web Service Host field. This should be left as default.
Step 14
Enter the user name that the Connector Web Service will use to communicate with PSOM in the Login
user name field. This should be left as default.
Step 15
Enter the corresponding password in the Login password field.
Step 16
Click Finish.
After the validation is finished, the configuration file is sent to the Connector Web Service and the IIS
Server hosting the Connector Web Service will be restarted.
A confirmation dialog box appears.
Step 17
Click OK.
The final window appears.
Configuring IPICS Integration Module
6
OL-24238-01
Using the Integration Module Wizard to Set Up the IPICS Integration Module
Step 18
Click Close.
The General Integration Module Configuration window now shows the new instance of the IPICS
Integration Module.
Configuring IPICS Integration Module
OL-24238-01
7
Using Connector Web Service and the Plugin Pages to Set Up the IPICS Integration Module
Using Connector Web Service and the Plugin Pages to Set Up
the IPICS Integration Module
To configure the IPICS Integration Module with Plugin Pages:
Step 1
From the machine where Connector Web Service is installed, open Internet Explorer and navigate to
http://localhost/PxConnectorWS/PluginPages/default.aspx.
The Connector Plugin Configuration window appears.
Step 2
Click Add Instance next to IPICS under Available to be Deployed.
The IPICS Instance Configuration window appears.
Configuring IPICS Integration Module
8
OL-24238-01
Using Connector Web Service and the Plugin Pages to Set Up the IPICS Integration Module
Step 3
Provide values for the IPICS Integration Module parameters as explained in Table 2.
Table 2
IPICS Integration Module Parameters
Parameter
Description
Instance Name
If there are multiple IPICS Servers, please assign unique names for
each instance of the IPICS Integration Module that you create to
access an actual IPICS Server.
Instance Description
A description that identifies this IPICS Integration Module.
Time Zone Offset
You may leave this value set to zero (0).
IPICS Server
The IP address where the IPICS Server is running.
IPICS User Name
An account that the IPICS Integration Module will use to
communicate with the IPICS Server. This account should have
dispatch privileges in IPICS.
IPICS Password
The corresponding password.
Web Service Host Name
The name of the machine where the Connector Web Service is
running and the IPICS Integration Module is hosted. This should be
left as default.
User name
The user name for logging into PSOM.
Password
The corresponding password for PSOM.
Enable SSL
Whether to enable SSL communication between the IPICS Server
and IPICS Integration Module.
Note
The IPICS Server needs to be enabled for SSL
communications if this option is checked.
Configuring IPICS Integration Module
OL-24238-01
9
Using Connector Web Service and the Plugin Pages to Set Up the IPICS Integration Module
Step 4
Click Add Instance.
If the IPICS Integration Module is properly configured, this screen appears.
Step 5
Click Get Sensors next to IPICS under Deployed Plugins.
The window that appears shows the IPICS Server and IPICS sensor(s) that can be accessed by the IPICS
Integration Module. The unique identifier for each IPICS sensor shown in the Sensor DeviceID column.
Configuring IPICS Integration Module
10
OL-24238-01
Using the IPICS Integration Module
Step 6
Click Get Sensor based Bulk Insert Xml to generate XML for performing a bulk-import of IPICS
sensors into the PSOM Repository.
Step 7
Copy the XML from the Data area in the window that appears, open Notepad, and paste the XML. Save
the Notepad data to a file with an .xml extension.
Step 8
Restart all PSOM services as described in the “Starting and Stopping PSOM Services” in the
Administering Cisco Physical Security Operations Manager guide.
Important: If the Bus Service is not running in the local machine, then it may take a few minutes for
changes to be reflected. If the Bus Service is running in the same machine, these changes will be
immediately reflected. If Bus Service running on a another machine, please wait a few minutes for the
updates to be picked up or restart the Bus Service for immediate update.
Using the IPICS Integration Module
Once the IPICS Integration Module is successfully installed and configured, you will be able to dispatch
PSOM alerts to the IPICS system and execute IPICS policies from the PSOM Operation Console or via
Business Logic.
IPICS Integration with the Operation Console
In the Operation Console, a Notify icon will appear in the task ribbon at the top of the main window.
Configuring IPICS Integration Module
OL-24238-01
11
Using the IPICS Integration Module
Click on any alert to view its Alert Details window. You will see two new actions: Dispatch and Notify.
Configuring IPICS Integration Module
12
OL-24238-01
Troubleshooting
To send information about the alert to IPICS Server, click the Dispatch button at the top right of the
window. In the dialog box that appears, click Yes. If the dispatch was successful, the IPICS Integration
Module created an incident in IPICS Server with the alert information from PSOM, an image of the
alert's sensor location (the alert mini-map), any images attached to the alert, and any related video
information.
To send a request to the IPICS Server to execute a specific IPICS policy, click the Notify button at the
top right of the window. The Send Notification To The Selected Policy window appears. Select an IPICS
policy from the policy list, enter desired notification text, and click OK. If the notification was
successful, the IPICS Integration Module sent a request to the IPICS Server to execute the specified
policy along with any notification text.
IPICS Integration with Business Logic
There are two business logic components for IPICS that can be integrated with PSOM using the Business
Logic Designer to enable PSOM to automatically execute IPICS policies or issue notifications to an
IPICS Server version 4.0. To use these components, the IPICS Integration Module must be installed and
configured.
•
IPICS Dispatch Alert component—Enables PSOM to automatically dispatch an alert to an IPICS
Server.
•
IPICS Notify Alert component—Enables PSOM to automatically execute IPICS policies on an
IPICS Server.
See the “Business Logic Component Reference” chapter in the Administering Cisco Physical Security
Operations Manage guide for details.
Troubleshooting
This section describes troubleshooting steps.
Configuring IPICS Integration Module
OL-24238-01
13
Troubleshooting
Situation
Resolution
Dispatch or Notify buttons do
not appear in the Alert Details
window of the Operation
Console.
Verify that IPICS IM is installed and operational:
•
Open the Administration Console.
•
Click Event Integration > Integration Modules.
•
Verify that an instance of IPICS is configured. If so, a check
mark appears next to IPICS in the list of modules. If not,
click Add Instance and complete the configuration process.
Verify that the PxConnectorService_XXXX.log file exists in the
c:\inetpub\wwwroot\PxConnectorWS\log directory. Open the
log file and find an entry similar to the following:
2010-06-28 10:36:05.9 [ 9][I] [PxPluginInstanceHost]
Done initializing
instance:INST[IPICSInst1]:VERS[4.0]:PROV[IPICS]
Restart the Operation Console.
Verify that Dispatch and Notify buttons appear in the Alert
Details window.
Dispatched alerts do not appear Verify that IPICS IM is installed and operational.
in IPICS.
Verify that the IPICS Server is operational.
Verify that you can login and view the IPICS Web Console by
navigating a web browser to http://<ipics_server_address>/.
Verify that there are no error messages after you click the
Dispatch button by opening the IPICS Integration Module log
file stored in c:\inetpub\wwwroot\PxConnectorWS\log\
PxConnectorService_XXXXXX.log.
A mini-map of the alert
Verify that the IPICS Integration Module is installed and
location (PxMinimap) does not operational.
appear in IPICS.
Verify that the PSOM Reporting Service is installed and
operational by clicking the User Services Controller icon in the
Windows task bar and verifying that the Reporting Service entry
is running.
Click the Dispatch button and verify that no error messages
appear in the Operation Console or the IPICS Integration Module
log file.
Contact your IPICS Server Administrator and verify that images
are being uploaded to the IPICS Server.
Check the IPICS Server log for any errors.
Configuring IPICS Integration Module
14
OL-24238-01
Troubleshooting
Situation
Resolution
Images attached to alerts to not
appear in IPICS. The IPICS
Integration Module should
forward any images annotated
to an alert to the IPICS Server
as part of the IPICS incident
media files.
Verify that there are images attached to the alert by opening the
Alert Details window and clicking Notes to view associated
images.
Check the IPICS Integration Module log file for any errors.
Contact your IPICS Server Administrator and verify that images
are being uploaded to the IPICS Server.
Check the IPICS Server log for any errors.
Video attached to an alert does
not appear in IPICS. The IPICS
Integration Module should
forward any video related to an
alert to the IPICS Server when
the alert is dispatched, making
the video easily viewable
through the IPICS Dispatch
Console (IDC).
Verify that the Cisco Video Service is installed and operational.
In the Administration Console, click Video Integration and then
Video Services. The Video Service Integration Module
Configuration window should show a check next to Cisco video
service.
If the Cisco Video Service is not installed, double-click the
PxVideoAdaptorSetup-Ciscox.x.msi file in the
\VideoAdaptorInstallers directory of the PSOM installation
media and complete installation. Then return to the Video
Service Integration Module Configuration window in the
Administration Console and click Configure next to the Cisco
video service. Complete configuration and restart the Operation
Console.
Verify that there is a Cisco camera sensor associated with the
sensor that generated the alert. To do so, open the Administration
Console and click Environment, then click Sensors, and click
the Sensor Groups tab. Verify that the sensor associated with the
dispatched alert is in a camera group that includes a Cisco
camera sensor.
Check the IPICS Integration Module log file for any errors.
Verify the video link entry in the Cisco IPICS Dispatch Console
(IDC) by double-clicking the incident, locating the Dispatched
Alert Video entry in the incident media list pane, and clicking
the video URL at the bottom to verify that it is a valid link.
Cisco and the Cisco Logo are trademarks of Cisco Systems, Inc. and/or its affiliates in the U.S. and other countries. A listing of Cisco's trademarks
can be found at www.cisco.com/go/trademarks. Third party trademarks mentioned are the property of their respective owners. The use of the word
partner does not imply a partnership relationship between Cisco and any other company. (1005R)
© 2011 Cisco Systems, Inc. All rights reserved.
Configuring IPICS Integration Module
OL-24238-01
15
Troubleshooting
Configuring IPICS Integration Module
16
OL-24238-01