| Oracle® Voicemail & Fax Administrator's Guide 10g Release 1 (10.1.1) Part Number B14496-03 |
|
|
View PDF |
| Oracle® Voicemail & Fax Administrator's Guide 10g Release 1 (10.1.1) Part Number B14496-03 |
|
|
View PDF |
This appendix contains the commands for the Interactive Voice Response Manager (ivrman).
IVR Manager is a command-line tool to create and manage the different components of IVR deployments. Using IVR Manager, you can:
Create, modify, and delete a call flow
Create, modify, and delete a sound file group
Create, modify, and delete a profile
Create, modify, and delete a deployment
The tool can be found at %ORACLE_HOME%/um/scripts on the machine where Oracle Voicemail & Fax is installed. Type ivrman at the command line to get help on the command syntax. You can type ivrman followed by one of the modes (callflow, sfgroup, profile, deployment) and get the syntax for all the commands for that mode. For example, if you type ivrman callflow, the tool displays the syntax for the ivrman callflow add, ivrman callflow delete, ivrman callflow dump, ivrman callflow list, and ivrman callflow replace commands.
Use the ivrman callflow commands to create and modify IVR call flows.
Takes the contents of the file_name file and loads the call flow in Oracle directory server with the name flow_name
Syntax
ivrman callflow add flow_name file_name
Parameters
flow_name – name of the call flow
file_name – name of the XML document that describes the call flow
Comments
If a call flow with the specified name already exists or the contents of the file are in the wrong format, the tool displays an error message and makes no changes.
To update an existing call flow, use ivrman callflow replace.
Deletes a call flow and all profiles associated with the call flow.
Syntax
ivrman callflow delete flow_name [-f]
Parameters
flow_name – name of the call flow
-f – If -f is not specified, the command deletes a call flow only if it is not referred to in a deployment. The -f flag deletes the call flow even if a deployment references the call flow.
Comments
If the -f flag is not specified and the call flow is referred to in a deployment, the tool displays a message telling the user to use the -f flag and it does not delete the call flow.
Saves the specified call flow description in the file_name file.
Syntax
ivrman callflow dump flow_name file_name
Parameters
flow_name – name of the call flow
file_name – name of the XML document
Comments
If the specified call flow does not exist, the tool displays an error. If the file_name specified already exists, the tool overwrites the contents of the file.
Displays a list of all call flows in the Oracle Voicemail & Fax system.
Syntax
ivrman callflow list
Comments
None.
Replaces the specified call flow with the contents of the file_name file.
Syntax
ivrman callflow replace flow_name file_name
Parameters
flow_name – name of the call flow
file_name – name of the text file
Comments
If the specified call flow does not exist or if the contents of the file are in the wrong format, the tool displays an error message and makes no changes.
Use ivrman callflow replace to make changes to an existing call flow. To create a new call flow, use the ivrman callflow add command.
Use the ivrman sfgroup commands to create and modify sound file groups.
Adds a new sound file group to Oracle Voicemail & Fax.
Syntax
ivrman sfgroup add group_name flow_name [-batch file_name]
Parameters
group_name – name of the sound file group
flow_name – name of the call flow
file_name – name of the file that contains the entries for the sound file group
Comments
ivrman sfgroup add can be used in interactive mode or batch mode using the -batch flag.
In interactive mode, IVR Manager prompts you for the path location and coder type of the sound file for each role in the specified call flow.
In batch mode, the file_name file includes an entry for each role that is declared in the specified call flow. You must include an entry for each role. One role is specified per line, and entries are in the following format:
role_name, path_location, coder_type
role_name is the value of the sfRole tag, path_location is the location of the sound file for this role, and coder_type is the compression algorithm used to compress the sound file. The following coder types are supported.
Table E-1 Supported Coder Types
| Coder Type Name | Description |
|---|---|
|
48k8BitLinear |
48 kbps (6 kHz), 8 bit linear PCM |
|
64k8BitLinear |
64 kbps (8 kHz), 8 bit linear PCM |
|
88k8BitLinear |
88 kbps (11 kHz), 8 bit linear PCM |
|
24kADPCM |
24 kbps ADPCM |
|
32kADPCM |
32 kbps ADPCM |
|
44kADPCM |
44 kbps ADPCM |
|
48kMuLaw |
48 kbps MuLaw PCM |
|
64kMuLaw |
64 kbps MuLaw PCM |
|
88kMuLaw |
88 kbps MuLaw PCM |
|
48kALaw |
48 kbps ALaw PCM |
|
64kALaw |
64 kbps ALaw PCM |
|
88kALaw |
88 kbps ALaw PCM |
If the sound file group with the specified name already exists, IVR Manager displays an error message and exits without adding the sound file group.
Deletes the specified sound file group.
Syntax
ivrman sfgroup delete group_name [-f]
Parameters
group_name – name of the sound file group
-f – If -f is not specified, the command deletes a sound file group only if it is not referred to in a deployment. The -f flag deletes the sound file group even if a deployment references the call flow.
Comments
If the -f flag is not specified and the sound file group is referenced by a deployment, IVR Manager displays an error message and does not delete the sound file group.
Displays a list of the sound file roles, coder types, and sound file sizes for the specified sound file group.
Syntax
ivrman sfgroup describe group_name
Parameters
group_name – name of the sound file group
Comments
None
Writes the sound file for the specified role and sound file group to the file_name file.
Syntax
ivrman sfgroup dump group_name role file_name
Parameters
group_name – name of the sound file group
role – name of the role in the sound file group
file_name – name of the file that contains the entries for the sound file group
Comments
None
Displays a list of all sound file groups installed in Oracle Voicemail & Fax.
Syntax
ivrman sfgroup list
Comments
None
Replaces sound files in a sound file group.
Syntax
ivrman sfgroup update group_name [-batch file_name]
Parameters
group_name – name of the sound file group
file_name – name of the file that contains the entries for the sound file group
Comments
ivrman sfgroup update only allows you to update the existing sound files. If you change the call flow and add another role, you need to delete the old sound file group, then re-create the sound file group using the new call flow.
ivrman sfgroup update can be used in interactive mode or batch mode using the -batch flag.
In interactive mode, IVR Manager prompts you to enter a sound file and the coder type for each role in the sound file group. The current setting appears in brackets beside the prompt. You may change the value or keep the current setting by pressing Enter.
In batch mode, IVR Manager uses a batch file. Refer to ivrman sfgroup add for the format of this file. You need to specify only those roles whose settings have changed. The tool does not modify the settings for roles that are not included.
If the batch file includes a role that is not included in the sound file group, a message is displayed and the tool ignores the role.
A profile is associated with a specific call flow. Therefore, you can have two profiles with the same name if they are tied to different call flows. A profile and a call flow together are required to identify a particular profile. Therefore, all of the ivrman profile commands (except ivrman profile list) require that you specify both the name of the profile and the name of the call flow.
Adds a new profile to the Oracle Voicemail & Fax system.
Syntax
ivrman profile add profile_name flow_name [-batch file_name]
Parameters
profile_name – name of the profile.
flow_name – name of the call flow for which the profile is being added.
file_name – name of the file that contains the profile keys and profile settings for the named profile. Used in batch mode.
Comments
ivrman profile add can be used in interactive mode or in batch mode using the -batch flag.
In interactive mode, IVR manager prompts you to enter a value for each profile key that is declared in the specified call flow. You must provide a value for each profile key.
In batch mode, the file_name file includes an entry for each profile key in the specified call flow. One profile key is specified per line, and entries are in the following format:
profile_key = value
The profile_key is the value of the profKey tag in the call flow and value is the setting for that key. If the batch file is missing settings for any declared profile key, IVR Manager prints an error and exits without adding the profile.
If the value is a phone number, the phone number must be entered in international format as a string of numbers with no spaces or punctuation, for example, 14152926000.
Displays a list of all profiles for the specified call flow.
Syntax
ivrman profile list flow_name
Parameters
flow_name – name of the call flow
Comments
None
Deletes the specified profile.
Syntax
ivrman profile delete profile_name flow_name [-f]
Parameters
profile_name – name of the profile.
flow_name – name of the call flow for which the profile is being updated.
-f – If -f is not specified, the command deletes a profile only if it is not referred to in a deployment. The -f flag deletes the profile even if it is referenced in a deployment.
Comments
If the -f flag is not specified and the profile is referenced by a deployment, IVR Manager displays an error message and does not delete the profile.
Displays the settings for the specified profile.
Syntax
ivrman profile dump profile_name flow_name
Parameters
profile_name – name of the profile.
flow_name – name of the call flow for which the profile is being updated.
Comments
IVR Manager displays the settings for a profile using the following format:
profile_key = value
profile_key is the value of the profKey tag in the call flow and value is the setting for that key.
Changes the settings for the profile keys in an installed profile.
Syntax
ivrman profile update profile_name flow_name [-batch file_name]
Parameters
profile_name – name of the profile.
flow_name – name of the call flow for which the profile is being updated.
file_name – name of the file that contains the profile keys and profile settings for the named profile. Used in batch mode.
Comments
ivrman profile update can be used in interactive mode or in batch mode using the -batch flag.
In interactive mode, IVR manager prompts you to enter a value for each profile key that is declared in the specified call flow. The current setting appears in brackets next to the prompt. You may change the value or keep the current setting by pressing Enter.
In batch mode, a file with the profile keys and settings is specified with the -batch flag. Refer to ivrman profile add for the format of this file. You need to specify only those profile keys whose settings have changed.
Use the deployment commands to create and modify your IVR deployments.
Adds a new deployment to the Oracle Voicemail & Fax system.
Syntax
ivrman deployment add deployment_name
Parameters
deployment_name – name of the deployment
Comments
The command prompts you to provide a locale for the deployment. This locale setting is the language in which callers to your system will hear the Oracle Voicemail & Fax voicemail prompts. This setting is optional; the default is U.S. English. Use the ovfucr displaylanguagelist command to display a list of the supported languages and their codes. See "ovfucr displaylanguagelist" for more information on using this command.
The locale setting should not be confused with the language in which you record your sound files. There is no locale setting for the IVR. To create an IVR in different languages, you need to provide a different set of sound files, recorded in the languages you want to support. See the LanguageChoiceAutoAttendant sample IVR deployment for an example.
ivrman deployment add prompts you to provide the name of the call flow, sound file group, and profile for each time category (Open, Closed, Holiday, and Special). The call flow, sound file group, and profile for each time category in your deployment must be created and added before you create a new deployment.
You must provide a call flow, profile, and sound file group for each time category. For some deployments, the same call flow, sound file group, and profile may be used for more than one time category. Some call flows may not have a sound file associated with it, for example, a call flow that sends a call directly to a voicemail mailbox. Or in the case of the Special time category, you cannot create a sound file in advance. In this situation, create a placeholder sound file group or profile.
Syntax
ivrman deployment delete deployment_name
Parameters
deployment_name – name of the deployment
Comments
ivrman deployment delete does not give you a warning before deleting the deployment.
Displays the deployment locale and the call profile, call flow, and sound file group for each category.
Syntax
ivrman deployment dump deployment _name
Parameters
deployment _name – name of the deployment
Comments
None
Displays a list of all IVR deployments on the Oracle Voicemail & Fax system.
Syntax
ivrman deployment list
Comments
None
Updates an existing deployment and assigns a different call flow, profile, or sound file group to the deployment.
Syntax
ivrman deployment update deployment_name
Parameters
deployment_name – name of the deployment
Comments
Use ivrman deployment update to assign a call flow, profile, or sound file group with a different name to one or more of the time categories. If you want to make a change to a call flow, profile, or sound file group that is currently assigned to a deployment, you do not need to update the deployment.
The command prompts you to provide a locale for the deployment. This locale setting is the language in which callers to your system will hear the Oracle Voicemail & Fax voicemail prompts. This setting is optional; the default is U.S. English. Use the ovfucr displaylanguagelist command to display a list of the supported languages and their codes. See"ovfucr displaylanguagelist" for more information on using this command.
ivrman deployment update prompts you to provide the name of the call flow, sound file group, and profile for each time category (Open, Closed, Holiday, and Special). You must first use IVR Manager to create and add any new call flows, sound file groups, or profiles to Oracle Voicemail & Fax before you update the deployment.
