Cisco Unity Express Command Reference for 3.0 and Later Versions
Cisco Unity Express Commands: P

Table Of Contents

P

parameter (ccn application)

parameter (ccn subsystem edbs dbprofile)-IVR Only

privilege

purge notification (ccn reporting historical)

purge now (ccn reporting historical)

purge purge-capacity (ccn reporting historical)

purge schedule (ccn reporting historical)

purge warning-capacity (ccn reporting historical)


P


Last Updated: October 20, 2009

parameter (ccn application)

parameter (ccn subsystem edbs dbprofile)-IVR Only

privilege

purge notification (ccn reporting historical)

purge now (ccn reporting historical)

purge purge-capacity (ccn reporting historical)

purge schedule (ccn reporting historical)

purge warning-capacity (ccn reporting historical)

parameter (ccn application)

To set the value for a CCN application parameter, use the parameter command in Cisco Unity Express configuration application mode. This command does not have a no form.

parameter parameter-name "value"

Syntax Description

parameter-name

Specifies the parameter whose value is being set. These parameters are specified in the application script.

"value"

Specifies the value for the parameter. The value must be entered within double quotes.


Command Modes

Configuration application

Command History

Cisco Unity Express Version
Modification

1.0

This command was introduced on the Cisco Unity Express network module and in Cisco Unified Communications Manager Express 3.0.

1.1

This command was implemented on the advanced integration module (AIM) and in Cisco Unified Communications Manager 3.3(3).

1.1.2

This command was implemented on the Cisco 2800 series and Cisco 3800 series routers.


Usage Guidelines

Following are the parameters that may be configured for the aa.aef script:

welcomePrompt—default: AAWelcome.wav

operExtn—default: none

holidayPrompt—default: AAHolidayPrompt.wav

businessOpenPrompt—default: AABusinessOpen.wav

businessClosedPrompt—default: AABusinessClosed.wav

businessSchedule—default: systemschedule

disconnectAfterMenu—default: false

allowExternalTransfers—default: false

Following are the parameters that may be configured for the aa_simple.aef script:

welcomePrompt—default: AAWelcome.wav

operExtn—default: 0

MaxRetry—default: 3

holidayPrompt—default: AAHolidayPrompt.wav

businessOpenPrompt—default: AABusinessOpen.wav

businessClosedPrompt—default: AABusinessClosed.wav

playExtensionsPrompt—default: AASPlayExtensions.wav

extensionLength—default: 1

businessSchedule—default: systemschedule

disconnectAfterMenu—default: false

allowExternalTransfers—default: false

Use the default parameter command to configure custom-defined parameters.

Examples

The following examples sets the value of the MaxRetry parameter to 6:

se-10-0-0-0# config t

se-10-0-0-0(config)# ccn application autoattendant

se-10-0-0-0(config-application)# parameter MaxRetry "6"

se-10-0-0-0(config-application)# end

se-10-0-0-0(config)# exit

Related Commands

Command
Description

ccn application

Configures the CCN applications, such as voice mail and auto attendant.

default (ccn application)

Configures application parameters.

show call-agent

Displays the CCN application details.


parameter (ccn subsystem edbs dbprofile)-IVR Only

To specify the Java Database Connectivity (JDBC) driver-specific parameter for the Cisco Unity Express IVR enterprise database subsystem (EDBS), use the parameter command in Cisco Unity Express IVR EDBS profile configuration mode. To delete the JDBC parameter, use the no form of this command.

parameter name value

no parameter name value

Syntax Description

name value

(Optional) Name value pair that matches the JDBC driver requirements.


Command Default

None

Command Modes

Cisco Unity Express IVR EDBS profile configuration

Command History

Cisco Unity Express Version
Modification

3.0

This command was introduced.


Usage Guidelines

After the ccn subsystem edbs dbprofile command is successfully performed, use the optional parameter command to specify the JDBC driver-specific parameter. The name value pair must match the JDBC driver requirements. Each JDBC driver can have its own unique set of customized settings. You can use this command multiple times to set multiple driver properties.

Examples

The following example configures the JDBC driver parameters:

se-10-0-0-0# config t
se-10-0-0-0(config)# ccn subsystem edbs dbprofile mydbprofile
Adding new Database profile
se-10-0-0-0(config-dbprof)# parameter *headerchar *continuation
se-10-0-0-0(config-dbprof)# end
se-10-0-0-0(config)# exit

Related Commands

Command
Description

show ccn subsystem edbs dbprofile-IVR Only

Displays the Cisco Unity Express IVR EDBS configuration settings.


privilege

To add and configure a new privilege or define the properties of an existing privilege, use the privilege command in Cisco Unity Express configuration mode. Use the no version to remove the privilege.

privilege privilege-name [description string | operation operation-name | include privilege-name2]

no privilege privilege-name

Syntax Description

privilege-name

Label used to identify and configure a new privilege.

description string

(Optional) Add a description for the privilege. The description appears in the output of the show privilege detail and show privileges commands.

operation operation-name

(Optional) Associate an operation to the privilege.

include privilege-name 2

(Optional) Include, or nest, another privilege into this privilege.


Defaults

If no new privileges are defined, only predefined privileges are available. Unless otherwise specified, the default for new privileges is that they have no operation associated with them, no text description, and no second privilege is nested within them.

Command Modes

Cisco Unity Express configuration (config)

Command History

Cisco Unity Express Version
Modification

7.0

This command was introduced.


Usage Guidelines

If no new privileges are added, predefined privileges are used.

Examples

The following example enables authentication for the console:

se-10-0-0-0# config t
se-10-0-0-0(config)# privilege sales_vp operation security.configuration 

Related Commands

Command
Description

show operations

Shows all operations.

show privileges

Shows all system privileges.


purge notification (ccn reporting historical)

To configure e-mail addresses to notify users of automatic database purges of the Cisco Unity Express IVR reporting historical database, use the purge notification command in Cisco Unity Express IVR reporting historical configuration mode. Use the no form of this command to delete this configuration.

purge notification email address email-address

no purge notification email address email-address

Syntax Description

email address email-address

E-mail address, or series of e-mail addresses (of up to 255 characters in length) separated by commas, sent to notify users that the reporting historical database has been purged.


Command Default

No default e-mail address is configured.

Command Modes

Cisco Unity Express IVR reporting historical configuration

Command History

Cisco Unity Express Version
Modification

3.0

This command was introduced,


Usage Guidelines

There is no default e-mail address for sending a notification. If an e-mail address is not configured, notifications are not sent.

If you must configure more than one e-mail address, enter the series of e-mail addresses separated by commas, without spaces.

Examples

The following example configures an e-mail address to notify administrators that the Cisco Unity Express IVR reporting historical database has been automatically purged:

se-10-0-0-0# config t
se-10-0-0-0(config)# ccn reporting historical
se-10-0-0-0(config-hrdm)# purge notification email address name@domain.com
se-10-0-0-0(config-hrdm)# end
se-10-0-0-0(config)# exit

Related Commands

Command
Description

show ccn reporting historical

Displays the Cisco Unity Express IVR reporting historical database configuration settings.


purge now (ccn reporting historical)

To manually purge the Cisco Unity Express IVR reporting historical database and remove historical data older than the configured days-to-keep number of days, use the purge now command in Cisco Unity Express IVR reporting historical configuration mode.

purge now days-to-keep days

Syntax Description

days-to-keep days

Number of days after which data older than the number of days specified are deleted from the reporting historical database. The valid range is from 1 to 1000.


Command Default

None

Command Modes

Cisco Unity Express IVR reporting historical configuration

Command History

Cisco Unity Express Version
Modification

3.0

This command was introduced,


Usage Guidelines

When the database is purged, historical statistics older than the configured days-to-keep value are removed from the database. The days-to-keep value is required for manually purging the database.

Examples

The following example manually purges the reporting historical database and any data older than 7 days:

se-10-0-0-0# config t
se-10-0-0-0# ccn reporting historical 
se-10-0-0-0(config-hrdm)# purge now days-to-keep 7
se-10-0-0-0(config-hrdm)# end
se-10-0-0-0(config)# exit

Related Commands

Command
Description

show ccn reporting historical

Displays the Cisco Unity Express IVR reporting historical database configuration setting.


purge purge-capacity (ccn reporting historical)

To set the purge threshold (as a percentage of the total database capacity) and the age of data to be purged in the Cisco Unity Express IVR reporting historical database, use the purge purge-capacity command in Cisco Unity Express IVR reporting historical configuration mode. Use the no form of this command to set the purge capacity percentage and the number-of-days to purge to the default value.

purge purge-capacity percentage percent days-to-purge days

no purge purge-capacity percentage percent days-to-purge days

Syntax Description

percentage percent

Purge threshold as a percentage of the total database capacity. The valid purge threshold percentage is in the range from 0 to 90.

days-to-purge days

Number of days after which data older than the number of days specified are deleted from the reporting historical database. The valid number of days-to-purge is in the range from 0 to 999.


Command Default

The default purge capacity percent value is 90.
The default number of days to purge is 7.

Command Modes

Cisco Unity Express IVR reporting historical configuration

Command History

Cisco Unity Express Version
Modification

3.0

This command was introduced,


Usage Guidelines

The maximum purge capacity percentage value allowed is 90.

Examples

The following example configures the Cisco Unity Express IVR reporting historical database purge capacity threshold to 90 and the number of days-to-purge data to 7:

se-10-0-0-0# config t
se-10-0-0-0(config)# ccn reporting historical
se-10-0-0-0(config-hrdm)# purge purge-capacity percentage 90 days-to-purge 7
se-10-0-0-0(config-hrdm)# end
se-10-0-0-0(config)# exit

Related Commands

Command
Description

show ccn reporting historical

Displays the Cisco Unity Express IVR reporting historical database configuration setting.


purge schedule (ccn reporting historical)

To schedule the time of day for daily purging the Cisco Unity Express IVR reporting historical database, use the purge schedule command in Cisco Unity Express IVR reporting historical configuration mode. Use the no form of this command to set the scheduled purge time and number of days to the default value.

purge schedule time hh:mm days-to-keep days

no purge schedule time hh:mm days-to-keep days

Syntax Description

time hh:mm

The daily time in hours and minutes (hh:mm) in 24-hour format, at which the data is purged from the reporting historical database.

days-to-keep days

Sets the number of days after which data older than the number of days specified are deleted from the reporting historical database. The value for days-to-keep is in the range from 0 to 1000.


Command Default

The default purge schedule is set at 04:00. The default number of days-to-keep is 90 for the AIM-CUE/AIM2-CUE module and 365 for the NM-CUE, NM-CUE-EC, NME-CUE and ISM-SRE-300-K9 modules.

Command Modes

Cisco Unity Express IVR reporting historical configuration

Command History

Cisco Unity Express Version
Modification

3.0

This command was introduced,


Usage Guidelines

Database purging is performed daily at the time of day (in hours:minutes 24-hour format) specified. Stored historical data older than that specified in the days-to-keep value (in days) is purged from the database. Table 5 summarizes the maximum values that can be specified for days-to-keep.

Table 5 Maximum Days-to-Keep Value

Database
Storage Limits

AIM-CUE/AIM2-CUE

90 days or database 90% full

NM/NM-EC/NME-CUE
ISM-SRE-300-K9
SM-SRE-700-K9

365 days or database 90% full


Examples

The following example configures the reporting historical database to purge data older than 30 days at 4:00 a.m. daily:

se-10-0-0-0# config t
se-10-0-0-0(config)# ccn reporting historical
se-10-0-0-0(config-hrdm)# purge schedule time 04:00 days-to-keep 30
se-10-0-0-0(config-hrdm)# end
se-10-0-0-0(config)# exit

Related Commands

Command
Description

show ccn reporting historical

Displays the Cisco Unity Express IVR reporting historical database configuration settings.


purge warning-capacity (ccn reporting historical)

To send an e-mail notification when a certain percentage database capacity is reached, use the purge warning-capacity command in Cisco Unity Express IVR reporting historical configuration mode.

When the percentage of capacity is reached, an e-mail is sent to notify users that the Cisco Unity Express IVR reporting historical database capacity is approaching its limit. Use the no form of this command to set the warning capacity percentage to the default value.

purge warning-capacity percentage percent

no purge warning-capacity percentage percent

Syntax Description

percentage percent

Percentage of the total Cisco Unity Express IVR reporting historical database capacity. The valid percentage is in the range from 0 to 95.


Command Default

The default is 85 percent of database capacity.

Command Modes

Cisco Unity Express IVR reporting historical configuration

Command History

Cisco Unity Express Version
Modification

3.0

This command was introduced,


Usage Guidelines

An e-mail warning is sent when the maximum percentage value (90 percent) is reached.

Examples

The following example configures the warning percentage for the Cisco Unity Express IVR reporting historical database at 80 percent:

se-10-0-0-0# config t
se-10-0-0-0(config)# ccn reporting historical
se-10-0-0-0(config-hrdm)# purge warning-capacity percentage 80
se-10-0-0-0(config-hrdm)# end
se-10-0-0-0(config)# exit

Related Commands

Command
Description

show ccn reporting historical

Displays the Cisco Unity Express IVR reporting historical database configuration settings.