Oracle® Web Conferencing Administrator's Guide Release 2 (2.0.4) Part Number B10877-01 |
|
|
View PDF |
This chapter discusses common post-installation steps required to make Oracle Web Conferencing completely functional in the selected deployment configuration.
To configure Oracle Web Conferencing, you must:
A standard configuration is a deployment in which corporate intranet users can hold online conferences with voice streaming and document conversion service. For additional functionality like e-mail invitations and conference access to users from outside the corporate firewall, follow the instructions in this chapter.
dcmctl is the command line utility used for most management tasks like start and stop for Oracle9iAS components like Oracle HTTP Server, OC4J_imeeting, and Oracle Process Management and Notification. There are other options, like the 9iAS Enterprise Manager for performing the same tasks. This document uses dcmctl to illustrate the tasks.
See Also:
Oracle9i Application Server Administrator's Guide for information on dcmctl |
The imtctl utility provides a command-line interface for administering and configuring Web Conferencing and the Real-Time Collaboration system. The utility supports a variety of commands to support actions such as starting and stopping Real-Time Collaboration components, viewing their current state, and configuring them. You can run imtctl in an interactive shell mode, or you can issue a single command as a command-line argument, in which case imtctl executes the command and exits.
The utility is available on all platforms under <ORACLE_HOME>/imeeting/bin. It is invoked as "imtctl" on all platforms. Invoking imtctl without any arguments opens the interactive shell. See Chapter 10, "imtctl Command Line Utility" for more information.
$ORACLE_HOME/imeeting/bin> imtctl
To display a list of supported commands, invoke the help command:
imtctl> help
To display specific instructions for a particular command, invoke the command followed by the -help
option:
imtctl> <COMMAND> -help
The exit command ends the shell session:
imtctl> exit
You can write simple scripts for the imtctl utility. These scripts consist of commands that are executed by imtctl, as well as optional comments. The advantage of these scripts over standard operating system scripts is that imtctl scripts are platform-independent and do not require multiple invocations of the utility to perform multiple commands.
Oracle Web Conferencing comes with a set of standard scripts you can use to perform typical post-installation configuration tasks. These scripts reside in the
<IMT_ HOME>/bin/scripts directory and end with the extension ".imt". Each script has been templated to indicate the values that must be set before running the script. Invoke the scripts using standard input redirection as in the following example:
imtctl> $ORACLE_HOME/imeeting/bin> imtctl < ../scripts/sample.imt
You can create new scripts, as needed. The scripts can contain any supported imtctl commands, plus comment lines (any line that begins with #) and the special "echo [on/off]" command for echoing commands executed by scripts.
At installation time, all the processes are automatically started by the installer.
At other times, all Web Conferencing components in an instance can be started using imtctl, except the Web Conferencing Application (OC4J_imeeting). The non-Web Conferencing component products on which Web Conferencing depends are started independently using their own management tools. Only basic startup commands for such products are listed. To start the Real-Time Collaboration Core Components instance:
Start OC4J with the following command:
$ORACLE_HOME/dcm/bin/dcmctl start -co OC4J_imeeting -t -v 120
Start the Oracle HTTP Server, if it is not already up. The following command shows the status of the Oracle HTTP Server, OC4J_imeeting, etc.:
$ORACLE_HOME/dcm/bin/dcmctl getState -v
To start the Oracle HTTP Server, invoke:
$.../dcmctl start -ct ohs -v -t120
To start the Oracle Process Monitor and Notification system, invoke:
$.../dcmctl start -ct opmn
To use imtctl, invoke the following start command:
$ORACLE_HOME/imeeting/bin> imtctl start
Alternatively, you can invoke imtctl in shell mode and then issue the start command. The second option makes it easier to verify the state of the Real-Time Collaboration system after the start command is completed:
$ORACLE_HOME/imeeting/bin> imtctl imtctl> start imtctl> getState
Stop the system by invoking the following stop command:
imtctl> stop
The Oracle HTTP Server and OC4J_imeeting are stopped using the corresponding dcmctl stop commands.
When you install the Real-Time Collaboration Core Components, you are installing the Web Conferencing Server and other related components. Every time you perform a new installation that results in the creation of an instance, you must perform the following two types of tasks:
Task | Reason it is Required | Nature of Task | Refer to: |
---|---|---|---|
Integrate with existing e-mail |
Oracle Web Conferencing must be integrated with the e-mail infrastructure in order to send e-mail invitations for conferences. |
System task |
See Step 2 of "System Tasks" in this chapter. |
Integrate with existing proxy server |
Oracle Web Conferencing must be integrated with the existing proxy settings for use by the Web Conferencing Console. This includes cobrowsing functionality, and cross-instance HTTP-based diagnostics. |
System task |
See Step 1 of "System Tasks" in this chapter. |
Integrate with Oracle HTTP Server |
Oracle Web Conferencing must be integrated with the Oracle HTTP Server associated with that instance. This allows access to intranet users behind remote firewalls. |
Instance task |
See Step 1 of "Instance Tasks" in this chapter. |
Configure Oracle Web Conferencing for reports |
Oracle Web Conferencing provides automatic generation and e-mailing of reports. Web Conferencing must be configured for this functionality. |
System task |
See Step 3 of "System Tasks" in this chapter. |
Set up for periodic monitoring |
The instance can be monitored periodically and the results plugged into an alert management system. |
Instance task |
See Step 2 of "Instance Tasks" in this chapter. |
Assign businessadmin role to an administrator |
This allows an administrator to view the administration pages in the Web Conferencing Application. |
System task |
See Step 4 of "System Tasks" in this chapter. |
The Web Conferencing Cobrowse mode accesses Web sites using the HTTP/S protocols from the Real-Time Collaboration Core Components instance machine. Depending on network topologies and firewall configurations, it might require an HTTP/S proxy server to access some sites. The following script provides a template for enabling proxy functionality:
$ORACLE_HOME/imeeting/bin/scripts/proxy.imt
Before executing the script, edit it to replace templated-values with actual deployment values. See the instructions in the script for details.
Set the following properties:
See Chapter 5, "Configuration" for more details on these properties.
The Web Conferencing Application can generate outbound e-mail for various purposes, such as inviting users to a conference. The Real-Time Collaboration system must be configured with certain e-mail-related properties to enable this feature. See the following imtctl script for details:
$ORACLE_HOME/imeeting/bin/scripts/mail.imt
Before executing the script, edit it to replace templated-values with actual deployment values. See the instructions in the script for details.
Set the following properties:
See Chapter 5, "Configuration" for more details on these properties.
Oracle Web Conferencing supports various reporting capabilities. Web Conferencing reports can be generated and sent via e-mail using the imtreport script. The script is located at $ORACLE_HOME/imeeting/bin and is invoked as "imtreport" on all platforms. The actual script file is "imtreport" for UNIX and Linux and "imtreport.cmd" for Microsoft Windows. Mandatory report options such as the recipient list are set by editing variables at the top of the report script. The script contains comments on the options provided. Be sure to edit the proper script for the platform you are using. You may want to send out automated weekly reports by using some operating system provided mechanism for invoking the script on a weekly basis (for example, cron job on UNIX or the Task Scheduler on Windows).
imtctl> modifyRole -username "username@company.com" -rolename "businessadmin"
These tasks assume that Oracle9iAS Web Cache is turned off on the machine. If Oracle9iAS Web Cache is turned on, a second IP address and additional configuration steps are needed. See Chapter 5, "Configuration" for more instructions.
Enable the mod_imeeting.
Make the necessary configuration changes to the Oracle HTTP Server in which mod_imeeting is configured. mod_imeeting is included through the
$ORACLE_HOME/imeeting/conf/mod_imeeting.conf file
, which in turn is included in $ORACLE_HOME/Apache/Apache/conf/oracle_apache.conf
file for Oracle HTTP Server.
To activate the mod:
include "$ORACLE_HOME/imeeting/conf/mod_imeeting.conf"
See Also:
Oracle9i Application Server Administrator's Guide for information on dcmctl |
$ORACLE_HOME/dcm/bin/dcmctl -v updateConfig -ct ohs
$ORACLE_HOME/dcm/bin/dcmctl -v restart -ct ohs
See the following imtctl script for details:
$ORACLE_HOME/imeeting/bin/scripts/Redirect.imt
Before executing the script, edit it to replace templated-values with actual deployment values. See the instructions in the script for details.
Set the MxRedirectPort property. See Chapter 5, "Configuration" for more details on this property.
The Real-Time Collaboration installer assumes that the actual host name configured for the Real-Time Collaboration Core Components machine is used by clients to access Real-Time Collaboration resources. This might not be true in some deployments where DNS aliasing and other advanced network deployment scenarios might require customization of the names used to access Real-Time Collaboration resources from external locations. The following script provides examples on how to support such configurations:
See the following imtctl script for details:
$ORACLE_HOME/imeeting/bin/scripts/hostname.imt
Before executing the script, edit it to replace templated-values with actual deployment values. See the instructions in the script for details.
Set the following properties:
See Chapter 5, "Configuration" for more details on these properties.
Set up your monitoring infrastructure to periodically ping the following URLs. For example, assuming the URL for the instance (ApacheWebHost) is imeeting1.company.com:
For conference service availability monitoring:
http://imeeting1.company.com/imtapp/servlet/ImtTestServlet?mtgtest=true
For Voice Conversion Server availability monitoring:
http://imeeting1.company.com/imtapp/servlet/ImtTestServlet?voiceconvtest=true
For Document Conversion Server availability monitoring:
http://imeeting1.company.com/imtapp/servlet/ImtTestServlet?docconvtest=true
See Section 7.6, "Real-Time Collaboration Interfaces" for more information.
Invoke the following test to verify that the Real-Time Collaboration Core Components have been configured correctly.
imtctl> runtests
For each test that has failed, verify that the post-installation steps have been done correctly.
When you install the Document Conversion Server or Voice Conversion Server, a new instance of the newly installed server is created. At the end of installation, it serves the Core Components instances in the default Real-Time Collaboration cluster. If you want it to serve instances in another cluster you must shut it down then reconfigure to use the other cluster and restart.
See Section 2.7, "Real-Time Collaboration Clusters" for more information on Real-Time Collaboration clusters.
Description: This property sets the dial-in prefix for an instance of the Voice Conversion Server. This prefix would be added to all dial-in numbers received by the Voice Conversion Server before dialing out. Typically, corporations have a dial-in prefix ("9," for example) for dialing numbers outside the company's internal phone network.
Default Value: None
Valid Value: Any valid dialing sequence. In most cases, it would be a number example: "9" A valid dialing sequence contains numbers 0-9 and any of the following characters: * # ,
Scope: Instance
To configure the dial-in prefix for a Voice Conversion Server instance to "9" invoke:
imtctl> setProperty -i <instance-name> -pname "VoiceDialinPrefix" -pvalue "9"
System dial-ins are system-wide dial-ins that an administrator creates. They are available to all Oracle Web Conferencing users. Typically, system administrators create system dial-ins for phone conference vendors that are used commonly by the users of the system. System dial-ins serve as templates for users to create their own dial-ins; however, users cannot edit them. In many cases, system dial-ins are incomplete dialing sequences in that they contain information that is common to all users and indicate the information a user must add to make it a usable dial-in. Users should make the recommended addition to the system dial-in and save it as a user-defined dial-in for use in a conference.
For example, phone conference vendors typically provide a PIN or conference ID to its users. A system administrator might create a system wide dial-in for the particular conference vendor that contains the toll-free number for the vendor, followed by a placeholder for the PIN/Conference ID and the required separators like ',', '#' or '*'. Users would then modify the system dial-in by adding their PIN/Conference ID and then save it under a different name.
System dial-ins can be managed through the imtctl utility.
Invoke the following:
imtctl> addSysDialin -name <dialin-name> -sequence <dialin-sequence> -default <true/false>
The default indicates whether the system dial-in should be made the default for all users. Users can override the default, from the Web Conferencing Console, if they choose.
Invoke the following:
imtctl> deleteSysDialin -name <dialin-name> -id <dialin-id>
The name or ID is required. If both are specified, name is used. To get the name or ID, invoke getSysDialins
.
Invoke getSysDialins
. It lists the ID, name, and sequence for existing system dial-ins.
Invoke the following:
imtctl> setProperty -pname InstanceLocation -pvalue "[\"InstanceLocation value for cluster 1, 2, etc.\"]"
Invoke imtctl> start
to start the Voice Conversion Server.
To verify that this Voice Conversion Server is set up correctly, shut down the other Voice Conversion Servers, if any, that are assigned to serve the same Real-Time Collaboration Core Components to which the new server is assigned. Then, on a Real-Time Collaboration Core Components instance machine do:
imtctl> runtests -testlist voiceconvtest
Do the same for the Document Conversion Server:
imtctl> runtests -testlist docconvtest
Verify that the Core Components machine is able to connect to it.
Users can set their time zone by logging in to the Web Conferencing Application and clicking Preferences. A list of available time zones displays.
After users have set their time zone, all date and time references in the Web Conferencing Application and Web Conferencing Console are automatically converted to their time zone.
Example: User A sets his time zone to "(-05:00) US Eastern Time." He then schedules a conference for 30-Mar-2004 5:00 PM. He intends to have the conference at 5 pm Eastern Time. User B, whose time zone is set to "(-08:00) US Pacific Time," is invited to this conference. When User B sees the invitation in her Upcoming Meetings tab, it displays as 30-Mar-2004 2:00 PM. The time has been converted to Pacific Time for User B.
See Appendix A, "Time Zones" for a complete list of supported time zones.
When a user registers with Oracle Web Conferencing for the first time, the user's default time zone is set based on the system-level property DefaultTimeZoneName. The default value of this property is UTC. An administrator might want to change this value. For example, if the Real-Time Collaboration system is deployed in New York, you can change the property as follows:
imtctl> setProperty -system -pname DefaultTimeZoneName -pvalue America/New_York
This only affects the default time zones for users who have not set their time zone yet. You should encourage users to set their time zones.
See Appendix A, "Time Zones" for a complete list of valid values for DefaultTimeZoneName.
For custom configuration, including Real-Time Collaboration cluster creation and use of SSL, please refer to Chapter 5, "Configuration" and Chapter 6, "Sample Deployments".