The following sections describe the custom WLST commands for Oracle Universal Content Management (Oracle UCM). These commands enable you to configure and monitor the Oracle Universal Content Management server and Content Server instance from the command line. Topics include:
For additional information about Oracle UCM and Oracle Content Server administration and configuration, see Oracle Fusion Middleware System Administrator's Guide for Oracle Content Server.
Note:
To use the Oracle Universal Content Management custom commands, you must invoke the WLST script from the Oracle Common home in which the component has been installed. See "Using Custom WLST Commands" in the Oracle Fusion Middleware Administrator's Guide.WLST UCM commands are divided into the following categories:
To view the Oracle UCM commands that can be invoked from WLST, enter the following command at the WLST prompt:
help('UCM')
To view help for a specific Oracle UCM command, replace the 'UCM' with the name of the command; for example:
help('getUCMServerPort')
The WLST component for Oracle UCM uses getter and setter methods to handle a situation where multiple applications register their corresponding Mbeans on a managed server, but WLST can talk to only one application.
The getter method is designed to handle zero or one argument.
If you do not provide an argument to an WLST Oracle UCM command, then one of two things occurs:
If only one application has registered its Mbean on the server, then the WLST Oracle UCM command should work successfully and display the output.
If multiple applications have registered Mbeans on the server, then an error message is displayed to prompt you to enter the specific application name in the argument.
If there is one argument to an WLST Oracle UCM command, then the following occurs:
You must enter the correct application name when entering an argument. If the name is not entered properly, then an error message is displayed to prompt you to enter the valid application name in the argument.
The setter method is designed to handle one or two arguments.
The first argument is the value to which you want to set the parameter.
The second argument is the application name, which can be null or a string.
Use the commands in Table 19-2 to configure the Oracle UCM Oracle Content Server instance.
Table 19-2 WLST Server Configuration Commands
| Use this command... | To... | Use with WLST... |
|---|---|---|
|
Display the HTTP Server Address value. |
Online |
|
|
Set the HTTP Server Address value. |
Online |
|
|
Display the Intradoc Server Port configuration parameter. |
Online |
|
|
Set the Intradoc Server Port configuration parameter. |
Online |
|
|
Display the IP Address Filter value. |
Online |
|
|
Set the IP Address Filter value. |
Online |
|
|
Display the Use SSL value. |
Online |
|
|
Set the Use SSL value. |
Online |
Use with WLST: Online
Sets the HTTP Server Address value in the config.cfg file. The HTTP Server Address can be of the form abc.xyz.def or an IP address with port number.
The HTTP Server Address is used to formulate full URLs in the Oracle Content Server user interface.
Use with WLST: Online
Gets the Intradoc Server Port configuration parameter from the config.cfg file and displays it.
Use with WLST: Online
Sets the Server Port configuration parameter. The Server Port must be a positive integer between 0 and 65535.
Use with WLST: Online
Sets the Oracle UCM IP Address Filter value, which must be of "*.*.*.*" format or IPV6 Format. The value must be taken from a list of IP Addresses allowed to communicate with the Content Server instance through the Intradoc Server Port.
Use with WLST: Online
Gets the Use SSL value from the config.cfg file and displays it. The value can be True or False.
Use the commands in Table 19-3 to configure e-mail for the Oracle UCM Oracle Content Server instance.
Table 19-3 WLST E-Mail Configuration Commands
| Use this command... | To... | Use with WLST... |
|---|---|---|
|
Display the Mail Server value. |
Online |
|
|
Set the Mail Server value. |
Online |
|
|
Display the SMTP Port value. |
Online |
|
|
Set the SMTP Port value. |
Online |
|
|
Display the Admin Address value. |
Online |
|
|
Set the Admin Address value. |
Online |
Use with WLST: Online
Sets the Mail Server value in the config.cfg file. The Mail Server value is the name of the mail server that the Oracle Content Server instance uses to send SMTP based e-mail.
Use with WLST: Online
Sets the SMTP Port value in the config.cfg file. The SMTP Port must be a positive integer between 1 and 65535. To reset the port to null, enter None for the value: setUCMSmtpPort(None)
Use with WLST: Online
Gets the Admin Address value from the config.cfg file and displays it. The value can be of the form abc@xyz.def.
Use the commands in Table 19-4 to configure additional settings to monitor the Oracle UCM Oracle Content Server instance.
Table 19-4 WLST Additional Configuration Commands
| Use this command... | To... | Use with WLST... |
|---|---|---|
|
Display the version number. |
Online |
|
|
Display the uptime value. |
Online |