Configuration Tools and Behavior

The Oracle Enterprise Communications Broker (OECB) Web GUI provides the following tools for working with configurations. Some tools are located in the navigation pane and others are located at the top of the center pane.

The Configuration Tab Display

The following screen capture shows the locations of all of the Configuration tab controls.

This screen capture shows all of the controls on the configuration page.

Controls in the Navigation Pane

The navigation pane displays links to Configuration Wizards and Show Commands. (Descriptions are listed in the center pane.) The Wizards help you specify certain parts of the configuration and the Commands show you information about the configuration on the system.

This screen capture shows the list of configuration wizards and provides their descriptions

This screen capture shows the list of show commands and provides their descriptions

Controls in the Center Pane

The controls located at the top of the center pane on a configuration page help you manage configuration objects.

This screen capture shows the controls located at the top of the center pane on any configuration pane. The are described in the following table.

Save

Use to save the current configuration session. Upon Save, the system displays a prompt giving you a choice of whether or not to activate the configuration. If you do not activate the configuration, you can continue to make changes and Save again. When finished, you can save and activate all of the configuration changes.

Verify

Use to confirm that the configuration is valid before you save it.

Discard

Use to undo all configuration changes made in the current session. The system can only discard the changes that you saved. It cannot discard any changes that you activated.

Use to find and display the current settings for the configuration you are editing. Enter the name of the configuration object.

Controls for Multi-Instance Objects

The controls located at the top of a list of multi-instance objects help you manage the objects on the list. The following screen capture shows the controls.

This screen capture shows the controls located at the top of the center pane on any multi-instance list. The are described in the following table.

Add

Use to add another instance of the configuration object with one or more parameters set differently.

Delete All

Use to delete all instances.

Caution:

You cannot select a sub-set of instances and delete only those. The system deletes all instances, regardless of how many you select.

Upload

Use to upload a configuration file in CSV format.

Download

Use to download a configuration file in CSV format.

Use to search the list of multi-instances for a specific instance. When you enter the name of an instance, the Web GUI displays it at the top of the list.

Configuration Wizards

The Wizards control in the navigation pane displays a list of Wizards, for performing selected configuration procedures for the Oracle Enterprise Communications Broker (OECB).

The Wizards help you perform the following tasks:

Set Boot Parameters

Specify the boot file and the boot parameters.

Set Entitlements

Set the number of sessions that a license entitles you to, and enable advanced features.

Set Initial Configuration

Configure a new OECB or reconfigure an existing one. Includes configuring High Availability.

Set License

Enter the license number for a feature that requires a license.

Set Logon Banner

Customize the text on the Web GUI log on banner.

Set Time Zone

Select the time zone for the deployment.

Upgrade Software

Upload a newer version of the software.

Set Boot Parameters Wizard

The Oracle Enterprise Communications Broker (OECB) requires you to enter the necessary parameters to boot the system in your deployment.

You can set the OECB boot parameters from the Set Boot Parameters Wizard on the Web GUI in either Basic mode or Expert mode.

Access the Set Boot Parameters Wizard: Configuration, Wizards, Set Boot Parameters.

In the Set Boot Parameters dialog, enter the following information:

Boot File

Name of the image file.

IP Address

Enter the IP address of the OECB.

VLAN

Range: 0-4095

Net Mask

Enter the net mask IP address in dot decimal format. For example, 255.255.0.0.

Gateway

Internet address of the boot host. Leave blank if the host is on the same network.

IPv6 Address

Enter the IPv6 address that you want to use.

IPv6 Gateway

Enter the IPv6 gateway that you want to use.

FTP Host IP

Enter the IP address of the FTP host.

FTP Username

Enter the FTP username for the FTP user on the boot host.

FTP Password

Enter the FTP password for the FTP user on the boot host.

Flags

Hexadecimal. Always starts with 0x. See "Configurable Boot Loader Flags."

Target Name

Name of the OECB, as displayed at the system prompt.

Console Device

Enter the type of console device. For example, VGA.

Console Baud Rate

Select a console baud rate from the drop-down list.

Other

For miscellaneous and deployment-specific boot settings.

Click Complete.
The system displays a success message.
Click OK.

Configurable Boot Loader Flags

You may configure the following boot flags in the boot loader:

0x04 - disables autoboot timeout (ap3820 and ap4500 only)
0x08 - extend autoboot countdown timer to 15 seconds
0x40 - use DHCP for wancom0 (VM Edition only)
0x80 - network boot using TFTP instead of FTP

Set Entitlements Wizard

Use the Set Entitlements Wizard to enter the maximum number of sessions that your license allows.

Note the session limit number from your license.

You can launch the Set Entitlements Wizard on the Web GUI in either Basic mode or Expert mode.

Access the Set Entitlements Wizard: Configuration, Wizards, Set Entitlements.

In the Set Entitlements dialog, do the following:

Advanced

Select to add the Advanced license.

Admin Security

Select to enable your Admin Security license.

Data Integrity (FIPS 140 2)

Select to enable FIPS 140 2 data integrity.

Transcode Codec AMR

Select to enable AMR transcoding.

Transcode Codec AMRWB

Select to enable AMRWB transcoding.

Transcode Codec EVS

Select to enable EVS transcoding.

Session Capacity

Set the session limit number from the license. Valid values: 0-512000

Transcode Codec AMR Capacity

Set the transcoding capacity for AMR. Valid values: 0-102375.

Transcode Codec AMRWB Capacity

Set the transcoding capacity for AMRWB. Valid values: 0-102375.

Transcode Codec EVS Capacity

Set the transcoding capacity forEVS. Valid values: 0-102375.

Transcode Codec Opus Capacity

Set the transcoding capacity for Opus. Valid values: 0-102375.

Transcode Codec SILK Capacity

Set the transcoding capacity for SILK. Valid values: 0-102375.

Click Complete.
The system displays a success message.
Click OK.

Set Initial Configuration Wizard

Use the Set Initial Configuration wizard to perform the initial configuration on an unconfigured system and to change the configuration on a configured system. During the configuration, you select the scope of configuration that you want to perform, define the boot parameters, opt to set a VLAN, and configure features such as High Availability (HA) and access to the Oracle Communications Session Delivery Manager (OC SDM). A valid license is required to run the Set Initial Configuration wizard.

Launch the Set Initial Configuration Wizard

Unconfigured system. The system launches the Web GUI Set Initial Configuration wizard upon the first logon. When the initial configuration is complete, the system saves the configuration, activates the configuration, and reboots. The system does not backup the initial configuration of an unconfigured system.
Configured system. From the Configuration tab on the Web GUI, click the Wizards button and click Set Initial Configuration. When the re-configuration is complete, the system saves a backup of the existing configuration, saves the new configuration, activates the new configuration, and reboots. The backup is stored in /code/bkups.

Before you can configure the OECB, the wizard requires you to make the following selections that determine which configuration parameters the wizard displays.

Enable Web GUI: Yes or No

If you select No, you may continue using the Wizard to set the initial configuration until you reboot. After you reboot, the system no longer displays the Web GUI. If you want to enable the Web GUI in the future, configure the Web Server Config object from the ACLI.

Choose Web GUI Mode: Basic or Expert

When selecting Basic mode or Expert mode, the decision is about how much control you want in the configuration process and whether or not you want to use one of more of the advanced features and settings provided in Expert mode.

In Basic Mode, the system displays the minimum number of settings that you need to successfully deploy and operate the OECB. While you cannot configure the advanced settings and features in Basic mode, you can switch to Expert mode to do so. Note that when you switch to Expert Mode and perform Save, you cannot switch back to Basic Mode. The Web GUI will display the Expert Mode from then on, including after a new log on.
In Expert Mode, you can use the advanced settings and options to control the configuration with more granularity. The system does not require you to configure all advanced settings and features. You can choose what you need for your deployment.

OECB Mode: Standalone or High Availability

If you select Standalone, you can begin configuring the parameters displayed.
If you select High Availability, the GUI adds OECB Role: Primary/Secondary to the display.

OECB Role: Primary or Secondary

If you selected High Availability for OECB Mode:

Select Primary, and configure the displayed parameters.
Select Secondary, and select Yes or No for Acquire Configuration from Primary. If you select No, the GUI adds a field where you enter the Peer Target Name.

Note:

Unlike other OECBs, which provide 2 management interfaces and 2 media interfaces, the Acme Packet 1100 provides 1 management interface and 2 media interfaces. When configuring HA, the configuration dialogs for the Acme Packet 1100 differ from the other OECBs because you must create a second, virtual management interface. For creating the second management interface, the HA dialogs on the Acme Packet 1100 contain more attributes than the dialogs for the other OECBs. Regardless of the OECB model, the path through the Set Initial Configuration wizard to the HA dialogs is the same as described in this topic.

Configure the System

The system requires an initial configuration of attributes, such as modes and IP addresses, before it can function in the network.

Use the Set Initial Configuration Wizard to define the attributes for the system. The system displays the Set Initial Configuration Wizard upon the first logon.

Logon to the Oracle Enterprise Communications Broker.
The system displays the Set initial configuration wizard.
Run the Set Initial Configuration Wizard, and click Complete.
The system saves the configuration, activates the configuration, and re-boots.

Configure the system objects.

Reconfigure the System

You can reconfigure the system from the Web GUI.

Use the Set Initial Configuration Wizard to change the initial configuration on a configured system, for example, change attributes such as IP addresses and modes.

Log on to the system.
Access the Set Initial Configuration Wizard: Configuration, Wizards, Set Initial Configuration.
Run the Set Initial Configuration Wizard and change the attributes, as needed.
Click Complete.
The system saves a backup of the existing configuration, saves the new configuration, activates the new configuration, and automatically re-boots.

(Optional) Reconfigure the system objects.

Set License Wizard

Use the Set License Wizard to enter the serial number for your license. You can use the Set License Wizard in Basic Mode and Expert Mode.

Obtain the license, which includes the serial number, for the feature that you want to add to the deployment. See "Obtain a License" in the ACLI Configuration Guide.

You need the license number for the following procedure.

Access the Set License Wizard: Configuration, Wizards, Set License.
In the Set License dialog, enter the license serial number in the Add license field.
Click Complete.
The system displays a success message.
Click OK.

Set Login Banner Wizard

Use the Set Login Banner Wizard to add customized text to the log on page. You can use the Set Login Banner Wizard in Basic mode and Expert Mode.

You can customize the log on page by adding text to help the user. For example, Welcome to <company name> <business unit> <location> session border controller <device name>.

Access the Set Login Banner Wizard: Configuration, Wizards, Set Login Banner.
In the Set Login Banner dialog, enter the text that you want to display on the log on page.
Click Complete.
The system displays a success message.
Click OK.

Set Time Zone Wizard

The system requires a setting for time zone.

You can set the system time from the Set Time Zone Wizard on the Web GUI. You can select a time zone or Coordinated Universal Time (UTC). You can use the Set Time Zone Wizard in Basic Mode and Expert Mode.

Access the Set Time Zone Wizard: Configuration, Wizards, Set Time Zone.
From the drop down list, select one of the following:
- Time zone by locale
- UTC
Click Complete.
The system displays a success message.
Click OK.

Upgrade Software Wizard

You can upgrade the system software with the Upgrade Software Wizard on the Web GUI. You can use the Upgrade Software Wizard in Basic Mode and Expert Mode.

Use the Upgrade Software Wizard to perform the following tasks:

Check the system health before the upgrade
Download new software
Change boot parameters
Reboot the system

The system requires a reboot after the upgrade for the changes to take effect.

Access the Upgrade Software Wizard: Wizards, Upgrade Software .
(Optional) In the Upgrade Software dialog, click Verification, and do the following:
- Click View Synchronization Health, and confirm that the system components are synchronized.
- Click View Configuration Version, and note the Current Version and Running Version.
- Click View Disk Usage, and confirm that the system has enough free space.

In the Upgrade Software dialog, do the following:

Upload method

Select an upload method from the drop-down list.

Software file to upload

Browse to the file to upload.

Reboot after upload

Select to reboot the system after the upgrade.

Click Complete.
- If you did not select Reboot After Upload, the system displays a message stating that a reboot is required for the changes to take effect.
- If you selected Reboot After Upload, the system displays a message stating that it is about to reboot.
Click OK.
The system performs the file transfer and any boot parameter changes. If you selected Reboot After Update, the system reboots.

Edit, Copy, and Delete Configurations

You can edit, copy, and delete multi-instance configurations by way of the controls that the Web GUI displays on each multi-instance configuration page. The edit and copy functions act only on a single instance of a configuration. The delete function can act on either a single instance or all instances.

To edit, copy, or delete a single multi-instance configuration, select the configuration and right-click. The Web GUI displays the edit, copy and delete menu.

This screen capture shows the right-clivk menu for the edit, copy, and delete opetations. It also shows Delete All in the tool bar at the top of the page.

When you click Delete, the system displays a confirmation dialog before performing the operation. When you click either Copy or Edit, the GUI displays the configuration dialog.

To delete all configurations at the same time, use Delete All.

Caution:

You cannot select several instances and delete only those. The system deletes them all, regardless of how many you select. For example, if you select two of three configurations and click Delete All, the system deletes all three.

Configuration States and Behavior

After you finish creating or modifying a configuration, you must save and activate the configuration before the Oracle Enterprise Communications Broker (OECB) saves the changes to the running configuration.

At any time, the following three versions of the configuration can exist on the OECB.

Editing. The editing configuration is the version that you are making changes to from the Web GUI. The editing version is stored in the OECB volatile memory. The editing version cannot survive a system reboot.
Saved. The saved configuration is the version of the editing configuration that the system copies into the non-volatile memory when you click Save on the Web GUI. Until you activate the saved configuration, the changes do not take effect on the OECB. The system does not load the saved, but not activated, configuration as the running configuration on reboot.
Running configuration. The running configuration is the configuration that the system is using. When you activate the saved configuration it becomes the running configuration. Most configuration changes can take effect upon activation. Some configuration changes require a system reboot. On reboot, the system loads the running configuration.

The process for saving and activating a configuration, includes the following steps.

OK. All configuration dialogs display an OK button that saves changes to the editing memory. If you reboot before the next step, the OECB does not save the changes.
Save. The Save button on the Web GUI toolbar verifies the configuration, displays errors, saves the current configuration to the last-saved configuration, and stores it on the OECB. The system displays any errors at the bottom of the Configuration page.
Activate. After you finish making one or more configuration changes, OK and Save from the last configuration dialog that you need to edit at this time. The system displays the Confirmation dialog containing the Activate button. When you click Activate, the OECB activates all of the saved configuration changes and saves the new configuration to the running configuration. If you cancel the activation function, the OECB saves the configuration in a file and does not change the running configuration. You can continue to make changes to the configuration.

Configuration Error Messages

If you save a configuration that contains errors, the system displays the following error message: There were errors! Are you sure you want to activate the configuration?

The system displays a list of errors at the bottom the page. Click an error to go to the location in the configuration where the error occurred and edit the configuration as needed.

Severity

Identifies the level of severity that the Oracle Enterprise Session Border Controller assigns to the error. Valid values are:

ERROR—Means that the issue identified in the Message column is not correctly configured or it does not exist. You can still verify, save, and activate the configuration if this severity exists.
WARNING—Means that the configuration contains invalid information for the element field identified in the Message column. You can still verify, save, and activate the configuration if this severity exists.
CRITICAL—Means that a critical error occurred in the configuration and you cannot verify, save, or activate until the error is corrected. The Message column indicates the element field where the error has occurred.

Message

Identifies the element field where the error, warning, or critical error occurred, and the reason for the error.

Object

Identifies the element and the field for that element where the error occurred.

Attribute Name

Identifies the attribute within the element where the error occurred.

Other

Identifies any other pertinent information relating to the error.

Uploading and Downloading Configuration File Elements

The Oracle Enterprise Communications Broker allows you to upload and download files containing certain key elements of your configuration that are more easily managed separately from the overall system configuration. Such elements include:

Dial Plans
Dial Patterns
User Database Entries
Route Database Entries
SIP Manipulation Rules

The corresponding dialogs for the items in the preceding list include controls for uploading and downloading files, depending on which action you choose. When you click the Upload button, for example, the system displays the Upload file dialog, which includes a Browse button. When you click Browse, the system opens a browse dialog, from which you can select the file that you want to upload. Download behavior is similar. The system performs the file transfer to the correct system directories in the correct format without requiring any intervention. The following screen capture shows an example of the Upload File dialog.

This screen capture shows an example of the Upload File dialog.

Using Tag Fields

The Oracle Enterprise Communications Broker provides a configuration element data field referred to as a tag. You enter information into the tag field for descriptive and grouping purposes. You can establish your own criteria for labeling configuration elements with these tags. Tag fields have no operational effect on signaling services.

The following configuration objects display the Tags text field:

Agents
Users
Routes

You can enter any text that you want into the field and you can apply as many tags to a configuration object as needed. You can filter the element list searches using tags as a means of organizing these objects. Applicable element list search fields include a down arrow that exposes a tag drop-down list, from which you select the tag on which to filter the list. Tags have no operational function other than supporting this kind of filtering.