This chapter provides detailed descriptions of custom WLST commands for Oracle WebCenter Content, including command syntax, arguments and command examples.
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 Oracle Fusion Middleware Administrator's Guide.
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. See "Using Custom WLST Commands" in the Oracle Fusion Middleware Administrator's Guide.
WLST WebCenter Content commands are divided into the following categories:
Table 19-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.
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.
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 WebCenter Content Server instance.
Table 19-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
getUCMHttpServerAddress(['appName'])
| Argument | Definition |
|---|---|
|
|
Optional. Name of the deployed application. |
Use with WLST: Online
Gets the Intradoc Server Port configuration parameter from the config.cfg file and displays it.
getUCMServerPort(['appName'])
| Argument | Definition |
|---|---|
|
|
Optional. Name of the deployed application. |
Use with WLST: Online
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. |
Use with WLST: Online
getUCMIPpAddressFilter(['appName'])
| Argument | Definition |
|---|---|
|
|
Optional. Name of the deployed application. |
Use with WLST: Online
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. |
Use the commands in Table 19-3 to configure email for the Oracle WebCenter 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 |
|
|
Display the Admin Address value. |
Online |
|
|
Set the Admin Address value. |
Online |
Use with WLST: Online
getUCMMailServer(['appName'])
| Argument | Definition |
|---|---|
|
|
Optional. Name of the deployed application. |
Use with WLST: Online
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. |
Use with WLST: Online
getUCMSmtpPort(['appName'])
| Argument | Definition |
|---|---|
|
|
Optional. Name of the deployed application. |
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.
getUCMSysAdminAddress(['appName'])
| Argument | Definition |
|---|---|
|
|
Optional. Name of the deployed application. |
Use the commands in Table 19-4 to configure additional settings to monitor the WebCenter 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 |
Use with WLST: Online
getUCMCSVersion(['appName'])
| Argument | Definition |
|---|---|
|
|
Optional. Name of the deployed application. |
Use the commands in Table 19-5 to configure general configuration options for the Oracle WebCenter Content Server instance.
Table 19-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
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.
getUCMOverRideFormat(['appName'])
| Argument | Definition |
|---|---|
|
|
Optional. Name of the deployed application. |
Use with WLST: Online
Sets the OverrideFormat parameter to enable or disable the ability for users to choose the application format of their content items.
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. |
Use with WLST: Online
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.
getUCMDownloadApplet(['appName'])
| Argument | Definition |
|---|---|
|
|
Optional. Name of the deployed application. |
Use with WLST: Online
Sets the DownloadApplet parameter value to enable or disable the ability for users to download multiple files from a search results page.
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. |
Use with WLST: Online
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.
getUCMMultiUpload(['appName'])
| Argument | Definition |
|---|---|
|
|
Optional. Name of the deployed application. |
Use with WLST: Online
Sets the MultiUpload parameter value to allow or disallow multiple files to be zipped and checked in as a single content item.
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. |
Use with WLST: Online
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.
getUCMUseAccounts(['appName'])
| Argument | Definition |
|---|---|
|
|
Optional. Name of the deployed application. |
Use with WLST: Online
Sets the UseAccounts parameter value to enable to disable the use of accounts in Oracle WebCenter Content.
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. |
Use with WLST: Online
Gets the value from the config.cfg file indicating whether the IsAutoNumber parameter is set. The IsAutoNumber parameter enables automatic numbering of Content IDs.
getUCMIsAutoNumber(['appName'])
| Argument | Definition |
|---|---|
|
|
Optional. Name of the deployed application. |
Use with WLST: Online
Sets the IsAutoNumber parameter value to enable or disable automatic numbering of Content IDs.
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. |
Use with WLST: Online
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.
getUCMAutoNumberPrefix(['appName'])
| Argument | Definition |
|---|---|
|
|
Optional. Name of the deployed application. |
Use with WLST: Online
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).
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. |
Use with WLST: Online
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.
getUCMMajorRevLabelSeq(['appName'])
| Argument | Definition |
|---|---|
|
|
Optional. Name of the deployed application. |
Use with WLST: Online
Sets the value for the MajorRevLabelSeq parameter, which defines the major sequence for revision numbers. MajorRevLabelSeq is the first part of the Revision Label.
setUCMMajorRevLabelSeq('value',['appName'])
| Argument | Definition |
|---|---|
|
|
Value can be any of the following: |
|
|
Optional. Name of the deployed application. |
Use with WLST: Online
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.
getUCMMinorRevLabelSeq(['appName'])
| Argument | Definition |
|---|---|
|
|
Optional. Name of the deployed application. |
Use with WLST: Online
Sets the value for the MinorRevLabelSeq parameter, which defines the minor sequence for revision numbers. MinorRevLabelSeq is the second part of the Revision Label.
setUCMMinorRevLabelSeq('value',['appName'])
| Argument | Definition |
|---|---|
|
|
Value can be any of the following: |
|
|
Optional. Name of the deployed application. |
Use with WLST: Online
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.
getUCMJspServerEnabled(['appName'])
| Argument | Definition |
|---|---|
|
|
Optional. Name of the deployed application. |
Use with WLST: Online
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.
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. |
Use with WLST: Online
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.
getUCMJspEnabledGroups(['appName'])
| Argument | Definition |
|---|---|
|
|
Optional. Name of the deployed application. |
Use with WLST: Online
Sets the value for the JspEnabledGroups parameter, which specifies security groups to be enabled for Java Server Page functionality.
setUCMJspEnabledGroups('value',['appName'])
| Argument | Definition |
|---|---|
|
|
Specifies the security groups to be enabled for Java Server Page functionality. |
|
|
Optional. Name of the deployed application. |
Use the commands in Table 19-6 to configure content security options for the Oracle WebCenter Content Server instance.
Table 19-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
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.
getUCMCopyAccess(['appName'])
| Argument | Definition |
|---|---|
|
|
Optional. Name of the deployed application. |
Use with WLST: Online
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.
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. |
Use with WLST: Online
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.
getUCMExclusiveCheckout(['appName'])
| Argument | Definition |
|---|---|
|
|
Optional. Name of the deployed application. |
Use with WLST: Online
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.
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. |
Use with WLST: Online
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.
getUCMAuthorDelete(['appName'])
| Argument | Definition |
|---|---|
|
|
Optional. Name of the deployed application. |
Use with WLST: Online
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.
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. |
Use with WLST: Online
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.
getUCMShowOnlyKnownAccounts(['appName'])
| Argument | Definition |
|---|---|
|
|
Optional. Name of the deployed application. |
Use with WLST: Online
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.
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. |
Use the commands in Table 19-7 to configure Component Manager options for the Oracle WebCenter Content Server instance.
Table 19-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
getUCMComponentStatus('componentName',['appName'])
| Argument | Definition |
|---|---|
|
|
Specifies a valid Content Server component name. For example, 'ContentFolios'. |
|
|
Optional. Name of the deployed application. |
Use with WLST: Online
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. |
Use with WLST: Online
installUCMComponent('filePath',['appName'])
| Argument | Definition |
|---|---|
|
|
Specifies a valid file path to a component. |
|
|
Optional. Name of the deployed application. |
Use with WLST: Online
uninstallUCMComponent('componentName',['appName'])
| Argument | Definition |
|---|---|
|
|
Specifies a valid Content Server component name. For example, 'ContentFolios'. |
|
|
Optional. Name of the deployed application. |
Use with WLST: Online
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. |
Use with WLST: Online
getUCMComponentConfig('componentName',['appName'])
| Argument | Definition |
|---|---|
|
|
Specifies a valid component name. For example, 'ContentFolios'. |
|
|
Optional. Name of the deployed application. |
Use with WLST: Online
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. |
Use the commands in Table 19-8 to configure records management options for the Oracle WebCenter Content Server instance.
Table 19-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
Gets the type of records management configuration and displays it. The type can have the following values:
none
standalone
adapter
getRMLevel(['appName'])
| Argument | Definition |
|---|---|
|
|
Optional. Name of the deployed application. |
Use with WLST: Online
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.
getRMConfigurationLevel(['appName'])
| Argument | Definition |
|---|---|
|
|
Optional. Name of the deployed application. |
Use with WLST: Online
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
getRMFeatures(['appName'])
| Argument | Definition |
|---|---|
|
|
Optional. Name of the deployed application. |
Use with WLST: Online
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
getRMDispositionActions(['appName'])
| Argument | Definition |
|---|---|
|
|
Optional. Name of the deployed application. |
Use with WLST: Online
Sets the records management configuration with feature and disposition actions and enables it.
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. |
Use with WLST: Online
Defines the outgoing provider that enables the Adapter server to connect to the Content Server instance with records management enabled.
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. |
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
Registration ensures that records management is aware of the Adapter and is ready to manage the stored content in the Adapter server's repository.
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. |
Use the commands in Table 19-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.
These commands can be used only after the WccADFUI.zip file has been installed and enabled on 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: WlstResources/common/bin/wlst.sh
Windows: WlstResources\common\bin\wlst.cmd
Before you run the WLST script, you must set the WL_HOME environment variable in the UNIX shell or Windows command prompt.
UNIX: export WL_HOME=/Oracle/WccUI/wlserver_10.3
Windows: set WL_HOME=C:\Oracle\WccUI\wlserver_10.3
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 19-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
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. |
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 = WccAdfDefaultConnection ProxyContent = true DocumentPreview = DOCUMENT_VIEWER DefaultLocale = en_US DefaultTimeZone = America/Los_Angeles ApplicationUrl = null ClusterCompatible = false TemporaryDirectory = null MaximumUploadedFileSize = 52428800 MaximumWindowsPerSession = 10 WccLoginPageEnabled = true SkinFamily = wcc-skin SkinVersion = null CustomBrandingLogo = null CustomBrandingTitle = null
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: WccAdfDefaultConnection
Use with WLST: Online
Updates the configuration of the Oracle WebCenter Content user interface application. The command can be used to update a single attribute or multiple attributes.
updateWccAdfConfig(appName, [wccInstanceName], [wccInstanceConnectionName], [proxyContent], [documentPreview], [defaultLocale], [defaultTimeZone], [applicationUrl], [clusterCompatible], [temporaryDirectory], [maximumUploadedFileSize], [maximumWindowsPerSession], [wccLoginPageEnabled], [skinFamily], [skinVersion], [customBrandingLogo], [customBrandingTitle])
| 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 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 "/tmp/wcc". 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='/tmp/wcc')
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)
Use the commands in Table 19-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.
These commands can be used only after the WccADFUI.zip file has been installed and enabled on 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: ConnArchWlstResources/common/bin/manageconnwlst.sh
Windows: ConnArchWlstResources\common\bin\manageconnwlst.cmd
Before you run the WLST script, you must set the WL_HOME environment variable in the UNIX shell or Windows command prompt.
UNIX: export WL_HOME=/Oracle/WccUI/wlserver_10.3
Windows: set WL_HOME=C:\Oracle\WccUI\wlserver_10.3
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 19-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
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. |
Use with WLST: Online
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.
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'])
| 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 optimizations 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. |
Use with WLST: Online
Lists all the RIDC connection MBeans present in an ADF connection architecture based application.
listRIDCConnections('appName')
| Argument | Type | Description |
|---|---|---|
|
|
java.lang.String |
Name of the application for which the connection mbeans has to be returned. |
Use with WLST: Online
Lists all the RIDC connection Mbeans present in an ADF connection architecture based application.
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. |
Use with WLST: Online
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.
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. |
The following command retrieves the connection property value of 'PropConnectionUrl'.
displayRIDCConnection('Oracle WebCenter Content - Web UI', 'WccAdfDefaultConnection','PropConnectionUrl')
The following command retrieves all the connection properties present in connection 'WccAdfDefaultConnetion'.
ddisplayRIDCConnection('Oracle WebCenter Content - Web UI', 'WccAdfDefaultConnection')