The following sections describe the custom WLST commands for Oracle WebCenter Content. These commands enable you to configure and monitor the Oracle WebCenter Content server and the Oracle WebCenter Content Server instance from the command line. Topics include:
For additional information about Oracle WebCenter Content and Content Server administration and configuration, see Administering Oracle Fusion Middleware.
Note:
To use the Oracle WebCenter Content custom commands, you must invoke the WLST script from the Oracle Common home in which the component has been installed. For more information, see Using WLST with Java Components and Oracle Fusion Middleware Services in Administering Oracle Fusion Middleware.
WLST WebCenter Content commands are divided into the following categories:
Table 3-1 WLST WebCenter Content Command Categories
| Command Category | Description |
|---|---|
|
View and manage server configuration options for the Content Server instance. |
|
|
View and manage email configuration options for the Content Server instance. |
|
|
View system status information for the Content Server instance. |
|
|
View and manage general configuration options for the Content Server instance. |
|
|
View and manage content security configuration options for the Content Server instance. |
|
|
View and manage Component Manager configuration options for the Content Server instance. |
|
|
View and manage records management configuration options for the Content Server instance. |
|
|
View and manage configuration for the optional Oracle WebCenter Content user interface. |
|
|
View and manage connections for the Oracle WebCenter Content user interface introduced in WebCenter Content 11g Release 1 (11.1.1.8) |
To view the WebCenter Content 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 Webcenter Content command, specify the name of the command; for example:
help('getUCMServerPort')
help('wccAdfConfig')
The WLST component for Oracle Webcenter Content 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.
Getter Method
The getter method is designed to handle zero or one argument.
If you do not provide an argument to an WLST WebCenter Content command, then one of two things occurs:
If only one application has registered its Mbean on the server, then the WLST WebCenter Content 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 WebCenter Content 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.
Setter Method
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 3-2 to configure the Oracle WebCenter Content Server instance.
Before you use these custom commands, set up the initial WLST connection as follows:
Set the environment variable ORACLE_HOME to <Middleware_Home>/Oracle_ECM1.
Run the WLST script from the following location: <middleware_home>/Oracle_ECM1/common/bin.
Connect to the WebCenter Content Server instance using the connect() command, for example, connect("weblogic","password","t3://localhost:16200").
Table 3-2 WLST Server Configuration Commands
| Use this command... | To... | Use with WLST... |
|---|---|---|
|
Display 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 |
Use with WLST: Online
Description
Gets the HTTP Server Address value from the config.cfg file and displays it.
Syntax
getUCMHttpServerAddress(['appName'])
| Argument | Definition |
|---|---|
|
|
Optional. Name of the deployed application. |
Example
The following command displays the Oracle Webcenter Content HTTP server address for the application "Oracle Universal Content Management - Content Server":
getUCMHttpServerAddress('Oracle Universal Content Management - Content Server')
server.example.com
Use with WLST: Online
Description
Gets the Intradoc Server Port configuration parameter from the config.cfg file and displays it.
Syntax
getUCMServerPort(['appName'])
| Argument | Definition |
|---|---|
|
|
Optional. Name of the deployed application. |
Example
The following command displays the Intradoc Server Port value for the application "Oracle Universal Content Management - Content Server":
getUCMServerPort('Oracle Universal Content Management - Content Server')
4442
Use with WLST: Online
Description
Sets the Server Port configuration parameter.
Syntax
setUCMServerPort(value,['appName'])
| Argument | Definition |
|---|---|
|
|
Server Port number. This number must be a positive integer between 0 and 65535. |
|
|
Optional. Name of the deployed application. |
Example
The following command sets the Server Port configuration parameter for the application '"Oracle Universal Content Management - Content Server":
setUCMServerPort(4442,'Oracle Universal Content Management - Content Server')
Use with WLST: Online
Description
Gets the IP Address Filter value from the config.cfg file and displays it.
Syntax
getUCMIPpAddressFilter(['appName'])
| Argument | Definition |
|---|---|
|
|
Optional. Name of the deployed application. |
Example
The following command displays the IP address filter value for the application "Oracle Universal Content Management - Content Server":
getUCMIpAddressFilter('Oracle Universal Content Management - Content Server')
10.131.123.*
Use with WLST: Online
Description
Sets the Webcenter Content IP Address Filter value.
Syntax
setUCMIpAddressFilter(value,['appName'])
| Argument | Definition |
|---|---|
|
|
WebCenter Content IP Address Filter number. This number 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. |
|
|
Optional. Name of the deployed application. |
Example
The following command sets the value for the WebCenter Content IP address filter for the application "Oracle Universal Content Management - Content Server":
setUCMIpAddressFilter(10.131.123.*,'Oracle Universal Content Management - Content Server')
Use with WLST: Online
Description
Gets the Use SSL value from the config.cfg file and displays it. The value can be True or False.
Syntax
getUCMUseSSL(['appName'])
| Argument | Definition |
|---|---|
|
|
Optional. Name of the deployed application. |
Example
The following command displays the Use SSL value for the application "Oracle Universal Content Management - Content Server":
getUCMUseSSL('Oracle Universal Content Management - Content Server')
True
Use the commands in Table 3-3 to configure email for the Oracle WebCenter Content Server instance.
Table 3-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 |
|
|
Display the Admin Address value. |
Online |
|
|
Set the Admin Address value. |
Online |
Use with WLST: Online
Description
Gets the Mail Server value from the config.cfg file and displays it.
Syntax
getUCMMailServer(['appName'])
| Argument | Definition |
|---|---|
|
|
Optional. Name of the deployed application. |
Example
The following command displays the Mail Server value for the application "Oracle Universal Content Management - Content Server":
getUCMMailServer('Oracle Universal Content Management - Content Server')
mymailserver.example.com
Use with WLST: Online
Description
Sets the Mail Server value in the config.cfg file.
Syntax
setUCMMailServer(value,['appName'])
| Argument | Definition |
|---|---|
|
|
Value for the Mail Server. The value is the name of the mail server that the Content Server instance uses to send SMTP based email. |
|
|
Optional. Name of the deployed application. |
Example
The following command sets the value for the Mail Server for the application "Oracle Universal Content Management - Content Server":
setUCMMailServer(mymailserver.example.com,'Oracle Universal Content Management - Content Server')
Use with WLST: Online
Description
Gets the SMTP Port value in the config.cfg file and displays it.
Syntax
getUCMSmtpPort(['appName'])
| Argument | Definition |
|---|---|
|
|
Optional. Name of the deployed application. |
Example
The following command displays the SMTP port value for the application "Oracle Universal Content Management - Content Server":
getUCMSmtpPort('Oracle Universal Content Management - Content Server')
4055
Use with WLST: Online
Description
Gets the Admin Address value from the config.cfg file and displays it. The value can be of the form abc@xyz.def.
Syntax
getUCMSysAdminAddress(['appName'])
| Argument | Definition |
|---|---|
|
|
Optional. Name of the deployed application. |
Example
The following command displays the Admin Address value for the application "Oracle Universal Content Management - Content Server":
getUCMSysAdminAddress('Oracle Universal Content Management - Content Server')
mymail@example.com
Use with WLST: Online
Description
Sets the Admin Address value in the config.cfg file.
Syntax
setUCMSysAdminAddress(value,['AppName'])
| Argument | Definition |
|---|---|
|
|
Value for the Admin Address. The Admin Address can be of the form abc@xyz.def. |
|
|
Optional. Name of the deployed application. |
Example
The following command sets the Admin Address value for the application "Oracle Universal Content Management - Content Server":
setUCMSysAdminAddress(mymail@example.com,'Oracle Universal Content Management - Content Server')
Use the commands in Table 3-4 to configure additional settings to monitor the WebCenter Content Server instance.
Table 3-4 WLST Additional Configuration Commands
| Use this command... | To... | Use with WLST... |
|---|---|---|
|
Display the version number. |
Online |
|
|
Display the uptime value. |
Online |
Use with WLST: Online
Description
Gets the version number of the Content Server running instance.
Syntax
getUCMCSVersion(['appName'])
| Argument | Definition |
|---|---|
|
|
Optional. Name of the deployed application. |
Example
The following command displays the version number of the active instance of the application "Oracle Universal Content Management - Content Server":
getUCMCSVersion('Oracle Universal Content Management - Content Server')
11g R1
Use with WLST: Online
Description
Gets the amount of time the Content Server instance has been up.
Syntax
getUCMServerUptime(['appName'])
| Argument | Definition |
|---|---|
|
|
Optional. Name of the deployed application. |
Example
The following command displays the amount of time the application "Oracle Universal Content Management - Content Server" has been up:
getUCMServerUptime('Oracle Universal Content Management - Content Server')
00H:01 Min:12 Sec
Use the commands in Table 3-5 to configure general configuration options for the Oracle WebCenter Content Server instance.
Table 3-5 WLST General Configuration Options Commands
| Use this command... | To... | Use with WLST... |
|---|---|---|
|
Display the OverRideFormat value. |
Online |
|
|
Set the OverRideFormat value. |
Online |
|
|
Display the DownloadApplet value. |
Online |
|
|
Set the DownloadApplet value. |
Online |
|
|
Display the MultiUpload value. |
Online |
|
|
Set the MultiUpload value. |
Online |
|
|
Display the UseAccount value. |
Online |
|
|
Set the UseAccount value. |
Online |
|
|
Display the AutoNumber value. |
Online |
|
|
Set the AutoNumber value. |
Online |
|
|
Display the AutoNumberPrefix value. |
Online |
|
|
Set the AutoNumberPrefix value. |
Online |
|
|
Display the MajorRevLabelSeq value. |
Online |
|
|
Set the MajorRevLabelSeq value. |
Online |
|
|
Display the MinorRevLabelSeq value. |
Online |
|
|
Set the MinorRevLabelSeq value. |
Online |
|
|
Display the JspServerEnabled value |
Online |
|
|
Set the JspServerEnabled value. |
Online |
|
|
Display the JspEnabledGroups value. |
Online |
|
|
Set the JspEnabledGroups value. |
Online |
Use with WLST: Online
Description
Gets the value from the config.cfg file, indicating whether the OverrideFormat parameter is set. The OverrideFormat parameter enables users to choose the application format of their content items.
Syntax
getUCMOverRideFormat(['appName'])
| Argument | Definition |
|---|---|
|
|
Optional. Name of the deployed application. |
Example
The following command displays the OverRideFormat parameter value:
getUCMOverRideFormat()
true
Use with WLST: Online
Description
Sets the OverrideFormat parameter to enable or disable the ability for users to choose the application format of their content items.
Syntax
getUCMOverRideFormat('value',['appName'])
| Argument | Definition |
|---|---|
|
|
Specifies whether to enable or disable the OverrideFormat option. Values can be: Yes, No, True, False, 1, 0. |
|
|
Optional. Name of the deployed application. |
Example
The following command enables the OverRideFormat parameter:
getUCMOverRideFormat('True')
Use with WLST: Online
Description
Gets the value from the config.cfg file indicating whether the DownloadApplet parameter is set. DownloadApplet enables users to download multiple files from a search results page.
Syntax
getUCMDownloadApplet(['appName'])
| Argument | Definition |
|---|---|
|
|
Optional. Name of the deployed application. |
Example
The following command gets the value for the DownloadApplet parameter:
getUCMDownloadApplet()
true
Use with WLST: Online
Description
Sets the DownloadApplet parameter value to enable or disable the ability for users to download multiple files from a search results page.
Syntax
setUCMDownloadApplet('value',['appName'])
| Argument | Definition |
|---|---|
|
|
Specifies whether to enable or disable the DownloadApplet option. Values can be: Yes, No, True, False, 1, 0. |
|
|
Optional. Name of the deployed application. |
Example
The following command sets the value for the DownloadApplet to enable the functionality:
setUCMDownloadApplet('Yes')
Use with WLST: Online
Description
Gets the value from the config.cfg file indicating whether the MultiUpload parameter is set. MultiUpload allows multiple files to be zipped and checked in as a single content item.
Syntax
getUCMMultiUpload(['appName'])
| Argument | Definition |
|---|---|
|
|
Optional. Name of the deployed application. |
Example
The following command displays the value for the MultiUpload parameter:
getUCMMultiUpload()
true
Use with WLST: Online
Description
Sets the MultiUpload parameter value to allow or disallow multiple files to be zipped and checked in as a single content item.
Syntax
setUCMMultiUpload('value',['appName'])
| Argument | Definition |
|---|---|
|
|
Specifies whether to enable or disable the MultiUpload option. Values can be: Yes, No, True, False, 1, 0. |
|
|
Optional. Name of the deployed application. |
Example
The following command sets MultiUpload to allow multiple files to be zipped and check in as a single content item:
setUCMMultiUpload('1')
Use with WLST: Online
Description
Gets the value from the config.cfg file indicating whether the UseAccounts parameter is set. UseAccounts enables the use of accounts in Oracle WebCenter Content.
Syntax
getUCMUseAccounts(['appName'])
| Argument | Definition |
|---|---|
|
|
Optional. Name of the deployed application. |
Example
The following command displays the value for the UseAccounts option:
getUCMUseAccounts()
True
Use with WLST: Online
Description
Sets the UseAccounts parameter value to enable to disable the use of accounts in Oracle WebCenter Content.
Syntax
setUCMUseAccounts('value',['appName'])
| Argument | Definition |
|---|---|
|
|
Specifies whether to enable or disable the UseAccounts option. Values can be: Yes, No, True, False, 1, 0. |
|
|
Optional. Name of the deployed application. |
Example
The following command sets UseAccounts to enable accounts in Oracle WebCenter Content:
setUCMUseAccounts('True')
Use with WLST: Online
Description
Gets the value from the config.cfg file indicating whether the IsAutoNumber parameter is set. The IsAutoNumber parameter enables automatic numbering of Content IDs.
Syntax
getUCMIsAutoNumber(['appName'])
| Argument | Definition |
|---|---|
|
|
Optional. Name of the deployed application. |
Example
The following command displays the value for the IsAutoNumber parameter:
getUCMIsAutoNumber()
True
Use with WLST: Online
Description
Sets the IsAutoNumber parameter value to enable or disable automatic numbering of Content IDs.
Syntax
setUCMIsAutoNumber('value',['appName'])
| Argument | Definition |
|---|---|
|
|
Specifies whether to enable or disable the AutoNumber option. Values can be: Yes, No, True, False, 1, 0. |
|
|
Optional. Name of the deployed application. |
Example
The following command sets IsAutoNumber to enable automatic numbering of Content IDs:
setUCMIsAutoNumber('True')
Use with WLST: Online
Description
Gets the value from the config.cfg file for the AutoNumberPrefix parameter. The prefix is used in all automatically numbered content IDs for newly checked-in files, if the AutoNumber parameter is enabled.
Syntax
getUCMAutoNumberPrefix(['appName'])
| Argument | Definition |
|---|---|
|
|
Optional. Name of the deployed application. |
Example
The following command displays the value for the AutoNumberPrefix parameter:
getUCMAutoNumberPrefix()
dadvml0231usor
Use with WLST: Online
Description
Sets the AutoNumberPrefix parameter value to a prefix used in all automatically numbered content IDs for newly checked-in files (if the AutoNumber parameter is enabled).
Syntax
setUCMUseAutoNumberPrefix('value',['appName'])
| Argument | Definition |
|---|---|
|
|
The prefix used in all automatically numbered content IDs for newly checked-in files. Only applies if the AutoNumber parameter is enabled. |
|
|
Optional. Name of the deployed application. |
Example
The following command sets the AutoNumberPrefix:
setUCMAutoNumberPrefix('dadvml0231usor')
Use with WLST: Online
Description
Gets the value from the config.cfg file for MajorRevLabelSeq, which defines the major sequence for revision numbers. MajorRevLabelSeq is the first part of the Revision Label.
Syntax
getUCMMajorRevLabelSeq(['appName'])
| Argument | Definition |
|---|---|
|
|
Optional. Name of the deployed application. |
Example
The following command displays the value for the MajorRevLabelSeq parameter:
getUCMMajorRevLabelSeq()
A1
Use with WLST: Online
Description
Sets the value for the MajorRevLabelSeq parameter, which defines the major sequence for revision numbers. MajorRevLabelSeq is the first part of the Revision Label.
Syntax
setUCMMajorRevLabelSeq('value',['appName'])
| Argument | Definition |
|---|---|
|
|
Value can be any of the following: |
|
|
Optional. Name of the deployed application. |
Example
The following command sets MajorRevLabelSeq to 'A1':
setUCMMajorRevLabelSeq('A1')
Use with WLST: Online
Description
Gets the value from the config.cfg file for MinorRevLabelSeq, which defines the minor sequence for revision numbers. MinorRevLabelSeq is the second part of the Revision Label.
Syntax
getUCMMinorRevLabelSeq(['appName'])
| Argument | Definition |
|---|---|
|
|
Optional. Name of the deployed application. |
Example
The following command displays the value for the MinorRevLabelSeq parameter:
getUCMMinorRevLabelSeq()
b2
Use with WLST: Online
Description
Sets the value for the MinorRevLabelSeq parameter, which defines the minor sequence for revision numbers. MinorRevLabelSeq is the second part of the Revision Label.
Syntax
setUCMMinorRevLabelSeq('value',['appName'])
| Argument | Definition |
|---|---|
|
|
Value can be any of the following: |
|
|
Optional. Name of the deployed application. |
Example
The following command sets MinorRevLabelSeq to 'b2':
setUCMMinorRevLabelSeq('b2')
Use with WLST: Online
Description
Gets the value from the config.cfg file indicating whether the JspServerEnabled is set. If the parameter is turned on, Content Server can execute Java Server Pages. The Java Server Pages must be checked in to Content Server.
Syntax
getUCMJspServerEnabled(['appName'])
| Argument | Definition |
|---|---|
|
|
Optional. Name of the deployed application. |
Example
The following command displays the value for the JspServerEnabled parameter:
getUCMJspServerEnabled()
true
Use with WLST: Online
Description
Sets the value for the JspServerEnabled parameter. If the parameter is turned on, Content Server can execute Java Server Pages. The Java Server Pages must be checked in to Content Server.
Syntax
setUCMJspServerEnabled('value',['appName'])
| Argument | Definition |
|---|---|
|
|
Specifies whether to enable or disable the parameter. Values can be: Yes, No, True, False, 1, 0. |
|
|
Optional. Name of the deployed application. |
Example
The following command sets JspServerEnabled to 'true':
setUCMJspServerEnabled('true')
Use with WLST: Online
Description
Gets the value from the config.cfg file for the JspEnabledGroups parameter and lists is. JspEnabledGroups lists security groups enabled for Java Server Page functionality. Security groups have certain permissions for contributors and administrators.
Syntax
getUCMJspEnabledGroups(['appName'])
| Argument | Definition |
|---|---|
|
|
Optional. Name of the deployed application. |
Example
The following command displays the value for the JspEnabledGroups parameter:
getUCMJspEnabledGroups()
group1
Jsp
Use with WLST: Online
Description
Sets the value for the JspEnabledGroups parameter, which specifies security groups to be enabled for Java Server Page functionality.
Syntax
setUCMJspEnabledGroups('value',['appName'])
| Argument | Definition |
|---|---|
|
|
Specifies the security groups to be enabled for Java Server Page functionality. |
|
|
Optional. Name of the deployed application. |
Example
The following command sets JspEnabledGroups to 'group1':
setUCMJspEnabledGroups('group1')
Use the commands in Table 3-6 to configure content security options for the Oracle WebCenter Content Server instance.
Table 3-6 WLST Content Security Configuration Commands
| Use this command... | To... | Use with WLST... |
|---|---|---|
|
Display the CopyAccess parameter value. |
Online |
|
|
Set the CopyAccess parameter value. |
Online |
|
|
Display the ExclusiveCheckout parameter value. |
Online |
|
|
Set the ExclusiveCheckout parameter value. |
Online |
|
|
Display the AuthorDelete parameter value. |
Online |
|
|
Set the AuthorDelete parameter value. |
Online |
|
|
Display the ShowOnlyKnownAccounts parameter value. |
Online |
|
|
Set the ShowOnlyKnownAccounts parameter value. |
Online |
Use with WLST: Online
Description
Gets the value from the config.cfg file and displays it. When CopyAccess is enabled, users with Read privilege on a content item can get a copy of the native file.
Syntax
getUCMCopyAccess(['appName'])
| Argument | Definition |
|---|---|
|
|
Optional. Name of the deployed application. |
Example
The following command displays the CopyAccess value:
getUCMCopyAccess()
True
Use with WLST: Online
Description
Sets the CopyAccess value in the config.cfg file. When CopyAccess is enabled, users with Read privilege on a content item can get a copy of the native file.
Syntax
setUCMCopyAccess('value',['appName'])
| Argument | Definition |
|---|---|
|
|
Specifies whether to enable or disable the parameter. Values can be: Yes, No, True, False, 1, 0. |
|
|
Optional. Name of the deployed application. |
Example
The following command sets the value to enable the CopyAccess parameter:
setUCMCopyAccess('True')
Use with WLST: Online
Description
Gets the value in the config.cfg file and displays it. When the ExclusiveCheckout parameter is enabled, Admin privilege is required to check out a content item checked in by another user.
Syntax
getUCMExclusiveCheckout(['appName'])
| Argument | Definition |
|---|---|
|
|
Optional. Name of the deployed application. |
Example
The following command displays the value for the ExclusiveCheckout parameter:
getUCMExclusiveCheckout()
True
Use with WLST: Online
Description
Sets the value in the config.cfg file. When the ExclusiveCheckout parameter is enabled, Admin privilege is required to check out a content item checked in by another user.
Syntax
setUCMExclusiveCheckout('value',['appName'])
| Argument | Definition |
|---|---|
|
|
Specifies whether to enable or disable the parameter. Values can be: Yes, No, True, False, 1, 0. |
|
|
Optional. Name of the deployed application. |
Example
The following command sets the value to enable the ExclusiveCheckout parameter:
setUCMExclusiveCheckout('True')
Use with WLST: Online
Description
Gets the value from the config.cfg file and displays it. When the AuthorDelete parameter is enabled, authors are allowed to delete their revisions without having Delete privilege.
Syntax
getUCMAuthorDelete(['appName'])
| Argument | Definition |
|---|---|
|
|
Optional. Name of the deployed application. |
Example
The following command displays the AuthorDelete parameter value:
getUCMAuthorDelete()
1
Use with WLST: Online
Description
Sets the AuthorDelete parameter value in the config.cfg file. When the AuthorDelete parameter is enabled, authors are allowed to delete their revisions without having Delete privilege.
Syntax
setUCMAuthorDelete('value',['appName'])
| Argument | Definition |
|---|---|
|
|
Specifies whether to enable or disable the parameter. Values can be: Yes, No, True, False, 1, 0. |
|
|
Optional. Name of the deployed application. |
Example
The following command enables the AuthorDelete parameter:
setUCMAuthorDelete('1')
Use with WLST: Online
Description
Gets the value from the config.cfg file and displays it. When the ShowOnlyKnownAccounts parameter is enabled, the list of Content Server accounts on a check-in page will contain only globally-predefined accounts.
Syntax
getUCMShowOnlyKnownAccounts(['appName'])
| Argument | Definition |
|---|---|
|
|
Optional. Name of the deployed application. |
Example
The following command displays the ShowOnlyKnownAccounts parameter value as enabled:
getUCMShowOnlyKnownAccounts()
Yes
Use with WLST: Online
Description
Sets the ShowOnlyKnownAccount parameter value in the config.cfg file. When the ShowOnlyKnownAccounts parameter is enabled, the list of Content Server accounts on a check-in page will contain only globally-predefined accounts.
Syntax
setUCMShowOnlyKnownAccounts('value',['appName'])
| Argument | Definition |
|---|---|
|
|
Specifies whether to enable or disable the parameter. Values can be: Yes, No, True, False, 1, 0. |
|
|
Optional. Name of the deployed application. |
Example
The following command enables the ShowOnlyKnownAccounts parameter:
setUCMShowOnlyKnownAccounts('yes')
Use the commands in Table 3-7 to configure Component Manager options for the Oracle WebCenter Content Server instance.
Table 3-7 WLST Component Manager Configuration Commands
| Use this command... | To... | Use with WLST... |
|---|---|---|
|
Display the status of a component. |
Online |
|
|
Set the status of a component. |
Online |
|
|
Install a component. |
Online |
|
|
Uninstall a component. |
Online |
|
|
Display the configuration for a component. |
Online |
|
|
Set configuration parameters for a component. |
Online |
Use with WLST: Online
Description
Gets the status of a component. The status can be enabled or disabled.
Syntax
getUCMComponentStatus('componentName',['appName'])
| Argument | Definition |
|---|---|
|
|
Specifies a valid Content Server component name. For example, 'ContentFolios'. |
|
|
Optional. Name of the deployed application. |
Example
The following command displays the status of the component "ContentFolios':
getUCMComponentStatus('ContentFolios')
Enabled
Use with WLST: Online
Description
Sets the status of a component in the config.cfg file.
Syntax
setUCMComponentStatus('componentName','status',['appName'])
| Argument | Definition |
|---|---|
|
|
Specifies a valid Content Server component name. For example, 'ContentFolios'. |
|
|
Specifies whether the status of the component is enabled or disabled. Values can be: Enable, Disable. |
|
|
Optional. Name of the deployed application. |
Example
The following command sets the status of 'ContentFolios' to 'Enable':
setUCMComponentStatus('ContentFolios','Enable')
Use with WLST: Online
Description
Installs the component present at the specified file location.
Syntax
installUCMComponent('filePath',['appName'])
| Argument | Definition |
|---|---|
|
|
Specifies a valid file path to a component. |
|
|
Optional. Name of the deployed application. |
Example
The following command installs the component at the location 'C:/manifest.zip':
installUCMComponent('C:/manifest.zip')
Use with WLST: Online
Description
Uninstalls the specified component.
Syntax
uninstallUCMComponent('componentName',['appName'])
| Argument | Definition |
|---|---|
|
|
Specifies a valid Content Server component name. For example, 'ContentFolios'. |
|
|
Optional. Name of the deployed application. |
Example
The following command uninstalls the component named 'ContentFolios':
uninstallUCMComponent('ContentFolios')
Use with WLST: Online
Description
Downloads the specified component to the specified file location.
Syntax
downloadUCMComponent('componentName','filePath',['appName'])
| Argument | Definition |
|---|---|
|
|
Specifies a valid Content Server component name. For example, 'ContentFolios'. |
|
|
Specifies a valid file path to a component. |
|
|
Optional. Name of the deployed application. |
Example
The following command downloads the component 'ContentFolios' to 'C:/manifest.zip':
downloadUCMComponet('ContentFolios', 'C:/manifest.zip')
Use with WLST: Online
Description
Gets the configuration of the specified component and displays it.
Syntax
getUCMComponentConfig('componentName',['appName'])
| Argument | Definition |
|---|---|
|
|
Specifies a valid component name. For example, 'ContentFolios'. |
|
|
Optional. Name of the deployed application. |
Example
The following command displays the configuration for the component 'ContentFolios':
getUCMComponentConfig('ContentFolios')
Use with WLST: Online
Description
Sets the specified component with the configuration options provided.
Syntax
updateUCMComponentConfig('componentName','updateParams',['appName'])
| Argument | Definition |
|---|---|
|
|
Specifies a valid component name. For example, 'Folders_g'. |
|
|
Specifies valid parameters for the component. |
|
|
Optional. Name of the deployed application. |
Example
The following command sets configuration parameters for the component 'Folders_g':
updateUCMComponentConfig('Folders_g','GetCopyAccess:true,CollectionHiddenMeta:xHidden')
Use the commands in Table 3-8 to configure records management options for the Oracle WebCenter Content Server instance.
Table 3-8 WLST Records Management Configuration Commands
| Use this command... | To... | Use with WLST... |
|---|---|---|
|
Display the type of records management configuration. |
Online |
|
|
Display the records management configuration level. |
Online |
|
|
Display records management features. |
Online |
|
|
Display records management dispositions actions. |
Online |
|
|
Update the records management configuration. |
Online |
|
|
Add an outgoing provider for the Adapter server used to store records management content. |
Online |
|
|
Register the source for the Adapter server repository so records management can find it. |
Online |
Use with WLST: Online
Description
Gets the type of records management configuration and displays it. The type can have the following values:
none
standalone
adapter
Syntax
getRMLevel(['appName'])
| Argument | Definition |
|---|---|
|
|
Optional. Name of the deployed application. |
Example
The following command displays the type of records management configuration:
getRMLevel()
adapter
Use with WLST: Online
Description
Gets the records management configuration level and displays it. The configuration level can have the following values:
minimal: Enables minimal amount of functionality and excludes some disposition actions and most of the application features. This is the default when the software is enabled.
typical: Enables all disposition actions and all features except for DoD Configuration, Classified Topics, FOIA/PA tracking (Freedom of Information Act/Privacy Act), and E-mail.
dod2: Enables the features from a Typical installation with the addition of DoD Configuration and E-mail.
dodclassified: Enables all features except for FOIA/PA.
custom: Enables the ability to choose a variety of features. Some disposition actions are dependent on other actions. If an action is selected, dependent actions are also automatically selected.
Syntax
getRMConfigurationLevel(['appName'])
| Argument | Definition |
|---|---|
|
|
Optional. Name of the deployed application. |
Example
The following command displays the type of records management configuration:
getRMConfigurationLevel(['appName']) minimal
Use with WLST: Online
Description
Gets a list of records management features and displays it. The list can have the following values:
feature_related_content
feature_audit_trigger
feature_subject_to_review
feature_revision_dates
feature_security_markings
feature_email_fields
feature_dod_config
feature_foia_privacyact
Syntax
getRMFeatures(['appName'])
| Argument | Definition |
|---|---|
|
|
Optional. Name of the deployed application. |
Example
The following command displays the records management features:
getRMFeatures()
feature_related_content
feature_audit_trigger
feature_subject_to_review
Use with WLST: Online
Description
Gets the values for records management disposition actions and displays them. The list can have the following values:
actions_activate
actions_obsolete
actions_cancel
actions_rescind
actions_expire
actions_cutoff
actions_approve_deletion
actions_destroy
Syntax
getRMDispositionActions(['appName'])
| Argument | Definition |
|---|---|
|
|
Optional. Name of the deployed application. |
Example
The following command displays a list of records management disposition actions:
getRMDispositionActions()
actions_active
actions_obsolete
actions_cancel
Use with WLST: Online
Description
Sets the records management configuration with feature and disposition actions and enables it.
Syntax
rmUpdate(urmLevel, level, featuresList, dispositionActionsList, enableRTMandURMAgent,['appName'])
| Argument | Definition |
|---|---|
|
|
Specifies a valid records management configuration type. |
|
|
Specifies a valid records management level. |
|
|
Specifies valid records management features. |
|
|
Specifies valid disposition actions. |
|
|
Specifies whether to enable the RTM and URM Agent.'. |
|
|
Optional. Name of the deployed application. |
Example
The following command sets the records management configuration and enables it:
rmUpdate(urmLevel='standalone',level='custom',featuresList='feature_related_content:feature_revision_dates',dispositionActionsList='actions_activate:actions:obsolete',enableRTMandURMAgent='1')
Use with WLST: Online
Description
Defines the outgoing provider that enables the Adapter server to connect to the Content Server instance with records management enabled.
Syntax
addOutgoingProvider(ProviderName, ProviderDescription, ServerHostName, HTTPServerAddress, ServerPort, InstanceName, RelativeWebRoot, extraUpdateParams,['appName'])
| Argument | Definition |
|---|---|
|
|
Name of the outgoing provider. |
|
|
Description of the outgoing provider. |
|
|
Name of the server host. |
|
|
Address of the HTTP server. |
|
|
Number of the server port. |
|
|
Name of the instance for the Content Server with records management enabled. |
|
|
Name of the relative web root. |
|
|
Extra parameters that can be used are: ClientHostIpFilter, ConnectionPassword, ConnectionPasswordName, IsRefinery, ProviderClass, ProviderConfig, ProviderConnection, RefineryMaxProJobs, RefineryReadOnly. |
|
|
Optional. Name of the deployed application. |
Example
The following command defines an outgoing provider for the Adapter server to connect to the records management instance.:
addOutgoingProvider(ProviderName='x',ProviderDescription='y',ServerHostName='localhost',HTTPServerAddress='z',ServerPort='4444',InstanceName='w', RelativeWebRoot='cs',updateParams='RefineryMasJobs:100,IsRefinery:1')
Use with WLST: Online
Description
Registration ensures that records management is aware of the Adapter and is ready to manage the stored content in the Adapter server's repository.
Syntax
registerSource(ProviderName, SourceName, SourceTableName, SourceDisplayName, ['appName'])
| Argument | Definition |
|---|---|
|
|
Name of the outgoing provider. |
|
|
Description of the source in the Adapter repository. |
|
|
Name of the source table in the Adapter repository. |
|
|
Display name for the source in the Adapter repository. |
|
|
Optional. Name of the deployed application. |
Example
The following command registers the Adapter server's repository source for the records management stored content:
registerSource(ProviderName='x',SourceName='y',SourceTableName='z',SourceDisplayName='w")
Use the commands in Table 3-9 to display and update the configuration of the Oracle WebCenter Content user interface introduced in Oracle WebCenter Content 11g Release 1 (11.1.1.8). For more information about this user interface, see Getting Started with the WebCenter Content User Interface in Using Oracle WebCenter Content.
To use these custom commands, you must invoke the WLST script from the appropriate Oracle home. Do not use the WLST script in the WebLogic Server home. For Oracle WebCenter Content user interface commands, the script is located at:
UNIX: MW_HOME/oracle_common/common/bin/wlst.sh
Windows: MW_HOME\oracle_common\common\bin\wlst.cmd
The WLST process must connect to the WebCenter Content UI server before you run the commands listed in the following table.
You can connect to the Content UI server instance using the connect() command, for example:
connect("weblogic","password","t3://localhost:16225").
Configuration changes made using these WLST commands are only effective after you restart the Managed Server on which the WebCenter Content - Web UI application is deployed.
Table 3-9 WLST WebCenter Content User Interface Commands
| Use this command... | To... | Use with WLST... |
|---|---|---|
|
Display the configuration of the WebCenter Content user interface application. |
Online |
|
|
Update the configuration of the WebCenter Content user interface application. |
Online |
Use with WLST: Online
Description
Displays the configuration of the Oracle WebCenter Content user interface application.
Syntax
displayWccAdfConfig(appName='value',[attrName='value'])
| Argument | Definition |
|---|---|
|
|
Name of the deployed application. |
|
|
Optional. Name of the attribute to display If omitted all attributes are displayed. |
Examples
The following command displays all configuration attributes for the Oracle WebCenter Content user interface deployed with the application name "Oracle WebCenter Content - Web UI".
wls:/wccadf_domain/serverConfig> displayWccAdfConfig(appName='Oracle WebCenter Content - Web UI') WccInstanceName = Default WccInstanceConnectionName = WccAdfServerConnection ProxyContent = true DocumentPreview = DOCUMENT_VIEWER DefaultLocale = en_US DefaultTimeZone = America/Los_Angeles ApplicationUrl = null ClusterCompatible = false TemporaryDirectory = null MaximumUploadedFileSize = 52428800 MaximumWindowsPerSession = 7 WccLoginPageEnabled = true SkinFamily = wcc-skin SkinVersion = null CustomBrandingLogo = null CustomBrandingTitle = null WccCustomizationLayerValues = null OracleCustomizationLayerValues = null CustomerCustomizationLayerValues = null CustomRequestBinderProperties = null UnfiledDocumentProhibited = false
The following command displays the value of the configuration attribute named "WccInstanceConnectionName".
wls:/wccadf_domain/serverConfig> displayWccAdfConfig(appName='Oracle WebCenter Content - Web UI', attrName='WccInstanceConnectionName') Attribute WccInstanceConnectionName value is: WccAdfServerConnection
Use with WLST: Online
Description
Updates the configuration of the Oracle WebCenter Content user interface application. The command can be used to update a single attribute or multiple attributes.
Syntax
updateWccAdfConfig(appName, [wccInstanceName], [wccInstanceConnectionName], [proxyContent], [documentPreview], [defaultLocale], [defaultTimeZone], [applicationUrl], [clusterCompatible], [temporaryDirectory], [maximumUploadedFileSize], [maximumWindowsPerSession], [wccLoginPageEnabled], [skinFamily], [skinVersion], [customBrandingLogo], [customBrandingTitle], [wccCustomizationLayerValues], [oracleCustomizationLayerValues], [customerCustomizationLayerValues], [customRequestBinderProperties], [unfiledDocumentProhibited])
| Argument | Definition |
|---|---|
|
|
Name of the deployed application. |
|
|
Reserved for future use. |
|
|
Name of the Content Server connection in Connection Architecture ( |
|
|
Controls how a browser retrieves document content, including the native file, the web-viewable rendition, thumbnails, and attachments. Must be "true" or "false". If "true" the browser requests this content from the Oracle WebCenter Content user interface, which in turn retrieves it from Content Server. If "false" the browser requests this content directly from Content Server. |
|
|
Controls the preview displayed for a document. Must be one of the following case-sensitive values:
|
|
|
Locale to use if a user's locale cannot be otherwise determined. Must be in the format used by the Java class |
|
|
Time zone to use if the user's time zone cannot be otherwise determined. Must be in the format used by the Java method |
|
|
Specifies the scheme, hostname, and port of URLs generated by the Oracle WebCenter Content user interface (for example, |
|
|
Specifies whether the Oracle WebCenter Content user interface supports session replication among nodes in a cluster. Either "true" or "false". Must be "true" if session replication is enabled on the Java EE Web Container. |
|
|
Base directory for temporary files created by the Oracle WebCenter Content user interface, such as in-progress uploads. This directory should be empty, on a fast file system with adequate free space, and readable and writable by only the owner of the process running the Oracle WebCenter Content user interface. The Oracle WebCenter Content user interface will create and manage a subdirectory structure. If clusterCompatible is "true" this directory must also be on a filesystem shared across all nodes in the cluster. Oracle recommends setting this attribute even if clusterCompatible is "false". If not set, the value of the Java system property |
|
|
Maximum size of uploaded files (in bytes). If less than zero, there is no maximum size. If zero, file upload is disabled. |
|
|
Maximum number of active windows (or browser tabs, depending on browser configuration) per session. When this limit is reached, the least recently used window expires and subsequent interaction with that window displays an error message. The Oracle WebCenter Content user interface main page, Use this attribute to control the maximum application server memory consumed by each session. Set to 0 to not limit the number of windows per session. |
|
|
Specifies whether the "wcclogin" page is enabled or disabled. Either "true" or "false". When Single Sign-On (SSO) authentication is enabled, the attribute value should be set to "false" to prevent users from using the "wcclogin" page instead of SSO. |
|
|
Name of the skin family. The <skin-family> element in |
|
|
Skin version. The <skin-version> element in |
|
|
HTTP URL of an image to display in the branding bar. Optional. If not set, a default image is displayed. |
|
|
The title to display in the branding bar. Optional. If not set, a default title is displayed. |
|
|
The values for the 'wcc' customization layer. Use comma-separated format to define multiple values. Optional. If not set, no customization is available for this layer. Example: demo, test, or production. |
|
|
The values for the 'oracle' customization layer. Use comma-separated format to define multiple values. Optional. If not set, no customization is available for this layer. Example: demo, test, or production. |
|
|
The values for the 'customer' customization layer. Use comma-separated format to define multiple values. Optional. If not set, no customization is available for this layer. Example: demo, test, or production. |
|
|
The list of supported custom properties that can be injected to Content Server service calls via ContentProxyServlet requests. Use comma-separated format to define multiple values. Optional. If not set, no injection would happen in Content Server service calls. Example: XFND_SCHEME_ID, XFND_RANDOM, and XFND_EXPIRES. |
|
|
Controls the creation of unfiled documents. When its value is true, uploading unfiled documents and unfiling filed documents are both disabled. Optional. The default value is false. |
Examples
The following command sets the proxyContent attribute to "true" for the Oracle WebCenter Content user interface deployed with the application name "Oracle WebCenter Content - Web UI". With this setting, browsers will retrieve document content from the Oracle WebCenter Content user interface, rather than directly from Content Server.
updateWccAdfConfig(appName='Oracle WebCenter Content - Web UI', proxyContent=true)
The following command sets the defaultLocale attribute to "en_US" and the defaultTimeZone attribute to "America/Los_Angeles". If the Oracle WebCenter Content user interface cannot determine a user's preferred locale and time zone (for example, based on user preferences), it will default to the English language and display times using the America/Los_Angeles time zone.
updateWccAdfConfig(appName='Oracle WebCenter Content - Web UI', defaultLocale='en_US', defaultTimeZone='America/Los_Angeles')
The following command sets the temporaryDirectory attribute to "/prod/wcctmp". The Oracle WebCenter Content user interface will store temporary files in this directory on the application server.
updateWccAdfConfig(appName='Oracle WebCenter Content - Web UI', temporaryDirectory='/prod/wcctmp')
The following command sets the wccLoginPageEnagled property to "false". This prevents users from authenticating to the Oracle WebCenter Content user interface using its "wcclogin" page, requiring them to use Single Sign-On (SSO).
updateWccAdfConfig(appName='Oracle WebCenter Content - Web UI', wccLoginPageEnabled=false)
We strongly recommend to set a value for the applcationUrl attribute.
updateWccAdfConfig(appName='Oracle WebCenter Content - Web UI', applicationUrl='https://wcc.example.com:16225')
The default value for the maximumWindowsPerSession attribute is set to 7. If the WebCenter Content instance is experiencing higher than desired memory consumption, the setting can be changed to 4 to reduce the required heap size.
updateWccAdfConfig(appName='Oracle WebCenter Content - Web UI', maximumWindowsPerSession=4)
Use the commands in Table 3-10 to manage connections for the Oracle WebCenter Content user interface introduced in WebCenter Content 11g Release 1 (11.1.1.8). For more information about this user interface, see Getting Started with the WebCenter Content User Interface in Using Oracle WebCenter Content.
To use these custom commands, you must invoke the WLST script from the appropriate Oracle home. Do not use the WLST script in the WebLogic Server home. For the Oracle WebCenter Content user interface commands, the script is located at:
UNIX: MW_HOME/oracle_common/common/bin/wlst.sh
Windows: MW_HOME\oracle_common\common\bin\wlst.cmd
The WLST process must connect to the WebCenter Content UI server before you run the connection commands listed in the following table.
You can connect to the Content UI server instance using the connect() command, for example:
connect("weblogic","password","t3://localhost:16225").
Configuration changes made using these WLST commands are only effective after you restart the Managed Server on which the WebCenter Content - Web UI application is deployed.
Table 3-10 WLST WebCenter Content User Interface Connection Commands
| Use this command... | To... | Use with WLST... |
|---|---|---|
|
Create a new RIDC connection. |
Online |
|
|
Update existing RIDC connection properties. |
Online |
|
|
List all the RIDC connection Mbeans present in an application. |
Online |
|
|
Remove an existing RIDC connection. |
Online |
|
|
Get all the attributes and their values associated with an RIDC connection Mbean with an option to get the value for a given attribute name. |
Online |
Use with WLST: Online
Description
Creates a new RIDC connection reference and adds the connection name to the mds layer.
Syntax
createRIDCConnection('appName','conName')
| Argument | Type | Description |
|---|---|---|
|
|
java.lang.String |
Name of the application for which the connection will be created. |
|
|
java.lang.String |
Name of the connection which is the placeholder for RIDC connection reference. |
Example
The following command creates an RIDC connection 'WccAdfServerConnection' in the application 'Oracle WebCenter Content - Web UI':
createRIDCConnection('Oracle WebCenter Content - Web UI','WccAdfServerConnection')
Use with WLST: Online
Description
Updates the connection properties for an existing RIDC connection reference. These changes and additions are read as runtime data and saved in the mds layer.
Syntax
updateRIDCConnection(appName, connName, ['connUrl'], ['connSockettimeout'], ['connPoolMethod'], ['connPoolSize'], ['connWaitTime'], ['credUsername'], ['credPassword'], ['credAppidkey'], ['credImpersonationAllowed'], ['jaxwsStack'], ['jaxwsPolicy'], ['jaxwsJpsconfigfile'], ['jaxwsSkipstackoptimizations'], ['jaxwsServerInstancename'], ['jaxwsRegisteridentityswitchfilter'], ['httpLibrary'], ['idcsAlgorithm'], ['idcsKeystoreFile'], ['idcsKeystorePassword'], ['idcsKeystoreAlias'], ['idcsKeystoreAliasPassword'], ['idcsTrustmanagerFile'], ['idcsTrustmanagerPassword'], [sessionPoolSupport], [sessionPoolAnonymousFallback], [sessionPoolCredentialProviderClass])
| Argument | Type | Definition |
|---|---|---|
|
|
java.lang.String |
Name of the application for which the connection has to be updated. |
|
|
java.lang.String |
Name of the connection which will be placeholder for RIDC connection properties. |
|
|
java.lang.String |
RIDC connection URL property. |
|
|
java.lang.Integer |
RIDC connection socket timeout property in seconds. |
|
|
java.lang.String |
RIDC connection pool method property. |
|
|
java.lang.Integer |
RIDC connection pool size property. |
|
|
java.lang.Integer |
RIDC connection wait time property. |
|
|
java.lang.String |
RIDC authorization credential username property. |
|
|
java.lang.String |
RIDC authorization credential password property. |
|
|
java.lang.String |
RIDC authorization credential appid key property. |
|
|
java.lang.Boolean |
Credential impersonation allowed property. |
|
|
java.lang.String |
JaxWs protocol stack property. |
|
|
java.lang.String |
JaxWs protocol policy property. |
|
|
java.lang.String |
JaxWs protocol Jps config file property. |
|
|
java.lang.Boolean |
JaxWs protocol skip stack optizations property. |
|
|
java.lang.String |
JaxWs protocol server instance name property. |
|
|
java.lang.Boolean |
JaxWs protocol register identity switch filter property. |
|
|
java.lang.String |
Http protocol library property. |
|
|
java.lang.String |
Secure Intradoc Protocol Algorithm property. |
|
|
java.lang.String |
Secure Intradoc Protocol Keystore File property. |
|
|
java.lang.String |
Secure Intradoc Protocol Keystore Password property. |
|
|
java.lang.String |
Secure Intradoc Protocol Keystore Alias property. |
|
|
java.lang.String |
Secure Intradoc Protocol Keystore Alias password property. |
|
|
java.lang.String |
Secure Intradoc Protocol TrustManager File property. |
|
|
java.lang.String |
Secure Intradoc Protocol TrustManager Password property. |
|
|
java.lang.Boolean |
RIDC Session Pool Supported property. |
|
|
java.lang.Boolean |
RIDC Session Pool Anonymous Fallback property. |
|
|
java.lang.String |
RIDC Session Pool Credential Provider Class property. |
Example
The following command updates the Intradoc Protocol Connection with a 90 second socket timeout.
updateRIDCConnection('Oracle WebCenter Content - Web UI','WccAdfServerConnection', connUrl='idc://contentserver:4444',credUsername='weblogic',connSockettimeout=90)
Use with WLST: Online
Description
Lists all the RIDC connection Mbeans present in an ADF connection architecture based application.
Syntax
listRIDCConnections('appName')
| Argument | Type | Description |
|---|---|---|
|
|
java.lang.String |
Name of the application for which the connection mbeans has to be returned. |
Example
The following command returns all the connection Mbeans with connection type 'RIDC' present in application 'Oracle WebCenter Content - Web UI'.
listRIDCConnections('Oracle WebCenter Content - Web UI')
Use with WLST: Online
Description
Lists all the RIDC connection Mbeans present in an ADF connection architecture based application.
Syntax
deleteRIDCConnection('appName','connName')
| Argument | Type | Description |
|---|---|---|
|
|
java.lang.String |
Name of the application for which the connection will be removed. |
|
connName |
java.lang.String |
Name of the connection to be removed for the given application. |
Example
The following command removes the connection name 'WccAdfServerConnection' present in application 'Oracle WebCenter Content - Web UI'.
deleteRIDCConnection('Oracle WebCenter Content - Web UI','WccAdfServerConnection')
Use with WLST: Online
Description
Gets all the attribute name-value pairs present in a given connection Mbean of an application, with an option to get the value of an attribute present in a given connection Mbean of an application.
Syntax
displayRIDCConnection(appName,connName,['attrName'])
| Argument | Type | Description |
|---|---|---|
|
|
java.lang.String |
Name of the application for which the connection Mbean attribute value is desired. |
|
|
java.lang.String |
Name of the connection that contains the mbean property. |
|
|
java.lang.String |
Optional. Attribute name in connection Mbean for which value is desired. |
Examples
The following command retrieves the connection property value of 'PropConnectionUrl'.
displayRIDCConnection('Oracle WebCenter Content - Web UI', 'WccAdfServerConnection','PropConnectionUrl')
The following command retrieves all the connection properties present in connection 'WccAdfServerConnection'.
ddisplayRIDCConnection('Oracle WebCenter Content - Web UI', 'WccAdfServerConnection')