-
Cisco IPICS Server Administration Guide - Release 4.0
-
Preface
-
Introducing Cisco IPICS
-
Performing Cisco IPICS System Administrator Tasks
-
Performing Cisco IPICS Operator Tasks
-
Performing Cisco IPICS User Tasks
-
Performing Cisco IPICS Dispatcher Tasks
-
Using the Cisco IPICS Policy Engine
-
Configuring and Managing Cisco IPICS Operational Views
-
Configuring and Managing the Cisco IPICS Policy Engine
-
Managing Radios and Radio Descriptors
-
Configuring and Managing Cisco IPICS High Availability
-
Performing Cisco IPICS Database Backup and Restore Operations
-
Understanding Cisco IPICS Serviceability and Diagnostic Information
-
Configuring the Cisco IPICS RMS Component
-
Using Cisco IPICS for External Notifications
-
Setting Up and Using a Cisco Unified IP Phone as a Cisco IPICS Push-to-Talk Device
-
Generating SSL Certificates for IPICS Mobile Clients
-
Frequently Asked Questions
-
Glossary
-
Index
-
Feedback
Table Of Contents
Performing Cisco IPICS System Administrator Tasks
Managing PTT Channels and Channel Groups
Understanding the Channels Window
Viewing and Editing Channel Details
Changing the Status of a PTT Channel
Understanding Association Attribute Behaviors
User-Channel Association Example
Associating PTT Channels to Ops Views
Associating Users to PTT Channels
Associating Radio Control Signals to PTT Channels
Understanding the Channel Groups Window
Viewing and Editing Channel Group Details
Viewing Channel Group Associations
Removing a PTT Channel from a Channel Group
Associating Ops Views to Channel Groups
Predefined Cisco IPICS Locations
Summary of Access Types and Connections
Understanding the Locations Window
Understanding the Multicast Pool Window
Guidelines for Using IP Multicast Addresses with Cisco IPICS
Viewing and Editing Multicast Address Information
Viewing and Editing RMS Details, Activating an RMS, and Deactivating an RMS
Editing or Viewing RMS Details
Deactivating or Activating an RMS
Viewing and Configuring Loopbacks
Viewing Detailed Information about a Loopback
Managing the RMS Configuration
Understanding the Incidents Window
Changing the Status of an Incident
Downloading Archived Incidents
Understanding the License Management Window
Understanding Time-bound License Behavior
Understanding the Activity Log Management Window
Viewing and Downloading Activity Logs
Downloading Archived Activity Logs
Managing Activity Log Options Per Ops View
Understanding the IDC Versions Window
Uploading IDC Versions to the Cisco IPICS Server
Changing the State of IDC Versions
Creating an IDC Alert Tone Set
Viewing or Editing IDC Alert Tone Sets
Associating an Alert Tone Set to an Ops View
Using the IDC Installer Window
Understanding the IDC Regions Window
Viewing or Editing IDC Regions
Performing Cisco IPICS System Administrator Tasks
The Cisco IPICS system administrator is responsible for installing the Cisco IPICS software and for setting up Cisco IPICS resources, including servers, routers, multicast addresses, locations, and PTT and radio channels. The system administrator also manages the Cisco IPICS licenses and IDC versions, monitors the status of the system, reviews log files, as needed, and creates operational views.
In addition, the system administrator is responsible for managing radios and radio descriptors, managing optional high availability, and performing backup and restore operations. For more information, see Chapter 9, "Managing Radios and Radio Descriptors," Chapter 10, "Configuring and Managing Cisco IPICS High Availability," and Chapter 11, "Performing Cisco IPICS Database Backup and Restore Operations."
Most of the system administrator activities that you perform are accessible from the Administration Console Configuration and Administration drawers. To access these drawers, log in to the Administration Console as described in the "Accessing the Administration Console" section on page 1-15, then choose the Configuration or the Administration drawer.
Note
You must be assigned the system administrator role to access the Configuration and Administration drawers.
The following sections describe many of the system administrator activities that you can perform from the Cisco IPICS Administration Console:
•
•
For information about managing operational views in the Ops Views window, see Chapter 7, "Configuring and Managing Cisco IPICS Operational Views."
For information about managing database backup and restore operations in the Database Management window, see Chapter 11, "Performing Cisco IPICS Database Backup and Restore Operations."
Managing PTT Channels and Channel Groups
A PTT channel, also referred to as a channel, is a communications path that allows users to communicate with each other. A Cisco IPICS channel defines and describes the specific content stream of the channel regardless of the source of that content. Channel connections distinguish one content stream from another, and are determined by location.
A channel carries traffic to and from a VTG, a land mobile radio (LMR) gateway, an IDC, and an IP phone. Remote IDC users can connect to a channel by using a unicast SIP connection to an RMS component.
A channel can also refer to a radio control interface (radio or radio channel), which also has an audio stream. For information about managing radios in Cisco IPICS, see Chapter 9, "Managing Radios and Radio Descriptors."
A channel group is a logical grouping of PTT channels. Channel groups allow Cisco IPICS dispatchers to work with multiple PTT channels efficiently. For example, instead of dragging individual PTT channels one at a time to set up a VTG, a Cisco IPICS dispatcher can drag a channel group to move all associated channels in the group. A PTT channel can be in as many channel groups as you require.
As a Cisco IPICS system administrator, you can perform the following PTT channel and channel group management tasks:
Channel Management Tasks
•
•
•
•
•
•
Channel Group Management Tasks
•
•
•
•
You perform the PTT channel management tasks in the Channels and Channel Groups windows, located in the Configuration drawer of the Administration Console. For more information about these windows, including how to access them, see the "Understanding the Channels Window" section and the "Understanding the Channel Groups Window" section.
Understanding the Channels Window
The Channels window lists information about each of the channels that you have added in Cisco IPICS.
The bottom area of this window displays a list of Cisco IPICS channels and general information for each channel. By default, this area displays all channels, but you can choose to display only channels that match search criteria that you specify in the top area of the window.
Note
This window also enables you to perform several channel management functions. To display the Channels window, access the Configuration drawer; then click Channels.
Table 2-1 describes the items in the Channels window.
Table 2-1 Items in the Channels Window
Channel Name field
This field allows you to display only channel names that include the character string that you enter (characters are not case-sensitive).
To limit the display of channels or to display a certain channel, enter the desired search criteria in the filter field; then, click Go.
Ops View drop-down list
This field allows you to display only channels for which the associated ops view matches the information that you choose.
Go button
Click this button to display channels by the filters that you choose.
Clear Filter button
Click this button to remove filter selections and display an empty list of channels.
Click the Channels link again to display the full list of entries.
Channel Name field
This field indicates the unique identifier that is assigned to the channel.
See the "Viewing and Editing Channel Details" section and the "Adding a PTT Channel" section
Ops View field
This field indicates the ops view to which the channel belongs.
Secure field
This field indicates whether the channel is secure.
VTG field
This field indicates whether the channel is allowed in a Virtual Talk Group (VTG).
See the "Viewing and Editing Channel Details" section and the "Adding a PTT Channel" section
Users field
This field indicates whether the channel is allowed to be associated to users to affect all endpoints such as the IDC and IP phone.
Channel Status field
This field indicates whether the channel is enabled, disabled, or active.
Prompt field
This field indicates whether a spoken name prompt is recorded for the channel.
This prompt plays for a user when the user logs in to the Cisco IPICS telephony user interface.
You can record the spoken name prompt for a user by clicking the Not Recorded or the Recorded link in the Prompt column. When you click a link in the Prompt column, the Spoken Names window displays.
See Chapter 8, "Configuring and Managing the Cisco IPICS Policy Engine"
Add button
Click this button to add a new channel in Cisco IPICS.
See the "Adding a PTT Channel" section
Delete button
Click this button to delete the specified channel(s).
See the "Deleting a PTT Channel" section
Change Status drop-down list
Choose from the enable or disable option to change the status of a channel.
Associations button
Click this button to view associations for the specified channel.
See the "Associating Users to PTT Channels" section, the "Viewing Channel Associations" section, and the "Associating Radio Control Signals to PTT Channels" section
Rows per page drop-down list
Specifies the number of rows of channels that are included in a channels list page.
Page field
Displays channels on a specific page.
|< (First page) button
Displays the first page of the channels list.
< (Previous page) button
Displays the previous page of the channels list.
> (Next page) button
Displays the next page of the channels list.
>| (Last page) button
Displays the last page of the channels list.
Adding a PTT Channel
Adding a PTT channel makes it available for use by Cisco IPICS.
Before you add a PTT channel, configure locations as described in the "Adding a Location" section.
To add a new channel, perform the following procedure:
Procedure
Step 1
Step 2
The General tab for a new channel displays.
Step 3
Step 4
This field is optional.
Step 5
If you do not want to add the channel, click Cancel.
Viewing and Editing Channel Details
You can view and edit information for any channel.
To view or edit channel details, perform the following procedure:
Procedure
Step 1
Step 2
The General tab for the selected channel displays. This window contains general information for that channel. Table 2-2 provides descriptions of the fields in the General tab.
Note
Table 2-2 General Tab Fields in Channels Window
Name
This field represents the name of the channel.
The name can include alphanumeric characters, spaces, and any of these characters: ". , - ` # ( ) / :_".
Choose a unique and recognizable name that accurately describes the PTT channel. It is often helpful to name the PTT channel according to the department or organization that use it, or for a particular geographic region (for example Fire Department or North Area).
Note
Short Name
This field represents the condensed name of the channel.
The name can include alphanumeric characters, spaces, and any of these characters: ". , _ ` # ( ) / :_".
Description—Optional
This field allows you to enter a description for this channel.
Secure Channel
This drop-down list allows you to specify whether this channel is a secure channel.
This field is for reference only and should be set to reflect the configuration of the channel in your network. Changing this setting does not affect the security configuration of the channel.
Note
Allow association to users
This check box allows you to indicate whether this channel is available to all Cisco IPICS users. Use this option to prevent certain channels from being associated to users.
If the channel is configured to disallow association to a user (attribute check box is not checked), the channel does not display as available to users in the User window and it is not available on the IDC. In addition, the User tab, in the channel Association window, does not display.
Note
Allow use in VTGs
This check box allows you to indicate whether this channel is an available resource for participation in a VTG.
Use this setting to prevent certain channels from being included in a VTG. For example, an IDC user who interacts with a another user may wish to hear all the call progress tones that the other user's handset generates, to give feedback when a radio channel is available. These types of progress tones can be assigned to this channel. Because the tones can be disruptive, however, you might not want to add this type of channel to a VTG with a large group of users; therefore, when you create this channel, you would disallow its use in VTGs.
If the channel is configured to disallow this channel in a VTG (attribute check box is not checked), the channel does not display in the Resources area of the VTGs in the VTG Management window and is not available for participation in VTGs. The channel can, however, display as available for association to users and user groups, in the User and User Groups windows.
If you change the channel such that it is no longer allowed in a VTG, the channel remains active in any current VTG to which it is a participant. However, the channel is not allowed to join any other VTG.
Note
Status—Display only
This field displays one the following channel states:
•
•
•
Type
This field specifies the type of connection that Cisco IPICS and devices use to connect to this channel when connecting from the corresponding location.
Choose one of the following options from the drop-down list:
•
•
The Radio options appears only if you have configured one or more tone control radios and have enabled one or more channel selectors for a tone control radio.
Location
This field displays when you choose a multicast connection type from the Type drop-down list.
Channels or users who are associated with the same location are reachable within a multicast network boundary. Therefore, users who are in the same multicast domain are also in the same Cisco IPICS location. Remote, SIP-based users are not in the same location as multicast users. Remote users connect by establishing connectivity with the appropriate RMS via a SIP-based unicast connection for each channel or VTG that has been assigned to the user.
Note
If the network is configured so that the channel can be accessed by users in every location, set this value to All.
See the "Managing Locations" section for more detailed information about how to configure locations.
Address
This field displays when you choose a multicast connection type from the Type drop-down list.
This field specifies the multicast address, in the corresponding location, that is used to connect to this channel.
Note
Two channels in the same location cannot have the same multicast address. See the "Managing Locations" section for more detailed information about locations.
Port
This field displays when you choose a multicast connection type from the Type drop-down list.
This field specifies the multicast address port number, in the corresponding location, that is used to connect to this channel.
Note
Codec
This drop-down list allows you to choose the codec (G.711 or G.729) that is used by this connection.
Use G.711 if this connection should be available to Cisco Unified IP Phone users or if it is part of a VTG.
Use G.711 or G.729 if this connection is available to IDC users. G.729 requires digital signal processor (DSP) resources for transcoding.
Note
For more information about codecs, see Solution Reference Network Design (SRND) (latest version).
Radio
This drop-down list displays when you choose a radio device type from the Type drop-down list.
Channel Selector
This field displays when you choose a radio device type from the Type drop-down list.
Choose a channel selector from the drop-down list.
Note
Each channel can have a specific set of signaling (over-the-air) tones that need to be broadcast over the radio. When a user is associated with the channel, any signaling tones that are defined for that channel are available for use by the IDC.
TipFor more information about the IDC, see IPICS Dispatch Console User Guide for release 4.0.
Belongs To
This drop-down list allows you to choose the ops view to which you want to associate this channel. See the "Associating PTT Channels to Ops Views" section for detailed information.
Note
For general information about ops views, see Chapter 7, "Configuring and Managing Cisco IPICS Operational Views."
Accessible To
This drop-down list allows you to choose the ops views to which you want this channel to be accessible. See the "Associating PTT Channels to Ops Views" section for information about how to associate ops views to channels.
Note
For general information about ops views, see Chapter 7, "Configuring and Managing Cisco IPICS Operational Views."
Edit button
Click this button to make this channel accessible to other ops views.
Note
See the "Associating PTT Channels to Ops Views" section for more information.
For general information about ops views, see Chapter 7, "Configuring and Managing Cisco IPICS Operational Views."
Step 3
The IDC tab for the selected channel displays. This window contains IDC information for the selected channel. Table 2-3 provides descriptions of the fields in the IDC tab.
Table 2-3 IDC Tab Fields in Channels Window
RX Mute During PTT
The following values affect how the receive mute functionality is configured on the IDC for this channel.
•
•
•
Enable Voice Activity Detection (VAD)
When you enable VAD on Cisco IPICS, the IDC only sends voice traffic when it detects a voice packet on this channel.
When this attribute is set to true (attribute check box is checked) on a channel, VAD is used by the IDC when communicating with the channel.
By default, this attribute is set to false (attribute check box is not checked).
Allow Latch
When set to true (attribute check box is checked) on a channel, the user can use latch to lock in the channel.
By default, this attribute is set to false (attribute check box is unchecked).
Listen Only
When set to true (attribute check box is checked), the user can hear, but cannot talk, on the channel.
Channel Color
This attribute specifies a color tag that you can choose from a drop-down list.
This setting identifies specific channels by using predefined colors for the background text that appears on the channel. You configure the color by choosing from the options in the drop-down list.
Note
Channel Region
From the drop-down list, choose the region in which this channel should appear on the IDC.
For information about configuring IDC regions, see the "Managing IDC Regions" section.
Step 4
Step 5
•
The users who are currently associated to this channel display. The Users window lists information about each of the users who are associated to the channel.
Table 2-4 describes the items in the Users window.
Note
You can associate additional users to the channel, by performing the steps in the"Associating Users to PTT Channels" section.
•
•
For more detailed information, see the "Associating Radio Control Signals to PTT Channels" section.
Step 6
The Change End Device Status drop-down list becomes active.
Note
Step 7
•
•
•
•
•
•
Note
Changing the Status of a PTT Channel
Cisco IPICS allows you to change the status (enable/disable) of a channel from either the main Channels window, or in the individual channel configuration windows.
The status of a channel affects whether the channel is available to the IDC, IP phones, and dialed-in users, or whether the channel can connect to a VTG. If the channel is disabled, it cannot be connected to a VTG.
In addition, a channel can be in the active state. Cisco IPICS puts a channel into this state automatically when it is in use by an active VTG in the system. When a channel is in the active state, you must deactivate the referencing VTG or disable the channel before you can change any of its media connection assignments.
For more information about the IDC, see Cisco IPICS Dispatch Console User Guide for release 4.0.
A channel can be configured as enabled or disabled.
You can change the status of a single channel, or you can change the status of several channels at one time.
To determine the current status, access the Configuration drawer, click Channels, and look at the information in the Status column for the channel.
To change the status of a channel from the main Channels window, perform the following procedure:
Procedure
Step 1
Step 2
•
The Enable or Disable button appears at the bottom of the channel configuration window. The name of the button depends on the current status of the channel.
•
Understanding Association Attribute Behaviors
Users, channels, and VTGs have attributes that control their behavior. In some cases, these resources may have the same attribute behaviors, so that when you associate channels to users, or users to VTGs, the system determines the resulting IDC behavior by how the attributes are configured for each associated resource. For an example of association attribute behaviors, see the "User-Channel Association Example" section.
Cisco IPICS allows you to override the resulting behaviors for specific associations. When you modify channel or user attributes that are part of an association, the resulting behavior depends on the attribute settings for users within the association. Typically, when resources are part of an association, any attribute changes to the resources also apply to the resource and associations within that resource. Resource attributes may have different settings when they are not part of an association.
The following section provides an example of some of the expected system behaviors when you configure user, channel, and VTG associations.
Changes to channel, user, or VTG attributes that are also present in associations, behave differently, depending on the override status. If the association is not overridden you are prompted to remove the overrides. An example of some association attribute behaviors is described below.
Note
To associate an ops view to a channel, see the "Associating Users to PTT Channels" section.
User-Channel Association Example
The following example describes different user-channel association scenarios that can be performed by a Cisco IPICS operator and a system administrator:
•
•
•
The resulting behavior for this association is that User A is not allowed to latch on Channel A on the IDC. On the server side, the Allow Latch attribute displays as No for both the user and the channel for this association, in the Latchable column in the Associations tab.
Note
•
•
Cisco IPICS marks this attribute as a customized value.
Note
After the IDC updates, users in this association can no longer latch on Channel A.
•
If you click OK to the message, the overrides are removed and latching on Channel A, for this association, is allowed on the IDC.
See the "Viewing and Editing Channel Details" section for more information about the specific channel attributes.
For information about associating a channel to a user or ops view, see the "Associating Users to PTT Channels" section.
For more information about the IDC, see IPICS Dispatch Console User Guide for release 4.0.
Associating PTT Channels to Ops Views
You can associate a channel to an ops view in the General tab of an individual window for a channel. When you associate a channel to an ops view, the channel can be seen by the users who belong to that particular ops view.
For more information about the Accessible To and Belongs To attributes for ops views, see Chapter 7, "Configuring and Managing Cisco IPICS Operational Views."
To associate a channel to an ops view, perform the following procedure:
Procedure
Step 1
Step 2
Step 3
The Ops View to Channel Association window displays the following information:
•
•
Step 4
•
•
•
Step 5
If you do not want to save your changes, click Cancel.
The ops views that you chose display in the Accessible To: field in the individual window for the channel.
Step 6
Step 7
Associating Users to PTT Channels
You can associate specific users to a channel in the Associations window. When you associate channels with a user, the channels that you choose appear as options on an IDC or a Cisco Unified IP Phone that has been configured for use with Cisco IPICS.
To determine the ops views to which the channels are currently associated, access the Configuration drawer, click Channels, and look at the information in the Ops View column for the channels.
Note
System administrators and operators who belong to an ops view that is associated to a channel can associate other users to the channel, and add the channel to VTGs, as long as the Allow in association to users and Allow use in VTGs check boxes are checked. See the "Adding a PTT Channel" section for more information.
To associate users to channels, perform the following procedure:
Procedure
Step 1
Step 2
•
•
Note
In the Associations window, make sure that the Users tab is selected.
This tab shows a list of the users who are associated with the channel, the status of each user, and information about attributes for devices that the user is using.
Step 3
The Search Users window displays. This window allows you to search for users to associate to the channel by choosing criteria based on the following filters:
•
•
•
•
See the "Managing Locations" section for detailed information about how to configure locations.
•
•
Step 4
Note
The results of your search criteria display in a list.
Step 5
The user that you choose displays in the user list in the Users tab.
Step 6
Step 7
Step 8
If the channel participates in a VTG, the VTG name and status displays.
Associating Radio Control Signals to PTT Channels
You can associate specific radio control functions to channels in the channel Associations window. When you associate signals to channels, the specific functions that the signals perform appear as options on the IDC for that channel.
Each channel can be associated with one or more signals. Users who are associated with channels can send signals from the IDC.
You can associate signals with a channel that is not associated with a radio, such as another type of tone-controlled device. For example, you could have a Cisco IPICS PTT channel that includes an LMR gateway that is connecting to a tone-controlled device that is not a radio, such as a device that opens a gate. This type of device can interpret tones and perform specific actions.
When the IDC plays the RFC 2833 and RFC 2198 signals, the LMR gateway detects these signals (in this example, the open gate signal) and converts them into audio. This audio gets sent to the devices that open the gate that triggers them to activate. No radio is present in this scenario. The devices are directly connected to the E&M interface on the LMR gateway.
Unlike alerting tones that cannot be restricted to a specific channel, you can associate signals directly with specific channels. This flexibility gives you the ability to control the appearance of and the ability to play out signals to the appropriate channel(s).
To associate signals to channels, perform the following procedure:
Procedure
Step 1
Step 2
•
•
Note
Step 3
This tab shows a list of the signals that are associated with the channel, and includes the short name, description, and where it originated.
Step 4
The Search Signals window displays. This window allows you to search for additional signals to associate to the channel.
Step 5
Step 6
Step 7
If the channel participates in a VTG, the VTG name and status displays.
Step 8
To associate users to the channel, see the "Associating Users to PTT Channels" section.
Viewing Channel Associations
You can view channel associations by performing the following procedure:
Procedure
Step 1
Step 2
•
•
Note
Step 3
•
Note
•
•
Note
Deleting a PTT Channel
If a PTT channel is no longer needed, you can delete it from Cisco IPICS. You can delete a single channel or you can delete several channels at one time.
To delete a channel, perform the following procedure.
Note
Procedure
Step 1
Step 2
Step 3
A dialog box prompts you to confirm the deletion.
Step 4
If you do not want to delete the channel(s), click Cancel.
Understanding the Channel Groups Window
The Channel Groups window lists information about each of the channel groups that you have added in Cisco IPICS.
The bottom area of this window displays a list of Cisco IPICS channel groups and general information for each channel group. By default, this area displays all channel groups, but you can choose to display only channel groups that match search criteria that you specify in the top area of the window.
Note
This window also provides you with the ability to perform several channel group management functions.
To display the Channel Groups window, access the Configuration drawer and click Channel Groups.
Table 2-5 describes the fields in the Channel Groups window.
Table 2-5 Fields in the Channel Groups Window
Name field
Allows you to display only channel group names that include the character string that you enter (characters are not case-sensitive)
To limit the display of channel groups or to display a certain channel group, enter the desired search criteria in the filter field; then, click Go.
Ops View drop-down list
Allows you to display only channel groups for which the associated ops view matches the information that you choose
Go button
Displays channel groups by the filters that you choose
Clear Filter button
Removes filter selections and displays an empty list of channel groups
Channel Group Name field
Name that is assigned to the channel group
See the "Viewing and Editing Channel Group Details" section and the "Removing a PTT Channel from a Channel Group" section
Ops View field
Ops view to which the channel group belongs
Add button
Allows you to add a new channel group in Cisco IPICS
See the "Removing a PTT Channel from a Channel Group" section
Copy button
Allows you to copy information from an existing channel group when you add a new channel group
Delete button
Allows you to delete a channel group
Associations button
Displays the Associations window for a channel group
See the "Associating Ops Views to Channel Groups" section and the "Viewing Channel Group Associations" section
Rows per page drop-down list
Specifies the number of rows of channel groups that are included in a channel groups list page
Page field
Displays channel groups on a specific page
|< (First page) button
Displays the first page of the channel groups list
< (Previous page) button
Displays the previous page of the channel groups list
> (Next page) button
Displays the next page of the channel groups list
>| (Last page) button
Displays the last page of the channel groups list
Adding a Channel Group
A channel group enables you to organize channels. You may find it useful to create and name channel groups according to location (for example, South Area Fire Department PTT Channel) or function (for example, Maintenance PTT Channel).
To create a channel group, perform the following procedure:
Procedure
Step 1
Step 2
•
•
Note
The New Channel Group window displays. If you clicked Copy, this window includes information from the existing channel group, except for the channel group name.
Step 3
Note
Step 4
If you do not want to add the channel group, click Cancel.
For information about how to associate channel groups to a VTG, see the "Managing VTGs" section on page 5-2.
Viewing and Editing Channel Group Details
You can view information about and edit any channel group in your Cisco IPICS network, including adding new channel members to the channel group.
To add a new channel group, see the "Adding a Channel Group" section.
To view and edit channel group details, and add channel members, perform the following procedure:
Procedure
Step 1
Step 2
The General tab for channel groups displays. This window contains general information for that channel group.
Step 3
Table 2-6 General Tab Fields in Channel Groups Window
Channel Group Name
Unique name of the channel group.
The name can include alphanumeric characters, spaces, and any of these characters: ". , - ` # ( ) / :_".
Description
Optional. Description of the channel group
Belongs To
Name of the ops view to which you want to associate this channel group.
For general information about ops views, see Chapter 7, "Configuring and Managing Cisco IPICS Operational Views."
Accessible To
Name of the ops view to which you want this channel group to be accessible.
For general information about ops views, see Chapter 7, "Configuring and Managing Cisco IPICS Operational Views."
Edit button
Click this button to associate ops views to the channel group. See the "Associating Ops Views to Channel Groups" section for detailed information.
Note
Step 4
Step 5
The Search Channels window displays. This window allows you to search for channels to add as members by choosing criteria based on the following filters:
•
•
Step 6
Note
You search results display in a list.
Step 7
The channel that you choose displays in the channel members list in the Members tab.
To view current channel group associations, see the "Viewing Channel Group Associations" section.
Viewing Channel Group Associations
To view channel group associations, perform the following procedure:
Procedure
Step 1
Step 2
The General tab for channel groups displays.
Step 3
•
•
Table 2-8 provides descriptions of the fields in the Associations window.
Removing a PTT Channel from a Channel Group
When you remove a PTT channel from a channel group, the channel is no longer a part of that group. Removing a PTT channel from a channel group does not remove the channel itself from Cisco IPICS, nor does it remove the channel from any other channel group to which it belongs.
To remove a PTT channel from a channel group, perform the following procedure:
Procedure
Step 1
Step 2
The General tab of the channel group displays.
Note
Step 3
Step 4
Step 5
Tip
To add channel members to a channel group, see the "Viewing and Editing Channel Group Details" section.
Associating Ops Views to Channel Groups
You can associate specific ops views to channel groups from the Channel Groups window. When you associate an ops view to a channel group, the channel group can be seen by the users who belong to that particular ops view.
For more information about the Accessible To and Belongs To attributes for ops views, see Chapter 7, "Configuring and Managing Cisco IPICS Operational Views."
To determine the ops views to which the channel group is currently associated, access the Configuration drawer, click Channel Groups, and look at the information in the Ops View column for the channel group.
To associate ops views to channel groups, perform the following procedure:
Procedure
Step 1
Step 2
Step 3
The Ops View to Channel Group Association window displays the following information:
•
•
Step 4
•
•
•
Step 5
If you do not want to associate the ops view to the channel group, click Cancel.
The ops views that you choose display in the Accessible To: field in the individual window for the channel group.
Step 6
Step 7
Deleting a Channel Group
When you delete a channel group, it is no longer available for use in Cisco IPICS. Deleting a channel group does not affect the channels that are contained in the channel group.
To delete a channel group, perform the following procedure:
Procedure
Step 1
Step 2
Step 3
A dialog box prompts you to confirm the deletion.
Step 4
If you do not want to delete this channel group, click Cancel.
Managing Locations
In Cisco IPICS, locations are used to define multicast domains within a Cisco IPICS deployment. A multicast domain comprises a set of multicast addresses that are reachable within a multicast network boundary. This implementation enables the Cisco IPICS server to assign the appropriate multicast address based on a specific user location.
If two or more users are connected to the same multicast network (or domain), they are in the same location but not necessarily in the same physical place. If two or more users are in the same location and are using the same multicast channel, they can talk to each other without the need for additional resource configuration.
This section includes the following topics:
•
•
Predefined Cisco IPICS Locations
In addition to specifically assigning names to locations, Cisco IPICS includes the following two predefined locations: ALL and REMOTE.
The ALL location signifies no network boundaries; that is, a channel that is designated with the ALL location means that there are no network boundaries within the Cisco IPICS deployment for that associated multicast address. The designation of ALL is the sum total of all defined locations.
Note
•
•
The REMOTE location is available only to IDC users. When an IDC user chooses the REMOTE location from the Location drop-down list, connectivity is established with the appropriate RMS via a SIP-based unicast connection for each channel or VTG that has been assigned to the user.
•
•
In all cases, the Cisco IPICS server allocates RMS resources upon successful IDC authentication. When additional channels or VTGs are assigned to a logged-in user, the server immediately allocates the necessary RMS resources for each channel or VTG. When the IDC user activates the channel or VTG, the IDC places the SIP call to the appropriate RMS.
Note
Location Associations
The following Cisco IPICS resources always maintain location associations:
•
•
The following examples describe the access that is available based on the specified configurations:
Configuration:
–
–
–
–
–
Example 1: IDC User 1 logs in to Cisco IPICS by using the Alpha location
–
–
–
–
Example 2: IDC User 1 logs in to Cisco IPICS by using the Delta location
–
–
–
–
Example 3: IDC User 1 logs in to Cisco IPICS by using the REMOTE location
–
–
–
–
•
•
When a user chooses the REMOTE location, the server configures all of the user-assigned channels and VTGs for SIP-based access. In this case, the server must allocate one RMS resource for each channel and VTG. If the server has insufficient resources to use in the location that is specified by the channel configuration, the IDC user receives a message to indicate that the channel is not available.
When the user chooses a location other than REMOTE, the server assigns direct multicast access to each channel that you configure with the same location as the chosen location, and any channel that you configure with the ALL location.
Note
•
•
–
–
In both cases, the server establishes a unicast call flow between the TUI user and the dial engine. The dial engine converts the unicast call flow to multicast by using the address that was assigned from the multicast pool. This multicast traffic flows to the RMS where the VTG was activated. When the VTG traffic reaches the RMS it is bridged to the channel or VTG that the user has selected. Therefore, the dial engine must be in the ALL location, or multicast domain.
•
Example 1:
–
–
–
When the server needs to allocate an RMS resource for Channel A, it determines which RMS is the "least recently used" RMS and allocates the resource in the appropriate RMS.
Example 2:
–
–
–
In the above example, the server allocates resources from RMS 2 because RMS 1 is defined in a different location.
Summary of Access Types and Connections
Table 2-9 shows a summary of the Cisco IPICS access types and connections, as they pertain to locations.
The following section provide additional information about location-related management tasks that you can perform:
•
•
Understanding the Locations Window
The Locations window lists information about each of the locations that you have added in Cisco IPICS. It also allows you to perform several locations management functions.
To display the Locations window, navigate to the Configuration > Locations link in the Administration Console.
Note
Table 2-10 describes the items in the Locations window.
Table 2-10 Items in the Locations Window
Location Name field
Specifies the name that is assigned to the location
Add button
Allows you to add a new location in Cisco IPICS
See the "Adding a Location" section
Delete button
Allows you to delete a location
See the "Deleting a Location" section
Adding a Location
You can add locations to Cisco IPICS as needed To do so, perform the following procedure:
Procedure
Step 1
Step 2
Step 3
The location can include alphanumeric characters, spaces, and any of these characters: . , - ` # ( ) / :_ .
Note
Tip
Step 4
If you choose not to add this location, click Cancel.
Viewing or Editing a Location
You can view or edit a location that is configured in Cisco IPICS.
To view or edit a location, perform the following procedure:
Procedure
Step 1
Step 2
The window for the location that you choose displays.
Step 3
Tip
If you do not want to save any changes, click Cancel.
To add a location, see the "Adding a Location" section. To delete a location, see the "Deleting a Location" section.
Deleting a Location
You can delete a location when it is no longer needed.
You cannot delete a location if it is associated with a channel or if it is set as the default location for a user. In these cases, you must disassociate the location from the channel or set another default location for the user before you can delete the location.
You also cannot delete the ALL or REMOTE locations.
To delete a location from Cisco IPICS, perform the following procedure:
Procedure
Step 1
Step 2
Step 3
A dialog box prompts you to confirm the deletion.
Step 4
If you choose not to delete this location, click Cancel.
Managing the Multicast Pool
Cisco IPICS stores multicast addresses in the multicast pool. When you activate a VTG, Cisco IPICS automatically assigns an available multicast address from the multicast pool to that VTG.
Note
When a VTG deactivates, its multicast address is released for use by another VTG.
Note
As a Cisco IPICS system administrator, you can perform these multicast pool management tasks:
•
When using multicast communications with Cisco IPICS, Cisco recommends that you follow the guidelines in the "Guidelines for Using IP Multicast Addresses with Cisco IPICS" section.
You perform the multicast pool management tasks in the Multicast Pool window. For more information about this window, including how to access it, see the "Understanding the Multicast Pool Window" section.
Understanding the Multicast Pool Window
The Multicast Pool window lists information about each of the multicast addresses that you have added in Cisco IPICS. It also allows you to perform several multicast pool functions.
Note
To display the Multicast Pool window, access the Configuration drawer and click Multicast Pool.
Each multicast address in the multicast pool window appears on its own row with related information in various columns. By default, rows of information appear in ascending order by multicast address.
Table 2-11 describes the items in the Multicast Pool window.
Table 2-11
Address field
This field specifies the multicast address and port.
See the "Guidelines for Using IP Multicast Addresses with Cisco IPICS" section
Location field
This field specifies the location that is assigned to this multicast address.
The location name can include alphanumeric characters, spaces, and any of these characters: . , - ` # ( ) / :_ .
See the "Viewing and Editing Multicast Address Information" section and the "Deleting a Multicast Address" section
See the "Managing Locations" section for more detailed information about locations.
Status field
Either of the following designations can display in this field:
•
•
Connection Type field
Either of the following designations can display in this field:
•
•
•
Used By field
This field specifies the name of the active channel, VTG, or radio that is using the multicast address, if applicable.
Add button
Click this button to add a multicast address.
Delete button
Click this button to delete a multicast address.
Fields in the Multicast Pool Window
Guidelines for Using IP Multicast Addresses with Cisco IPICS
Be aware of the following guidelines when you use multicast communications with Cisco IPICS:
Cisco IPICS strongly recommends IP multicast addresses that are in the 239.192.0.0 to 239.251.255.255 range.
•
•
For additional information about the use of IP multicast addressing, go to the following URL:
http://www.cisco.com/en/US/tech/tk828/
tsd_technology_support_protocol_home.htmlAdding Multicast Addresses
When you add a multicast address to the multicast pool, it becomes available for use by active VTGs.
If you later assign the address to a channel, it is no longer available for use by active VTGs.
Before you add a multicast address, configure locations, as described in the "Managing Locations" section.
To add one or more multicast addresses to the multicast pool, perform the following procedure:
Procedure
Step 1
Step 2
The New Multicast Pool window displays.
Step 3
Be sure to enter a valid multicast address that begins with 239.
Note
Step 4
You can enter a number between 1 and 255.
Cisco IPICS can generate a list of multicast addresses and add them to the multicast pool. This feature can be useful when you need to add several multicast addresses.
When you choose to have Cisco IPICS generate a sequence of multicast addresses, you specify the first address and the number of addresses that you want. Cisco IPICS returns the number of addresses that you specify, starting with the first address that you specified and incrementing the fourth octet of each additional address by one. You can generate a sequence of up to 255 multicast addresses at a time.
For example, if you request five addresses and specify the first address to be 239.195.5.1, Cisco IPICS generates this sequence of addresses:
239.195.5.1239.195.5.2239.195.5.3239.195.5.4239.195.5.5
Note
Step 5
This value must be an even number in the range of 21000 through 65534.
Step 6
If you choose not to add this address, click Cancel.
Step 7
Viewing and Editing Multicast Address Information
You can view information for any multicast address, and you can change a multicast address and port number. You do so in the Multicast Pool window.
To view or edit multicast address information, perform the following procedure:
Procedure
Step 1
Step 2
The Multicast Address Pool Information window for the selected multicast address displays.
Step 3
Table 2-12 Multicast Address Details Area Fields
Address
This field represents the multicast address.
You add an address, enter a valid multicast address, and make sure to enter all 4 octets of the address. Each octet must be in the range of 0 through 255.
Note
Port
This field represents the port number assigned to the multicast address.
This value must be an even number in the range of 21000 through 65534.
Note
Connection Type— Display only
This field can include either of the following designations:
•
•
•
Status—Display only
This field can include either of the following states:
•
•
Location—Display only
Location that is assigned to this multicast address.
An address for a PTT channel has a specific location, either location ALL or another location name. Regardless of the location in this field, a VTG can contain only channels that are in the same multicast domain as the RMS that is used to mix the channels. See the "Managing Locations" section for more detailed information about locations.
Used By—Display only
Name of the active channel, VTG, or radio that is using the multicast address, if applicable.
Last Released—Display only
This field displays when the multicast address was last released.
Step 4
If you do not want to save your changes, click Cancel.
Deleting a Multicast Address
You can delete a multicast address when it is no longer needed.
Note
To delete a multicast address from the multicast pool, perform the following procedure:
Procedure
Step 1
Step 2
Step 3
A dialog box prompts you to confirm the deletion.
Step 4
If you choose not to delete this address, click Cancel.
Managing the RMS
An RMS is a component that enables the Cisco IPICS IDC to remotely attach to a VTG. It also provides support for remotely attaching (combining) two or more VTGs through its loopback functionality.
Note
As a Cisco IPICS system administrator, you can perform these RMS management tasks:
•
•
•
You perform the RMS management tasks in the RMS window, which is located in the Configuration drawer. For more information about this window, including how to access it, see the "Understanding the RMS Window" section.
Note
Understanding the RMS Window
The RMS window lists the RMS components that are available in your Cisco IPICS network. This window also allows you to perform the RMS management functions.
To display the RMS window, navigate to the Configuration > RMS window in the Administration Console.
The Routers pane in the RMS window displays the name of each RMS that is configured in your Cisco IPICS network.
For detailed RMS configuration information, see Appendix A, "Configuring the Cisco IPICS RMS Component."
Table 2-13 describes the items in the RMS window.
Table 2-13 Items in the RMS Window
RMS Name field
This field specifies a unique name that is assigned to the RMS.
See the "Viewing and Editing RMS Details, Activating an RMS, and Deactivating an RMS" section and the "Adding an RMS" section
See the "Managing Locations" section for detailed information about configuring locations
Location field
This field specifies the multicast domain that contains the multicast addresses that can be accessed by this RMS.
IP Address field
This field specifies the IP address of the Loopback interface.
Router Type field
This field specifies the model number of the RMS.
Status field
This field indicates whether an RMS is operational, configured, stopped, deactivated, or unreachable.
Available field
Number of DS0s that are available for use in Cisco IPICS.
In Use field
Number of DS0s that are currently being used in Cisco IPICS.
Reserved field
Number of DS0s that are reserved for non-Cisco IPICS use.
In Error field
Number of DS0s that are misconfigured.
Add button
Choose this button to add an RMS component.
See the "Adding an RMS" section
Delete button
Choose this button to delete an RMS component.
See the "Deleting an RMS" section
Configuration drop-down list
Provides the ability to merge, update, or show configuration information for an RMS component.
Rows per page drop-down list
Specifies the number of rows of RMS components that are included in a RMS components list page.
Page field
Displays RMS components on a specific page.
|< (First page) button
Displays the first page of the RMS components list.
< (Previous page) button
Displays the previous page of the RMS components list.
> (Next page) button
Displays the next page of the RMS components list.
>| (Last page) button
Displays the last page of the RMS components list.
Viewing and Editing RMS Details, Activating an RMS, and Deactivating an RMS
You can view and edit information for any RMS in your Cisco IPICS network. You can also deactivate an RMS, which makes it unavailable for use by Cisco IPICS, or reactivate an RMS. You perform these tasks in the Edit Router Details area.
By default, Cisco IPICS polls the RMS every 10 minutes, using the RMS comparator mechanism. The RMS comparator checks the responsiveness of the RMS if there have been any changes made to the configuration. If there have been changes to the RMS configuration and these changes are not reflected in the Cisco IPICS server, the RMS comparator automatically updates the configuration so that the two components are synchronized. (You can change the polling period by entering a new value in the RMS Polling Frequency field in the Options window in the Administration drawer. For more information, see the "Managing Cisco IPICS Options" section.)
Tip
Note
Editing or Viewing RMS Details
You can edit or view a variety of information for an RMS. To do so, perform the following procedure:
Procedure
Step 1
Step 2
The General tab for the selected RMS displays.
Step 3
This action makes the RMS temporarily unavailable to Cisco IPICS.
Tip
Step 4
Table 2-14 Fields in the General Tab of the RMS Window
Name
This field specifies the name of the RMS.
The name can include alphanumeric characters, spaces, and any of these characters: . , - ` # ( ) / :.
Location
This field specifies the multicast domain that contains the multicast addresses that can be accessed by this RMS.
An RMS must be configured with the same location that is configured for the channels that it serves.
See the "Managing Locations" section for detailed information about locations.
Description
This field specifies a description for the RMS.
Status—Display only
This field can include any of the following statuses:
•
•
•
Note
•
Note
•
IP Address
This field specifies the IP address of the Loopback interface.
Host Name— Display only
This field specifies the host name of the RMS.
User Name
This field specifies the user name that Cisco IPICS uses to access the RMS. This name must have administrator privileges on the RMS.
Password
This field specifies the password that Cisco IPICS uses to access the RMS.
Router Type—Display only
This field specifies the model number of the RMS.
Controllers— Display only
This field displays the T1/E1 connections on the RMS. The number in parentheses is the number of ports on the corresponding controller.
Loopbacks—(Click the Loopbacks Tab to access the Loopback information)
This field specifies the mappings between two controllers that are physically connected.
To change a loopback, choose a pair of controllers from the two Loopback drop-down lists and click Add. A controller appears in gray if it is in use.
Each configured loopback appears in a list near the bottom of this area. To see detailed information about a loopback, click the right arrow next to its name.
To see detailed information about all loopbacks, click Expand All. To collapse an expanded view of a loopback, click the down arrow next to its name. To collapse detailed information about all loopbacks, click Collapse All.
For an explanation of the detailed loopback information, see the "Viewing and Configuring Loopbacks" section.
Step 5
Step 6
To exit without saving changes, click Cancel.
Step 7
After you change information for an RMS, it can take up to 10 minutes (by default) for Cisco IPICS to recognize the changes. If you want to cause Cisco IPICS to recognize the changes immediately, see the "Managing the RMS Configuration" section.
Note
Deactivating or Activating an RMS
When you deactivate an RMS, it goes into the Deactivated state and becomes unavailable for use by Cisco IPICS until you activate it. You should deactivate an RMS when you make certain changes to it, as described in the "Editing or Viewing RMS Details" section.
Note
When you activate an RMS component, it becomes available for use by Cisco IPICS.
To deactivate or activate an RMS, perform the following procedure:
Procedure
Step 1
Step 2
Step 3
Note
Adding an RMS
When you add an RMS, you make it available to Cisco IPICS. Before you add an RMS, make sure that these conditions are met:
•
•
To add a new RMS in Cisco IPICS, perform the following procedure:
Procedure
Step 1
Step 2
The Add New Router Media Service window displays.
Step 3
Note
a.
b.
c.
d.
See the "Managing Locations" section for more detailed information about locations.
e.
If you do not want to add this RMS, click Cancel.
When you click Save, Cisco IPICS determines whether it can access the RMS. This process can take up to one minute. If the RMS is accessible, Cisco IPICS displays the Router Details area for the RMS. If the router is not accessible, a message informs you of the possible reason.
The Router Details area displays the following information for the router that you added:
–
–
–
–
–
–
–
–
Step 4
By default, the name that displays is the router host name. You might find it useful to give the RMS a descriptive name. A name that you enter is for Cisco IPICS use only, it does not change the router host name.
Step 5
Repeat this step as needed to create additional loopbacks.
Step 6
Step 7
If you do not want to add this RMS, click Cancel.
After you add an RMS, it can take up to 10 minutes (by default) for Cisco IPICS to recognize the addition. If you want to cause Cisco IPICS to recognize the addition immediately, see the "Managing the RMS Configuration" section.
Viewing and Configuring Loopbacks
Each loopback that you create in Cisco IPICS appears in a list near the bottom of the Edit Router Details area. You can perform the following tasks related to loopbacks:
•
Viewing Detailed Information about a Loopback
You view loopback information in the Loopbacks tab of the RMS window. You can access this tab by navigating to the Configuration > RMS window and clicking the Loopbacks tab.
For more information about the RMS window, see the "Understanding the RMS Window" section.
To see detailed information about a loopback, click the left arrow next to its name. To collapse an expanded view of a loopback, click the down arrow next to its name.
To see detailed information about all loopbacks, click Expand All. To collapse detailed information about all loopbacks, click Collapse All.
An expanded view of a loopback provides this information for each time slot in the loopback:
•
•
–
–
•
–
–
–
–
•
Enabling DS0s in a Loopback
After you create a loopback, you must enable the DS0s that can be used by Cisco IPICS. You can enable DS0s in one loopback at a time, or in several loopbacks at a time.
To enable DS0s in a loopback, perform the following procedure:
Procedure
Step 1
Step 2
Step 3
Step 4
If you want to enable all DS0s in a loopback, check the check box next to Number at the top of the list of DS0s for that loopback.
If you want to uncheck check boxes, take one of these actions:
•
•
Step 5
The state for the DS0 displays Enabled in green text.
Step 6
If you do not want to enable the DS0 or DS0s, click Cancel.
Disabling DS0s in a Loopback
If you disable a DS0 in a loopback, it cannot be used by Cisco IPICS. You can disable DS0s in one loopback at a time, or in several loopbacks at a time.
To disable DS0s in a loopback, perform the following procedure:
Procedure
Step 1
Step 2
Step 3
Step 4
If you want to disable all DS0s in a loopback, check the check box next to Number at the top of the list of DS0s for that loopback.
If you want to uncheck check boxes, take one of these actions:
•
•
Step 5
The state for the DS0 displays Disabled in red text.
Step 6
If you do not want to disable the DS0 or DS0s, click Cancel.
Removing a Loopback
To remove a loopback, click Remove next to its name; then, click Save.
If you decide not to remove the loopback, click Add next to its name or click Cancel instead of clicking Save.
Deleting an RMS
Deleting an RMS removes all of its resources from Cisco IPICS and makes the RMS unavailable to Cisco IPICS.
You cannot delete an RMS if any of its DS0s are in use by Cisco IPICS.
To delete an RMS, perform the following procedure:
Procedure
Step 1
Step 2
Step 3
A dialog box prompts you to confirm the deletion.
Step 4
If you do not want to delete this RMS, click Cancel.
Managing the RMS Configuration
You can manage the RMS configuration by navigating to the Configuration > RMS window.
Merging RMS configuration updates Cisco IPICS with the following router information:
•
•
•
Merge the RMS configuration if you add or remove controllers on the router or if you change its host name, and you want Cisco IPICS to recognize the change.
Updating the configuration of an RMS applies the RMS configuration that is specified in Cisco IPICS to the RMS. This procedure can be useful in the following situations:
•
•
•
•
An RMS that shuts down returns to its default configuration when it restarts. Within 10 minutes—by default—after it restarts, Cisco IPICS compares the current RMS configuration with the RMS configuration in the Cisco IPICS database. If there is a discrepancy, Cisco IPICS refreshes the RMS configuration to match the configuration in the database.
Note
To manage the RMS configuration, perform the following procedure:
Procedure
Step 1
Step 2
Step 3
•
•
•
The configuration output displays in a separate window showing the configuration of the voice-ports and dial-peers for this RMS.
Cisco IPICS displays changes in the Edit Router Details area.
Tip
Managing Incidents
An incident is an event that you identify in Cisco IPICS and for which various users can coordinate responses by using the IDC. An incident can be any event, such as a fire or other situation, that requires a response.
The following section uses these incident-related terms:
•
•
•
For detailed information about coordinating incidents by using the IDC, see IPICS Dispatch Console User Guide for release 4.0.
As a Cisco IPICS system administrator, you can perform the following incident management tasks, which allow you to obtain information and manage system resources:
•
•
•
You perform the incident management tasks in the Incidents window, located in the Incidents drawer of the Administration Console. For more information about this window, including how to access it, see the "Understanding the Incidents Window" section.
Note
Understanding the Incidents Window
The Incidents window lists information about each incident that is configured in Cisco IPICS and is not yet archived.
The bottom area of this window displays a list of incidents and general information for incident. By default, this area displays all incidents, but you can choose to display only incidents that match search criteria that you specify in the top area of the window.
Note
This window also enables you to perform various incident management functions. To display the Incidents window, access the Configuration drawer; then click Incidents.
Table 2-15 describes the items in the Incidents window.
Table 2-15 Items in the Incidents Window
Incident ID field
This field allows you to display only the incident with the ID that you enter.
To limit the display of incidents or to display a certain incident, enter the desired search criteria in the filter field; then, click Go.
Incident Name field
This field allows you to display only incidents with names that include the character string that you enter (characters are not case-sensitive).
Started Before fields
These fields allows you to display only incidents that were activated before the date and time that you specify. To specify a date, click the Started Before field, then choose a date. To specify a time, choose the hour (24-hour format) and minute from the "at" drop-down lists.
State field
This field allows you to display only incidents that are active or only incidents that are inactive.
Incident VTG field
This field allows you to display only incidents that have an active incident VTG or only incidents that have an inactive incident VTG.
Ops View field
This field allows you to display only incidents that belong to the designated ops view.
Go button
Click this button to display incidents by the filters that you choose.
Clear Filter button
Click this button to remove filter selections and display an empty list of incidents.
Click the Incidents link again to display the full list of entries.
ID field
This field indicates the unique identifier that Cisco IPICS assigned to the incident
—
Name field
This field indicates the name that is assigned to the incident.
See IPICS Dispatch Console User Guide for release 4.0.
Ops View field
This field indicates the ops view to which the incident belongs. An incident belongs to the same ops view as that of the user who created it.
—
Activated field
Indicates the date and time that the incident was activated.
See IPICS Dispatch Console User Guide for release 4.0.
State field
This field indicates whether the incident is active or inactive.
Incident VTG field
This field indicates whether the incident VTG is active or inactive, if the incident includes an incident VTG.
See IPICS Dispatch Console User Guide for release 4.0.
Delete button
Click this button to delete the specified incident(s).
See the "Deleting an Incident" section.
Change Status drop-down list
Choose from the Activate or Deactivate option to change the status of an incident.
Download Archived Incident(s) button
Click this button to obtain archived incidents.
Rows per page drop-down list
Specifies the number of rows of channels that are included in a channels list page.
Page field
Displays channels on a specific page.
|< (First page) button
Displays the first page of the channels list.
< (Previous page) button
Displays the previous page of the channels list.
> (Next page) button
Displays the next page of the channels list.
>| (Last page) button
Displays the last page of the channels list.
Viewing Incident Details
You can view information for any incident. To do so, perform the following procedure:
Procedure
Step 1
Step 2
Information for the selected incident displays. Table 2-16 describes this information.
Step 3
Changing the Status of an Incident
Cisco IPICS allows you to change the status of an incident. An incident status can be either of the following:
•
•
To determine the current status of an incident, access the Configuration drawer, click Incidents, and look at the information in the State column for the incident.
To change the status of an incident, perform the following procedure.
Procedure
Step 1
Step 2
Step 3
Downloading Archived Incidents
Cisco IPICS automatically archives an incident 30 days after it is deactivated (by default) or after the retention period that you configured. (For information about configuring archives, see the description of the Incident Archive pane options in Table 2-22.) The system stores information about each archived incidents in a unique XML file. The XML files contain information about users, channels, radios, VTGs, journal entries, images, and videos that are part of the incident.
You can download the incident archive, which contains the XML files for all archived incidents. This process copies the zipped archived incident file to your local disk.
When an incident is archived, the system deletes it from the Cisco IPICS database, and it no longer appears in the list of incidents in the Incidents window. If the incident includes images or video clips that are stored on the Cisco IPICS server disk, and these items are not referenced by another incident the archiving process deletes these items from the disk.
To download an archived incident, To delete an incident, perform the following procedure:
Procedure
Step 1
Step 2
This button is enabled only after the system creates and archive file.
Step 3
By default, the archive file name is ipics_incident_archive.zip.
Deleting an Incident
If an incident is no longer needed, you can delete it from Cisco IPICS. You can delete a single incident or you can delete several incidents at one time.
When you delete an incident, it goes into the pending deletion state. The system archives incidents in this state the next time it runs the archiver, then deletes the incidents from the Cisco IPICS database. When an incident is in this state, it does not appear in the IDC nor in the Incidents page in the Cisco IPICS Administration Console.
To delete an incident, perform the following procedure:
Procedure
Step 1
Step 2
Step 3
Step 4
A dialog box prompts you to confirm the deletion.
Step 5
If you do not want to delete the incident(s), click Cancel.
Managing Licenses
The Cisco IPICS license determines the number of concurrent LMR ports, multicast ports, dial users, Cisco Unified IP Phone users, Silver IDC users, Platinum IDC users, mobile endpoint users, and ops views that are available for your system. Licenses also determine whether the policy engine is enabled on your system, and whether high availability is enabled on your system.
If your requirements exceed the limits of your current license, you can obtain additional licenses. For detailed information about licenses and how to obtain them, see Cisco IPICS Server Installation and Upgrade Guide for release 4.0.
As a Cisco IPICS system administrator, you can obtain and upload new license files, after you have obtained them, to the Cisco IPICS server so that the new licenses take effect. For instructions, see the "Uploading a License File" section.
You perform the license management tasks in the Administration > License Management window. For more information about this window, including how to access it, see the "Understanding the License Management Window" section.
Understanding the License Management Window
The License Management window provides information about the licenses that you configure for your Cisco IPICS installation. It also allows you to upload new licenses to the Cisco IPICS server after obtaining the licenses. See the "Uploading a License File" section for information about uploading licenses.
To access the License Management window, navigate to Administration >License Management window in the Cisco IPICS Administration Console.
In this window, the Summary tab provides a summary of information about the licenses you have obtained for Cisco IPICS. This tab displays license feature names, the total number of ports, current port usage, and available ports. See Table 2-17 for a description of the licenses that can display in this tab.
If your system includes high availability, the high availability license resides on the secondary server only. The other licenses reside on the primary server only.
The Usage Per Ops View tab provides license information per ops view. This tab displays types of licenses, the ops view, and current license usage information. See Table 2-18 for a description of the licenses, per ops view, that can display in this tab and the criteria that Cisco IPICS uses to determine license consumption for ports, IDC, IP phone, policy engine, and ops view usage.
Note
Note
The Usage Per Ops View tab provides license information per ops view. This tab displays the types of licenses, the ops view, current license usage, and the allocated ports. See Table 2-18 for a description of the information in this tab.
Understanding Time-bound License Behavior
Time-bound, or evaluation, licenses differ from permanent licenses by the inclusion of a predefined expiration date.
Note
After you remove the old license(s), restart the server by entering the following command:
[root]# service ipics restartFor more detailed information and guidelines about time-bound licenses, see Cisco IPICS Server Installation and Upgrade Guide for release 4.0.
About 30 days before a time-bound license is to expire, Cisco IPICS displays a warning message to alert you. You can dismiss this warning by clicking the Dismiss button.
When a license feature expires, the relevant functionality of that license becomes disabled. If the license is an uncounted license, the feature is disabled; however, if the license is a counted license, the number of ports that correspond to that license type is reduced by the count of the expired license feature. In this case, Cisco IPICS reloads all of the license features when it detects that one or more license features has expired. Expired license features display in the license detail area as flagged items.
Uploading a License File
After you obtain a new Cisco IPICS license file, you must upload it to the Cisco IPICS server before it becomes effective. This procedure copies a license file from the server location where you stored it to the Cisco IPICS server.
Note
/opt/cisco/ipics/tomcat/versions/current/webapps/license/To upload a license file, perform the following procedure:
Procedure
Step 1
Step 2
To locate this file in a Choose File window, click Browse.
Note
Step 3
Step 4
Cisco IPICS associates the license file with the server and restarts the license manager.
Note
For more information about Cisco IPICS licenses, see Cisco IPICS Server Installation and Upgrade Guide for release 4.0.
Viewing Active Users
As a Cisco IPICS system administrator, you can view the activity for users who are logged in to the system via an IDC, mobile client, Cisco Unified IP Phone, or dial-in, and users who are participating in a VTG by accessing the Administration > Active Users window. This window contains information about each type of user who is logged in to the system, such as the identification of the user, the location of the user, and ops views to which the user belongs. Using this window, you can also manually force logged-in and dialed-in users to log out of Cisco IPICS, if necessary.
To view active users and the associated information for each user, perform the following procedure:
Procedure
Step 1
Step 2
•
•
•
•
•
A window displays a list of the type of users that you chose. See Table 2-19 for a description of the fields in the Active Users window.
You can specify the number of rows of active users that display per results page by choosing from the Rows per page drop-down list at the top right of the window. To navigate between the results pages, click the arrows at the bottom of the window; then click Go.
Step 3
•
•
When you log out an IDC user, all resources, including licenses and RMS resources, are deallocated immediately.
If the IDC is running in offline mode, multicast audio for the IDC continues to work after you log out an IDC user if the Cisco IPICS server cannot reach the IDC to inform it of the logout and a channel or VTG is active. However, if the IDC was REMOTE (that is, using a unicast SIP call to the RMS), the server tears down the dedicated SIP connection for that IDC upon when you click Logout on the IDC tab.
•
When you log out a mobile client user, all resources, including licenses and RMS resources, are deallocated immediately.
•
Tip
Step 4
Managing Activity Logs
The Cisco IPICS logs store a variety of information about activities relating to VTGs, such as the ops view for each channel, user, and VTG, the creator of log entries, and the time that log activities occurred. You can review this information at any time. Log activity information is also used for historical reporting.
You search for and download activity logs in the Activity Log Management window. This window contains a Logs tab and an Archives tab. See the "Understanding the Activity Log Management Window" section for more information about the Activity Log Management window.
Cisco IPICS tracks and logs the date and time that certain types of activities occur. For detailed information about the activity types that are logged in Cisco IPICS, and how to specify what activity types get logged per ops view, see the "Managing Activity Log Options Per Ops View" section.
You can choose how to view activity logs:
•
•
•
•
•
To view and download activity logs. See the "Viewing and Downloading Activity Logs" section for more information.
Understanding the Activity Log Management Window
The Activity Log Management window displays each channel, radio, user, or VTG that is configured in Cisco IPICS, depending on the information that you choose to view. It also allows you to perform the activity logs management functions.
The Activity Log Management window contains two tabs, in which you can manage activity log information: the Logs tab and the Archives tab.
In the Logs tab, you can choose to view logs by ops view and resource type (such as channel, radio, user, and VTG), and search for particular logs based on a date range. If you are assigned the system administrator and/or ops view administrator role, you can also apply the date range filter to minimize the logs that get returned from the system. After filtering the activity log resource list by ops view and resource type, you can then choose one of the resources from a single list. For more information about using the search filters, see Chapter 1, "Using Search Windows."
Note
For information about viewing and downloading Cisco IPICS activity logs, see the "Viewing and Downloading Activity Logs" section.
In the Archives tab, you can download activity log files that have been archived according to the threshold limits that are configured in the Administration > Options window. For more information about managing Cisco IPICS options, see the "Managing Cisco IPICS Options" section. For information about downloading archived activity logs, see the "Downloading Archived Activity Logs" section.
For information on the display controls, see the "Navigating Item Lists" section on page 1-19.
To open the Activity Logs Management window, navigate to the Administration > Activity Log Management window.
Viewing and Downloading Activity Logs
To perform detailed analysis of activities, you can view and download activity logs. You can view activity logs for any channel, radio, user, or VTG, based on ops views and resource type. You view and download activity logs in the Activity Log Management window.
When you download activity logs, Cisco IPICS takes these actions:
•
•
The file includes information about the related log entries for the search criteria that you specify (such as ops view, resource type, and date range).
To view and download activity logs, perform the following procedure:
Procedure
Step 1
Step 2
Step 3
Step 4
Step 5
•
•
•
•
Step 6
Step 7
Step 8
The activity logs display according to the criteria that you choose.
Note
Step 9
Step 10
Step 11
Note
Step 12
Note
•
Microsoft Excel creates a schema that is based on the .xml file source data.
•
–
–
–
–
–
Step 13
Downloading Archived Activity Logs
You can download archived activity logs. Cisco IPICS archives the activity logs based on the thresholds that you assigned in the Administration > Options window in the Administration Console. For more information about the Options window, see the "Managing Cisco IPICS Options" section.
To download archived activity logs, perform the following procedure:
Procedure
Step 1
Step 2
Table 2-20 shows the fields in the Archive Status pane.
Step 3
Note
Step 4
Step 5
Note
If the name of the downloaded archived activity log file is "ipics_activity.xml.<1-24>", rename the file to "ipics_Activity<1-24>.xml" making sure that the .xml extension appears at the end of the file name, before opening in Microsoft Excel. Renaming the file ensures that Excel recognizes the file as an .xml file.
Managing Activity Log Options Per Ops View
You can specify the activities that you want Cisco IPICS to log, by ops view, in the Activity Log Options window. For example, if you want Cisco IPICS to only log when a VTG gets activated in a particular ops view, and no other activities, you would choose the Resource Creation and Deletion activity type for that ops view.
Table 2-21 describes the types of activities that can be logged in by ops views.
You can access the Activity Log Options window in the Administration Console by navigating to Administration > Activity Log Options.
To manage activity logs per ops view, perform the following procedure:
Procedure
Step 1
Step 2
Note
Step 3
•
•
•
Step 4
If you do not want to save your changes, click Cancel.
Managing Cisco IPICS Options
Cisco IPICS provides you with the ability to adjust system preferences and turn on or off certain options in the Options window. Cisco IPICS allows you to restore default settings at any time.
Information in the Options window is contained in the following information tabs:
•
•
•
Cisco IPICS detects changes that are made to the system options and immediately makes the adjustments for those changes. You do not have to take any further action for the changes to take effect.
You can access the Options window in the Administration Console by navigating to Administration > Options.
You can use the options in the Options window in the following ways:
•
Note
•
Table 2-22, Table 2-23, and Table 2-24 describe the fields in the Options window.
Table 2-22 General Tab in the Options Window
RMS Pane
Disable RMS Comparator
The RMS comparator is the mechanism that checks the responsiveness of the RMS and if there have been any changes made to the configuration. If there have been changes to the RMS configuration and these changes are not reflected in the Cisco IPICS server, the RMS comparator automatically updates the configuration so that the two components are synchronized.
Because the RMS comparator can interject delays, you can disable it by checking this check box.
Note
This check box is unchecked by default.
If the Disable RMS Comparator check box is selected, the RMS Polling Frequency field displays as dimmed.
RMS Polling Frequency
The RMS comparator functionality includes a polling mechanism that regularly checks whether the server can reach all of the RMS components that are listed in the RMS window.
This setting specifies a value in seconds. To change the default, double-click the current setting and enter a new value.
Valid values: 1 through 32767.
The default interval between checks specifies 10 minutes.
Activity Logs Pane
Maximum Activity Logs
This setting the maximum amount of database space that may be used by Cisco IPICS activity logs. For more information, see Chapter 12, "Understanding Cisco IPICS Serviceability and Diagnostic Information."
This setting specifies a value in megabytes (MB). To change the default, double-click the current value and enter a new value.
Valid values: 1 through 250.
The default maximum space for activity logs specifies 50 MB.
Activity Log Retention Period
This setting specifies the number of days that Cisco IPICS retains activity log entries. When this number has been reached, the logs get written to a rolling archive log. The archive log files are preserved until they get overwritten when the number of rolling files reaches the maximum number of archive files limit that is set by the system.
Valid values: 1 through 365.
The default setting specifies 90 days.
Cisco Unified IP Phone Pane
Cisco Unified IP Phone Timeout Period
This setting specifies whether a Cisco Unified IP Phone times out after a configured period of inactivity, forcing a user to log in again.
Note
This setting specifies a value in minutes. To change the default, double-click the current value and enter a new value.
Valid values: 0 through 99999.
The default setting specifies 30 minutes.
Cisco IPICS Session Pane
Cisco IPICS Session Timeout Period
This setting specifies whether a Cisco IPICS session times out after a configured period of inactivity, forcing a user to log in again.
Note
This setting specifies a value in minutes. To change the default, double-click the current value and enter a new value.
Valid values: 0 through 99999.
The default setting specifies 30 minutes.
Incident Archive Pane
Maximum File Size
This field specifies the maximum size of archive file, in MB. When an archive file reaches this size, older information is deleted.
The default setting specifies 50 MB.
Retention Period
This field specifies how many days Cisco IPICS retains an inactive incident before archiving the incident. Until a incident is archived, you can reactivate it from the Incidents window.
The default setting specifies 30 day.
Archive File Name
This field specifies the location on the Cisco IPICS server where the archive file is stored, and the name of the archive file.
The default location and file name is /idspri/archive/incident/ ipics_incident_archive.zip
Run at
The server time at which Cisco IPICS runs the archive process each day. At this time, Cisco IPICS archives any incidents have been inactive for 30 days (by default) or for the retention period that you configured.
The default time is 00:00 (midnight), server time.
Operator Role Assignments Pane
Restrict Operator Role assignments
If you check this box, users with the operator role can grant users (including themselves) the operator, dispatcher, or Ops view administrator roles only.
Not checked.
CUCM Settings for IDC Dialer
CUCM Host Name or IP Address
Host name or IP address of the Cisco Unified Communications Manager or Cisco Unified Communications Manager Express that the IDC uses for the dialer functionality.
—
Table 2-23 Passwords Tab in the Options Window
User Passwords Pane
Minimum Password Length
This setting specifies the minimum number of characters that a user can enter when creating or changing the Cisco IPICS password in the Home > My Profile window. See the "Managing Your User Profile" section on page 4-2.
Use the drop-down list to choose a new setting. The minimum length can range from 4 to 20 characters.
To ensure a strong password, you must create a password that is at least eight characters long, and includes the following elements:
•
•
•
•
@ [ ] ^ _ ` ! '' # $ % & ' ( ) * + , - . / : ; { < | = } > ~ ?
Valid values: 4 through 20.
The default setting specifies 8 characters.
Minimum Digit Password Length
This setting specifies the minimum number of numeric characters that a user can enter when creating or changing the digit password in the My Profile window, in the Home drawer of the Administration Console.
Use the drop-down list to choose a new setting. The minimum length can range from 4 to 10 characters.
Valid values: 4 through 10.
The default setting specifies 4 characters.
Minimum Lower Case Letter Count
This setting specifies the minimum number of lower case letters that a user can enter when creating or changing the Cisco IPICS login password in the My Profile window, in the Home drawer of the Administration Console.
The range of this field is from 0 to whatever number is specified in the Minimum Password Length field.
Note
Valid values: 0 through 20.
The default setting specifies 1 character.
Minimum Upper Case Letter Count
This setting specifies the minimum number of upper case letters that a user can enter when creating or changing the Cisco IPICS login password in the My Profile window, in the Home drawer of the Administration Console.
The range of this field is from 0 to whatever number is specified in the Minimum Password Length field.
Note
Valid values: 0 through 20.
The default setting specifies 1 character.
Minimum Numeric Character Count
This setting specifies the minimum numeric character that a user can enter when creating or changing the Cisco IPICS login password in the My Profile window, in the Home drawer of the Administration Console.
The range of this field is from 0 to whatever number is specified in the Minimum Password Length field.
Note
Valid values: 0 through 20.
The default setting specifies 1 character.
Minimum Special Character Count
This setting specifies the minimum special character that a user can enter when creating or changing the Cisco IPICS login password in the My Profile window, in the Home drawer of the Administration Console.
The range of this field is from 0 to whatever number is specified in the Minimum Password Length field.
Valid values: 0 through 20.
The default setting specifies 1 character.
Password History Count
This setting specifies the number of passwords that Cisco IPICS marks as previously used, and that the user is not able to use again.
For example, if the Password History Count is set to 5, the user is not able to use any of the passwords that they have used for the previous five times.
Note
Valid values: 0 through 999.
The default setting specifies 5 previous passwords.
Password Expiration Pane
Apply User Password Expiration
This check box specifies whether Cisco IPICS applies the value that is specified in the Password Expiration field.
If this check box is unchecked, there is no user password or digit expiration applied.
Valid values: true or false.
This check box is unchecked by default.
If this check box is not selected, the Password Expiration and Password Expiration Notification fields display as dimmed.
Password Expiration
This setting specifies the number of days in which the Cisco IPICS login password and the digit password expires. For example, if the value is 180 days, the password expires after 180 days from the date that the password was created.
Note
Tip
To force a login password update after a migration, configure the Password Expiration Days setting to 1; then once that one day has passed you can change the setting back to 180 days, or whatever setting you want to specify. This action forces users who log in to Cisco IPICS during that day (after the migration) to change their login passwords.Valid values: 1 through 999.
The default setting specifies 180 days.
Password Expiration Notification
This setting specifies the number of days before the password expires that the user receives a warning. For example, if the specified number of days is set to 3, the user receives the warning 3 days before password expiration.
Note
TipValid values: 1 through 999.
The default setting specifies 3 days.
User Account Lockout Pane
Apply User Account Lockout
This check box specifies whether Cisco IPICS applies the value that is specified in the Maximum Invalid Login Attempts Allowed field. When this check box is checked and a user exceeds the number of invalid login attempts that is specified, the user account is locked and the user can no longer log in to Cisco IPICS until the account is unlocked.
For information about how to unlock an account that has been locked, see Chapter 3, "Performing Cisco IPICS Operator Tasks."
Note
If this check box is unchecked, there is no account lockout applied.
Valid values: true or false.
This check box is unchecked by default.
If this check box is not selected, the Maximum Invalid Login Attempts Allowed and the Failed Password Attempt Expiration fields display as dimmed.
Maximum Invalid Login Attempts Allowed
This setting specifies the maximum number of times a user can attempt to log in to Cisco IPICS with invalid login information (user name/password) before the user account gets locked out. The failed login attempts are consecutive.
Valid values: 1 through 999.
Note
When a user gets locked out of Cisco IPICS, a message displays stating that the user ID has been locked and that the user should contact the system administrator or operator for assistance.
To unlock a user account, see Chapter 3, "Performing Cisco IPICS Operator Tasks."
The default setting specifies 5 attempts.
Failed Password Attempt Expiration
This setting specifies the number of hours that Cisco IPICS resets the Maximum Invalid Login Attempts Allowed field back to 0 once a user has reached the maximum invalid login attempts.
Valid values: 1 through 999.
The default setting specifies 8 hours.
Table 2-24 IDC Tab in the Options Window
Configuration Pane
IDC Update Poll
This setting specifies the frequency that the IDC uses to poll the server for updates. For more information, see IPICS Dispatch Console User Guide for release 4.0.
This setting specifies a value in seconds. To change the default, double-click the current setting and enter a new value.
Valid values: 3 through 3600.
The default polling interval specifies 5 seconds.
IDC Activity Logs Pane
Disable IDC Activity Log Upload
When you check this check box, the IDC does not upload logs to the server.
Note
Valid values: true or false.
This check box is unchecked by default.
If this check box is checked the IDC Log Upload Frequency field and the IDC Send Logs on Rollover fields/check box display as dimmed.
IDC Log Upload Frequency (IDC to server)
When an IDC client has activity logs ready to upload to the Cisco IPICS server, the IDC application places the logs in a queue. At regular intervals, the IDC client checks the queue and uploads to the server any logs that are waiting to be uploaded. Log files are copied to the $TOMCAT_HOME/webapps/ ipics_server/pmclogs directory, and are based on user ID and IDC ID. Log files that are not successfully uploaded get put back in to the queue and are uploaded at a later time.
This setting specifies the interval between these checks, in seconds. To change the default, double-click the current setting and enter a new value.
Note
For detailed information about IDC log files, see "Managing an End Device from the IDC Tab" section on page 3-18.
Valid values: 60 through 32767.
The default upload frequency specifies 600 seconds (10 minutes).
IDC Send Logs on Rollover
Cisco IPICS defines the IDC UserInterface.log, Authentication.log, and ChannelStatistics.log log files based on a maximum size of 1MB. When any one of these log files reaches this predefined limit, the system creates a new log file.
When you enable this option, the Cisco IPICS server retrieves the log files from the IDC based on file size rollover and renames the uploaded log file to reflect an archive copy. If you do not enable this option, the IDC deletes the log files when they reach their maximum size limit.
Be aware of the following caveats:
•
•
Valid values: true or false.
The IDC uploads files on rollover (the check box is checked).
IDC Activity Log Update
The Cisco IPICS server gathers activity logs from the IDC client machines and updates the database with this information at regular intervals. In the Cisco IPICS database, this data is parsed, organized, and made available for queries from the Activity Log window of the Administration Console.
This setting specifies a value in seconds. To change the default, double-click the current setting and enter a new value.
Valid values: 30 through 32767.
The default update frequency specifies 600 seconds (10 minutes).
Managing IDC Versions
The Cisco IPICS server maintains a repository of one or more versions of the IDC. Users can update their IDC clients at their convenience by downloading the current version of the ID utility, as described in the "Downloading the IDC" section on page 4-22.
Note
When you initially install Cisco IPICS, an IDC package is included with the server. You must generate the IDC Installer for that version to be available for download to IDC users.
When subsequent versions of the IDC becomes available, you upload the new IDC package to the Cisco IPICS server making it available for the IDC users to download to their IDC clients.
When you log in to the Cisco IPICS server from the IDC, the IDC determines whether there is a new version to which it can or must update. You configure IDC versions to designate whether an update is required or recommended. For more information about configuring the IDC versions, see the "Changing the State of IDC Versions" section.
As a Cisco IPICS system administrator, you can perform the following IDC version management tasks:
•
•
You perform the IDC version update tasks in the IDC Versions window. For more information about this window, including how to access it, see the "Understanding the IDC Versions Window" section.
Understanding the IDC Versions Window
The IDC Versions window allows you to specify information about IDC versions to use for IDC updates. It also enables you to upload new IDC versions to the Cisco IPICS server, and it lists information about each of the IDC versions that have been uploaded to the Cisco IPICS server.
To display the IDC Versions window in the Administration Console, navigate to IDC Management > IDC Versions.
Table 2-25 describes the items in the IDC Versions window.
Table 2-25 Items in the IDC Versions Window
Upgrade Package field
This field identifies the IDC version to be uploaded to the Cisco IPICS server.
See the "Uploading IDC Versions to the Cisco IPICS Server" section
Browse button
Click this button to browse to the location that contains the IDC version upgrade package to upload to the Cisco IPICS server.
Upload button
Click this button to upload a new IDC version to the Cisco IPICS server.
Priority field
Specifies the order of preference for IDC versions.
Version field
This field specifies a unique version number that is assigned to the IDC version upgrade package.
Name field
This field allows you to assign a unique identification to the IDC version upgrade package.
State field
This field specifies the priority (state) that is assigned to the upgrade package.
Delete button
Click this button to delete an IDC version from the Cisco IPICS server.
See the "Deleting IDC Versions" section
drop-down list for IDC version states
Choose from this list box to configure the state for the IDC versions.
Change State button
Click this button to change the state of the IDC version.
Uploading IDC Versions to the Cisco IPICS Server
When you upload a new IDC version, the upgrade package file is copied from a specified location on your PC to the Cisco IPICS server.
To upload an IDC version to the Cisco IPICS server, perform the following procedure:
Procedure
Step 1
Step 2
Step 3
The file that you choose displays in the Upgrade Package field.
Step 4
Cisco IPICS uploads the file from your PC to the Cisco IPICS server. The IDC version displays in the IDC Versions list.
Note
Changing the State of IDC Versions
The IDC Versions window enables you to specify various states for IDC versions. You can use states to designate whether in IDC version is a recommended or required update for an IDC user. IDC states are:
•
•
•
You must upload an IDC version to the Cisco IPICS server before it becomes available in any of the fields in the IDC Versions window.
To change the state of IDC versions for automatic updates, perform the following procedure:
Procedure
Step 1
Step 2
Step 3
Step 4
Deleting IDC Versions
To delete IDCC versions, perform the following procedure:
Procedure
Step 1
Step 2
Step 3
A message displays asking if you want to delete the selected version.
Step 4
This version of the IDC is completely removed from the server.
If you do not want to delete the IDC version, click Cancel.
Managing IDC Alert Tones
IDC tone broadcast wave (.wav) files contain alerting tones, hereafter referred to as alert tones, that can be broadcast to a variety of Cisco IPICS users at the same time. Cisco IPICS stores alert tones in a set on the Cisco IPICS server. The alert tone set is packaged in a .zip file that you can upload to the server and that IDC users can then download on to their client machines.
An alert tone set is associated with an ops view; therefore, each IDC user can see only one tone set based on the ops view association. For more information about ops views, see Chapter 7, "Configuring and Managing Cisco IPICS Operational Views."
The IDC alert tone feature requires the use of compatible alerting tone files. These files must be:
•
•
•
•
•
As a Cisco IPICS system administrator, you can perform the following alert tone management functions:
•
•
•
Creating an IDC Alert Tone Set
To provide the alert tones that get downloaded to the IDC, you must first create an IDC alert tone set and upload it to the Cisco IPICS server. To create the tone set, perform the following procedure:
Procedure
Step 1
C:\Program Files\Cisco Systems\Cisco IDC 4.0
Step 2
This file contains a sample alert tone set.
Step 3
These files must be normalized to -2 db and must be PCM 8KHz signed, Little Endian, 16-bit mono codec.
Step 4
Note
Step 5
<file item="1" name="stop.wav" displayName="STOP" type="tone" priority="required" /><file item="2" name="message.wav" displayName="Message" type="tone" priority="required" /><file item="3" name="siren.wav" displayName="Siren" type="tone" priority="required" /><file item="4" name="alert.wav" displayName="Alert" type="tone" priority="required" /><file item="5" name="urgent.wav" displayName="URGENT" type="tone" priority="required" />where:
"name" represents the .wav file to be played, and "displayName" is the text that displays on the IDC.
Step 6
Note
Step 7
Step 8
Step 9
Tip
Step 10
Step 11
See the "Associating an Alert Tone Set to an Ops View" section for information about how to upload a tone set.
Note
Adding IDC Alert Tone Sets
To add a new IDC alert tone set, perform the following procedure.
Tip
Procedure
Step 1
Step 2
A blank alert tone detail window displays.
Step 3
Step 4
Step 5
Step 6
The tone set gets uploaded to the server and is available for use by IDC users.
The alert tone set name, file size, and MD5 summary information of the new alert tone set also displays.
If you do not want to save your changes, click Cancel.
Step 7
Viewing or Editing IDC Alert Tone Sets
To view or edit the IDC alert tone sets that are available for use in Cisco IPICS, perform the following procedure:
Procedure
Step 1
Step 2
An alert tones detail window displays current information about the tone set that you chose.
Step 3
Step 4
•
•
•
Step 5
If you do not want to save your changes, click Cancel.
Step 6
Associating an Alert Tone Set to an Ops View
You can associate an alert tone set to an ops view while you are adding a new alert tone set, or you can associate an ops view to an existing tone set. Associating an alert tone set to an ops view ensures that IDC users can see only the tone set that is associated with the ops view to which they belong.
To associate an alert tone set to an ops view, perform the following procedure:
Procedure
Step 1
Step 2
Step 3
Step 4
•
•
•
Step 5
IDC users can now only see the alert tone set that is in the ops view to which they belong.
Note
If you do not want to save you changes, click Cancel.
Deleting IDC Alert Tones
To delete IDC tones, perform the following procedure:
Procedure
Step 1
Step 2
Step 3
The alert tone that you deleted is no longer available for use by the IDC users.
Note
Managing the IDC Installer
Before an IDC user can download a new IDC version to a clients, you must configure the IDC Installer.
The IDC Installer installs the IDC on IDC client machines. The IDC installer, called idcsetup.exe, downloads to an IDC client when a IDC user clicks the Download IDC link in the Home drawer, as described in the "Downloading the IDC" section on page 4-22.
As a Cisco IPICS system administrator, you can upload a new IDC package and generate the IDC Installer as described in the "Generating the IDC Installer" section.
You perform these tasks in the IDC Installer window. For more information about this window, including how to access it, see the "Using the IDC Installer Window" section.
Using the IDC Installer Window
The IDC Installer window contains configuration information that is necessary to generate an IDC installer.
To display the IDC Installer window, navigate to the IDC Management drawer in the Cisco IPICS Administration Console and click the IDC Installer link.
The Installer Status field displays the date and time that an idcsetup.exe file was last generated, and displays the IP address defined by the bundled idc.ini file. These files are used to install the IDC.
Generating the IDC Installer
Generating an IDC Installer installs a new IDC version package. It also makes the IDC version package available for download from the Download IDC link in the Home drawer (see the "Downloading the IDC" section on page 4-22).
For information about configuring additional IDC options, see the "Managing Cisco IPICS Options" section.
To generate an IDC Installer, perform the following procedure:
Procedure
Step 1
Step 2
•
•
If you use this option, the IP address that you enter should be tested in the network domain that is supported with that server to ensure that NAT or firewall restrictions do not prevent the IDC from connecting to that server.
In a high availability deployment, specify the IP address of the primary server. Information about the secondary server is provided to the IDC automatically so that the IDC properly fails over to the secondary server if the primary server goes down.
Step 3
Step 4
Note
Step 5
The drop-down list should be populated with the version numbers of the idcinst.exe files that have been uploaded to the Cisco IPICS server. See the "Managing IDC Versions" section for more information.
Note
Step 6
IDC users can now download a new version of the IDC application, as described in the "Downloading the IDC" section on page 4-22.
If you do not want to save your changes, click Cancel.
Managing IDC Regions
An IDC region is a grouping of channels on the IDC. Channels (radios) are divided among regions. Channels, radios, and VTGs are configured to belong to a particular region when they are created. You can configure regions (views) that the IDC displays to a user.
When you configure new regions in the Cisco IPICS server, they are represented by tabs that display in the IDC. The position of the region in the IDC Regions window in the Administration Console determines where the region displays on the IDC.
You create regions in the IDC Management > IDC Regions window in the Administration Console. You can configure up to six regions.
You can add new IDC regions, as well as edit and delete existing regions, as described in the following procedures:
•
•
Understanding the IDC Regions Window
The IDC Regions window allows you to create new IDC regions that display on the IDC. You can also edit and delete existing IDC regions in this window.
The IDC Regions window lists information about each of the IDC regions that have been created in the Cisco IPICS server.
To display the IDC Regions window, navigate to the IDC Management > IDC Regions window.
Table 2-26 describes the items in the IDC Regions window.
Table 2-26 Item in the IDC Versions Window
Name field
This field specifies the name of the IDC regions.
See the "Adding IDC Regions" section and the "Viewing or Editing IDC Regions" section
Short Name field
This field specifies the shortened name of the regions.
Position field
This field specifies the position of the regions on the IDC display.
Add button
Click this button to add a new IDC region to the Cisco IPICS server.
See the "Adding IDC Regions" section
Delete button
Click this button to delete an IDC region.
See the "Deleting IDC Regions" section
Adding IDC Regions
To add a new IDC region, perform the following procedure:
Procedure
Step 1
Step 2
A blank New IDC Region detail window displays.
Note
Step 3
Step 4
Tip
Step 5
Position indicates where the region appears in the Regions list in the IDC. Position 1 indicates the top position, and 6 indicates the bottom position. If you want to assign a region to a position that is in use, you must delete the in-use region first, as described in the "Deleting IDC Regions" section.
Step 6
Step 7
The region displays in the list of IDC regions and is available to assign to a channel/VTG while creating/updating channel/VTGs.
If you do not want to save your changes, click Cancel.
Viewing or Editing IDC Regions
To view or edit the IDC regions that are available for use in Cisco IPICS, perform the following procedure.
Procedure
Step 1
Step 2
A window displays current information about the region that you choose.
Step 3
•
•
•
•
For a description of the fields in this window, see the "Adding IDC Regions" section.
Step 4
If you do not want to save your changes, click Cancel.
Deleting IDC Regions
To delete IDC regions, perform the following procedure. When you delete an IDC region, any associated channels and VTGs are moved to region 1.
Procedure
Step 1
Step 2
Step 3
The region that you deleted is no longer available for use by the IDC users.
