Oracle Applications DBA Blog

Getting Familiar with RTCCTL

One of the components that comes with Oracle Collaboration Suite is the Real Time Collaboration or RTC. The two main components of Real-Time Collaboration are

• Oracle Web Conferencing
• Oracle Messenger

Other than using OPMNCTL as described in my previous post to manage the services of Oracle Collaboration Suite, Oracle has also provided a utility rtcctl which can be used to manage the specific components which relate to Oracle Web Conferencing and Oracle Messenger. The rtcctl is a command-line utility which provides an interface to configure and administer your

Real-Time Collaboration components. This configuration and administration for RTC components is done through a set of properties which control the behavior of your RTC environment.

The rtcctl utility is located in the $ORACLE_HOME/imeeting/bin directory in your Oracle Collaboration Suite middle tier servers.

The RTCCTL utility allows you to

• View the status of the process related to Real-Time Collaboration.
• Start and stop all or specific components.
• View the value of Real-Time Collaboration specific components.
• Set the value of Real-Time Collaboration specific components.
• To view and Modify an RTC user's Access.
• Creating and Using a Broadcast Group.

To get the status of RTC
The getstate command executed within rtcctl show you the status of the components related to Real-Time Collaboration

rtcctl> getstate
ID      COMPONENT_NAME TYPE      STATUS         NUM_PROCS
10007   rtc-connmgr    connmgr   UP             2
10000   rtc-confsvr    confsvr   UP             4
10006   rtc-imrtr      imrtr     ACTIVE-OK      1
10008   rtc-voiceproxy voiceproxyUP             1
10004   rtcpm          rtcpm     UP             1
10003   rtc-rdtr       rdtr      UP             1
10002   rtc-mx         mx        UP             1

Setting RTC porperty Values
The getProperties command show a list of properties that are applicable to the current instance of RTC

rtcctl> getProperties
ApacheProtocolSecure="false"
ApacheWebHost="samlnx.appsdbablog.com"
ApacheWebPort="7780"
ApacheWebSecurePort="8250"
DefaultTimeZoneName="America/Los_Angeles"
EmailEnabled="false"
IMDomainNames="["appsdbablog.com"]"
RTCSSLSupportEnabled="false"
SmtpHost="samlnx.appsdbablog.com"
SmtpPort="25"
VoiceDialinPrefix=""

To get a the value of a specific property you could use the getpropety command with the -pname clause which refers to the property name

rtcctl> getproperty -pname IMDomainNames
The effective value for instance of the property "IMDomainNames" is "["appsdbablog.com"]"

The getproperties command along with the -maxlevel all clause displays a complete list of all RTC related properties.

The setProperty command allows you to set the value for a specific property

rtcctl> setProperty -pname property-name -pvalue property-name

You can use the rtcctl utility to configure and administer multiple instances of RTC running at your site.
To set properties at an instance level you can use the -i clause and to set it at a system level use the -system clause. By default the properties are set at the system level.

Startup and Shutdown Of RTC Services
The stop command shutsdown down all RTC managed process

rtcctl> stop
rtcctl> getstate
ID      COMPONENT_NAME TYPE      STATUS         NUM_PROCS
10007   rtc-connmgr    connmgr   DOWN           0
10000   rtc-confsvr    confsvr   DOWN           0
10006   rtc-imrtr      imrtr     DOWN           0
10008   rtc-voiceproxy voiceproxyDOWN           0
10004   rtcpm          rtcpm     DOWN           0
10003   rtc-rdtr       rdtr      DOWN           0
10002   rtc-mx         mx        DOWN           0

The start command startsup up the RTC managed processes

rtcctl> start
rtcctl> getstate
ID      COMPONENT_NAME TYPE      STATUS         NUM_PROCS
10007   rtc-connmgr    connmgr   UP             2
10000   rtc-confsvr    confsvr   UP             4
10006   rtc-imrtr      imrtr     ACTIVE-OK      1
10008   rtc-voiceproxy voiceproxyUP             1
10004   rtcpm          rtcpm     UP             1
10003   rtc-rdtr       rdtr      UP             1
10002   rtc-mx         mx        UP             1

Individual components can be started and stopped either by using the component type or the component name clause along with the start or stop command.

rtcctl> stop -cname rtc-confsvr
The stops the rtc-confsvr component.

rtcctl> start -ctype confsvr
This starts the confsvr type component.

RTC user Management
The modifyRole command can be used to modify the existing role of user

rtcctl> modifyRole -username sam -rolename businessadmin

Broadcast Groups
You can also use the RTCCTL utility to create broadcast groups.

rtcctl> addGroup -groupname APPS_DBA_SUPPORT -type A -owner sam@appsdbablog.com -subscription S -permission R  -groupdisplayname "DBA Support Team"
Add group 'APPS_DBA_SUPPORT', type = A, owner = sam@appsdbablog.com, subscription = S, permission = R, groupdisplayname = DBA Support Team

You can user the -permission = O to create a open group which does not require approval for joining

The getGroups command displays the available groups in the system

rtcctl> getGroups
Groups:
Group IM Address: apps_dba_support@groups.appsdbablog.com
Group Display Name: DBA Support Team
Owner IM Address: sam@appsdbablog.com
Type: A
Subscription Type: S
Subscription Permission: R
Number of Members: 0

You can use the addGroupMember to add a new member to this group explicitly

rtcctl> addGroupMember -groupname APPS_DBA_SUPPORT -username samtest
Add Member 'samtest' to group 'APPS_DBA_SUPPORT'

Similarly the deleteGroupMember command removes a user from the group explicilty.

The deleteGroup command can be used to delete an existing group

rtcctl> deleteGroup -groupname APPS_DBA_SUPPORT
Delete group 'APPS_DBA_SUPPORT'

Getting real Time Statistics
The getMonitorStats command allows you to get real time statistics of your RTC environment.

rtcctl> getMonitorStats
Instance - OCSMI_home.samlnx.appsdbablog.com:
Component Name: rtc-confsvr, Component Type: confsvr
SERVICE_NAME                                 TMTGS CMTGS CLTS TMEM    UMEM
confsvr:OCSMI_home.samlnx.appsdbablog.com.rtc-confsvr.00     0     0    4,100K  2,620K
confsvr:OCSMI_home.samlnx.appsdbablog.com.rtc-confsvr.10     0     0    4,092K  2,782K
confsvr:OCSMI_home.samlnx.appsdbablog.com.rtc-confsvr.20     0     0    4,092K  2,800K
confsvr:OCSMI_home.samlnx.appsdbablog.com.rtc-confsvr.30     0     0    4,092K  2,588K
Component Name: rtc-imrtr, Component Type: imrtr presence                                    

Testing RTC
Th runTest command allows you to run a series of tests against your RTC environment to test the configuration.

rtcctl> runtests
Instance - OCSMI_home.samlnx.appsdbablog.com:
TEST NAME      SUCCESS
mtgtest        true
dbtest         true
apptest        true
proxytest      false
emailtest      false
imtest         true
servletAccessTesttrue