This chapter describes WebLogic Scripting Tool (WLST) commands for Oracle WebCenter. These commands enable you to configure WebCenter applications from the command-line. For additional details about WebCenter application configuration, see Oracle Fusion Middleware Administrator's Guide for Oracle WebCenter.
Notes:
To use these commands, you must invoke WLST from the Oracle home in which the component has been installed. See "Using Custom WLST Commands" in the Oracle Fusion Middleware Administrator's Guide.Most configuration changes made using WebCenter WLST commands are only effective after you restart the Managed Server on which the WebCenter application is deployed. The only exceptions are WLST commands for External Applications, Portlet Producers, and WebCenter Import and Export.
WebCenter WLST commands are described in the following sections:
Oracle WebCenter WLST commands are grouped into the following categories (Table 10-1).
Most configuration changes made using WebCenter WLST commands are only effective after you restart the Managed Server on which the WebCenter application is deployed. The only exceptions are the External Applications, Portlet Producers, and WebCenter Import and Export WLST commands.
Table 10-1 WLST Command Categories
| Command Category | Description |
|---|---|
|
Manage WebCenter connections. |
|
|
Manage Analytics Collector connections and configure the Analytics Collector (on |
|
|
Manage Activity Graph metadata and provider configuration (on |
|
|
Archive and restore activity stream data generated for a WebCenter application. |
|
|
Manage content repository connections and configure the Documents service. |
|
|
Manage discussions server connections and configure the Discussion and Announcement services. |
|
|
Manage external application connections. |
|
|
Manage instant messaging and presence server connections and configure the Instant Messaging and Presence service. |
|
|
Manage mail server connections and configure the Mail service. |
|
|
Manage settings for the Notifications service. |
|
|
Manage personal event server connections. |
|
|
Manage personalization server connections. |
|
|
Manage portlet producers. |
|
|
Manage proxy settings for the RSS service. |
|
|
Manage Oracle Secure Enterprise Search (SES) connections and other search-related properties. |
|
|
Manage Oracle Secure Enterprise Search (SES) crawlers. |
|
|
Manage search crawlers for WebCenter Spaces. |
|
|
Manage BPEL server connections. |
|
|
Manage WebCenter Spaces workflow settings and Space metadata. |
|
|
Configure options for searching a WebCenter application's identity store. |
|
|
Export and import WebCenter Spaces applications, Spaces, Space templates, and producer metadata. |
Use the General commands, listed in Table 10-2, to manage WebCenter connections.
Configuration changes made using these WebCenter WLST commands are only effective after restarting the Managed Server on which the WebCenter application is deployed. For details, see Oracle Fusion Middleware Administrator's Guide for Oracle WebCenter.
Table 10-2 General WLST Commands
| Use This Command... | To... | Use with WLST... |
|---|---|---|
|
Delete any WebCenter connection. |
Online |
|
|
Set WebCenter Service Framework configuration properties. |
Online |
|
|
Return WebCenter Service Framework configuration properties. |
Online |
|
|
Return status information for the last WebCenter command executed. |
Online |
|
|
List all the WebCenter connection types. |
Online |
|
|
Clone a WebCenter Managed Server. |
Online |
Module: Oracle WebCenter
Use with WLST: Online
Deletes a named WebCenter connection.
If you use deleteConnection to delete a WSRP or PDK-Java producer connection (instead of using deregisterWSRPProducer or deregisterPDKJavaProducer), unused secondary connections will remain, which you might want to remove. For example, when you delete a WSRP producer connection, its associated Web Service connection remains; when you delete a PDK-Java producer connection, its associated URL connection remains.
deleteConnection(appName, name, [server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the WebCenter application in which to perform this operation. |
name
|
Connection name. |
server
|
Optional. Name of the managed server where the WebCenter application is deployed. For example, WC_Spaces.
Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the WebCenter application is deployed. |
Module: Oracle WebCenter
Use with WLST: Online
Sets WebCenter Service Framework configuration properties, such as the Resource Action Handler class and display as popup properties.
setWebCenterServiceFrameworkConfig(appName, [resourceActionHandlerClassName], [resourceActionHandlerDisplayInPopup], [server], [applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the WebCenter application in which to perform this operation. For WebCenter Spaces, the name is always webcenter. |
resourceActionHandlerClassName
|
Optional. Class used by the Service Framework Resource Action Handler. |
resourceActionHandlerDisplayInPopup |
Optional. Indicates whether the Resource Action Handler displays resources in a popup or inline. Valid options are 1 (true) and 0 (false). |
server
|
Optional. Name of the managed server where the WebCenter application is deployed. For example, WC_Spaces.
Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the WebCenter application is deployed. |
The following example sets the WebCenter Service Framework Resource Action Handler class to my.company.ResourceActionHandler:
wls:/wc_domain/domainRuntime> setWebCenterServiceFrameworkConfig(appName='webcenter', resourceActionHandlerClassName='my.company.ResourceActionHandler') Successfully set the WebCenter service framework configuration. Resource Action Handler class: my.company.ResourceActionHandler To effect connection changes, you must restart the managed server on which the WebCenter application is deployed.
The following example sets only the WebCenter Service Framework Resource Action Handler display as popup value to 1 (true):
wls:/wc_domain/domainRuntime>
setWebCenterServiceFrameworkConfig(appName='webcenter', resourceActionHandlerDisplayInPopup=1)
Successfully set the WebCenter service framework configuration.
Resource Action Handler Display In Popup: true To effect connection changes, you must restart the managed server on which the WebCenter application is deployed.
Module: Oracle WebCenter
Use with WLST: Online
Returns WebCenter Service Framework configuration property settings, such as:
resourceActionHandlerClassName: Class currently used by the WebCenter Service Framework Resource Action Handler
resourceActionHandlerDisplayInPopup: Indicates whether the Resource Action Handler displays resources in a popup or inline. Valid options are 1 (true) and 0 (false).
getWebCenterServiceFrameworkConfig(appName, [server], [applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the WebCenter application in which to perform this operation. For WebCenter Spaces, the name is always webcenter. |
server
|
Optional. Name of the managed server where the WebCenter application is deployed. For example, WC_Spaces.
Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the WebCenter application is deployed. |
The following example returns the service framework resource action handler class and display as popup properties, for the named application.
wls:/weblogic/serverConfig>getWebCenterServiceFrameworkConfig(appName='webcenter')
Resource Action Handler Class: my.company.ResourceActionHandler
Resource Action Handler Display In Popup: true
Module: Oracle WebCenter
Use with WLST: Online
Returns the status of last WebCenter command executed.
Use the webcenterErrorOccurred command to determine the status of the last WebCenter command executed. The command returns 1 if an error occurred or 0 otherwise.
Module: Oracle WebCenter
Use with WLST: Online
getWebCenterConnectionTypes (appName, [server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the WebCenter application in which to perform this operation. For WebCenter Spaces, the name is always webcenter. |
server
|
Optional. Name of the managed server where the WebCenter application is deployed. For example, WC_Spaces.
Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the WebCenter application is deployed. |
Module: Oracle WebCenter
Use with WLST: Online
Creates a new managed server with the same resources as a specified, base managed server.
cloneWebCenterManagedServer(baseManagedServer, newManagedServer, newManagedServerPort, [verbose])
| Argument | Definition |
|---|---|
baseManagedServer
|
Name of the base managed server. |
newManagedServer
|
Name for the new, clone managed server. |
newManagedServerPort
|
Port number for the new managed server. |
verbose |
Optional. Creates the managed server in verbose mode. Valid values are 1 and 0.
When set to The default is |
Analytics Collector Connections
Use the commands listed in Table 10-3 to manage Analytics Collector connections for a WebCenter application. Events raised in WebCenter applications using OpenUsage APIs can be sent to an Analytics Collector for use by Analytics and Activity Graph services.
Connection configuration changes made using these WebCenter WLST commands are only effective after your restart the Managed Server on which the WebCenter application is deployed. For details, see Oracle Fusion Middleware Administrator's Guide for Oracle WebCenter.
Table 10-3 Analytics Collector Connection WLST Commands
| Use this command... | To... | Use with WLST... |
|---|---|---|
|
Create a connection to an Analytics Collector for a WebCenter application. |
Online |
|
|
Edit an existing Analytics Collector connection. |
Online |
|
|
List all of the Analytics Collector connections that are configured for a WebCenter application. |
Online |
|
|
Specify the default (or active) Analytics Collector connection for a WebCenter application. |
Online |
|
|
Return connection details for the Analytics Collector being used by a WebCenter application. |
Online |
Analytics Collector and Cluster Configuration
Use the commands listed in Table 10-4 to configure event collection properties for the Analytics Collector that is deployed on the WC_Utilities managed server.
If you reconfigure the Analytics Collector or set up clustering, you must restart the managed server on which the Analytic Collector is deployed (WC_Utilities).
Table 10-4 Analytics Collector Configuration WLST Commands
| Use this command... | To... | Use with WLST... |
|---|---|---|
|
Set Analytics Collector options, and cluster options if operating a clustered environment. |
Online |
|
|
Return Analytics Collector settings. |
Online |
|
|
List events currently registered with the Analytics Collector. |
Online |
Module: Oracle WebCenter
Use with WLST: Online
Creates a connection to an Analytics Collector for a named WebCenter application.
Events raised in WebCenter applications using OpenUsage APIs can be sent to an Analytics Collector for use by the Analytics and Activity Graph services.
While you can register multiple Analytics Collector connections for a WebCenter application, only one Analytics Collector connection is used - the default (or active) connection where default=1.
createAnalyticsCollectorConnection(appName, name, [isUnicast, collectorhost, clusterName, collectorPort, isEnabled, timeout, default, server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the WebCenter application in which to perform this operation. For WebCenter Spaces, the name is always webcenter. |
name
|
Connection name. The name must be unique across all connection types within the WebCenter application. |
isUnicast
|
Optional. Specifies whether events are sent to a clustered Analytics Collector in multicast mode or whether a single Analytics Collector using unicast communication is required. Valid values are 1 (true) and 0 (false). The default value is 1 (unicast). |
collectorHost
|
Optional. Host name where the Analytics Collector is running. The default value is localhost.
Only required for unicast communication, that is, where |
clusterName
|
Optional. Name of the cluster where a clustered Analytics Collector is running.
Only required for multicast communication, that is, where |
collectorPort
|
Optional. Port on which the Analytics Collector listens for events. The default value is 31314. |
isEnabled
|
Optional. Specifies whether to send analytics events raised using OpenUsage APIs to the Analytics Collector. Valid values 1 (true) and 0 (false). The default value is 0.
Analytics events are sent to the Analytics Collector when |
timeout
|
Optional. Length of time (in seconds) to wait for a response from the Analytics Collector. Default value is 30.
Only required for multicast communication, that is, where |
default
|
Optional. Indicates whether this connection is the default (or active) Analytics Collector connection for the WebCenter application. Valid values are 1 (true) and 0 (false). When set to 1, the WebCenter application sends events on this connection. When set to 0, the connection is not used. The default for this argument is 0.
While you can register multiple Analytics Collector connections for a WebCenter application, only one connection is used by Analytics and Activity Graph services—the default (or active) connection. |
server
|
Optional. Name of the managed server where the WebCenter application is deployed. For example, WC_Spaces.
Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the WebCenter application is deployed. |
The following example creates a connection named MyAnalyticsCollector for a WebCenter application named webcenter. Events are sent to a single Analytics Collector using unicast communication:
wls:/weblogic/serverConfig>createAnalyticsCollectorConnection(appName='webcenter', connectionName='MyAnalyticsCollector', isUnicast=1, collectorHost='myhost.com', collectorPort=31314, isEnabled=1, timeout=30, default=1)
The following example creates a connection named MyAnalyticsCollector for a WebCenter application named webcenter. Events are sent to a clustered Analytics Collector in multicast mode
wls:/weblogic/serverConfig>createAnalyticsCollectorConnection(appName='webcenter', connectionName='MyAnalyticsCollector', isUnicast=0, clusterName='collector-cluster', ccollectorPort=31314, isEnabled=1, timeout=30, default=1)
Module: Oracle WebCenter
Use with WLST: Online
Edits an existing Analytics Collector connection for a named WebCenter application.
Events raised in WebCenter applications using OpenUsage APIs can be sent to an Analytics Collector for use by the Analytics and Activity Graph services.
While you can register multiple Analytics Collector connections for a WebCenter application, only one Analytics Collector connection is used - the default (or active) connection.
setAnalyticsCollectorConnection(appName, name, [isUnicast, collectorHost, clusterName, collectorPort, isEnabled, timeout, default, server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the WebCenter application in which to perform this operation. For WebCenter Spaces, the name is always webcenter. |
name
|
Connection name. The name must be unique (across all connection types within the WebCenter application). |
isUnicast
|
Optional. Specifies whether events are sent to a clustered Analytics Collector in multicast mode or whether a single Analytics Collector using unicast communication is required. |
collectorHost
|
Optional. Host name where the Analytics Collector is running. The default value is localhost.
Only required for unicast communication, that is, where |
clusterName
|
Optional. Name of the cluster where a clustered Analytics Collector is running.
Only required for multicast communication, that is, where |
collectorPort
|
Optional. Port on which the Analytics Collector listens for events. The default value is 31314. |
isEnabled
|
Optional. Specifies whether to send analytics events raised using OpenUsage APIs to the Analytics Collector. Valid values 1 (true) and 0 (false). The default value is false.
Analytics events are sent to the Analytics Collector when |
timeout
|
Optional. Length of time (in seconds) to wait for a response from the Analytics Collector. Default value is 30.
Only required for multicast communication, that is, where |
default
|
Optional. Indicates whether this connection is the default (or active) Analytics Collector connection for the WebCenter application. Valid values 1 (true) and 0 (false). When set to 1, the WebCenter application sends events on this connection. When set to 0, the connection is not used. The default for this argument is 0.
While you can register multiple Analytics Collector connections for a WebCenter application, only one connection is used by the Analytics and Activity Graph services— the default (or active) connection. |
server
|
Optional. Name of the managed server where the WebCenter application is deployed. For example, WC_Spaces.
Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the WebCenter application is deployed. |
The following example updates host and port details for an existing Analytics Collector connection named MyAnalyticsCollector. On this connection, events are sent to a single Analytics Collector in unicast mode:
wls:/weblogic/serverConfig>setAnalyticsCollectorConnection(appName='webcenter', connectionName='MyAnalyticsCollector', collectorHost='myhost.com', collectorPort=31314)
The following example updates cluster, port, and timeout details for an existing Analytics Collector connection named MyAnalyticsCollector. On this connection, events are sent to a clustered Analytics Collector in multicast mode:
wls:/weblogic/serverConfig>setAnalyticsCollectorConnection(appName='webcenter', connectionName='MyAnalyticsCollector', clusterName='collector-cluster', collectorPort=31314, timeout=60)
Module: Oracle WebCenter
Use with WLST: Online
Lists connection names and details for all Analytics Collector connections that are configured for a named WebCenter application.
listAnalyticsCollectorConnections(appName, [server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the WebCenter application in which to perform this operation. |
server
|
Optional. Name of the managed server where the WebCenter application is deployed. For example, WC_Spaces.
Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the WebCenter application is deployed. |
Module: Oracle WebCenter
Use with WLST: Online
Specifies the default Analytics Collector connection for a named WebCenter application.
The default Analytics Collector connection is used to send events raised in WebCenter applications using OpenUsage APIs to an Analytics Collector for use by Analytics and Activity Graph services.
While you can register multiple Analytics Collector connections for a WebCenter application, only one Analytics Collector connection is used - the default (or active) connection.
setDefaultAnalyticsCollectorConnection(appName, name, [server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the WebCenter application in which to perform this operation. |
name
|
Name of an existing Analytics Collector connection. |
server
|
Optional. Name of the managed server where the WebCenter application is deployed. For example, WC_Spaces.
Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the WebCenter application is deployed. |
Module: Oracle WebCenter
Use with WLST: Online
Return details about the Analytics Collector connection that is currently configured for a WebCenter application.
While you can register multiple Analytics Collector connections for a WebCenter application, only one Analytics Collector connection is used—the default (or active) connection.
listDefaultAnalyticsCollectorConnection(appName, [server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the WebCenter application in which to perform this operation. |
server
|
Optional. Name of the managed server where the WebCenter application is deployed. For example, WC_Spaces.
Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the WebCenter application is deployed. |
Module: Oracle WebCenter
Use with WLST: Online
Configure the Analytics Collector deployed on the WC_Utilities managed server. Additionally, in a clustered environment, use this commands to set cluster settings.
setAnalyticsCollectorConfig(appName, [collectorHost, defaultPort, maxPort, broadcastType, clusterEnabled, clusterName, clusterBroadcastFrequency, server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the Analytics Collector application. |
collectorHost
|
Optional. Name of the host on which the Analytics Collector is running. The default value is localhost. |
defaultPort
|
Optional. Default port number on which the Analytics Collector listens. The default value is 31314. |
maxPort
|
Optional. Highest port number that the Analytics Collector can use when allocating a listener.
This property is mostly used in a clustered environment where more than one collector is running in the same box. Each collector listens for incoming UDP messages on a free port within a given port range. The range is from the default port number to the maxPort number. |
broadcastType
|
Optional. Indicates the network channel on which the Analytics Collector broadcasts a 'heartbeat' to advertise its location to event producers. Valid values are Broadcast and Multicast.
|
clusterEnabled
|
Optional. Indicates whether the Analytics Collector is deployed in a cluster. Valid values are 1 (true) and 0 (false).
If set to |
clusterName
|
Optional. Name of the Analytics Collector cluster.
Only required when |
clusterBroadcastFrequency
|
Optional. Broadcast Analytics Collector listening information every 'n' seconds. The default frequency is 10 seconds.
The Analytics Collector periodically broadcasts a 'heartbeat' to advertise its location ( |
server
|
Optional. Name of the managed server where the Analytics Collector is deployed. For example, WC_Utilities.
Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the application is deployed. |
Module: Oracle WebCenter
Use with WLST: Online
listAnalyticsCollectorConfig(appName, [server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the Analytics Collector application. |
server
|
Optional. Name of the managed server where the Analytics Collector is deployed. For example, WC_Utilities.
Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the application is deployed. |
The following command lists current settings for the Analytics Collector that is configured for an application named webcenter:
wls:/weblogic/serverConfig>listAnalyticsCollectorConfig(appName='analytics-collector')
This is sample output for an Analytics Collector in a clustered environment:
CollectorHost = localhost CollectorDefaultPort = 31314 CollectorMaximumPort = 31318 BroadcastType = Multicast ClusterEnabled = 1 ClusterName = myCluster ClusterBroadcastFrequency = 55
This is sample output for a standalone Analytics Collector:
CollectorHost = localhost CollectorDefaultPort = 31314 CollectorMaximumPort = 31314 BroadcastType = Multicast ClusterEnabled = ClusterName = ClusterBroadcastFrequency = 55
Module: Oracle WebCenter
Use with WLST: Online
listAnalyticsEventTypes(appName, [server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the Analytics Collector application. |
server
|
Optional. Name of the managed server where the Analytics Collector is deployed. For example, WC_Utilities.
Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the application is deployed. |
The following command lists all the events currently registered with the Analytics Collector for use by a WebCenter application named webcenter:
wls:/weblogic/serverConfig>listAnalyticsEventTypes(appName='webcenter')
Sample output:
{HTTP://WWW.ORACLE.COM/ANALYTICS/WC}DISCUSSION_ANNOUNCEMENTEDIT
{HTTP://WWW.ORACLE.COM/ANALYTICS/WC}DISCUSSION_TOPICDELETE
{HTTP://WWW.ORACLE.COM/ANALYTICS/WC}PAGEEDIT
{HTTP://WWW.ORACLE.COM/ANALYTICS/WC}DOCLIB_DOCUMENTCREATE
{HTTP://WWW.ORACLE.COM/ANALYTICS/WC}LOGINS
...
Use the commands listed in Table 10-5 to manage Activity Graph system properties and metadata.
Configuration changes made using the setAGProperty WLST command are only effective after your restart the managed server on which the Activity Graph application is deployed (WC_Utilities). For all other commands, configuration changes are effective immediately.
See also, "Managing the Activity Graph Service" in the Oracle Fusion Middleware Administrator's Guide for Oracle WebCenter.
Table 10-5 Activity Graph WLST Commands
| Use this command... | To... | Use with WLST... |
|---|---|---|
|
Export Activity Graph metadata definitions to an XML file. |
Online |
|
|
Import Activity Graph metadata definitions from an XML file. |
Online |
|
|
Export provider configuration, for a given provider, to an Activity Graph metadata definition file. |
Online |
|
|
Delete all the Activity Graph metadata that is defined for a WebCenter application. |
Online |
|
|
Delete the metadata for an action registered with Activity Graph. |
Online |
|
|
Delete the metadata for a node class registered with Activity Graph. |
Online |
|
|
Delete the metadata for a similarity calculation registered with Activity Graph. |
Online |
|
|
Delete the metadata for a rank calculation registered with Activity Graph. |
Online |
|
|
Delete the metadata for a provider assignment registered with Activity Graph. |
Online |
|
|
Delete the metadata for a QRPP registered with Activity Graph. |
Online |
|
|
Delete the metadata for a provider configuration registered with Activity Graph. |
Online |
|
|
Change the URN of an action registered with Activity Graph. |
Online |
|
|
Change the URN of a node class registered with Activity Graph. |
Online |
|
|
Set a system property for Activity Graph. |
Online |
|
|
Return the current setting for a given Activity Graph property. |
Online |
|
|
Set credentials (user name and password) for an Activity Graph property. |
Online |
Module: Oracle WebCenter
Use with WLST: Online
exportAGMetadata(appName, directoryPath, definitionFileName, includeProviderConfigurations,[server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the Activity Graph application in which to perform this operation—always activitygraph-engines. |
directoryPath
|
Destination directory for the XML file that will be generated. If you specify a directory that does not exist then it will be created. |
definitionFileName
|
Name for the XML file that will be generated. If a file with the same name exists in the destination directory then it will be overwritten. |
includeProviderConfigurations
|
Determines whether the export includes provider configuration metadata. Valid values are 1 (true) and 0 (false).
Provider configurations are a subset of Activity Graph metadata that you may want to manage separately from the other metadata. |
server
|
Optional. Name of the managed server where the application is deployed. For example, WC_Utilities.
Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the Activity Graph application is deployed. |
The following example exports Activity Graph metadata definitions to an XML file named ag-metadata.xml, at the specified location:
wls:/weblogic/serverConfig> exportAGMetadata(appName='activitygraph-engines', directoryPath='/scratch/myAGmetadata', definitionFileName='ag-metadata.xml', includeProviderConfigurations='1')
Module: Oracle WebCenter
Use with WLST: Online
Imports Activity Graph metadata definitions from an XML file.
On import, new Activity Graph metadata definitions are created on the target and existing definitions are overwritten.
importAGMetadata(appName, definitionFilePath, [server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the Activity Graph application in which to perform this operation—always activitygraph-engines. |
definitionFilePath
|
Relative path to the XML file containing metadata definitions. For example, metadata/import-metadata.xml. |
server
|
Optional. Name of the managed server where the application is deployed. For example, WC_Utilities.
Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the Activity Graph application is deployed. |
Module: Oracle WebCenter
Use with WLST: Online
Exports provider configuration, for a given provider, to an Activity Graph metadata definition file.
exportAGProviderConfiguration(appName, directoryPath, definitionFileName, urn, [server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the Activity Graph application in which to perform this operation—always activitygraph-engines. |
directoryPath
|
Destination directory for the XML file that will be generated. If you specify a directory that does not exist, then it will be created. |
definitionFilePath
|
Name for the XML file that will be generated. If a file with the same name exists in the destination directory then it will be overwritten. Example |
urn
|
URN for the Activity Graph provider to export. |
server
|
Optional. Name of the managed server where the application is deployed. For example, WC_Utilities.
Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the Activity Graph application is deployed. |
The following example exports configuration information for the Activity Graph provider oracle.webcenter.activitygraph.analytics to an XML file named 'ag-provider-config.xml, at the specified location:
wls:/weblogic/serverConfig> exportAGProviderConfiguration(appName='activitygraph-engines', directoryPath='/scratch/myAGmetadata', definitionFileName='ag-provider-config.xml', urn='oracle.webcenter.activitygraph.analytics')
Module: Oracle WebCenter
Use with WLST: Online
Deletes all the Activity Graph metadata that is defined for a WebCenter application. The delete operation is immediate and non-reversible.
You can use this command in conjunction with the WLST command importAGMetadata to completely re-install Activity Graph metadata.
Note: Any data in the relation store, similarity store, and rank store will be deleted the next time the Activity Graph engines run.
deleteAllAGMetadata(appName, [server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the Activity Graph application in which to perform this operation—always activitygraph-engines. |
server
|
Optional. Name of the managed server where the application is deployed. For example, WC_Utilities.
Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the Activity Graph application is deployed. |
Module: Oracle WebCenter
Use with WLST: Online
Deletes the metadata for an action that is currently registered with Activity Graph. The delete operation is immediate and non-reversible.
Note:
Any data in the relation store that is associated with the action will be deleted the next time the Activity Graph engines run.deleteAGAction(appName, urn, [server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the Activity Graph application in which to perform this operation—always activitygraph-engines. |
urn
|
URN for the Activity Graph action to delete. |
server
|
Optional. Name of the managed server where the application is deployed. For example, WC_Utilities.
Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the Activity Graph application is deployed. |
Module: Oracle WebCenter
Use with WLST: Online
Deletes the metadata for a node class that is currently registered with Activity Graph. The delete operation is immediate and non-reversible.
Note:
Any data in the relation store that is associated with the node class will be deleted the next time the Activity Graph engines run.deleteAGNodeClass(appName, urn, [server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the Activity Graph application in which to perform this operation—always activitygraph-engines. |
urn
|
URN for the Activity Graph node class to delete. |
server
|
Optional. Name of the managed server where the application is deployed. For example, WC_Utilities.
Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the Activity Graph application is deployed. |
Module: Oracle WebCenter
Use with WLST: Online
Deletes the metadata for a similarity calculation that is currently registered with Activity Graph. The delete operation is immediate and non-reversible.
deleteAGSimilarityCalculation(appName, urn, [server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the Activity Graph application in which to perform this operation—always activitygraph-engines. |
urn
|
URN for the Activity Graph similarity calculation to delete. |
server
|
Optional. Name of the managed server where the application is deployed. For example, WC_Utilities.
Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the Activity Graph application is deployed. |
Module: Oracle WebCenter
Use with WLST: Online
Deletes the metadata for a rank calculation that is currently registered with Activity Graph. The delete operation is immediate and non-reversible.
deleteAGRankCalculation(appName, urn, [server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the Activity Graph application in which to perform this operation—always activitygraph-engines. |
urn
|
URN for the Activity Graph rank calculation to delete. |
server
|
Optional. Name of the managed server where the application is deployed. For example, WC_Utilities.
Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the Activity Graph application is deployed. |
Module: Oracle WebCenter
Use with WLST: Online
Deletes the metadata for a provider assignment that is currently registered with Activity Graph, that is, a provider assignment defined by the unique triple combination (action, sourceClass, trgClass). The delete operation is immediate and non-reversible.
deleteAGProviderAssignment(appName, actionURN, srcClasURN, trgClassURN [server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the Activity Graph application in which to perform this operation—always activitygraph-engines. |
actionURN
|
URN for the action. |
srcClassURN |
URN for the source node class. |
trgClassURN
|
URN for the target node class. |
server
|
Optional. Name of the managed server where the application is deployed. For example, WC_Utilities.
Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the Activity Graph application is deployed. |
Module: Oracle WebCenter
Use with WLST: Online
Deletes the metadata for a QRPP (Query Result Post Processor) that is currently registered with Activity Graph. The delete operation is immediate and non-reversible.
deleteAGQRPPRegistration(appName, urn [server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the Activity Graph application in which to perform this operation—always activitygraph-engines. |
urn |
URN for the QRPP to delete. |
server
|
Optional. Name of the managed server where the application is deployed. For example, WC_Utilities.
Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the Activity Graph application is deployed. |
Module: Oracle WebCenter
Use with WLST: Online
Deletes the metadata for a provider configuration. The delete operation is immediate and non-reversible.
deleteAGProviderConfiguration(appName, urn [server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the Activity Graph application in which to perform this operation—always activitygraph-engines. |
urn |
URN for the Activity Graph provider to delete. |
server
|
Optional. Name of the managed server where the application is deployed. For example, WC_Utilities.
Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the Activity Graph application is deployed. |
Module: Oracle WebCenter
Use with WLST: Online
Changes the URN of an action that is currently registered with Activity Graph. Any data in the relation store that is associated with the action is preserved.
Note:
This command does not delete the action and create an action with a different name as this causes data associated with the original action to be deleted.renameAGAction(appName, currentURN, newURN,[server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the Activity Graph application in which to perform this operation—always activitygraph-engines. |
currentURN |
Current action URN. |
newURN |
New action URN. |
server
|
Optional. Name of the managed server where the application is deployed. For example, WC_Utilities.
Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the Activity Graph application is deployed. |
Module: Oracle WebCenter
Use with WLST: Online
Changes the URN of a node class that is currently registered with Activity Graph. Any data in the relation store that is associated with the node class is preserved.
Note:
This command does not delete the node class and create a node class with a different name as this would cause data associated with the original node class to be deleted.renameAGNodeClass(appName, currentURN, newURN,[server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the Activity Graph application in which to perform this operation—always activitygraph-engines. |
currentURN |
Current node class URN. |
newURN |
New node class URN. |
server
|
Optional. Name of the managed server where the application is deployed. For example, WC_Utilities.
Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the Activity Graph application is deployed. |
Module: Oracle WebCenter
Use with WLST: Online
Sets a system property for Activity Graph. This command sets a value based on the property's datatype (String, Integer, Float, Boolean).
Activity Graph system properties include settings for:
Oracle Secure Enterprise Search (SES) Admin API Web service connection
Rank engine
JNDI datasources
Activity Graph database
Analytics database
Debugging and testing
See also, "Managing the Activity Graph Service" in the Oracle Fusion Middleware Administrator's Guide for Oracle WebCenter for a list of system properties and their datatypes.
Configuration changes made using the setAGProperty WLST command are only effective after your restart the managed server on which the Activity Graph application is deployed (WC_Utilities).
setAGProperty(appName, propertyName, propertyValue, propertyType,[server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the Activity Graph application in which to perform this operation—always activitygraph-engines. |
propertyName |
Name of the Activity Graph property. |
propertyValue |
Value for the Activity Graph property. |
propertyType |
Datatype of the property. Valid values are: String, Int, Float or Boolean.
Values are case sensitive. |
server
|
Optional. Name of the managed server where the application is deployed. For example, WC_Utilities.
Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the Activity Graph application is deployed. |
Module: Oracle WebCenter
Use with WLST: Online
Returns the current setting for a given Activity Graph property.
See also, "Managing the Activity Graph Service" in the Oracle Fusion Middleware Administrator's Guide for Oracle WebCenter for a list of valid system properties.
getAGProperty(appName, propertyName, propertyType [server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the Activity Graph application in which to perform this operation—always activitygraph-engines. |
propertyName |
Name of the Activity Graph property. |
propertyType |
Datatype of the property. Valid values are: String, Int, Float or Boolean.
Values are case sensitive. |
server
|
Optional. Name of the managed server where the application is deployed. For example, WC_Utilities.
Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the Activity Graph application is deployed. |
The following example returns the current value of the system property oracle.webcenter.activitygraph.providers.datasources.ses.soap.admin.url:
wls:/weblogic/serverConfig> getAGProperty(appName='activitygraph-engines', propertyName='oracle.webcenter.activitygraph.providers.datasources.ses.soap.admin.url', propertyType='String')
Module: Oracle WebCenter
Use with WLST: Online
Sets credentials (user name and password) for an Activity Graph credential property.
See also, "Managing the Activity Graph Service" in the Oracle Fusion Middleware Administrator's Guide for Oracle WebCenter for a list of properties with the PasswordCredential datatype, for example, oracle.webcenter.activitygraph.providers.datasources.ses.soap.admin.credential.
setAGPasswordCredentialProperty(appName, propertyName, userName, password,[server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the Activity Graph application in which to perform this operation—always activitygraph-engines. |
propertyName |
Name of the Activity Graph property that specifies credentials (and has PasswordCredential datatype). |
userName |
User name associated with the credential property. |
password |
Password associated with the user name specified. |
server
|
Optional. Name of the managed server where the application is deployed. For example, WC_Utilities.
Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the Activity Graph application is deployed. |
The following example sets user name and password credentials for the Oracle SES Admin tool:
wls:/weblogic/serverConfig> setAGProperty(appName='activitygraph-engines', propertyName='oracle.webcenter.activitygraph.providers.datasources.ses.soap.admin.credential', userName='myname', password='GuessWhat')
Use the commands listed in Table 10-6 to archive and restore activity stream data generated for a WebCenter application.
Configuration changes made using these WebCenter WLST commands are only effective after your restart the Managed Server on which the WebCenter application is deployed. For details, see Oracle Fusion Middleware Administrator's Guide for Oracle WebCenter.
Table 10-6 Activity Stream WLST Commands
| Use this command... | To... | Use with WLST... |
|---|---|---|
|
Archive activity stream data that is older than a specified date. |
Online |
|
|
Archive activity stream data associated with deleted objects. |
Online |
|
|
Archive activity stream data associated with Spaces that are currently closed. |
Online |
|
|
Archive activity stream data associated with Spaces that have been inactive since a specified date. |
Online |
|
|
Restore archived activity stream data from a specified date into production tables. |
Online |
|
|
Truncates activity stream archive data. |
Online |
Module: Oracle WebCenter
Use with WLST: Online
Archives activity stream data that is older than a specified date.
This command moves data from production tables to archive tables. Exceptions include WC_ACTOR_DETAIL and WC_OBJECT_DETAIL—data in these tables is copied to archive tables rather than moved.
Rows in WC_OBJECT_DETAIL that are not used by any activity element are deleted.
archiveASByDate(appName, year, month, day, [server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the WebCenter application in which to perform this operation. |
year
|
Year before which to archive activity stream data. For example, 2009. |
month
|
Month before which to archive activity stream data. For example, enter 1 for January, 2 for February, and so on. |
day
|
Day of the month before which to archive activity stream data. |
server
|
Optional. Name of the managed server where the WebCenter application is deployed. For example, WC_Spaces.
Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the WebCenter application is deployed. |
Module: Oracle WebCenter
Use with WLST: Online
Archives activity stream data associated with deleted objects.This command moves data from production tables to archive tables, except for WC_ACTOR_DETAIL—data in this table is copied to the archive table rather than moved.
Rows in WC_OBJECT_DETAIL that satisfy the criteria (in this case, deleted objects) are deleted.
archiveASByDeletedObjects(appName, [server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the WebCenter application in which to perform this operation. |
server
|
Optional. Name of the managed server where the WebCenter application is deployed. For example, WC_Spaces.
Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the WebCenter application is deployed. |
Module: Oracle WebCenter
Use with WLST: Online
Archives activity stream data associated with Spaces that are currently closed.
This command moves data from production tables to archive tables, except for WC_ACTOR_DETAIL—data in this table is copied to the archive table rather than moved. Rows in WC_OBJECT_DETAIL that satisfy the criteria (in this case, objects involved in activities of Spaces that are closed) are deleted.
archiveASByClosedSpaces(appName, [server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the WebCenter application in which to perform this operation. |
server
|
Optional. Name of the managed server where the WebCenter application is deployed. For example, WC_Spaces.
Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the WebCenter application is deployed. |
Module: Oracle WebCenter
Use with WLST: Online
Archives activity stream data associated with Spaces that have been inactive since a specified date. An inactive Space is an open or closed Space in which there has been no activity since the specified date.
This command moves data from production tables to archive tables, except for WC_ACTOR_DETAIL—data in this table is copied to the archive table rather than moved.Rows in WC_OBJECT_DETAIL that satisfy the criteria (in this case, objects involved in activities of Spaces that have been inactive since the specified date) are deleted.
archiveASByInactiveSpaces(appName, year, month, day, [server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the WebCenter application in which to perform this operation. |
year
|
Year the Space became inactive. For example, 2009. |
month
|
Month the Space became inactive. For example, enter 1 for January, 2 for February, and so on. |
day
|
Day of the month the Space became inactive. |
server
|
Optional. Name of the managed server where the WebCenter application is deployed. For example, WC_Spaces.
Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the WebCenter application is deployed. |
Module: Oracle WebCenter
Use with WLST: Online
Restores archived activity stream data from a specified date into production tables.
This command moves data from archive tables to production tables, except for WC_ACTOR_DETAIL—data in this table is not restored because data is not deleted from this table during the archive process.
Rows that already exist in the production tables are not changed during the restore process.
restoreASByDate(appName, year, month, day, [server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the WebCenter application in which to perform this operation. |
year
|
Year from which to restore activity stream data. For example, 2009. |
month
|
Month from which to restore activity stream data. For example, enter 1 for January, 2 for February, and so on. |
day
|
Day of the month from which to restore activity stream data. |
server
|
Optional. Name of the managed server where the WebCenter application is deployed. For example, WC_Spaces.
Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the WebCenter application is deployed. |
Module: Oracle WebCenter
Use with WLST: Online
truncateASArchive(appName, [server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the WebCenter application in which to perform this operation. |
server
|
Optional. Name of the managed server where the WebCenter application is deployed. For example, WC_Spaces.
Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the WebCenter application is deployed. |
Use the commands listed in Table 10-7 to manage content repository connections and configure the Documents service for a WebCenter application.
Configuration changes made using these WebCenter WLST commands are only effective after your restart the Managed Server on which the WebCenter application is deployed. For details, see Oracle Fusion Middleware Administrator's Guide for Oracle WebCenter.
Table 10-7 Content Repository WLST Commands
| Use this command... | To... | Use with WLST... |
|---|---|---|
|
Create an Oracle Content Server repository connection. |
Online |
|
|
Edit an existing Oracle Content Server connection. |
Online |
|
|
List individual or all Oracle Content Server connections that are configured for a WebCenter application. |
Online |
|
|
Create an Oracle Portal repository connection. |
Online |
|
|
Edit an existing Oracle Portal repository connection. |
Online |
|
|
List all Oracle Portal connections that are configured for a WebCenter application. |
Online |
|
|
Create a connection to a file system. |
Online |
|
|
Edit an existing file system repository connection. |
Online |
|
|
List individual or all file system connections configured for a WebCenter application. |
Online |
|
|
Create a Microsoft SharePoint 2007 repository connection. |
Online |
|
|
Edit a Microsoft SharePoint 2007 repository connection. |
Online |
|
|
List all Microsoft SharePoint 2007 connections that are configured for a WebCenter application. |
Online |
|
|
List properties for the back-end Oracle Content Server repository that is being used by WebCenter Spaces. |
Online |
|
|
Modify properties for the back-end Oracle Content Server repository used by WebCenter Spaces. |
Online |
|
|
Delete properties for the back-end Oracle Content Server repository used by WebCenter Spaces. |
Online |
Module: Oracle WebCenter
Use with WLST: Online
Creates an Oracle Content Server repository connection, for a named WebCenter application.
createJCRContentServerConnection(appName, name, socketType, [url, serverHost, serverPort, keystoreLocation, keystorePassword, privateKeyAlias, privateKeyPassword, webContextRoot, clientSecurityPolicy, cacheInvalidationInterval, binaryCacheMaxEntrySize, adminUsername, adminPassword, extAppId, timeout, isPrimary, server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the WebCenter application in which to perform this operation. |
name
|
Connection name. The name must be unique (across all connection types) within the WebCenter application. |
socketType
|
Specifies whether the Oracle Content Server connects on the content server listener port or the Web server filter, and whether the listener port is SSL enabled. Valid values are socket, web, and socketssl. This option has no default.
Choose from:
|
url
|
Optional. Oracle Content Server URL. Required only if socketType is set to web or jaxws. URL should be in the format: http://<hostname>:<port>/<web root>/<plugin root>
For example, |
serverHost
|
Optional. Host name of the machine where the Oracle Content Server is running. Required if socketType is set to socket or socketssl. |
serverPort
|
Optional. Port on which the Oracle Content Server listens. Required if socketType is set to socket or socketssl:
This property corresponds to the |
keystoreLocation
|
Optional. Location of key store that contains the private key used to sign the security assertions. Required only if socketType is set to socketssl.
The key store location must be an absolute path. |
keystorePassword
|
Optional. Password required to access the key store. Required only if socketType is set to socketssl. |
privateKeyAlias
|
Optional. Client private key alias in the key store. The key is used to sign messages to the server. The public key corresponding to this private key must be imported in the server keystore.
Required only if |
privateKeyPassword
|
Optional. Password to be used with the private key alias in the key store. Required only if socketType is set to socketssl. |
webContextRoot
|
Optional. Web server context root for Oracle Content Server. Use the format /<context_root>. For example, /cs.
When specified, several Oracle Universal Content Management (UCM) features based on iFrame are available in the WebCenter application. This includes:
Note: To fully enable these UCM features you must access the WebCenter application through Oracle HTTPS Server (OHS) to expose Oracle Content Server and the WebCenter application under the same host and port. The WebCenter application and Oracle Content Server must also both use single sign on. For information about setting up OHS to front-end WebCenter applications, see "Oracle Content Server - Configuration" in Oracle Fusion Middleware Administrator's Guide for Oracle WebCenter. If your WebCenter application is connected to multiple UCM servers, Oracle recommends that each UCM server has a unique Web Server Context Root so that OHS re-direction works correctly. |
clientSecurityPolicy
|
Optional. Client security policy to be used when the socketType is jaxws. For example: oracle/wss11_saml_token_with_message_protection_service_policy |
cacheInvalidationInterval
|
Optional. Frequency between checks for external Oracle Content Server content changes (in minutes). WebCenter automatically clears items that have changed from the cache. Defaults to 0 which means that cache invalidation is disabled. The minimum interval is 2 minutes. |
binaryCacheMaxEntrySize
|
Optional. Maximum cacheable size (in bytes) for Oracle Content Server binary documents. Documents larger than this size are not cached by WebCenter. Defaults is 102400 bytes (100K).
Tune this value based on your machine's memory configuration and the types of binary documents that you expect to cache. |
adminUsername
|
Optional. User name with administrative rights for this Oracle Content Server instance. This user will be used to fetch content type information based on profiles and track document changes for cache invalidation purpose. Defaults to sysadmin. |
adminPassword
|
Optional. Password for the Oracle Content Server administrator specified in adminUsername. Required when socketType is set to web. |
extAppId
|
Optional. External application used to authenticate WebCenter users against the Oracle Content Server. This value should match the name of an existing external application connection. See also listExtAppConnections. If extAppId is not set, no change is made to the authentication method or external application ID.
If |
timeout
|
Optional. Length of time allowed to log in to Oracle Content Server (in ms) before issuing a connection timeout message. If no timeout is set, there is no time limit for the login operation. |
isPrimary
|
Optional. Valid string values are 1 (true) and 0 (false). 1 specifies that this connection is the primary connection used by the Documents service. This argument defaults to 0.
In WebCenter Spaces, the primary connection is used to store Space content and Home Space content. |
server
|
Optional. Name of the managed server where the WebCenter application is deployed. For example, WC_Spaces.
Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the WebCenter application is deployed. |
The following example creates a socket-based connection to an Oracle Content Server running on myhost.com at port 4444. For authentication purposes, an existing external application named myExtApp is used. See also, createExtAppConnection.
wls:/weblogic/serverConfig> createJCRContentServerConnection(appName='webcenter', name='myContentServerConnection', socketType='socket', serverHost='myhost.com', serverPort='4444', extAppId='myExtApp', isPrimary=1)
The following example creates an SSL socket-based connection to an Oracle Content Server repository.
wls:/weblogic/serverConfig> createJCRContentServerConnection(appName='webcenter', name='myContentServerConnection', socketType='socketssl', serverHost='myhost.com', serverPort='4444', keystoreLocation='d:/keys/here', keystorePassword='AlphaSquad7', privateKeyAlias='enigma', privateKeyPassword='S0larPl3x1s', extAppId='myExtApp')
The following example creates a JAX-WS (Java API for XML Web Services) connection to an Oracle Content Server repository:
wls:/weblogic/serverConfig> createJCRContentServerConnection(appName='webcenter', name='myContentServerConnection', socketType='jaxws', url='http://myhost.com:9044/idcnativews', clientSecurityPolicy='oracle/wss10_saml_token_client_policy')
Module: Oracle WebCenter
Use with WLST: Online
Edits an existing Oracle Content Server connection. This command requires that you specify values for appName and name, plus one additional argument.
setJCRContentServerConnection(appName, name, [socketType, url, serverHost, serverPort, keystoreLocation, keystorePassword, privateKeyAlias, privateKeyPassword, webContextRoot, clientSecurityPolicy, cacheInvalidationInterval, binaryCacheMaxEntrySize, adminUsername, adminPassword, extAppId, timeout, isPrimary, server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the WebCenter application in which to perform this operation. |
name
|
Name of an existing Oracle Content Server connection. |
socketType
|
Optional. Specifies whether the Oracle Content Server connects on the content server listener port or the Web server filter, and whether the listener port is SSL enabled. Valid values are socket, web, and socketssl. This option has no default.
Choose from:
|
url
|
Optional. Oracle Content Server URL. Required only if socketType is set to web or jaxws. URL should be in the format: http://<hostname>:<port>/<web root>/<plugin root>
For example, |
serverHost
|
Optional. Host name of the machine where the Oracle Content Server is running. Required if socketType is set to socket or socketssl. |
serverPort
|
Optional. Port on which the Oracle Content Server listens. Required if socketType is set to socket or socketssl:
For example, |
keystoreLocation
|
Optional. Location of key store that contains the private key used to sign the security assertions. Required only if socketType is set to socketssl.
The key store location must be an absolute path. |
keystorePassword
|
Optional. Password required to access the key store. Required only if socketType is set to socketssl. |
privateKeyAlias
|
Optional. Client private key alias in the key store. Required only if socketType is set to socketssl. The value for this argument must be a string that contains neither special characters nor white space. |
privateKeyPassword
|
Optional. Password to be used with the private key alias in the key store. Required only if socketType is set to socketssl. |
webContextRoot
|
Optional. Web server context root for Oracle Content Server. Use the format /<context_root>. For example, /cs.
When specified, several Oracle Universal Content Management (UCM) features based on iFrame, such as previewing files in a slide viewer, are available in the WebCenter application. Note: To fully enable these UCM features you must access the WebCenter application through Oracle HTTPS Server (OHS) to expose Oracle Content Server and the WebCenter application under the same host and port. The WebCenter application and Oracle Content Server must also both use single sign on. For information about setting up OHS to front-end WebCenter applications, see "Oracle Content Server - Configuration" in Oracle Fusion Middleware Administrator's Guide for Oracle WebCenter.
|
clientSecurityPolicy
|
Optional. Client security policy to be used when the socketType is jaxws. For example: oracle/wss11_saml_token_with_message_protection_service_policy |
cacheInvalidationInterval
|
Optional. Frequency between checks for external Oracle Content Server content changes (in minutes). WebCenter automatically clears items that have changed from the cache. Defaults to 0 which means that cache invalidation is disabled. The minimum interval is 2 minutes. |
binaryCacheMaxEntrySize
|
Optional. Maximum cacheable size (in bytes) for Oracle Content Server binary documents. Documents larger than this size are not cached by WebCenter. Defaults is 102400 bytes (100K).
Tune this value based on your machine's memory configuration and the types of binary documents that you expect to cache. |
adminUsername
|
Optional. User name with administrative rights for this Oracle Content Server instance. This user will be used to fetch content type information based on profiles and track document changes for cache invalidation purpose. Defaults to sysadmin. |
adminPassword
|
Optional. Password for the Oracle Content Server administrator specified in adminUsername. Required when socketType is set to web. |
extAppId
|
Optional. External application used to authenticate WebCenter users against the Oracle Content Server. This value should match the name of an existing external application connection. See also listExtAppConnections. If extAppId is not set, no change is made to the authentication method or external application ID.
If |
timeout
|
Optional. Length of time allowed to log in to Oracle Content Server (in ms) before issuing a connection timeout message. If no timeout is set, there is no time limit for the login operation. |
isPrimary
|
Optional. Valid string values are 1 (true) and 0 (false). 1 specifies that this connection is the primary connection used by the Documents service. This argument defaults to 0.
In WebCenter Spaces, the primary connection is used to store Space content and Home Space content. |
server
|
Optional. Name of the managed server where the WebCenter application is deployed. For example, WC_Spaces.
Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the WebCenter application is deployed. |
The following example edits a socket-based connection to an Oracle Content Server.
wls:/weblogic/serverConfig>setJCRContentServerConnection(appName='webcenter', name='myContentServerConnection', socketType='socket', serverHost='myhost.com', serverPort='4444', extAppId='myExtApp', isPrimary=1)
The following example edits an SSL socket-based connection to an Oracle Content Server.
wls:/weblogic/serverConfig>setJCRContentServerConnection(appName='webcenter', name='myContentServerConnection', socketType='socketssl', serverHost='myhost.com', serverPort='8443', keystoreLocation='d:/keys/here', keystorePassword='T0PS3CR3T', privateKeyAlias='TekJansen', privateKeyPassword='LadyNocturne', extAppId='myExtApp', isPrimary=1)
The following example edits a JAX-WS (Java API for XML Web Services) connection to an Oracle Content Server repository:
wls:/weblogic/serverConfig> setJCRContentServerConnection(appName='webcenter', socketType='jaxws', url='http://myhost.com:9044/idcnativews', clientSecurityPolicy='oracle/wss10_saml_token_client_policy')
Module: Oracle WebCenter
Use with WLST: Online
Without any arguments, this command lists all of the Oracle Content Server connections that are configured for a named WebCenter application.
listJCRContentServerConnections(appName, [verbose], [name, server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the WebCenter application in which to perform this operation. |
verbose
|
Optional. Displays content repository connection details in verbose mode. Valid options are 1 (true) and 0(false). When set to 1, listJCRContentServerConnections lists all Oracle Content Server connections that are configured for a WebCenter application, along with their details. When set to 0, only connection names are listed. This argument defaults to 0. |
name
|
Optional. Name of an existing Oracle Content Server connection. When specified you can view connection details for a specific Oracle Content Server connection. If you supply a value for name, you must supply a value for verbose. |
server
|
Optional. Name of the managed server where the WebCenter application is deployed. For example, WC_Spaces.
Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the WebCenter application is deployed. |
The following example lists Oracle Content Server connections configured for an application named webcenter.
wls:/weblogic/serverConfig> listJCRContentServerConnections(appName='webcenter')
The following example lists all properties of the Oracle Content Server connection named myContentServerConnection1. The connection named myContentServerConnection1 must exist and be an Oracle Content Server connection. If, for example, you specify an Oracle Portal connection, the properties are not listed and an error is displayed.
wls:/weblogic/serverConfig>listJCRContentServerConnections(appName='webcenter', verbose=1, name='myContentServerConnection1')
Module: Oracle WebCenter
Use with WLST: Online
createJCRPortalConnection(appName, name, dataSource, [extAppId, isPrimary, timeout, server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the WebCenter application in which to perform this operation. |
name
|
Connection name. The name must be unique (across all connection types) within the WebCenter application. |
dataSource
|
JNDI DataSource location used to connect to the portal. For example: jdbc/MyPortalDS
The datasource must be on the server where the WebCenter application is deployed. |
extAppId
|
Optional. External application used to authenticate WebCenter users against Oracle Portal. This value should match the name of an existing external application connection. See also listExtAppConnections. If extAppId is not set, no change is made to the authentication method or external application ID.
If |
timeout
|
Optional. Length of time allowed to log in to Oracle Portal (in ms) before issuing a connection timeout message. If no timeout is set, there is no time limit for the login operation. |
isPrimary
|
Optional. Valid string values are 1 (true) and 0 (false). 1 specifies that this connection is the primary connection used by the Documents service. This argument defaults to 0.
In WebCenter Spaces, the primary connection must be an Oracle Content Server connection. |
server
|
Optional. Name of the managed server where the WebCenter application is deployed. For example, WC_Spaces.
Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the WebCenter application is deployed. |
The following example creates a Oracle Portal connection named myPortalConnection using the data source jdbc/portalDS and specifies that an external application, named myExtApp, is used for authentication.
wls:/weblogic/serverConfig> createJCRPortalConnection(appName='myApp', name='myPortalConnection', dataSource='jdbc/portalDS', extAppId='myExtApp', isPrimary=1)
Module: Oracle WebCenter
Use with WLST: Online
Edits an existing Oracle Portal connection. This command requires that you specify values for either the dataSource or isPrimary argument.
setJCRPortalConnection(appName, name, [dataSource, extAppId, timeout, isPrimary, server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the WebCenter application in which to perform this operation. |
name
|
Name of an existing Oracle Portal connection. |
dataSource
|
Optional. JNDI DataSource location used to connect to the portal. For example: jdbc/MyPortalDS
The datasource must be on the server where the WebCenter application is deployed. |
extAppId
|
Optional. External application used to authenticate WebCenter users against Oracle Portal. This value should match the name of an existing external application connection. See also listExtAppConnections. If extAppId is not set, no change is made to the authentication method or external application ID.
If |
timeout
|
Optional. Length of time allowed to log in to Oracle Portal (in ms) before issuing a connection timeout message. If no timeout is set, there is no time limit for the login operation. |
isPrimary
|
Optional. Valid string values are 1 (true) and 0 (false). 1 specifies that this connection is the primary connection used by the Documents service. When set to 0, and the specified connection is the primary connection used by the Documents service, the primary connection is reset. If this parameter is not set, the primary connection used by the Documents service does not change. This argument has no default.
In WebCenter Spaces, the primary connection must be an Oracle Content Server connection. |
server
|
Optional. Name of the managed server where the WebCenter application is deployed. For example, WC_Spaces.
Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the WebCenter application is deployed. |
Module: Oracle WebCenter
Use with WLST: Online
Without any arguments, this command lists all of the Oracle Portal connections that are configured for a named WebCenter application.
listJCRPortalConnections(appName, [verbose, name, server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the WebCenter application in which to perform this operation. |
verbose
|
Optional. Displays content repository connection details in verbose mode. Valid options are 1 (true) and 0 (false). When set to 1, listJCRPortalConnections lists all Oracle Portal connections that are configured for a WebCenter application, along with their details. When set to 0, only connection names are listed. This argument defaults to 0. |
name
|
Optional. Name of an existing Oracle Portal connection. When specified you can view connection details for a specific Oracle Portal connection. If you supply a value for name, you must supply a value for verbose. |
server
|
Optional. Name of the managed server where the WebCenter application is deployed. For example, WC_Spaces.
Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the WebCenter application is deployed. |
Module: Oracle WebCenter
Use with WLST: Online
Creates a connection to a file system repository.
Note:
File system connections must not be used in production or enterprise application deployments. This feature is provided for development purposes only.createJCRFileSystemConnection(appName, name, path, [isPrimary, server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the WebCenter application in which to perform this operation. |
name
|
Connection name. The name must be unique (across all connection types) within the WebCenter application. |
path
|
Full path to a folder whose contents you want to expose through this file system connection. For example, if you have a folder called C:\ProjectDocuments and you want to use that folder with the Documents service, you need to specify this folder as the path argument to this command. |
isPrimary
|
Optional. Valid values are 1 (true) and 0 (false). 1 specifies that this connection is the primary connection used by the Documents service. When set to 0, and when the specified connection is the primary connection used by the Documents service, the primary connection is reset. If this parameter is not set, the primary connection used by the Documents service does not change. This argument has no default.
In WebCenter Spaces, the primary connection must be an Oracle Content Server connection. |
server
|
Optional. Name of the managed server where the WebCenter application is deployed. For example, WC_Spaces.
Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the WebCenter application is deployed. |
Module: Oracle WebCenter
Use with WLST: Online
Edits an existing file system repository connection. This command requires that you specify values for either the path or isPrimary arguments.
Note:
File system connections must not be used in production or enterprise application deployments. This feature is provided for development purposes only.setJCRFileSystemConnection(appName, name, [path, isPrimary, server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Application name in which to set Document service properties. |
name
|
Name for the connection to be used by the Documents service. |
path
|
Optional. Full path to a folder whose contents you want to expose through this file system connection. For example, if you have a folder called C:\ProjectDocuments and you want to use that folder with the Documents service, you need to specify this folder as the path argument to this command. |
isPrimary
|
Optional. Valid values are 1 (true) and 0 (false). When set to 1, specifies that this connection is the primary connection used by the Documents service. When set to 0, and when the specified connection is the primary connection used by the Documents service, the primary connection is reset. If this parameter is not set, the primary connection used by the Documents service does not change. This argument has no default.
Note that in WebCenter Spaces, the primary connection must be an Oracle Content Server connection. |
server
|
Optional. Name of the managed server where the WebCenter application is deployed. For example, WC_Spaces.
Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the WebCenter application is deployed. |
Module: Oracle WebCenter
Use with WLST: Online
Without any arguments, this command lists all of the file system connections that are configured for a named WebCenter application.
Note:
File system connections must not be used in production or enterprise application deployments. This feature is provided for development purposes only.listJCRFileSystemConnections(appName, [verbose, name, server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the WebCenter application in which to perform this operation. |
verbose
|
Optional. Displays content repository connection details in verbose mode. Valid options are 1 (true) and 0 (false). When set to 1, listJCRFileSystemConnections lists all file system connections that are configured for a WebCenter application, along with their details. When set to 0, only connection names are listed. This argument defaults to 0. |
name
|
Optional. Name of an existing file system connection. When specified you can view connection details for a specific file system connection. If you supply a value for name, you must supply a value for verbose. |
server
|
Optional. Name of the managed server where the WebCenter application is deployed. For example, WC_Spaces.
Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the WebCenter application is deployed. |
The following example lists all of the file system connections that are configured for an application named webcenter.
wls:/weblogic/serverConfig> listJCRFileSystemConnections(appName='webcenter')
The following example lists all of the file system connections that are configured, in verbose mode.
wls:/weblogic/serverConfig> listJCRFileSystemConnections(appName='webcenter', verbose=1)
Module: Oracle WebCenter
Use with WLST: Online
createJCRSharePointConnection(appName, name, url, [likeLimit, extAppId, timeout, isPrimary, server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the WebCenter application in which to perform this operation. |
name
|
Connection name. The name must be unique (across all connection types) within the WebCenter application. |
url
|
Web address of the SharePoint site to which you want to connect.
For example, if the SharePoint site address is |
likeLimit
|
Optional. Number of characters the LIKE operator matches. The default is 64.
The SharePoint query language can use a As Oracle recommends the default value (64), there is no need to specify this argument when you create a connection using the WLST command Note: Only specify a value above 64 if your SharePoint instance supports LIKE queries on URLs greater than 64 characters. |
extAppId
|
Optional. External application used to authenticate WebCenter users against the SharePoint repository. This value should match the name of an existing external application connection. See also listExtAppConnections.
If
|
timeout
|
Optional. Length of time allowed to log in to the SharePoint repository (in ms) before issuing a connection timeout message. If no timeout is set, there is no time limit for the login operation. |
isPrimary
|
Optional. Valid values are 1 (true) and 0 (false). 1 specifies that this connection is the primary connection used by the Documents service. The argument defaults to 0. If this parameter is omitted, the primary connection used by the Documents service does not change.
In WebCenter Spaces, the primary connection must be an Oracle Content Server connection. |
server
|
Optional. Name of the managed server where the WebCenter application is deployed. For example, WC_Spaces.
Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the WebCenter application is deployed. |
Module: Oracle WebCenter
Use with WLST: Online
Edits an existing Microsoft SharePoint 2007 repository connection. This command requires that you specify values for appName and name, plus at least one additional argument.
setJCRSharePointConnection(appName, name, [url, likeLimit, extAppId, timeout, isPrimary, server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the WebCenter application in which to perform this operation. |
name
|
Name of an existing SharePoint connection. |
url
|
Optional. Web address of the SharePoint site to which you want to connect.
For example, if the SharePoint site address is |
likeLimit
|
Optional. Number of characters the LIKE operator matches. The default is 64.
The SharePoint query language can use a Oracle recommends the default value (64). The default is suitable in most instances so, typically, there is no need to set a new value. To reset the default, specify Note: Only specify a value above 64 if your SharePoint instance supports LIKE queries on URLs greater than 64 characters. |
extAppId
|
Optional. External application used to authenticate WebCenter users against the SharePoint repository. This value should match the name of an existing external application connection. See also listExtAppConnections. If extAppId is not set, no change is made to the current external application ID.
If no external application is set, the SharePoint connection will not work. |
timeout
|
Optional. Length of time allowed to log in to the SharePoint repository (in ms) before issuing a connection timeout message. If no timeout is set, there is no time limit for the login operation. |
isPrimary
|
Optional. Valid values are 1 (true) and 0 (false). 1 specifies that this connection is the primary connection used by the Documents service. When set to 0, and the specified connection is the primary connection used by the Documents service, the primary connection is reset. If this parameter is not set, the primary connection used by the Documents service does not change. This argument has no default.
In WebCenter Spaces, the primary connection must be an Oracle Content Server connection. |
server
|
Optional. Name of the managed server where the WebCenter application is deployed. For example, WC_Spaces.
Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the WebCenter application is deployed. |
Module: Oracle WebCenter
Use with WLST: Online
Without any arguments, this command lists all of the SharePoint connections that are configured for a named WebCenter application.
listJCRSharePointConnections(appName, [verbose, name, server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the WebCenter application in which to perform this operation. |
verbose
|
Optional. Displays SharePoint connection details in verbose mode. Valid options are 1 (true) and 0 (false). When set to 1, listJCRSharePointConnections lists all SharePoint connections that are configured for a WebCenter application, along with their details. When set to 0, only connection names are listed. This argument defaults to 0. |
name
|
Optional. Name of an existing SharePoint connection. When specified you can view connection details for a specific SharePoint connection. If you supply a value for name, you must supply a value for verbose. |
server
|
Optional. Name of the managed server where the WebCenter application is deployed. For example, WC_Spaces.
Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the WebCenter application is deployed. |
The following example lists the names of all the SharePoint connections that are configured for an application named webcenter.
wls:/weblogic/serverConfig> listJCRSharePointConnections(appName='webcenter')
The following example lists connection details for all of the SharePoint connections that are configured.
wls:/weblogic/serverConfig> listJCRSharePointConnections(appName='webcenter', verbose=1)
Module: Oracle WebCenter
Use with WLST: Online
Lists properties for the back-end Oracle Content Server repository that is being used by WebCenter Spaces to store Space documents and Home Space documents. This command is only valid for the WebCenter Spaces application.
listDocumentsSpacesProperties(appName, [server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the WebCenter Spaces application in which to perform this operation—always webcenter. |
server
|
Optional. Name of the managed server where the WebCenter application is deployed. For example, WC_Spaces.
Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the WebCenter application is deployed. |
The following example lists properties for the back-end Oracle Content Server repository that is being used by a WebCenter Spaces application (named webcenter) to store Space documents and Home Space documents.
wls:/weblogic/serverConfig> listDocumentsSpacesProperties(appName='webcenter')
The Documents Spaces container is "/WebCenter1109"
The Documents repository administrator is "sysadmin"
The Documents Spaces container is "/WebCenter1109"The Documents primary connection is "myOCSConnection"
Module: Oracle WebCenter
Use with WLST: Online
Modifies properties for the back-end Oracle Content Server repository that is being used by WebCenter Spaces to store Space-related data. This command is only valid for the WebCenter Spaces application.
setDocumentsSpacesProperties(appName, [spacesRoot, adminUserName, applicationName, server, applicationVersion])
| Argument | Definition |
|---|---|
| appName | Name of the WebCenter Spaces application in which to perform this operation—always webcenter. |
spacesRoot
|
Optional. Root folder under which WebCenter Spaces content is stored. The value for this argument must use the format: /<foldername>. For example, /WebCenter or /WebCenterSpaces. The spacesRoot cannot be /, the root itself, and it must be unique across applications. If the folder specified does not exist it will be created for you.
Note that if you provide a value for this argument, you must also provide values for the |
adminUserName
|
Optional. User name of the content repository administrator. For example: sysadmin. This user will be used to create and maintain folders for WebCenter Spaces content and manage content access rights.
Administrative privileges are required for this connection so that operations can be performed on behalf of WebCenter users. Note that if you provide a value for this argument, you must also provide values for the |
applicationName
|
Optional. Unique WebCenter Spaces application identifier. This name is used to separate data when multiple WebCenter Spaces applications share the same content repository, and must be unique across applications.
The value for this argument must begin with an alphabetical character, followed by any combination of alphanumeric characters or the underscore character. The string must be less than or equal to 30 characters. Note that if you provide a value for this argument, you must also provide values for the The name specified here is also used to name document-related workflows, as follows:
When naming workflows, only the first 14 characters of the Application Name are used. |
server
|
Optional. Name of the managed server where the WebCenter application is deployed. For example, WC_Spaces.
Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the WebCenter application is deployed. |
The following example modifies connection properties for the back-end Oracle Content Server repository that is being used by WebCenter Spaces to store Space documents and Home Space documents.
wls:/weblogic/serverConfig> setDocumentsSpacesProperties(appName='webcenter', spacesRoot='/AccountingSpaces', adminUserName='admin', applicationName='WCAccounting')
The following example modifies the administrator's user name for the back-end Oracle Content Server repository that is being used by WebCenter Spaces to store Space documents and Home Space documents.
wls:/weblogic/serverConfig> setDocumentsSpacesProperties(appName='webcenter', adminUserName='sysadmin')
Module: Oracle WebCenter
Use with WLST: Online
Deletes properties for the back-end Oracle Content Server repository used by WebCenter Spaces, that is the adminUserName, applicationName, and spacesRoot. This command is only valid for the WebCenter Spaces application.
deleteDocumentsSpacesProperties(appName, [server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the WebCenter Spaces application in which to perform this operation—always webcenter. |
server
|
Optional. Name of the managed server where the WebCenter application is deployed. For example, WC_Spaces.
Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the WebCenter application is deployed. |
Use the commands listed in Table 10-8 to manage discussions server connections for WebCenter applications.
Configuration changes made using these WebCenter WLST commands are only effective after your restart the Managed Server on which the WebCenter application is deployed. For details, see Oracle Fusion Middleware Administrator's Guide for Oracle WebCenter.
Table 10-8 Discussion and Announcement WLST Commands
| Use this command... | To... | Use with WLST... |
|---|---|---|
|
Create a new discussions server connection for a WebCenter application. |
Online |
|
|
Edit an existing discussions server connection. |
Online |
|
|
Specify the default connection for the Discussions and Announcements services. |
Online |
|
|
List all of the discussions server connections that are configured for an application. |
Online |
|
|
List the default discussions server connection for an application. |
Online |
|
|
Set an additional discussions server connection property. |
Online |
|
|
Delete a discussions server connection property. |
Online |
|
|
Specify defaults for the Discussions service. |
Online |
|
|
Remove defaults for the Discussions service. |
Online |
|
|
List Discussions service properties. |
Online |
|
|
Specify defaults for the Announcements service. |
Online |
|
|
Remove defaults for the Announcements service. |
Online |
|
|
List Announcements service properties. |
Online |
|
|
Grant system administrator permissions on the discussions server to a user or a group. |
Online |
|
|
Synchronizes discussion server permissions for Subspaces that inherit security from their parent. |
Online |
|
|
Set discussions server properties. |
Online |
|
|
Return discussions server property values. |
Online |
|
|
Remove current discussions server property values. |
Online |
Module: Oracle WebCenter
Use with WLST: Online
Creates a new discussions server connection for a named WebCenter application.
The Discussions service and the Announcements service both require a discussions server connection. Both services use the same discussions server connection.
While you can register multiple discussions server connections for a WebCenter application, only one connection is used for discussion and announcement services - the default (or active) connection.
createDiscussionForumConnection(appName, name, url, adminUser, [timeout, default, policyURIForAuthAccess, policyURIForPublicAccess, recipientKeyAlias])
| Argument | Definition |
|---|---|
appName
|
Name of the WebCenter application in which to perform this operation. |
name
|
Connection name. The name must be unique (across all connection types) within the WebCenter application. |
url
|
URL of the discussions server hosting discussion forums and announcements. For example: http://myhost:8888/owc_discussions. |
adminUser
|
Name of the discussions server administrator. This account is used by the Discussions and Announcements services to perform administrative operations on behalf of WebCenter users.
This account is mostly used for managing discussions and announcements in WebCenter Spaces. It is not necessary for this user to be a |
policyURIForAuthAccess
|
Optional. URI to the SAML token based policy required for authenticated access to the discussions server Web service.
The client policy specified must be compatible with the service policy that is configured for the Valid client policy values include:
See also "Managing the Announcements and Discussions Services" in the Oracle Fusion Middleware Administrator's Guide for Oracle WebCenter. |
policyURIForPublicAccess
|
Optional. URI to the policy required to enforce message security and integrity for public access to the discussions server Web service.
Default value is The client policy specified must be compatible with the service policy that is configured for the Valid client policy values include:
|
recipientKeyAlias
|
Optional. Recipient key alias to be used for message protected policies (applicable to the OWCDiscussionsServicePublic and OWCDiscussionsServiceAuthenticated endpoints). This is the alias to the certificate that contains the public key of the discussions server in the configured keystore. The default is null.
See also "Configuring WS-Security for WebCenter Applications and Components" in the Oracle Fusion Middleware Administrator's Guide for Oracle WebCenter. |
timeout
|
Optional. Length of time (in seconds) the Discussions service waits for a response from the discussions server before issuing a connection timeout message. This argument defaults to -1. When set to -1, the service default (10 seconds) applies. |
default
|
Optional. Indicates that this connection is the default connection for the Discussions and Announcements services.
Valid options are |
server
|
Optional. Name of the managed server where the WebCenter application is deployed. For example, WC_Spaces.
Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the WebCenter application is deployed. |
The following example creates a discussions server connection for a WebCenter application.
wls:/weblogic/serverConfig> createDiscussionForumConnection(appName='webcenter', name='MyDiscussionServer', url='http://myhost.com:8888/owc_discussions', adminUser='admin', policyURIForAuthAccess='oracle/wss10_saml_token_client_policy', default=0)
Module: Oracle WebCenter
Use with WLST: Online
Edits an existing discussions server connection. Use this command to update connection attributes.
The connection is created using the createDiscussionForumConnection command.
setDiscussionForumConnection(appName, name, [url, adminUser, policyURIForAuthAccess, policyURIForPublicAccess, recipientKeyAlias, timeout, default, server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the WebCenter application in which to perform this operation. |
name
|
Name of an existing discussions server connection. |
url
|
Optional. URL to the discussions server. |
adminUser
|
Optional. Name of the discussions server administrator. This account is used by the Discussions service to perform administrative operations on behalf of WebCenter users.
This account is mostly used for managing discussions and announcements in WebCenter Spaces. It is not necessary for this user to be a |
policyURIForAuthAccess
|
Optional. URI to the SAML token based policy required for authenticated access to the discussions server Web service.
The client policy specified must be compatible with the service policy that is configured for the Valid client policy values include:
See also "Managing the Announcements and Discussions Services" in the Oracle Fusion Middleware Administrator's Guide for Oracle WebCenter. |
policyURIForPublicAccess
|
Optional. URI to the policy required to enforce message security and integrity for public access to the discussions server Web service.
Default value is The client policy specified must be compatible with the service policy that is configured for the Valid client values include:
|
recipientKeyAlias
|
Optional. Recipient key alias to be used for message protected policy authentication. Only required when the discussion server connection is using a message protection-based security policy for authentication. The default is null.
See also "Configuring WS-Security for WebCenter Applications and Components" in the Oracle Fusion Middleware Administrator's Guide for Oracle WebCenter. |
timeout
|
Optional. Length of time (in seconds) the Discussion and Announcement services wait for a response from the discussions server before issuing a connection timeout message. This argument defaults to -1. When set to -1, the service default (10 seconds) applies. |
default
|
Optional. Indicates that this connection is the default connection for the Discussions and Announcements services. Required only if more than one connection is defined.
Valid options are To specify that the Discussion and Announcements service use this connection, change the value from To disable this connection, use the removeDiscussionForumServiceProperty command:
Note: While you can register multiple discussions server connections for a WebCenter application, only one connection is used for discussion and announcement services— the default (or active) connection. |
server
|
Optional. Name of the managed server where the WebCenter application is deployed. For example, WC_Spaces.
Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the WebCenter application is deployed. |
The following example updates attributes for a secure discussions server connection named MyDiscussionsServer.
wls:/weblogic/serverConfig> setDiscussionForumConnection(appName='webcenter', name='MyDiscussionServer', url='http://myhost.com:7786/owc_discussions', adminUser='admin', policyURIForAuthAccess='oracle/wss10_saml_token_client_policy', default=1)
Module: Oracle WebCenter
Use with WLST: Online
Sets a discussions server connection property. Use this command when additional parameters are required to connect to your discussions server.
This commands provides an extensible way to add any connection property using a key and a value. (You are not limited to connection properties specified by createDiscussionForumConnection and setDiscussionForumConnection.)
Note:
Do not use the setDiscussionForumConnectionProperty to set connection properties available through createDiscussionForumConnection or setDiscussionForumConnection. Attempting to do so, has no effect.All known, additional connection properties are listed in Table 10-9, "Additional Discussion Connection Properties".
Table 10-9 Additional Discussion Connection Properties
| Additional Connection Property | Description |
|---|---|
|
|
(WebCenter Spaces only) Application root category ID on the discussions server under which all discussion forums are stored. For example, if set to 3, then all forums are stored inside the category 3. |
setDiscussionForumConnectionProperty(appName, name, key, value, [secure, server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the WebCenter application in which to perform this operation. |
name
|
Name of an existing discussions server connection. |
key
|
Name of the connection property. |
value
|
Value for the property. Allows any property to be modified on the connection with a key and value. |
secure
|
Optional. Indicates whether the property value must be stored securely using encryption. Valid options are 1 (true) and 0 (false). When 1, the value is encrypted. The default option is 0.
Set to |
server
|
Optional. Name of the managed server where the WebCenter application is deployed. For example, WC_Spaces.
Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the WebCenter application is deployed. |
The following example configures the location of the keystore certificate for a discussions server connection named MyDiscussionServer.
wls:/weblogic/serverConfig> setDiscussionForumConnectionProperty (appName='webcenter', name='MyDiscussionServer', key='application.root.category.id', value='3')
The following example adds a custom discussions server connection property called myProperty1 with a value propertyValue1.
wls:/weblogic/serverConfig> setDiscussionForumConnectionProperty (appName='webcenter', name='MyDiscussionServer', key='myProperty1', value='propertyValue1')
The following example adds a secured discussions server connection property called securedProperty with the value secureValue.
wls:/weblogic/serverConfig> setDiscussionForumConnectionProperty (appName='webcenter', name='MyDiscussionServer', key='securedProperty', value='secureValue', secure=1)
Module: Oracle WebCenter
Use with WLST: Online
Deletes a discussions server connection property. Take care when deleting connection properties because the connection may not work as expected if the configuration becomes invalid as a result.
This command can only delete additional connection properties added using the setDiscussionForumConnectionProperty command.
deleteDiscussionForumConnectionProperty(appName, name, key, [server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the WebCenter application in which to perform this operation. |
name
|
Name of an existing discussions server connection. |
key
|
Name of the connection property you want to delete. |
server
|
Optional. Name of the managed server where the WebCenter application is deployed. For example, WC_Spaces.
Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the WebCenter application is deployed. |
Module: Oracle WebCenter
Use with WLST: Online
Lists all of the discussions server connections that are configured for a named WebCenter application.
listDiscussionForumConnections(appName, [verbose, name, server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the WebCenter application in which to perform this operation. |
verbose
|
Optional. Valid options are 1 (true) and 0 (false). When set to 1, listDiscussionForumConnections lists all of the discussions server connections that are configured for a WebCenter application, along with their details. When set to 0, only connection names are listed. This argument defaults to 0. |
name
|
Optional. Name of an existing discussions server connection. Use this argument to view connection details for a specific discussions server connection. |
server
|
Optional. Name of the managed server where the WebCenter application is deployed. For example, WC_Spaces.
Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the WebCenter application is deployed. |
The following example lists the names of all of the discussions server connections that are currently configured for an application named webcenter.
wls:/weblogic/serverConfig>listDiscussionForumConnections(appName='webcenter')
The following example lists connection names and details for all of the discussions server connections currently configured for an application named webcenter.
wls:/weblogic/serverConfig>listDiscussionForumConnections(appName='webcenter', verbose=1)
The following example lists connection details for a discussions server connection named myDiscussionsServer.
wls:/weblogic/serverConfig> listDiscussionForumConnections(appName='webcenter', name='myDiscussionsServer')
Module: Oracle WebCenter
Use with WLST: Online
Names the discussions server connection that the Discussions service and the Announcements service are using, in a named WebCenter application. While you can register multiple discussions server connections for a WebCenter application, the Discussions/Announcements service only uses one connection—known as the default (or active) connection.
listDefaultDiscussionForumConnection(appName, [verbose, server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the WebCenter application in which to perform this operation. |
verbose
|
Optional. Valid options are 1 (true) and 0 (false). When set to 1, the name and details of the discussions server connections are listed. When set to 0, only the connection name displays. This argument defaults to 0. |
server
|
Optional. Name of the managed server where the WebCenter application is deployed. For example, WC_Spaces.
Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the WebCenter application is deployed. |
The following example names the discussions server connection that the Discussions/Announcements service are using, in an application named webcenter.
wls:/weblogic/serverConfig> listDefaultDiscussionForumConnection(appName='webcenter')
The following example lists the name and details of the discussions server connection that the Discussions/Announcements service are using.
wls:/weblogic/serverConfig> listDefaultDiscussionForumConnection(appName='webcenter', verbose=1)
Module: Oracle WebCenter
Use with WLST: Online
Specifies the default discussions server connection for the Discussions service and the Announcements service, in a named WebCenter application.
While you can register multiple discussions server connections with a WebCenter application, the Discussions/Announcements services only uses one connection—this is known as the default (or active) connection.
setDefaultDiscussionForumConnection(appName, name, [server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the WebCenter application in which to perform this operation. |
name
|
Name of an existing discussions server connection. |
server
|
Optional. Name of the managed server where the WebCenter application is deployed. For example, WC_Spaces.
Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the WebCenter application is deployed. |
Module: Oracle WebCenter
Use with WLST: Online
Specifies default values for the Discussions service.
Configurable properties for the Discussions service are listed in Table 10-10, "Discussion Service Configuration Properties".
Table 10-10 Discussion Service Configuration Properties
| Configuration Property | Description |
|---|---|
|
|
Maximum number of topics fetched by the Discussions service and displayed in the topics view. |
|
|
Maximum number of forums fetched by the Discussions service and displayed in the forums view. |
|
|
Maximum number of topics fetched by the Discussions service and displayed in the recent topics view. |
|
|
Maximum number of topics fetched by the Discussions service and displayed in the watched topics view. |
|
|
Maximum number of forums fetched by the Discussions service and displayed in the watched forums view. |
|
|
Application root category ID on the discussions server under which all discussion forums are stored. For example, if set to 3, all forums are stored inside category 3. |
|
|
Communication through mail distribution lists can be published as discussion forum posts. This parameter starts or stops the gateway for this communication. For WebCenter Spaces, the default value is For WebCenter Portal applications, the default value is |
setDiscussionForumServiceProperty(appName, property, value, [server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the WebCenter application in which to perform this operation. |
property
|
Name of the configuration property. |
value
|
Value for the property. |
server
|
Optional. Name of the managed server where the WebCenter application is deployed. For example, WC_Spaces.
Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the WebCenter application is deployed. |
Module: Oracle WebCenter
Use with WLST: Online
Removes the current value that is set for a Discussions service property. Use this command to remove any of the properties listed in Table 10-10, "Discussion Service Configuration Properties".
Take care when using this command as removing values for these properties might cause unexpected behavior.
Note:
Use this command syntax to disable the connection currently used for discussion and announcement services:removeDiscussionForumServiceProperty('appName='webcenter', property='selected.connection')
This command forces the default connection argument to 0. See also, setDiscussionForumConnection.
removeDiscussionForumServiceProperty(appName, property, [server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the WebCenter application in which to perform this operation. |
property
|
Name of the configuration property. |
server
|
Optional. Name of the managed server where the WebCenter application is deployed. For example, WC_Spaces.
Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the WebCenter application is deployed. |
Module: Oracle WebCenter
Use with WLST: Online
listDiscussionForumServiceProperties(appName, [server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the WebCenter application in which to perform this operation. |
server
|
Optional. Name of the managed server where the WebCenter application is deployed. For example, WC_Spaces.
Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the WebCenter application is deployed. |
Module: Oracle WebCenter
Use with WLST: Online
Specifies default values for the Announcements service.
Configurable properties for the Announcements service are listed in Table 10-11, "Announcements Service Configuration Properties".
Table 10-11 Announcements Service Configuration Properties
| Configuration Property | Description |
|---|---|
|
|
Maximum number of announcements displayed in the Announcements mini view. |
|
|
Maximum number of announcements displayed in the Announcements main view. |
|
|
Maximum number of announcements displayed in the Announcements links view. |
|
|
Number of days that announcements display and remain editable. |
setAnnouncementServiceProperty(appName, property, value, [server, applicationVersion})
| Argument | Definition |
|---|---|
appName
|
Name of the WebCenter application in which to perform this operation. |
property
|
Name of the configuration property. |
value
|
Property value. |
server
|
Optional. Name of the managed server where the WebCenter application is deployed. For example, WC_Spaces.
Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the WebCenter application is deployed. |
Module: Oracle WebCenter
Use with WLST: Online
Removes the current value that is set for a Announcements service property. Use this command to remove any of the properties listed in Table 10-11, "Announcements Service Configuration Properties".
Take care when using this command as removing values for these properties might cause unexpected behavior.
removeAnnouncementServiceProperty(appName, property, [server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the WebCenter application in which to perform this operation. |
property
|
Name of the configuration property. |
server
|
Optional. Name of the managed server where the WebCenter application is deployed. For example, WC_Spaces.
Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the WebCenter application is deployed. |
Module: Oracle WebCenter
Use with WLST: Online
listAnnouncementServiceProperties(appName, [server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the WebCenter application in which to perform this operation. |
server
|
Optional. Name of the managed server where the WebCenter application is deployed. For example, WC_Spaces.
Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the WebCenter application is deployed. |
Module: Oracle WebCenter
Use with WLST: Online
Grants system administrator permissions on the discussions server to a user or a group. This command is useful when you connect the discussions server to a new identity store that does not contain any of the current administrators.
addDiscussionsServerAdmin(appName, name, [type, server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the discussions server application in which to perform this operation. For example, owc_discussions. |
name
|
Name of the user or group to add as an administrator on the discussions server. |
type
|
Optional. Identifies the type of identity. Valid values are USER and GROUP. The default value is USER. |
server
|
Optional. Name of the managed server on which the application is deployed. For example, WC_Collaboration.
Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the application is deployed. |
The following example grants system administrator permissions on the discussions server to the user weblogic:
addDiscussionsServerAdmin(appName='owc_discussions', name='weblogic', type='USER')
The following example grants system administrator permissions on the discussions server to all users in the Administrators user group:
addDiscussionsServerAdmin(appName='owc_discussions', name='Administrators', type='GROUP')
Module: Oracle WebCenter
Use with WLST: Online
(WebCenter Spaces only) Synchronizes discussion server permissions for Subspaces that inherit security from their parent.
When you update Discussions or Announcement permissions for Space hierarchies in WebCenter Spaces, the Subspaces do not automatically inherit the corresponding permission change on the Oracle WebCenter Discussions server. Therefore, whenever changes are made, you must run this command to synchronize Discussions and Announcement permissions within a Space hierarchy, such that Subspaces inherit the same Oracle WebCenter Discussions server permissions as their parent.
Note:
To execute discussion server WLST commands, such assyncDiscussionServerPermissions, the user used to connect to the Admin Server must also have administrative privileges on the discussion server.syncDiscussionServerPermissions(appName, [server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the WebCenter Spaces application in which to perform this operation—always webcenter. |
server
|
Optional. Name of the managed server where the WebCenter application is deployed. For example, WC_Spaces.
Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the WebCenter application is deployed. |
Module: Oracle WebCenter
Use with WLST: Online
Sets a discussions server property.
Use this command to set a system property on the discussions server.
Note:
To execute discussion server WLST commands, such assetDiscussionsServerProperty, the user used to connect to the Admin Server must also have administrative privileges on the discussion server.setDiscussionsServerProperty(appName, key, value, [server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the discussions server application in which to perform this operation. For example, owc_discussions. |
key
|
Name of the discussions server property. |
value
|
Value for the discussions server property. |
server
|
Optional. Name of the managed server where the application is deployed. For example, WC_Collaboration.
Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the application is deployed. |
The following example sets properties that configures the discussions server for SSO, where example.com:8890/owc_discussions is the base URL of the webtier on which the discussions server is deployed:
wls:/weblogic/serverConfig> setDiscussionsServerProperty(appName='owc_discussions', key='owc_discussions.sso.mode', value='true')
setDiscussionsServerProperty(appName='owc_discussions', key='jiveURL', value='example.com:8890/owc_discussions')
Module: Oracle WebCenter
Use with WLST: Online
Returns the current value of a discussions server property.
Note:
To execute discussion server WLST commands, such asgetDiscussionsServerProperty, the user used to connect to the Admin Server must also have administrative privileges on the discussion server.getDiscussionsServerProperty(appName, key, [server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the discussions server application in which to perform this operation. For example, owc_discussions. |
key
|
Name of the discussions server property. For example, owc_discussions.sso.mode, AuthFactory.className, UserManager.className, GroupManager.className, owc_discussions.setup.complete_11.1.1.2.0, and so on. |
server
|
Optional. Name of the managed server where the application is deployed. For example, WC_Collaboration.
Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the application is deployed. |
The following example returns current values for some key discussions server properties:
wls:/weblogic/serverConfig> getDiscussionsServerProperty (appName='owc_discussions', key='AuthFactory.className') getDiscussionsServerProperty (appName='owc_discussions', key='UserManager.className') getDiscussionsServerProperty (appName='owc_discussions', key='GroupManager.className') getDiscussionsServerProperty (appName='owc_discussions', key=', )
Module: Oracle WebCenter
Use with WLST: Online
Removes the current values that is set for a discussions server property.
Note:
To execute discussion server WLST commands, such asremoveDiscussionsServerProperty, the user used to connect to the Admin Server must also have administrative privileges on the discussion server.removeDiscussionsServerProperty(appName, key, [server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the discussions server application in which to perform this operation. For example, owc_discussions. |
key
|
Name of the discussions server property. For example, owc_discussions.sso.mode, AuthFactory.className, UserManager.className, GroupManager.className, owc_discussions.setup.complete_11.1.1.2.0, and so on. |
server
|
Optional. Name of the managed server where the application is deployed. For example, WC_Collaboration.
Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the application is deployed. |
Use the commands listed in Table 10-12 to manage external application connections for WebCenter applications.
Configuration changes made using these WebCenter WLST commands are immediately available in the WebCenter application.
Table 10-12 External Application WLST Commands
| Use this command... | To... | Use with WLST... |
|---|---|---|
|
Create an external application connection, for a named WebCenter application. |
Online |
|
|
Edit an existing external application connection. |
Online |
|
|
List individual or all external applications that are configured for a specific WebCenter application. |
Online |
|
|
Add another login field for a specific external application connection. |
Online |
|
|
Edit the value and display-to-user setting for a specific external application login field. |
Online |
|
|
Remove an external application login field. |
Online |
|
|
Specify shared or public credentials for an external application. |
Online |
|
|
Edit shared or public credentials for an external application. |
Online |
|
|
Remove shared or public credentials currently configured for an external application. |
Online |
Module: Oracle WebCenter
Use with WLST: Online
createExtAppConnection(appName, name, [displayName, url, authMethod, userFieldName, pwdFieldName, server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the WebCenter application in which to perform this operation. |
name
|
Connection name. The name must be unique (across all connection types) within the WebCenter application. |
displayName
|
Optional. External application display name. A user friendly name for the application that WebCenter users will recognize. The display name must be unique across all external applications within the WebCenter application. |
url
|
Optional. External application login URL.
To determine an application's URL, navigate to the application's login page and note down the URL for that page. For example: |
authMethod
|
Optional. Authentication mechanism used by the external application. Valid options are GET, POST, and BASIC. This argument defaults to POST. |
userFieldName
|
Optional. Name that identifies the user name or user ID field on the external application's login form. To find this name, look at the HTML source for the login page. This argument does not specify user credentials.
Mandatory if |
pwdFieldName
|
Optional. Name that identifies the password field on the external application's login form. To find this name, look at the HTML source for the login page. This argument does not specify user credentials.
Mandatory if |
server
|
Optional. Name of the managed server where the WebCenter application is deployed. For example, WC_Spaces.
Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the WebCenter application is deployed. |
The following example creates a connection for an external application named My Yahoo!, in a WebCenter application.
wls:/weblogic/serverConfig> createExtAppConnection(appName='webcenter', name='yahoo', displayName='My Yahoo!', url='http://login.yahoo.com/config/login', authMethod='POST', userFieldName='login', pwdFieldName='passwd')
Module: Oracle WebCenter
Use with WLST: Online
setExtAppConnection(appName, name, [displayName], [url], [authMethod], [userFieldName], [pwdFieldName], [server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the WebCenter application in which to perform this operation. |
name
|
Name of an existing external application connection. |
displayName
|
Optional. External application display name. A user-friendly name for the application that WebCenter users will recognize. The display name must be unique across all external applications within the WebCenter application. |
url
|
Optional. External application login URL. To determine an application's URL, navigate to the application's login page and note down the URL for that page. |
authMethod
|
Optional. Authentication mechanism used by the external application. Valid options are GET, POST, and BASIC. This argument defaults to POST. |
userFieldName
|
Optional. Name that identifies the user name or user ID field on the external application's login form. To find this name, look at the HTML source for the login page. This argument does not specify user credentials.
Mandatory if |
pwdFieldName
|
Optional. Name that identifies the password field on the external application's login form. To find this name, look at the HTML source for the login page. This argument does not specify user credentials.
Mandatory if |
server
|
Optional. Name of the managed server where the WebCenter application is deployed. For example, WC_Spaces.
Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the WebCenter application is deployed. |
Module: Oracle WebCenter
Use with WLST: Online
When used with only the appName argument, this command lists the names of all the external applications currently configured for a specific WebCenter application.
listExtAppConnections(appName, [verbose, name, server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the WebCenter application for which to perform this operation. |
verbose
|
Optional. Displays external application details in verbose mode. Valid options are 1 (true) and 0 (false). When set to 1, listExtAppConnections lists all of the external applications that are configured for a WebCenter application, along with their details. When set to 0, listExtAppConnections lists only the names of the external applications. This argument defaults to 0.
If you set this argument to |
name
|
Optional. Name of an existing external application connection. You can use this argument to view details about a specific connection. |
server
|
Optional. Name of the managed server where the WebCenter application is deployed. For example, WC_Spaces.
Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the WebCenter application is deployed. |
The following example lists the names of all the external applications currently used by a WebCenter application named webcenter.
wls:/weblogic/serverConfig> listExtAppConnections(appName='webcenter')
app1
app2
app3
The following example lists details for the external applications app1, app2, and app3.
wls:/weblogic/serverConfig> listExtAppConnections(appName='webcenter', verbose=1)
----
app1
----
Name: app1
Display Name: Application1
Login URL: http://app1
Authentication Method: POST
User Field Name: login
Password Field Name: passwd
Shared Credential: Disabled
Public Credential: Disabled
----
app2
----
Name: app2
Display Name: Application2
Login URL: http://app2
Authentication Method: POST
User Field Name: login
Password Field Name: passwd
Additional Fields: {Account1:1, Accout2:DefVal:0}
Shared Credential: Disabled
Public Credential: Enabled
----
app3
----
Name: app3
Display Name: Application3
Authentication Method: POST
Shared Credential: Enabled
Public Credential: Enabled
The following example lists details for external application app1 only.
wls:/weblogic/serverConfig> listExtAppConnections(appName='webcenter', verbose=1, name='app1')
----
app1
----
Name: app1
Display Name: Application1
Login URL: http://app1
Authentication Method: POST
User Field Name: login
Password Field Name: passwd
Shared Credential: Disabled
Public Credential: Disabled
Module: Oracle WebCenter
Use with WLST: Online
Adds another login field for a specific external application connection. For example, in addition to user name and password, an external application may require other login criteria such as Host and MailAddress.
Optionally, additional login fields can appear on the external application's login for a user to specify.
If you add another login field and the external application uses shared or public credentials, you can use the WLST commands addExtAppCredential and setExtAppCredential to update the shared/public credentials. See addExtAppCredential and setExtAppCredential.
addExtAppField(appName, name, fieldName, [fieldValue], [displayToUser], [server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the WebCenter application in which to perform this operation. |
name
|
Name of an existing external application connection. |
fieldName
|
Login field name. The name that identifies the field on the HTML login form. This field is not applicable if the application uses BASIC authentication. |
fieldValue
|
Optional. Login field value. Enter a default value for the login field or leave blank for a user to specify. This argument is blank by default. |
displayToUser
|
Optional. Specifies whether the login field displays on the external application's login screen. Valid options are 1 (true) and 0 (false). This argument defaults to 0.
Note that if you set this argument to |
server
|
Optional. Name of the managed server where the WebCenter application is deployed. For example, WC_Spaces.
Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the WebCenter application is deployed. |
This example creates an additional field named Account with the default value username.default.example in an external application called ABC. This field will be displayed in ABC's login screen.
wls:/weblogic/serverConfig> addExtAppField(appName='webcenter', name='ABC', fieldName='Account', fieldValue='username.default.example', displayToUser=1)
Module: Oracle WebCenter
Use with WLST: Online
Modifies the field value and display-to-user setting for one or more login fields currently configured for an external application. Either fieldValue or displayToUser must be specified along with the external application name and login field name. The fieldValue and displayToUser arguments are optional.
Using this command has implications on any shared or public credentials that you might have created for this external application. If you modify displayToUser to 1, you may also need to update existing shared user or public user credentials. See also setExtAppCredential.
setExtAppField(appName, name, fieldName, [fieldValue], [displayToUser], [server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the WebCenter application in which to perform this operation. |
name
|
Name of an existing external application connection. |
fieldName
|
Name of an existing login field. |
fieldValue
|
Optional. New or changed login field value.
Enter a default value for the login field or leave blank for a user to specify. This argument is blank by default. |
displayToUser
|
Optional. Specifies whether the login field displays on the external application's login screen. Valid options are 1 (true) and 0 (false).
If set to |
server
|
Optional. Name of the managed server where the WebCenter application is deployed. For example, WC_Spaces.
Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the WebCenter application is deployed. |
The following example specifies a default value for a login field named Account and displays the field on the external application's credential provisioning screen.
wls:/weblogic/serverConfig> setExtAppField(appName='webcenter', name='ABC', fieldName='Account', fieldValue='admin', displayToUser=1)
Module: Oracle WebCenter
Use with WLST: Online
Removes a login field from an external application connection.
This command has implications on any shared or public credentials that you may have created for this external application, that is, you may need to remove the login field from shared user or public user credentials.
You can use the setExtAppCredential command to remove a login field, if required. For example, external application myApp has an additional field called Account and public credentials were previously specified using:
addExtAppCredential(appName='webcenter', name='myApp', type='PUBLIC', username='admin', password='mypublic.password', field='Account:admin@myhost.com')
If you remove the Account field, you can modify the credentials by running:
setExtAppCredential(appName='webcenter', name='myApp', type='PUBLIC', username='admin', password='mypublic.password')
For details on using setExtAppCredential, see setExtAppCredential
removeExtAppField(appName, name, fieldName, [server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the WebCenter application in which to perform this operation. |
name
|
Connection name. |
fieldName
|
Login field that you want to remove. |
server
|
Optional. Name of the managed server where the WebCenter application is deployed. For example, WC_Spaces.
Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the WebCenter application is deployed. |
Module: Oracle WebCenter
Use with WLST: Online
Configures shared user or public user credentials for a specific external application.
When shared credentials are specified, every user accessing the WebCenter application is authenticated using the user name and password defined here. WebCenter users are not presented with a login form.
Public users accessing this application through WebCenter are logged in using the public credentials defined here.
If credentials already exists, a warning indicates that the setExtAppCredential command should be used instead.
addExtAppCredential(appName, name, type, username, password, [field, server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the WebCenter application in which to perform this operation. |
name
|
Name of an existing external application connection. |
type
|
Credential type. Valid values are SHARED and PUBLIC. |
username
|
Name of the shared or public user. |
password
|
Password for the shared or public user. |
field
|
Optional. Additional login field value. Use the format FieldName:FieldValue, where FieldName names an additional login field configured with displayToUser=1. |
server
|
Optional. Name of the managed server where the WebCenter application is deployed. For example, WC_Spaces.
Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the WebCenter application is deployed. |
The following example specifies public credentials for an external application named ABC. The public user name is mypublic.username, the password is mypublic.password, and there is one additional field named Account.
wls:/weblogic/serverConfig> addExtAppCredential(appName='webcenter', name='ABC', type='PUBLIC', username='mypublic.username', password='mypublic.password', field='Account:username.example')
Module: Oracle WebCenter
Use with WLST: Online
Modifies shared user or public user credentials currently configured for an external application. If the credential has already not been specified, then a warning indicates that addExtAppCredential needs to be used instead. See addExtAppCredential.
The arguments username and password are optional because setExtAppCredential only manipulates existing credentials. At least one of the parameters, username, password or field, must be specified.
You can use setExtAppCredential command to update passwords in systems that require changing passwords every few days.
setExtAppCredential(appName, name, type, [username], [password], [field], [server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the WebCenter application in which to perform this operation. |
name
|
Name of an existing external application connection. |
type
|
Credential type. Valid values are SHARED and PUBLIC. |
username
|
Optional. User name of the shared or public user. |
password
|
Optional. Password for the shared or public user. |
field
|
Optional. Additional login field value. Use the format FieldName:FieldValue, where FieldName names an additional login field configured with displayToUser=1. |
server
|
Optional. Name of the managed server where the WebCenter application is deployed. For example, WC_Spaces.
Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the WebCenter application is deployed. |
Module: Oracle WebCenter
Use with WLST: Online
Removes shared user or public user credentials currently configured for an external application.
If credentials do not exist, an error displays.
removeExtAppCredential(appName, name, type, [server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the WebCenter application in which to perform this operation. |
name
|
Name of an existing external application connection. |
type
|
Credential type. Valid values are SHARED and PUBLIC. |
server
|
Optional. Name of the managed server where the WebCenter application is deployed. For example, WC_Spaces.
Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the WebCenter application is deployed. |
Use the commands listed in Table 10-13, to manage instant messaging and presence server connections.
Configuration changes made using these WebCenter WLST commands are only effective after your restart the Managed Server on which the WebCenter application is deployed. For details, see Oracle Fusion Middleware Administrator's Guide for Oracle WebCenter.
Table 10-13 Instant Messaging and Presence WLST Commands
| Use this command... | To... | Use with WLST... |
|---|---|---|
|
Create a new instant messaging and presence server connection for a WebCenter application. |
Online |
|
|
Edit an existing instant messaging and presence server connection. |
Online |
|
|
Modify instant messaging and presence server connection properties. |
Online |
|
|
Delete an instant messaging and presence server connection property. |
Online |
|
|
List which presence servers the WebCenter application supports. |
Online |
|
|
List all of the instant messaging and presence server connections that are configured for an application. |
Online |
|
|
List the default instant messaging and presence server connection that is configured for an application. |
Online |
|
|
Set a specified connection as the default instant messaging and presence server connection. |
Online |
|
|
Specify defaults for the Instant Messaging and Presence service. |
Online |
|
|
Remove defaults for the Instant Messaging and Presence service. |
Online |
|
|
List Instant Messaging and Presence service properties. |
Online |
|
|
Create an external application suitable for instant messaging and presence server connection. |
Online |
Module: Oracle WebCenter
Use with WLST: Online
Creates an instant messaging and presence server connection for a named WebCenter application.
Use the listIMPAdapters command to find out which types of instant messaging and presence servers are supported. Out-of-the-box, WebCenter applications support Oracle WebLogic Communications Server (OWLCS), Microsoft Live Communications Server (LCS), and Microsoft Communications Server 2007 (OCS).
While you can register multiple presence server connections for a WebCenter application, only one connection is used for instant messaging and presence services—the default (or active) connection.
createIMPConnection(appName, name, adapter, url, [domain, appId, poolName, policyURI, userDomain, timeout, default, server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the WebCenter application in which to perform this operation. |
name
|
Connection name. The name must be unique (across all connection types) within the WebCenter application. |
adapter
|
Adapter name. Specify the adapter that matches your instant messaging and presence server. Valid values are LCS, OWLCS, and OCS.
Choose Choose Choose |
url
|
URL of the sever hosting instant messaging and presence services.
For example: |
domain
|
Deprecated.
Use the setIMPServiceProperty command to resolve IM addresses. |
appId
|
Optional. External application associated with the presence server connection.
If specified, external application credential information is used to authenticate users against the LCS, OCS, or OWLCS server. This argument is mandatory for LCS and OCS server connections. The external application you configure for instant messaging and presence services must use See also addExtAppField and setExtAppField. |
poolName
|
Optional. (LCS and OCS connections only.) Pool name that is required to create an LCS or OCS connection. Refer to Microsoft Live Communications Server or Microsoft Office Communications Server documentation for details on pool names. This argument is mandatory for LCS server and OCS server connections. |
policyURI
|
Optional. (OWLCS connections only.) URI to the security policy that is required for authentication on the Oracle WebLogic Communication Server (OWLCS) server. |
userDomain
|
Optional. (OCS connections only.) Active Directory domain on the OCS server. This argument is mandatory for OCS server connections. |
timeout
|
Optional. Length of time (in seconds) that the Instant Messaging and Presence service waits for a response from the presence server before issuing a connection timeout message. This argument defaults to -1. When set to -1, the service default (10 seconds) applies. |
default
|
Optional. Indicates whether this connection is the default connection for the Instant Messaging and Presence service. Valid values are 1 (true) and 0 (false). The default for this argument is 0. |
server
|
Optional. Name of the managed server where the WebCenter application is deployed. For example, WC_Spaces.
Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the WebCenter application is deployed. |
The following example creates an instant messaging and presence server connection to a Oracle WebLogic Communication Server named myOWLCSPresenceServer.
wls:/weblogic/serverConfig>createIMPConnection(appName='webcenter', name='myOWLCSPresenceServer', adapter='OWLCS', url='http://myowlcshost.com:8888')
The following example also creates an instant messaging and presence server connection to a Oracle WebLogic Communication Server named myOWLCSPresenceServer.
wls:/weblogic/serverConfig>createIMPConnection(appName='webcenter', name='myOWLCSPresenceServer', adapter='OWCLS', url='http://myowlcshost.com:8888', policyURI='oracle/wss11_saml_token_with_message_protection_client_policy', timeout=60, default=0)
The following example creates an external application suitable for an instant messaging and presence server connection and then creates a connection named myLCSPresenceServer to a Microsoft Live Communications Server:
wls:/weblogic/serverConfig> createIMPExtApp(appName='webcenter', name='LCSExtApp', displayName='IMP Ext App') wls:/weblogic/serverConfig> createIMPConnection(appName='webcenter', name='myLCSPresenceServer', adapter='LCS', url='http://mylcshost.com/owc/lcs', appId='LCSExtApp', poolName='pool1.myhost.com', timeout=60, default=1)
The following example creates an instant messaging and presence server connection to a Microsoft Office Communications Server named myOCSPresenceServer.
wls:/weblogic/serverConfig> createIMPConnection(appName='webcenter', name='myOCSPresenceServer', adapter='OCS', url='http://myocshost.com/owc/ocs', appId='OCSExtApp', userDomain='OCS', poolName='pool01.myocshost.com', timeout=60, default=1)
Module: Oracle WebCenter
Use with WLST: Online
Edits an existing instant messaging and presence server connection. Use this command to update connection attributes.
The connection is created using the createIMPConnection command.
setIMPConnection(appName, name, [adapter, url, domain, appId, poolName, policyURI, userDomain, timeout, default, server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the WebCenter application in which to perform this operation. |
name
|
Name of an existing presence server connection. |
adapter
|
Optional. Adapter name. Specify the adapter that matches your instant messaging and presence server. Valid values are LCS, OWLCS, and OCS.
Choose Choose Choose |
url
|
Optional. URL of the server hosting instant messaging and presence services. |
domain
|
Deprecated.
Use the setIMPServiceProperty command to resolve IM addresses. |
appId
|
Optional. External application associated with the presence server connection.
If specified, external application credential information is used to authenticate users against the LCS, OCS, or OWLCS server. This argument is mandatory for LCS and OCS server connections. The external application you configure for instant messaging and presence services must use See also addExtAppField and setExtAppField. |
poolName
|
Optional. (LCS and OCS connections only.) Pool name that is required to create an LCS or OCS connection. Refer to Microsoft Live Communications Server or Microsoft Office Communications Server documentation for details on pool names. This argument is mandatory for LCS server and OCS server connections. |
policyURI
|
Optional. (OWLCS connections only.) URI to the security policy that is required for authentication on the Oracle WebLogic Communication Server (OWLCS) server. |
userDomain
|
Optional. (OCS connections only.) Active Directory domain on the OCS server. This argument is mandatory for OCS server connections. |
timeout
|
Optional. Length of time (in seconds) that the Instant Messaging and Presence service waits for a response from the presence server before issuing a connection timeout message. This argument defaults to -1. When set to -1, the service default (10 seconds) applies. |
default
|
Optional. Indicates whether this connection is the default connection for the Instant Messaging and Presence service. Valid values are 1 (true) and 0 (false). The default for this argument is 0.
To specify that the Instant Messaging and Presence service uses this connection, change the value from To disable this connection, use the removeIMPServiceProperty command:
While you can register multiple presence server connections for a WebCenter application, only one connection is used for instant messaging and presence services—the default (or active) connection. |
server
|
Optional. Name of the managed server where the WebCenter application is deployed. For example, WC_Spaces.
Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the WebCenter application is deployed. |
The following example updates attributes for an existing instant messaging and presence server connection.
wls:/weblogic/serverConfig>setIMPConnection(appName='webcenter', name='myOWLCSPresenceServer', adapter='OWCLS', url='http://myowlcshost.com:8888')
The following example sets attributes on an existing instant messaging and presence server connection.
wls:/weblogic/serverConfig>setIMPConnection(appName='webcenter', name='myOWLCSPresenceServer', adapter='OWCLS', url='http://myowlcshost.com:8888', policyURI='oracle/wss11_saml_token_with_message_protection_client_policy', timeout=60, default=0)
The following example sets attributes on an existing instant messaging and presence server connection.
wls:/weblogic/serverConfig>setIMPConnection(appName='webcenter', name='myLCSPresenceServer', adapter='LCS', url='http://mylcshost.com/owc/lcs', appId='LCSExtApp', poolName='pool1.myhost.com', timeout=60, default=0)
Module: Oracle WebCenter
Use with WLST: Online
Sets an instant messaging and presence server connection property. Use this command if additional parameters are required to connect to your presence server. This is an extensible way to add any connection property using a key and a value. (You are not limited to connection properties specified by createIMPConnection and setIMPConnection.)
All known, additional connection properties are listed in Table 10-14, "Additional IMP Connection Properties".
Table 10-14 Additional IMP Connection Properties
| Additional IMP Connection Property | Valid IMP Servers | Description |
|---|---|---|
|
|
OWLCS |
URL to the OWLCS Presence service. Required if the OWLCS Presence service is deployed on a separate node. When no value is specified, the connection |
|
|
OWLCS |
URL to the OWLCS Contact Management service. Required if the OWLCS Contact Management service is deployed on a separate node. When no value is specified, the connection |
|
|
OWLCS |
URL to the OWLCS Third Party Call service. Required if the OWLCS Third Party Call service is deployed on a separate node. When no value is specified, the connection's |
|
|
OWLCS |
Third party call method. Valid values are: |
|
|
OWLCS |
Domain name of the PSTN gateway. Required when the |
|
|
OWLCS |
User profile attribute used to store users' phone numbers. The default attribute is Required when the call.method is |
|
|
OWLCS |
Alias used to import the OWLCS certificate. The value must be unique and must not be used by another service. If no alias name is supplied, the application uses the default value |
Do not use the setIMPConnectionProperty to set connection properties available through createIMPConnection or setIMPConnection. Attempting to do so, has no effect.
setIMPConnectionProperty(appName, name, key, value, [secure, server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the WebCenter application in which to perform this operation. |
name
|
Name of an existing presence server connection. |
key
|
Name of the connection property. |
value
|
Value for the property. Allows any property to be modified on the connection with a key and value. |
secure
|
Optional. Indicates whether the property value must be stored securely using encryption. Valid options are 1 (true) and 0 (false). When 1, the value is encrypted. The default option is 0. |
server
|
Optional. Name of the managed server where the WebCenter application is deployed. For example, WC_Spaces.
Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the WebCenter application is deployed. |
Module: Oracle WebCenter
Use with WLST: Online
Deletes an instant messaging and presence server connection property. Use caution when deleting connection properties because the connection might not work as expected if the configuration becomes invalid as a result.
This command can only delete additional connection properties added using the setIMPConnectionProperty command.
deleteIMPConnectionProperty(appName, name, key, [server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the WebCenter application in which to perform this operation. |
name
|
Name of an existing presence server connection. |
key
|
Name of the connection property you want to delete. |
server
|
Optional. Name of the managed server where the WebCenter application is deployed. For example, WC_Spaces.
Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the WebCenter application is deployed. |
Module: Oracle WebCenter
Use with WLST: Online
Lists which types of instant messaging and presence servers Oracle WebCenter supports. Out-of-the-box, WebCenter applications support Oracle WebLogic Communication Server (OWLCS), Microsoft Live Communications Server (LCS), and Microsoft Office Communications Server (OCS).
Module: Oracle WebCenter
Use with WLST: Online
Lists all of the instant messaging and presence server connections that are configured for a named WebCenter application.
listIMPConnections(appName,[verbose], [name], [server, applicationVersion)
| Argument | Definition |
|---|---|
appName
|
Name of the WebCenter application in which to perform this operation. |
verbose
|
Optional. Displays presence server connection details in verbose mode. Valid values are 1 (true) and 0 (false). When set to 1, listIMPConnections lists all of the presence server connections that are configured for a WebCenter application, along with their details.When set to 0, only connection names are listed. This argument defaults to 0. |
name
|
Optional. Name of an existing presence server connection. Use this argument to view connection details for a specific presence server connection. Note that if you use the name argument when verbose argument set to 1, the verbose argument is ignored. |
server
|
Optional. Name of the managed server where the WebCenter application is deployed. For example, WC_Spaces.
Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the WebCenter application is deployed. |
The following example lists all of the instant messaging and presence server connections that are configured for an application named webcenter.
wls:/weblogic/serverConfig> listIMPConnections(appName='webcenter')
The following example lists all of the instant messaging and presence server connections that are configured for the application in verbose mode.
wls:/weblogic/serverConfig> listIMPConnections(appName='webcenter', verbose=1)
The following example lists connection details for an instant messaging and presence server connections named impConnection1.
wls:/weblogic/serverConfig> listIMPConnections(appName='webcenter', name='impConnection1')
Module: Oracle WebCenter
Use with WLST: Online
Lists the connection that the Instant Messaging and Presence service is using, in a named WebCenter application. While you can register multiple presence server connections for a WebCenter application, the Instant Messaging and Presence service only uses one connection—the default (or active) connection.
If only one presence server connection is available, that connection is assumed to be the default connection.
listDefaultIMPConnection(appName, verbose, [server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the WebCenter application in which to perform this operation. |
verbose
|
Optional. Displays the default presence server connection in verbose mode, if available. Valid options are 1 (true) and 0 (false). When set to 1, the name and details of the presence server connection are listed. When set to 0, only the connection name displays. This argument defaults to 0. |
server
|
Optional. Name of the managed server where the WebCenter application is deployed. For example, WC_Spaces.
Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the WebCenter application is deployed. |
Module: Oracle WebCenter
Use with WLST: Online
Specifies the default connection for the Instant Messaging and Presence service, in a named WebCenter application. While you can register multiple presence server connections with a WebCenter application, the Instant Messaging and Presence service only uses one connection—the default (or active) connection.
If only one presence server connection is available, that connection is assumed to be the default connection.
setDefaultIMPConnection(appName, name, [server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the WebCenter application in which to perform this operation. |
name
|
Name of an existing instant messaging and presence connection. |
server
|
Optional. Name of the managed server where the WebCenter application is deployed. For example, WC_Spaces.
Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the WebCenter application is deployed. |
Module: Oracle WebCenter
Use with WLST: Online
Specifies default values for the Instant Messaging and Presence service.
Configurable properties for the Instant Messaging and Presence service are listed in Table 10-15, "Instant Messaging and Presence Service Configuration Properties".
Table 10-15 Instant Messaging and Presence Service Configuration Properties
| Configuration Property | Description |
|---|---|
|
|
Connection used by the Instant Messaging and Presence service. |
|
|
Cache timeout for instant messaging and presence data. The default is 60 seconds. |
|
|
Determines what to display if user display names are missing. When set to Display names are not mandatory in presence data. If the WebCenter application does not always provide display names by default and you consider this information important, set |
|
|
Resolver implementation used to map user names to IM addresses and IM addresses to user names. The default setting is
|
|
|
User profile attribute used to determine a user's IM address. The default setting is |
setIMPServiceProperty(appName, property, value, [server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the WebCenter application in which to perform this operation. |
property
|
Name of the configuration property. |
value
|
Value for the property. |
server
|
Optional. Name of the managed server where the WebCenter application is deployed. For example, WC_Spaces.
Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the WebCenter application is deployed. |
Module: Oracle WebCenter
Use with WLST: Online
Removes the current value that is set for an Instant Messaging and Presence service property. Use this command to remove any of the properties listed in Table 10-15, "Instant Messaging and Presence Service Configuration Properties".
Take care when using this command as removing values for these properties might cause unexpected behavior.
Note:
Use this command syntax to disable the connection currently used by the Instant Messaging and Presence service:removeIMPServiceProperty('appName='webcenter', property='selected.connection')
This command forces the default connection argument to 0. See also, setIMPConnection.
removeIMPServiceProperty(appName, property, [server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the WebCenter application in which to perform this operation. |
property
|
Name of the configuration property. |
server
|
Optional. Name of the managed server where the WebCenter application is deployed. For example, WC_Spaces.
Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the WebCenter application is deployed. |
Module: Oracle WebCenter
Use with WLST: Online
listIMPServiceProperties(appName, [server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the WebCenter application in which to perform this operation. |
server
|
Optional. Name of the managed server where the WebCenter application is deployed. For example, WC_Spaces.
Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the WebCenter application is deployed. |
Module: Oracle WebCenter
Use with WLST: Online
Creates an external application suitable for instant messaging and presence server connections. The external application is configured with the required additional properties: authMethod=POST, and additional fields fieldName='Account' and displaytoUser=1.
createIMPExtAppConnection(appName, name, [displayName, server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the WebCenter application in which to perform this operation. |
name
|
Connection name. The name must be unique (across all connection types) within the WebCenter application. |
displayName
|
Optional. External application display name. A user friendly name for the application that WebCenter users will recognize. The display name must be unique across all external applications within the WebCenter application. |
server
|
Optional. Name of the managed server where the WebCenter application is deployed. For example, WC_Spaces.
Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the WebCenter application is deployed. |
Use the commands listed in Table 10-16 to manage mail server connections for a WebCenter application.
You can register multiple mail server connections:
WebCenter Spaces supports multiple mail connections. The mail connection configured with default=1 is the default connection for mail services in WebCenter Spaces. All additional connections are offered as alternatives; WebCenter Spaces users can choose which one they want to use through user preferences.
WebCenter Portal applications only use one mail connection—the connection configured with default=1. Any additional connections are ignored.
Configuration changes made using these WebCenter WLST commands are only effective after your restart the Managed Server on which the WebCenter application is deployed. For details, see Oracle Fusion Middleware Administrator's Guide for Oracle WebCenter.
Table 10-16 Mail WLST Commands
| Use this command... | To... | Use with WLST... |
|---|---|---|
|
Create a mail server connection for a WebCenter application. |
Online |
|
|
Edit an existing mail server connection. |
Online |
|
|
Set mail server connection properties. |
Online |
|
|
Delete a mail server connection property. |
Online |
|
|
List all of the mail server connections that are configured for an application. |
Online |
|
|
List the default mail server connection that is configured for an application. |
Online |
|
|
Set a specified connection as the default mail server connection. |
Online |
|
|
Specify defaults for the Mail service. |
Online |
|
|
Remove defaults for the Mail service. |
Online |
|
|
List Mail service properties. |
Online |
|
|
Create an external application suitable for mail connections. |
Online |
Module: Oracle WebCenter
Use with WLST: Online
Creates a mail server connection for a WebCenter application.
WebCenter applications support the Microsoft Exchange Server or any mail server that supports IMAP4 and SMTP. The most important mail server connection attributes are: imapHost, imapPort, imapSecured, smtpHost, smtpPort, and smtpSecured
You can register multiple mail server connections:
WebCenter Spaces supports multiple mail connections. The mail connection configured with default=1 is the default connection for mail services in WebCenter Spaces. All additional connections are offered as alternatives; WebCenter Spaces users can choose which one they want to use through user preferences.
WebCenter Portal applications only use one mail connection—the connection configured with default=1. Any additional connections are ignored.
createMailConnection(appName, name, [imapHost, imapPort, smtpHost, smtpPort, imapSecured, smtpSecured, appId, timeout, default, server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the WebCenter application in which to perform this operation. |
name
|
Connection name. The name must be unique (across all connection types) within the WebCenter application. |
imapHost
|
Optional. Host name of the machine on which the IMAP service is running. |
imapPort
|
Optional. Port on which the IMAP service listens. |
smtpHost
|
Optional. Host name of the machine where the SMTP service is running. |
smtpPort
|
Optional. Port on which the SMTP service listens. |
imapSecured
|
Optional. Specifies whether the mail server connection to the IMAP server is SSL-enabled. Valid values are 1 (true) and 0 (false). The default for this argument is 0. |
smtpSecured
|
Optional. Specifies whether the SMTP server is secured. Valid values are 1 (true) and 0 (false). The default for this argument is 0. |
appId
|
External application associated with the mail server connection.
External application credential information is used to authenticate users against the IMAP and SMTP servers. The same credentials are supplied to authenticate the user on both the IMAP and SMTP servers. The external application you configure for the Mail service must use
If an external application does not exist yet, use the WLST command createMailExtApp to create an external application that automatically has all the required additional fields. See also createExtAppConnection. |
timeout
|
Optional. Length of time (in seconds) that the service waits to acquire a connection before terminating. This argument defaults to -1. When set to -1, the service default (10 seconds) applies. |
default
|
Optional. Indicates whether this connection is the default connection for the Mail service. Valid values are 1 (true) and 0 (false). This argument defaults to 0.
|
server
|
Optional. Name of the managed server where the WebCenter application is deployed. For example, WC_Spaces.
Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the WebCenter application is deployed. |
The following example creates an external application suitable for a mail server connection, and then creates a mail server connection named myMailConnection:
wls:/weblogic/serverConfig> createMailExtApp(appName='webcenter', name='extApp_Mail', displayName='Mail Ext App') wls:/weblogic/serverConfig> createMailConnection(appName='webcenter' , name='myMailConnection' , imapHost='myimaphost.com', imapPort=143 , smtpHost='mysmtphost.com' , smtpPort=25 , imapSecured=0, smtpSecured=0, appId='extApp_Mail', timeout=60, default=1)
Module: Oracle WebCenter
Use with WLST: Online
Edits an existing mail connection. Use this command to update connection attributes.
The connection is created using the createMailConnection command.
(WebCenter Spaces application only.) This command enables you to set additional, optional, LDAP server attributes that cannot be set using createMailConnection. When LDAP details are defined, the Mail service creates, edits, and deletes Space distribution lists for WebCenter Spaces. Distribution lists are named after their Space (excluding non-java identifiers) and assigned a domain (derived from the domain attribute, for example, @mycompany.com). If LDAP details are not provided, Space distribution lists are not created or maintained. The mail server must be a Microsoft Exchange Server.
setMailConnection(appName, name, [imapHost, imapPort, smtpHost, smtpPort, imapSecured, smtpSecured, appId, default, ldapHost, ldapPort, ldapBaseDN, ldapAdminUser, ldapAdminPassword, ldapSecured, domain, defaultUser, timeout, server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the WebCenter application in which to perform this operation. |
name
|
Name of an existing mail server connection. |
imapHost
|
Optional. Host name of the machine on which the IMAP service is running. |
imapPort
|
Optional. Port on which the IMAP service listens. |
smtpHost
|
Optional. Host name of the machine where the SMTP service is running. |
smtpPort
|
Optional. Port on which the SMTP service listens. |
imapSecured
|
Optional. Specifies whether the connection to the IMAP server is secured (SSL-enabled). Valid values are 1 (true) and 0 (false). The default for this argument is 0. |
smtpSecured
|
Optional. Specifies whether the connection to the SMTP server is secured (SSL-enabled). Valid values are 1 (true) and 0 (false). The default for this argument is 0. |
appId
|
Optional. External application associated with the mail server connection.
External application credential information is used to authenticate users against the IMAP and SMTP servers. The same credentials are supplied to authenticate the user on both the IMAP and SMTP servers. The external application you configure for the Mail service must use
If an external application does not exist yet, use the WLST command createMailExtApp to create an external application that automatically has all the required additional fields. See also createExtAppConnection. |
ldapHost
|
Optional. Host name of the machine where the LDAP directory server is running. |
ldapPort
|
Optional. Port on which the LDAP directory server listens. |
ldapBaseDN
|
Optional. Base distinguished name for the LDAP schema. For example, CN=Users,DC=oracle,DC=com. |
ldapAdminUser
|
Optional. User name of the LDAP directory server administrator. A valid administrator with privileges to make entries into the LDAP schema. |
ldapAdminPassword
|
Optional. Password for the LDAP directory server administrator. This password will be stored in a secured store. |
ldapSecured
|
Optional. Specifies whether the connection to the LDAP server is secured (SSL enabled). Valid values are 1 (true) and 0 (false). The default for this argument is 0. Set this to 1 for all LDAP communications over SSL. |
domain
|
Optional. Domain name appended to Space distribution lists. For example, if the domain attribute is set to mycompany.com, the Finance Project Space will maintain a distribution list named FinanceProject@oracle.com. |
defaultUser
|
Optional. Comma-delimited list of user names to whom you want to grant moderation capabilities. These users become members of every Space distribution list that is created. The users specified must exist in the Base LDAP schema (specified in the ldapBaseDN argument). |
timeout
|
Optional. Length of time (in seconds) that the service waits to acquire a connection before terminating. This argument defaults to -1. When set to -1, the service default (10 seconds) applies. |
default
|
Optional. Indicates whether this connection is the default (or active) connection for the Mail service. Valid values are 1 (true) and 0 (false). This argument defaults to 0. 1 specifies that this connection is the default connection for the Mail service.
A connection does not cease to be the default connection for the Mail service if you change the To stop using a default connection, use the removeMailServiceProperty command as follows:
|
server
|
Optional. Name of the managed server where the WebCenter application is deployed. For example, WC_Spaces.
Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the WebCenter application is deployed. |
The following example sets individual attributes of a mail server connection.
wls:/weblogic/serverConfig>setMailConnection(appName='webcenter', name='myMailConnection', imapHost='myimaphost.com', imapPort=143, smtpHost='mysmtphost.com' , smtpPort=25 , imapSecured=0, smtpSecured=0, appId='extApp_Mail', timeout=60, default=1)
The following example sets individual attributes of a mail server connection.
wls:/weblogic/serverConfig>setMailConnection(appName='webcenter', name='myMailConnection', imapPort=993, imapSecured=1, smtpPort=465 , smtpSecured=1)
The following example sets LDAP attributes for a mail server connection.
wls:/weblogic/serverConfig>setMailConnection(appName='webcenter', name='myMailConnection', domain='ORACLE.COM', defaultUser='admin', imapHost='myimaphost.com', imapPort=143, smtpHost='mysmtphost.com', imapSecured=0, smtpSecured=0, smtpPort=25, appId='extApp_Mail', default=1, ldapHost='myldaphost.com', ldapPort=389, ldapBaseDN='CN=Users,DC=exchange,DC=uk,DC=com', ldapAdminUser='administrator', ldapAdminPassword='adminpswd', ldapSecured=0, timeout=60)
Module: Oracle WebCenter
Use with WLST: Online
Sets a mail server connection property. Use this command if additional parameters are required to connect to your mail server. This is an extensible way to add any connection property using a key and a value. (You are not limited to connection properties specified by createMailConnection and setMailConnection.)
All known, additional connection properties are listed in Table 10-17, "Additional Mail Connection Properties".
Table 10-17 Additional Mail Connection Properties
| Additional Connection Property | Description |
|---|---|
|
|
Characterset used on the connection. The default charset is |
|
Various IMAP properties |
Any valid IMAP connection property. For example, A list of valid IMAP properties are available at: |
|
Various SMTP properties |
Any valid SMTP connection property. For example, A list of valid SMTP properties are available at: |
Note:
Do not use the setMailConnectionProperty to set connection properties available through createMailConnection or setMailConnection. Attempting to do so, has no effect.setMailConnectionProperty(appName, name, key, value, [secure], [server], [applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the WebCenter application in which to perform this operation. |
name
|
Name of an existing mail server connection. |
key
|
Name of the connection property. |
value
|
Value for the property. Allows any property to be modified on the connection with a key and value. |
secure
|
Optional. Indicates whether the property value must be stored securely using encryption. Valid options are 1 (true) and 0 (false). When 1, the value is encrypted. The default option is 0. |
server
|
Optional. Name of the managed server where the WebCenter application is deployed. For example, WC_Spaces.
Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the WebCenter application is deployed. |
Module: Oracle WebCenter
Use with WLST: Online
Deletes a mail server connection property. Take care when deleting connection properties because the connection may not work as expected if the configuration becomes invalid as a result.
This command can only delete additional connection properties added using the setMailConnectionProperty command.
deleteMailConnectionProperty(appName, name, key, [server], [applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the WebCenter application in which to perform this operation. |
name
|
Name of an existing mail server connection. |
key
|
Name of the connection property you want to delete. |
server
|
Optional. Name of the managed server where the WebCenter application is deployed. For example, WC_Spaces.
Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the WebCenter application is deployed. |
Module: Oracle WebCenter
Use with WLST: Online
Lists all of the mail server connections that are configured for a named WebCenter application.
listMailConnection(appName, [verbose, name, server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the WebCenter application in which to perform this operation. |
verbose
|
Optional. Displays mail server connection details in verbose mode. Valid options are 1 (true) and 0 (false). When set to 1, listMailConnections lists all of the mail server connections that are configured for a WebCenter application, along with their details. When set to 0, only connection names are listed. This argument defaults to 0. |
name
|
Optional. Name of an existing mail server connection. Use this argument to view connection details for a specific mail server connection. |
server
|
Optional. Name of the managed server where the WebCenter application is deployed. For example, WC_Spaces.
Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the WebCenter application is deployed. |
The following example lists the names of mail server connections that are currently configured for an application named webcenter.
wls:/weblogic/serverConfig> listMailConnections(appName='webcenter')
The following example lists connection names and details for all of the mail server connections that are currently configured for an application named webcenter.
wls:/weblogic/serverConfig> listMailConnections(appName='webcenter', verbose=1)
The following example lists connection details for a mail server connection named mailConnection1.
wls:/weblogic/serverConfig> listMailConnections(appName='webcenter', name='mailConnection1')
Module: Oracle WebCenter
Use with WLST: Online
Lists the default mail server connection that the Mail service is using, in a named WebCenter application.
You can register multiple mail server connections but there can only be one default connection:
WebCenter Spaces supports multiple mail connections. The mail connection configured with default=1 is the default connection for mail services in WebCenter Spaces. All additional connections are offered as alternatives; WebCenter Spaces users can choose which one they want to use through user preferences.
WebCenter Portal applications only use one mail connection—the connection configured with default=1. Any additional connections are ignored.
listDefaultMailConnection(appName,[verbose], [server], [applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the WebCenter application in which to perform this operation. |
verbose
|
Optional. Displays the default mail server connection in verbose mode, if available. Valid options are 1 (true) and 0 (false). When set to 1, the name and details of the mail server connection are listed. When set to 0, only the connection name displays. This argument defaults to 0. |
server
|
Optional. Name of the managed server where the WebCenter application is deployed. For example, WC_Spaces.
Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the WebCenter application is deployed. |
Module: Oracle WebCenter
Use with WLST: Online
Specifies the default mail server connection for the Mail service, in a named WebCenter application.
You can register multiple mail server connections but there can only be one default connection:
WebCenter Spaces supports multiple mail connections. The mail connection configured with default=1 is the default connection for mail services in WebCenter Spaces. All additional connections are offered as alternatives; WebCenter Spaces users can choose which one they want to use through user preferences.
WebCenter Portal applications only use one mail connection—the connection configured with default=1. Any additional connections are ignored.
setDefaultMailConnection(appName, name, [server], [applicationVersion])
| Argument | Description |
|---|---|
appName
|
Name of the WebCenter application in which to perform this operation. |
name
|
Name of an existing mail connection. |
server
|
Optional. Name of the managed server where the WebCenter application is deployed. For example, WC_Spaces.
Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the WebCenter application is deployed. |
Module: Oracle WebCenter
Use with WLST: Online
Specifies default values for the Mail service.
Configurable properties for the Mail service are listed in Table 10-18, "Mail Service Configuration Properties".
Table 10-18 Mail Service Configuration Properties
| Configuration Property | Description |
|---|---|
|
|
Defines the delimiter that is used to separate multiple mail addresses. A comma is used by default. Some mail servers require mail addresses in the form |
|
|
The frequency, in seconds, that Space distribution lists are checked for new incoming emails. The default is 1800 seconds (30 minutes). Email communication through Space distribution lists can be published as discussion forum posts on a discussions server. For details, see "Publishing Space Mail in a Discussion Forum" in Oracle Fusion Middleware User's Guide for Oracle WebCenter. |
|
|
Maximum number of messages displayed in mail inboxes. |
|
|
Determines whether user email addresses are resolved to WebCenter user names when LDAP is configured. Valid values are When set to Set this property to |
setMailServiceProperty(appName, property, value, [server], [applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the WebCenter application in which to perform this operation. |
property
|
Name of the configuration property |
value
|
Value for the property. |
server
|
Optional. Name of the managed server where the WebCenter application is deployed. For example, WC_Spaces.
Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the WebCenter application is deployed. |
Module: Oracle WebCenter
Use with WLST: Online
Removes the current value that is set for a Mail service property. Use this command to remove any of the properties listed in Table 10-18, "Mail Service Configuration Properties".
Take care when using this command as removing values for these properties might cause unexpected behavior.
Note:
Use this command syntax to stop the Mail service from using the current default connection:removeMailServiceProperty('appName='webcenter', property='selected.connection')
This command forces the default connection argument to 0. See also, setMailConnection.
removeMailServiceProperty(appName, property, [server], [applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the WebCenter application in which to perform this operation. |
property
|
Name of the configuration property. |
server
|
Optional. Name of the managed server where the WebCenter application is deployed. For example, WC_Spaces.
Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the WebCenter application is deployed. |
Module: Oracle WebCenter
Use with WLST: Online
listMailServiceProperties(appName, [server], [applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the WebCenter application in which to perform this operation. |
server
|
Optional. Name of the managed server where the WebCenter application is deployed. For example, WC_Spaces.
Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the WebCenter application is deployed. |
Module: Oracle WebCenter
Use with WLST: Online
Creates an external application suitable for mail server connections. The external application is configured with the required additional properties: authMethod=POST, and specify several additional login fields:
fieldName='Email Address' and displaytoUser=1
fieldName='Your Name' and displaytoUser=1
fieldName='Reply-To Address' and displaytoUser=1
createMailExtAppConnection(appName, name, [displayName, server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the WebCenter application in which to perform this operation. For WebCenter Spaces, the name is always webcenter. |
name |
Connection name. The name must be unique (across all connection types) within the WebCenter application. |
displayName
|
Optional. External application display name. A user friendly name for the application that WebCenter users will recognize. The display name must be unique across all external applications within the WebCenter application. |
server
|
Optional. Name of the managed server where the WebCenter application is deployed. For example, WC_Spaces.
Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the WebCenter application is deployed. |
Use the commands listed in Table 10-19 to manage settings for the Notifications service in a WebCenter application.
Configuration changes made using these WebCenter WLST commands are only effective after your restart the Managed Server on which the WebCenter application is deployed. For details, see Oracle Fusion Middleware Administrator's Guide for Oracle WebCenter.
Table 10-19 Notifications WLST Commands
| Use this command... | To... | Use with WLST... |
|---|---|---|
|
Specify the connection used for routing notifications raised in a WebCenter application. |
Online |
|
|
Return details about the connection that is used to send notifications raised in a WebCenter application. |
Online |
Module: Oracle WebCenter
Use with WLST: Online
Specifies the connection used for routing notifications raised in a WebCenter application.
Use an existing mail server or BPEL server connection. If the WebCenter application is connected to a BPEL server, the Oracle User Messaging Service (UMS) is available for routing notifications through multiple messaging channels, including mail, worklists, and SMS. If you configure the Notifications service to use a BPEL server connection, you may specify a sender 'From' address for each available messaging channel. That is, you can specify a sender mail address and an SMS address.
Alternatively, you can route notification messages through a mail server. If you configure the Notifications service to use a mail server connection, the external application associated with the mail server connection must contain shared credentials. Shared credentials are required for routing application-wide notifications.
setNotificationsConfig(appName, type, name, [senderMailAddress, senderSMSAddress, server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the WebCenter application in which to perform this operation. For WebCenter Spaces, the name is always webcenter. |
type
|
Type of connection used to send notifications. Valid values are MAIL and BPEL. |
name
|
Name of an existing connection.
Consider the following:
|
senderMailAddress
|
Optional. Mail address from which all mail notifications are sent.
Use the format:
For example, This argument applies to notifications routed through BPEL servers. When a BPEL server is used and UMS is configured with multiple email drivers, this address is also used to identify the appropriate email driver. When a mail server is used, the "From Address" is the same user that is specified for the associated external application's shared credentials. |
senderSMSAddress
|
Optional. SMS number from which all SMS notifications are sent.
Typically, the SMS address format is a 4-6 digit number (without -, spaces, or any other characters). For example, This argument applies to notifications routed through BPEL servers. When a BPEL server is used and UMS is configured with multiple SMS drivers, this address is also used to identify the appropriate SMS driver. |
server
|
Optional. Name of the managed server where the WebCenter application is deployed. For example, WC_Spaces.
Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the WebCenter application is deployed. |
The following example specifies that the Notifications service use a BPEL server connection named 'WebCenter-Worklist' and also defines the mail address and SMS address from which all notifications are sent:
wls:/weblogic/serverConfig>setNotificationsConfig(appName='webcenter', type='BPEL', name='WebCenter-Worklist', senderMailAddress='WebCenter Notification<notifications@webcenter.com', senderSMSAddress='28734')
Module: Oracle WebCenter
Use with WLST: Online
Returns details about the connection that is used to send notifications raised in a WebCenter application.
getNotificationsConfig(appName, [server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the WebCenter application in which to perform this operation. For WebCenter Spaces, the name is always webcenter. |
server
|
Optional. Name of the managed server where the WebCenter application is deployed. For example, WC_Spaces.
Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the WebCenter application is deployed. |
The following example returns details about the connection used by the Notifications service in WebCenter Spaces:
wls:/weblogic/serverConfig>getNotificationsConfig(appName='webcenter') ConnectionType: BPEL ConnectionName: WebCenter-Worklist SenderMailAddress: notifications@webcenter.com SenderSMSAddress: 28776
Use the commands listed in Table 10-20 to manage personal events server connections for a WebCenter application.
Configuration changes made using these WebCenter WLST commands are only effective after your restart the Managed Server on which the WebCenter application is deployed. For details, see Oracle Fusion Middleware Administrator's Guide for Oracle WebCenter.
Table 10-20 Personal Events WLST Commands
| Use this command... | To... | Use with WLST... |
|---|---|---|
|
Create a personal events server connection for a named WebCenter application. |
Online |
|
|
Edit an existing personal events server connection. |
Online |
|
|
List all of the personal events server connections that are configured for a named WebCenter application |
Online |
Module: Oracle WebCenter
Use with WLST: Online
Creates a personal events server connection for a named WebCenter application.
The Personal Events service supports connections to Microsoft Exchange Server 2003 and Microsoft Exchange Server 2007.While you can register multiple personal events connections for a WebCenter application, only one connection is used for personal events services - the default (or active) connection.
createPersonalEventConnection(appName, name, webServiceUrl, adapterName, appId, [default, server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the WebCenter application in which to perform this operation. For WebCenter Spaces, the name is always webcenter. |
name
|
Connection name. The name must be unique (across all connection types within the WebCenter application. |
webServiceUrl
|
URL of the Web service exposing the event application.
Use the format |
adapterName
|
Specify the adapter that matches the personal events server. Valid values are MSEx2003 and MSEx2007. Choose MSEx2003 for Microsoft Exchange Server 2003 and MSEx2007 for Microsoft Exchange Server 2007.
Each adapter has its own mechanism of authenticating and exchanging data |
appId
|
External application associated with the Microsoft Exchange Server providing personal events services. If specified, external application credential information is used to authenticate users against the Microsoft Exchange Server. |
default
|
Optional. Indicates whether this connection is the default connection for the Personal Events service. Valid values are 1 (true) and 0 (false). The default for this argument is 0.
To specify that the Personal Events service uses this connection, set the value to While you can register multiple connections for a WebCenter application, only one connection is used for personal event services—the default (or active) connection. |
server
|
Optional. Name of the managed server where the WebCenter application is deployed. For example, WC_Spaces.
Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the WebCenter application is deployed. |
The following example creates a connection named MyPEConnection for WebCenter Spaces (appName='webcenter'). The connection points to a Microsoft Exchange Server 2007 and is designated as the default connection for the Personal Events service.
wls:/weblogic/serverConfig>createPersonalEventConnection(appName='webcenter',
name='MyPEConnection', webServiceUrl='http://myexchange.com/EWS/Services.wsdl',
adapterName='MSEx2007', appId='ExtPEApp', default=1)
The following example creates a connection named MyPEConnection for a WebCenter Spaces. The connection points to a Microsoft Exchange Server 2003.
wls:/weblogic/serverConfig>createPersonalEventConnection(appName='webcenter',
name='MyPEConnection',webServiceUrl='http://myexchange.com/ExchangeWS/PersonalEventsWebService.asmx', adapterName='MSEx2003', appId='ExtPEApp')
Module: Oracle WebCenter
Use with WLST: Online
setPersonalEventConnection(appName, name, [webServiceUrl, adapterName, appId, default, server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the WebCenter application in which to perform this operation. For WebCenter Spaces, the name is always webcenter. |
name
|
Name of an existing personal events server connection. |
webServiceUrl
|
Optional. URL of the Web service exposing the event application.
Use the format |
adapterName
|
Optional. Specify the adapter that matches the personal events server. Valid values are MSEx2003 and MSEx2007. Choose MSEx2003 for Microsoft Exchange Server 2003 and MSEx2007 for Microsoft Exchange Server 2007.
Each adapter has its own mechanism of authenticating and exchanging data |
appId
|
Optional. External application associated with the Microsoft Exchange Server providing personal events services. If specified, external application credential information is used to authenticate users against the Microsoft Exchange Server. |
default
|
Optional. Indicates whether this connection is the default connection for the Personal Events service. Valid values are 1 (true) and 0 (false). The default for this argument is 0.
To specify that the Personal Events service uses this connection, set the value to While you can register multiple connections for a WebCenter application, only one connection is used for personal event services— the default (or active) connection. |
server
|
Optional. Name of the managed server where the WebCenter application is deployed. For example, WC_Spaces.
Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the WebCenter application is deployed. |
The following example updates the Web service URL for a connection named MyPEConnection.
wls:/weblogic/serverConfig>setPersonalEventConnection(appName='webcenter', name='MyPEConnection', webServiceUrl='http://myexchange.com/EWS/Services.wsdl')
The following example makes a connection named MyPEConnection the default connection for personal events services in WebCenter Spaces.
wls:/weblogic/serverConfig>setPersonalEventConnection(appName='webcenter', name='MyPEConnection', default=1)
Module: Oracle WebCenter
Use with WLST: Online
Lists all of the personal events server connections that are configured for a named WebCenter application.
listPersonalEventConnections(appName, [verbose, name, server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the WebCenter application in which to perform this operation. |
verbose
|
Optional. Displays connection details for the Personal Events service in verbose mode. Valid options are 1 (true) and 0 (false). When set to 1, listPersonalEventConnections lists all of the personal events server connections that are configured for a WebCenter application, along with their details. When set to 0, only connection names are listed. This argument defaults to 0.
When set to |
name
|
Optional. Name of an existing personal events connection. Use this argument to view connection details for a specific personal events server. |
server
|
Optional. Name of the managed server where the WebCenter application is deployed. For example, WC_Spaces.
Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the WebCenter application is deployed. |
The following example lists connection names and details for all of the personal events server connections currently configured for WebCenter Spaces.
wls:/weblogic/serverConfig>listPersonalEventConnections(appName='webcenter', verbose=1)
The following example displays connection details for a personal events server connection named MyPEConnection.
wls:/weblogic/serverConfig>listPersonalEventConnections(appName='webcenter', verbose=1, name='MyPEConnection')
Use the commands listed in Table 10-21 to manage WebCenter personalization connections for a WebCenter application.
Configuration changes made using these WebCenter WLST commands are only effective after your restart the Managed Server on which WebCenter Personalization Services is deployed. For details, see Oracle Fusion Middleware Administrator's Guide for Oracle WebCenter.
Table 10-21 Personalization WLST Commands
| Use this command... | To... | Use with WLST... |
|---|---|---|
|
Create a CMIS connection for the WebCenter Personalization service. |
Online |
|
|
Create an Activity Graph connection for the WebCenter Personalization service. |
Online |
|
|
Create a People connection for the WebCenter Personalization service. |
Online |
|
|
Create a custom connection for the WebCenter Personalization service. |
Online |
|
|
Modify properties of an existing connection for the WebCenter Personalization service. |
Online |
|
|
List CMIS connections configured for the WebCenter Personalization service. |
Online |
|
|
List Activity Graph connections configured for the WebCenter Personalization service. |
Online |
|
|
List People connections configured for the WebCenter Personalization service. |
Online |
|
|
List custom connections configured for the WebCenter Personalization service. |
Online |
|
|
Create a CMIS connection for the WebCenter Personalization service. |
Online |
|
|
Create an Activity Graph connection for the WebCenter Personalization service. |
Online |
|
|
Create a People connection for the WebCenter Personalization service. |
Online |
|
|
Create a custom connection for the WebCenter Personalization service. |
Online |
Module: Oracle WebCenter
Use with WLST: Online
Creates a CMIS (Content Management Interoperability Service) connection for the WebCenter Personalization service.
createWCPSCMISConnection(name, repositoryId, host, port, [scheme, namespace, isDefault, path, pathPrepend, servletPathPart, rewriteUrls, pathTrim, timeoutInMillisecs, propagateTimeoutExceptions, server])
| Argument | Definition |
|---|---|
name
|
Connection name. The name must be unique for this connection type within a namespace. |
repositoryId |
CMIS repository ID.
Typically, the name of the Oracle Content Server connection name. |
host |
Hostname of the server hosting the CMIS REST service.
Typically, the machine name of the |
port |
Port of the server hosting the CMIS REST service.
Typically, the port number of the |
scheme |
Optional. HTTP scheme for accessing the CMIS REST service. Valid options are http and https. Defaults to http. |
namespace
|
Optional. WebCenter Personalization connection namespace for the connection. If not specified or set to none, the connection is available to all namespaces. |
isDefault |
Optional. Indicates whether this connection is the default CMIS connection. Valid values are 1 (true) or 0 (false). Defaults to 0. |
path |
Optional. CMIS service URL path. Defaults to /api/cmis/repository/<repositoryId>. |
pathPrepend |
Optional. Base CMIS service URL path to prepend to the servletPathPart and path. Defaults to /rest. |
servletPathPart |
Optional. Servlet section of the CMIS service URL path. |
rewriteUrls |
Optional. Specifies how to rewrite URLs returned from the CMIS REST service. Valid options are producer, consumer, and none. Defaults to none.
For more details, see 'Managing WebCenter Personalization' in the Oracle Fusion Middleware Administrator's Guide for Oracle WebCenter. |
pathTrim |
Optional. Specifies the path parts to trim from URLs returned from the CMIS REST service. Defaults to None.
For more details, see 'Managing WebCenter Personalization' in the Oracle Fusion Middleware Administrator's Guide for Oracle WebCenter. |
timeoutInMillisecs |
Optional. Timeout in milliseconds (as a string) to wait for CMIS calls to return, or None for no timeout. Defaults to None. |
propagateTimeoutExceptions |
Optional. Valid values are 1 (true) and 0 (false). When set to 1, CMIS call timeouts raise an exception. When set to 0, exceptions are not raised. |
server
|
Optional. Name of the Managed Server hosting the WebCenter Personalization service.
This parameter is only required in a nondefault deployment configuration. No value is required for a default deployment where the |
Module: Oracle WebCenter
Use with WLST: Online
createWCPSActivityGraphConnection(name, host, port, [scheme], [namespace], [isDefault], [restResourceIndex], [rewriteUrls], [pathTrim], [server])
| Argument | Definition |
|---|---|
name
|
Connection name. Must be unique for this connection type within a namespace. |
host |
Hostname of the server hosting the Activity Graph REST service.
Typically, the machine name of the |
port |
Port of the server hosting the Activity Graph service.
Typically, the port number of the |
scheme |
Optional. HTTP scheme for accessing the Activity Graph service. Valid options are http and https. Defaults to http. |
namespace
|
Optional. WebCenter Personalization connection namespace for the connection. If not specified or set to none, the connection is available to all namespaces. |
isDefault |
Optional. Indicates whether this connection is the default Activity Graph connection. Valid values are 1 (true) or 0 (false). Defaults to 0. |
restResourceIndex |
Optional. URL path for the resourceIndex of the REST server. Defaults to /rest/api/resourceIndex. |
rewriteUrls |
Optional. Specifies how to rewrite URLs returned from the Activity Graph REST service. Valid options are producer, consumer, and none. Defaults to none.
For more details, see 'Managing WebCenter Personalization' in the Oracle Fusion Middleware Administrator's Guide for Oracle WebCenter. |
pathTrim |
Optional. Specifies the path parts to trim from URLs returned from the Activity Graph REST service. Defaults to None.
For more details, see 'Managing WebCenter Personalization' in the Oracle Fusion Middleware Administrator's Guide for Oracle WebCenter. |
server
|
Optional. Name of the Managed Server hosting the WebCenter Personalization service.
This parameter is only required in a nondefault deployment configuration. No value is required for a default deployment where the |
Module: Oracle WebCenter
Use with WLST: Online
createWCPSPeopleConnection(name, host, port, [scheme], [namespace], [isDefault], [restResourceIndex], [rewriteUrls], [pathTrim], [server])
| Argument | Definition |
|---|---|
name
|
Connection name. Must be unique for this connection type within a namespace. |
host |
Hostname of the server hosting the People Connection REST service.
Typically, the machine name of the |
port |
Port of the server hosting the People Connection service.
Typically, the port number of the |
scheme |
Optional. HTTP scheme for accessing the People Connection service. Valid options are http and https. Defaults to http. |
namespace
|
Optional. WebCenter Personalization connection namespace for the connection. If not specified or set to none, the connection is available to all namespaces. |
isDefault |
Optional. Indicates whether this connection is the default People connection. Valid values are 1 (true) or 0 (false). Defaults to 0. |
restResourceIndex |
Optional. URL path for the resourceIndex of the REST server. Defaults to /rest/api/resourceIndex. |
rewriteUrls |
Optional. Specifies how to rewrite URLs returned from the People Connection REST service. Valid options are producer, consumer, and none. Defaults to none.
For more details, see 'Managing WebCenter Personalization' in the Oracle Fusion Middleware Administrator's Guide for Oracle WebCenter. |
pathTrim |
Optional. Specifies the path parts to trim from URLs returned from the People Connection service. Defaults to None.
For more details, see 'Managing WebCenter Personalization' in the Oracle Fusion Middleware Administrator's Guide for Oracle WebCenter. |
server
|
Optional. Name of the Managed Server hosting the WebCenter Personalization service.
This parameter is only required in a nondefault deployment configuration. No value is required for a default deployment where the |
Use with WLST: Online
Creates a connection of a specific type for the WebCenter Personalization service.
Custom connection types are used with custom data providers and property locators.
createWCPSCustomConnection(name, type, [namespace], [properties], [server])
| Argument | Definition |
|---|---|
name
|
Connection name. Must be unique for this connection type within a namespace. |
type
|
Custom connection type specific to the custom data provider or property locator implementation. |
namespace
|
Optional. WebCenter Personalization connection namespace for the connection. If not specified or set to none, the connection is available to all namespaces. |
properties |
Optional. Dictionary of connection properties and values.
The set of properties is specific to the connection type. All values in the dictionary must be strings. |
server
|
Optional. Name of the Managed Server hosting the WebCenter Personalization service.
This parameter is only required in a nondefault deployment configuration. No value is required for a default deployment where the |
Module: Oracle WebCenter
Use with WLST: Online
Lists all CMIS (Content Management Interoperability Service) connections configured for the WebCenter Personalization service or lists a single connection.
listWCPSCMISConnections([server], [verbose], [name], [namespace])
| Argument | Definition |
|---|---|
server
|
Optional. Name of the Managed Server hosting the WebCenter Personalization service.
This parameter is only required in a nondefault deployment configuration. No value is required for a default deployment where the |
verbose
|
Optional. Controls verbose or concise output. Valid options are 1 and 0. When set to 1, this command lists the CMIS connections and their properties. When set to 0, this command lists connection names only. Defaults to 1. |
name
|
Optional. Name of an existing connection. If not specified or set to None, then all connections are listed. |
namespace
|
Optional. WebCenter Personalization connection namespace for the connection you want to list. If not specified or set to none, this command lists connections configured to be available in all namespaces. |
The following example lists the names of all the CMIS connections:
wls:/weblogic/serverConfig> listWCPSCMISConnections(verbose=0)
Repos1CMISConnection
Repos2CMISConnection
The following example lists the details of one CMIS connection:
wls:/weblogic/serverConfig> listWCPSCMISConnections(name='Repos1CMISConnection')
----------------------
Repos1CMISConnection (type=cmis.provider.connection, namespace=*)
----------------------
host: myhost.com
isDefault: false
path: /api/cmis/repository/repo1
pathPrepend: /rest
port: 8888
repositoryId: ucm11g-server
rewriteUrls: none
scheme: http
Module: Oracle WebCenter
Use with WLST: Online
Lists all Activity Graph connections configured for the WebCenter Personalization service or lists a single connection.
listWCPSActivityGraphConnections([server], [verbose], [name], [namespace])
| Argument | Definition |
|---|---|
server
|
Optional. Name of the Managed Server hosting the WebCenter Personalization service.
This parameter is only required in a nondefault deployment configuration. No value is required for a default deployment where the |
verbose
|
Optional. Controls verbose or concise output. Valid options are 1 and 0. When set to 1, this command lists the Activity Graph connections and their properties. When set to 0, this command lists connection names only. Defaults to 1. |
name
|
Optional. Name of an existing connection. If not specified or set to None, then all connections are listed. |
namespace
|
Optional. WebCenter Personalization connection namespace for the connection you want to list. If not specified or set to none, this command lists connections configured to be available in all namespaces. |
The following example lists the names of all the Activity Graph connections:
wls:/weblogic/serverConfig> listWCPSActivityGraphConnections(verbose=0)
AG1Connection
AG2Connection
The following example lists the details of one Activity Graph connection:
wls:/weblogic/serverConfig> listWCPSActivityGraphConnections(name='AG1Connection')
----------------------
AG1Connection (type=activity.provider.connection, namespace=*)
----------------------
host: myhost.com
isDefault: false
port: 8888
restResourceIndex: /rest/api/resourceIndex
rewriteUrls: producer
scheme: http
Module: Oracle WebCenter
Use with WLST: Online
Lists all People connections configured for the WebCenter Personalization service or lists a single connection.
listWCPSPeopleConnections([server], [verbose], [name], [namespace])
| Argument | Definition |
|---|---|
server
|
Optional. Name of the Managed Server hosting the WebCenter Personalization service.
This parameter is only required in a nondefault deployment configuration. No value is required for a default deployment where the |
verbose
|
Optional. Controls verbose or concise output. Valid options are 1 and 0. When set to 1, this command lists the People connections and their properties. When set to 0, this command lists connection names only. Defaults to 1. |
name
|
Optional. Name of an existing connection. If not specified or set to None, then all connections are listed. |
namespace
|
Optional. WebCenter Personalization connection namespace for the connection you want to list. If not specified or set to none, this command lists connections configured to be available in all namespaces. |
The following example lists the names of all the People connections:
wls:/weblogic/serverConfig> listWCPSPeopleConnections(verbose=0)
People1Connection
People2Connection
The following example lists the details of one People connection:
wls:/weblogic/serverConfig> listWCPSPeopleConnections(name='PeopleConnection')
----------------------
PeopleConnection (type=people.service.connection, namespace=*)
----------------------
host: myhost.com
isDefault: false
port: 8888
restResourceIndex: /rest/api/resourceIndex
rewriteUrls: producer
scheme: http
Module: Oracle WebCenter
Use with WLST: Online
Lists all connections of a particular type configured for the WebCenter Personalization service or lists a single connection.
Custom connection types are used with custom data providers and property locators.
listWCPSCustomConnections(type, [server], [verbose], [name], [namespace])
| Argument | Definition |
|---|---|
type
|
Custom connection type specific to the custom data provider or property locator implementation. |
server
|
Optional. Name of the Managed Server hosting the WebCenter Personalization service.
This parameter is only required in a nondefault deployment configuration. No value is required for a default deployment where the |
verbose
|
Optional. Controls verbose or concise output. Valid options are 1 and 0. When set to 1, this command lists the connections and their properties. When set to 0, this command lists connection names only. Defaults to 1. |
name
|
Optional. Name of an existing connection. If not specified or set to None, then all connections are listed. |
namespace
|
Optional. WebCenter Personalization connection namespace for the connection you want to list. If not specified or set to none, this command lists connections configured to be available in all namespaces. |
The following example lists the names of all connections with the type my.connection.type:
wls:/weblogic/serverConfig> listWCPSCustomConnections(type='my.connection.type', verbose=0)
Custom1Connection
Custom2Connection
The following example lists the details of one custom connection:
wls:/weblogic/serverConfig> listWCPSPeopleConnections(type='my.connection.type', name='CustomConnection')
----------------------
CustomConnection (type=my.connection.type, namespace=*)
----------------------
host: myhost.com
isDefault: false
port: 8888
customConnectionProperty: someValue
scheme: http
Module: Oracle WebCenter
Use with WLST: Online
Deletes a CMIS (Content Management Interoperability Service) connection configured for the WebCenter Personalization service.
deleteWCPSCMISConnection(name, [namespace, server])
| Argument | Definition |
|---|---|
name
|
Connection name. |
namespace
|
Optional. WebCenter Personalization connection namespace for the connection you want to delete. If not specified or set to none, this command deletes connections configured to be available in all namespaces. |
server
|
Optional. Name of the Managed Server hosting the WebCenter Personalization service.
This parameter is only required in a nondefault deployment configuration. No value is required for a default deployment where the |
Module: Oracle WebCenter
Use with WLST: Online
Deletes an Activity Graph connection configured for the WebCenter Personalization service.
deleteWCPSActivityGraphConnection(name, [namespace, server])
| Argument | Definition |
|---|---|
name
|
Connection name. |
namespace
|
Optional. WebCenter Personalization connection namespace for the connection you want to delete. If not specified or set to none, this command deletes connections configured to be available in all namespaces. |
server
|
Optional. Name of the Managed Server hosting the WebCenter Personalization service.
This parameter is only required in a nondefault deployment configuration. No value is required for a default deployment where the |
Module: Oracle WebCenter
Use with WLST: Online
deleteWCPSPeopleConnection(name, [namespace, server])
| Argument | Definition |
|---|---|
name
|
Connection name. |
namespace
|
Optional. WebCenter Personalization connection namespace for the connection you want to delete. If not specified or set to none, this command deletes connections configured to be available in all namespaces. |
server
|
Optional. Name of the Managed Server hosting the WebCenter Personalization service.
This parameter is only required in a nondefault deployment configuration. No value is required for a default deployment where the |
Module: Oracle WebCenter
Use with WLST: Online
deleteWCPSCustomConnection(name, type, [namespace, server])
| Argument | Definition |
|---|---|
name
|
Connection name. |
type
|
Custom connection type. |
namespace
|
Optional. WebCenter Personalization connection namespace for the connection you want to delete. If not specified or set to none, this command deletes connections configured to be available in all namespaces. |
server
|
Optional. Name of the Managed Server hosting the WebCenter Personalization service.
This parameter is only required in a nondefault deployment configuration. No value is required for a default deployment where the |
Module: Oracle WebCenter
Use with WLST: Online
Add, modify, or delete properties of an existing connection for the WebCenter Personalization service. The properties supported by a connection are specific to the connection type:
CMIS connections support the following properties: repositoryId, host, port, scheme, path, pathPrepend, servletPathPart, rewriteUrls, pathTrim, isDefault, timeoutInMillisecs, propagateTimeoutException
See also, createWCPSCMISConnection.
Activity Graph and People Connections support the following properties: host, port, scheme, restResourceIndex, rewriteUrls, pathTrim, isDefault
See also, createWCPSActivityGraphConnection and createWCPSPeopleConnection.
setWCPSConnectionProperty(connectionName, connectionType, propertyName, propertyValue, [namespace], [server])
| Argument | Definition |
|---|---|
connectionName
|
Connection name. |
connectionType
|
Connection type. Valid values are WCPS_CMIS_CONNECTION_TYPE, WCPS_AG_CONNECTION_TYPE, and WCPS_PC_CONNECTION_TYPE for CMIS, Activity Graph, and People Connections, respectively.
Alternatively, any valid, custom connection type can be specified |
propertyName
|
Property name. |
propertyValue
|
Property value as a string. Use None to remove a property value from the connection. |
namespace
|
Optional. WebCenter Personalization connection namespace for the connection you want to change. If not specified or set to none, this command modifies properties of connections configured to be available in all namespaces. |
server
|
Optional. Name of the Managed Server hosting the WebCenter Personalization service.
This parameter is only required in a nondefault deployment configuration. No value is required for a default deployment where the |
The following example changes or adds a property to a CMIS connection:
wls:/weblogic/serverConfig> setWCPSConnectionProperty(connectionName='ReposCMISConnection', connectionType=WCPS_CMIS_CONNECTION_TYPE, propertyName='propagateTimeoutExceptions', propertyValue=0)
The following example removes a property from a custom connection.:
wls:/weblogic/serverConfig> setWCPSConnectionProperty(connectionName='CustomConnection', connectionType='my.connection.type', propertyName='prop2', propertyValue=None)
Use the commands listed in Table 10-22 to manage portlet producers used in WebCenter applications.
All configuration changes made using these WebCenter WLST commands are immediately available in the WebCenter application.
Table 10-22 Producer WLST Commands
| Use this command... | To... | Use with WLST... |
|---|---|---|
|
Create and register a WSRP producer. |
Online |
|
|
Edit WSRP producer registration details. |
Online |
|
|
List WSRP producer registration details. |
Online |
|
|
Deregister a WSRP producer, and delete the associated WSRP and Web Service connections. |
Online |
|
|
List registration properties supported by a WSRP producer. |
Online |
|
|
List any user categories that the WSRP producer might support. |
Online |
|
|
Map a role that is defined in the specified application to a user category supported by a WSRP producer. |
Online |
|
|
Create and register an Oracle PDK-Java producer. |
Online |
|
|
Edit PDK-Java producer registration details. |
Online |
|
|
List registered Oracle PDK-Java producers. |
Online |
|
|
Deregister an Oracle PDK-Java producer, deleting the associated connection. |
Online |
|
|
Create and register a WebCenter Pagelet producer. |
Online |
|
|
Edit WebCenter Pagelet producer registration details. |
Online |
|
|
List WebCenter Pagelet producer registration details. |
Online |
|
|
Deregister a WebCenter Pagelet producer, deleting the associated connection. |
Online |
|
|
Refresh the metadata stored for the named producer to reflect the portlets currently offered by that producer. |
Online |
|
|
Register out-of-the-box producers provided with Oracle WebCenter. |
Online |
|
|
Deregister out-of-the-box producers provided with Oracle WebCenter. |
Online |
|
|
Register the sample producers provided with Oracle WebCenter. |
Online |
|
|
Deregister sample producers. |
Online |
Module: Oracle WebCenter
Use with WLST: Online
Creates a connection to a WSRP portlet producer and registers the WRSP producer with a named WebCenter application. When you create a WSRP producer connection, a Web Service connection is also created named <name>-wsconn where <name> is the value specified for the name argument.
registerWSRPProducer(appName, name, url, [proxyHost], [proxyPort], [timeout],[externalApp],[registrationProperties],[tokenType],[issuer],[defUser], [keyStorePath],[keyStorePswd],[sigKeyAlias],[sigKeyPswd],[encKeyAlias], [encKeyPswd],[recptAlias], [enforcePolicyURI], [server],[applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the WebCenter application in which to perform this operation. |
name
|
Connection name. The name must be unique (across all connection types) within the WebCenter application.
The name you specify here will appear in the Oracle Composer (under the Portlets folder). |
url
|
Producer WSDL URL. The syntax will vary according to your WSRP implementation, for example:
Where:
For example:
|
proxyHost
|
Optional. Host name or IP address of the proxy server.
A proxy is required when the WebCenter application and the remote portlet producer are separated by a firewall and an HTTP proxy is needed to communicate with the producer. |
proxyPort
|
Optional. Port number on which the proxy server listens. |
timeout
|
Optional. Timeout setting for communications with the producer, in seconds. For example, the maximum time the producer may take to register, deregister, or display portlets on WebCenter pages. This argument defaults to 30.
Individual portlets may define their own timeout period, which takes precedence over the value expressed here. |
registrationProperties
|
Optional. A list of registration properties and their values. The format of this argument must be a comma-separated list of valid registration properties, each followed by an equals symbol and the value. For example: name=Producer,key=123. The registration properties for a producer can be found using listWSRPProducerRegistrationProperties. See listWSRPProducerRegistrationProperties. |
tokenType
|
Optional. Type of token profile to use for authentication with this WSRP producer.
When the argument
|
tokenType
continued...
|
If the argument |
issuer
|
Optional. Name of the issuer of the token. The issuer name is the entity that vouches for the verification of the subject. For example: www.oracle.com.
This argument only applies when the tokenType is: |
defUser
|
Optional. User name to assert to the remote producer when the user is not authenticated with the WebCenter application.
When unauthenticated, the identity anonymous is associated with the application user. The value anonymous may be inappropriate for the remote producer, so you may need to specify an alternative identity here. Keep in mind though, that in this case, the WebCenter application has not authenticated the user so the default user you specify should be a low privileged user in the remote producer. If the user has authenticated to the application, the user's identity is asserted rather than the default user. This argument only applies when the tokenType is: |
extApp |
Optional. This argument applies when the tokenType is USERNAME_WITH_PASSWORD. If this producer uses an external application to store and supply user credentials for authentication, use this argument to name the associated external application. |
keyStorePath
|
Optional. Full path to the key store that contains the certificate and the private key that is used for signing some parts of the SOAP message, such as the security token and SOAP message body. The selected file should be a key store created with the Java keytool. |
keyStorePswd
|
Optional. Password to the key store that was set when the key store was created. |
sigKeyAlias
|
Optional. Identifier for the certificate associated with the private key that is used for signing. |
sigKeyPswd
|
Optional. Password for accessing the key identified by the alias that is specified using the sigKeyAlias argument. |
encKeyAlias
|
Optional. Key alias to be used for encryption. A valid value is one of the key aliases that is located in the specified key store. |
encKeyPswd
|
Optional. Password for accessing the encryption key. |
recptAlias
|
Optional. Key store alias that is associated with the producer's certificate. This certificate is used to encrypt the message to the producer.
Do not specify a recipient key alias when the |
enforcePolicyURI
|
Optional. Valid values are 1 (true) and 0 (false).When set to 1, users must specify one of the following token profiles for the tokenType argument: USERNAME_WITHOUT_PASSWORD, USERNAME_WITH_PASSWORD, SAML_TOKEN_WITH_MSG_PROTECTION, SAML_TOKEN_WITH_MSG_INTEGRITY, WSS11_SAML_TOKEN_WITH_MSG_PROTECTION,WSS10_SAML_TOKEN_ONLY
When set to The default value is |
server
|
Optional. Name of the managed server where the WebCenter application is deployed. For example, WC_Spaces.
Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the WebCenter application is deployed. |
The following example registers a WSRP producer named WSRPSamples and registers the WSRP producer with an application named webcenter.
wls:/weblogic/serverConfig> registerWSRPProducer(appName='webcenter', name='WSRPSamples', url='http://myhost.com:9999/ portletapp/portlets/wsrp2?WSDL')
The following example registers a secure WSRP producer.
wls:/weblogic/serverConfig> registerWSRPProducer(appName='webcenter', name='WSRPSamples2', url='http://myhost.com:8899/portletapp/portlets/wsrp2?WSDL', tokenType='WSS11_SAML_TOKEN_WITH_MSG_PROTECTION', issuer='www.oracle.com', defUser='anonymous', keyStorePath='/keys/mykeystore.jks', keyStorePswd='Test1', sigKeyAlias='mysigalias',sigKeyPswd='mysigpswd', encKeyAlias='myencalias', encKeyPswd='myencpswd', recptAlias='myrcptalias')
Module: Oracle WebCenter
Use with WLST: Online
setWSRPProducer(appName, name, [url], [proxyHost], [proxyPort], [timeout], [externalApp], [tokenType],[issuer], [defUser], [keyStorePath], [keyStorePswd] [sigKeyAlias], [sigKeyPswd], [encKeyAlias], [encKeyPswd], [recptAlias], [enforcePolicyURI], [server], [applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the WebCenter application in which to perform this operation. |
name
|
Name of an existing WSRP producer. |
url
|
Optional. WSRP producer URL. The syntax will vary according to your WSRP implementation, for example:
Where:
For example:
|
proxyHost
|
Optional. Host name or IP address of the proxy server.
A proxy is required when the WebCenter application and the remote portlet producer are separated by a firewall and an HTTP proxy is needed to communicate with the producer. |
proxyPort
|
Optional. Port number on which the proxy server listens. |
timeout
|
Optional. Timeout setting for communications with the producer, in seconds. For example, the maximum time the producer may take to register, deregister, or display portlets on WebCenter pages.
This argument defaults to Individual portlets may define their own timeout period, which takes precedence over the value expressed here. |
extApp |
Optional. This argument applies when the tokenType is USERNAME_WITH_PASSWORD. If this producer uses an external application to store and supply user credentials for authentication, use this argument to name the associated external application. |
tokenType
|
Optional. Type of token profile to use for authentication with this WSRP producer.
When the argument
|
tokenType
continued...
|
If the argument |
issuer
|
Optional. Name of the issuer of the token. The issuer name is the entity that vouches for the verification of the subject. For example: www.oracle.com.
This argument only applies when the tokenType is: |
defUser
|
Optional. User name to assert to the remote producer when the user is not authenticated with the WebCenter application.
When unauthenticated, the identity anonymous is associated with the application user. The value anonymous may be inappropriate for the remote producer, so you may need to specify an alternative identity here. Keep in mind though, that in this case, the WebCenter application has not authenticated the user so the default user you specify should be a low privileged user in the remote producer. If the user has authenticated to the application, the user's identity is asserted rather than the default user. This argument only applies when the tokenType is: |
keyStorePath
|
Optional. Full path to the key store that contains the certificate and the private key that is used for signing some parts of the SOAP message, such as the security token and SOAP message body. The selected file should be a key store created with the Java keytool. |
keyStorePswd
|
Optional. Password to the key store that was set when the key store was created. |
sigKeyAlias
|
Optional. Identifier for the certificate associated with the private key that is used for signing. |
sigKeyPswd
|
Optional. Password for accessing the key identified by the alias that is specified using the sigKeyAlias argument. |
encKeyAlias
|
Optional. Key alias used by the producer to encrypt the return message. A valid value is one of the key aliases that is located in the specified key store. If not specified, the producer uses the signing key for encrypting the return message. |
encKeyPswd
|
Optional. Password for accessing the encryption key. |
recptAlias
|
Optional. Key store alias that is associated with the producer's certificate. This certificate is used to encrypt the outbound message to the producer.
Do not specify a recipient key alias when the |
enforcePolicyURI
|
Optional. Valid values are 1 (true) and 0 (false).When set to 1, users must specify one of the following token profiles for the tokenType argument: USERNAME_WITHOUT_PASSWORD, USERNAME_WITH_PASSWORD, SAML_TOKEN_WITH_MSG_PROTECTION, SAML_TOKEN_WITH_MSG_INTEGRITY, WSS11_SAML_TOKEN_WITH_MSG_PROTECTION, WSS10_SAML_TOKEN_ONLY
When set to The default value is |
server
|
Optional. Name of the managed server where the WebCenter application is deployed. For example, WC_Spaces.
Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the WebCenter application is deployed. |
This example increases the timeout, for the WSRPSamples producer, to 60 seconds.
wls:/weblogic/serverConfig>setWSRPProducer(appName='webcenter', name='WSRPSamples', timeout=60)
This example updates security properties on a secure WSRP producer.
wls:/weblogic/serverConfig>setWSRPProducer(appName='webcenter', name='WSRPSamples2', tokenType='WSS11_SAML_TOKEN_WITH_MSG_PROTECTION', issuer='www.oracle.com', defUser='anonymous', keyStorePath='/keys/mykeystore.jks', keyStorePswd='Test1', sigKeyAlias='mysigalias', sigKeyPswd='mysigpswd',encKeyAlias='myencalias', encKeyPswd='myencpswd', recptAlias='myrcptalias')
This example removes all the security properties set on a secure WSRP producer.
wls:/weblogic/serverConfig>setWSRPProducer(appName='webcenter', name='WSRPSamples2', tokenType='')
Module: Oracle WebCenter
Use with WLST: Online
listWSRPProducers(appName,[name],[verbose], [server], [applicationVersion])
| Argument | Definition |
|---|---|
appName
|
The name of the application in which one or more WSRP producers is registered. |
name
|
Optional. Name of an existing WSRP producer. If omitted, connection details for all WSRP producers configured for this WebCenter application are listed. |
verbose
|
Optional. Displays WSRP producer connection details in verbose mode. Valid options are 1 (true) and 0 (false). When set to 1, listWSRPProducers lists all connection properties. When set to 0, listWSRPProducers lists connection names only. This argument defaults to 1.
If you set this argument to |
server
|
Optional. Name of the managed server where the WebCenter application is deployed. For example, WC_Spaces.
Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the WebCenter application is deployed. |
Module: Oracle WebCenter
Use with WLST: Online
Deregisters a WSRP producer, and deletes the associated WSRP and Web Service connections.
deregisterWSRPProducer(appName, name, [server], [applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the WebCenter application where the producer is registered. |
name
|
Name of an existing WSRP producer. |
server
|
Optional. Name of the managed server where the WebCenter application is deployed. For example, WC_Spaces.
Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the WebCenter application is deployed. |
Module: Oracle WebCenter
Use with WLST: Online
listWSRPProducerRegistrationProperties(appName, url,[proxyHost, [proxyPort], [server], [applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the WebCenter application in which to perform this operation. |
url
|
WSRP producer URL. The syntax will vary according to your WSRP implementation, for example:
Where:
For example:
|
proxyHost
|
Optional. Host name or IP address of the proxy server.
A proxy is required when the WebCenter application and the remote portlet producer are separated by a firewall and an HTTP proxy is needed to communicate with the producer. |
proxyPort
|
Optional. Port number on which the proxy server listens. |
server
|
Optional. Name of the managed server where the WebCenter application is deployed. For example, WC_Spaces.
Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the WebCenter application is deployed. |
The following example lists valid registration properties for the WSRP producer with the WSDL URL provided.
wls:/weblogic/serverConfig> listWSRPProducerRegistrationProperties (appName='webcenter', url='http://myhost:9999/portletapp/portlets/wsrp2?WSDL') Registration Property hint : hint text Registration Property label : label text Registration Property language : en Registration Property name : {urn:xyz:wlp:prop:reg:registration}consumerRole Registration Property value : None
Module: Oracle WebCenter
Use with WLST: Online
Lists any user categories that a WSRP producer might support. WebCenter users can use the WLST command mapWSRPProducerUserCategory to map application roles to a producer's user category.
listWSRPProducerUserCategories(appName, name, [server], [applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the WebCenter application in which to perform this operation. |
name
|
Name of an existing WSRP producer. |
server
|
Optional. Name of the managed server where the WebCenter application is deployed. For example, WC_Spaces.
Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the WebCenter application is deployed. |
The following example displays the categories associated with a WSRP producer named WSRPSamples.
wls:/weblogic/serverConfig> listWSRPProducerUserCategories(appName='webcenter', name='WSRPSamples') User Category Name : categoryTwo User Category Description : Custom role two. User Category Mapped Local Roles : None User Category Name : categoryOne User Category Description : Custom role one. User Category Mapped Local Roles : None
Module: Oracle WebCenter
Use with WLST: Online
Maps a role that is defined in the specified WebCenter application to a user category supported by a WSRP producer. The user categories may be found using listWSRPProducerUserCategories.
mapWSRPProducerUserCategory(appName, name, localRole, producerUserCategory, [server], [applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the WebCenter application in which to perform this operation. |
name
|
Name of an existing WSRP producer. |
localRole
|
Name of the WebCenter application role to be mapped. |
producerUserCategory
|
WSRP producer user category to which the WebCenter role will be mapped. |
server
|
Optional. Name of the managed server where the WebCenter application is deployed. For example, WC_Spaces.
Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the WebCenter application is deployed. |
Module: Oracle WebCenter
Use with WLST: Online
Creates a connection to an Oracle PDK-Java portlet producer and registers the Oracle PDK-Java producer with a named WebCenter application.
registerPDKJavaProducer(appName, name, url, [serviceId], [proxyHost, [proxyPort]], [subscriberId], [sharedKey], [timeout], [establishSession],[externalApp], [mapUser], [server], [applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the WebCenter application for which to perform this operation. |
name
|
Connection name. The name must be unique (across all connection types) within the WebCenter application. |
url
|
URL for the Oracle PDK-Java producer. Use the following syntax:
Where:
For example:
|
serviceId
|
Optional. Service ID of the producer.
PDK-Java enables you to deploy multiple producers under a single adapter servlet. Producers are identified by their unique service ID. A service ID is required only if the service ID is not appended to the URL end point. For example, the following URL endpoint requires
However, the following URL endpoint, does not require a service ID:
The service ID is used to look up a file called |
proxyHost
|
Optional. Host name or IP address of the proxy server.
A proxy is required if the WebCenter application and the remote portlet producer are separated by a firewall and an HTTP proxy is needed for communication with the producer. |
proxyPort
|
Optional. Port number on which the proxy server listens. This argument defaults to 80. |
sharedKey
|
Optional. Shared key used for message authentication with the remote producer. Message authentication ensures that the incoming messages are sent from a host with a shared key. This argument defaults to null.
The shared key can contain between 10 and 20 alphanumeric characters. |
subscriberId
|
Optional. Consumer's identifier, if required.
When a producer is registered with an application, a call is made to the producer. During the call, the consumer (WebCenter application in this instance) passes the value for subscriberId to the producer. The producer may be coded to use the subscriber ID. |
timeout
|
Optional. Timeout setting for communications with the producer, in seconds. For example, the maximum time the producer may take to register, deregister, or display portlets on WebCenter pages.
This argument defaults to Individual portlets may define their own timeout period, which takes precedence over the value expressed here. |
establishSession
|
Optional. Enable a user session when executing portlets from this producer. Valid values are 1 (true) and 0 (false). The default for this argument is 0.
When sessions are enabled ( |
externalApp
|
Optional. Name of the external application with which to associate the producer. Required if one of this producer's portlets requires authentication. |
mapUser
|
Optional. Flag indicating whether the mapped user name from the external application should be passed to the producer. Valid values are 1 (true) and 0 (false). This argument defaults to 1. |
server
|
Optional. Name of the managed server where the WebCenter application is deployed. For example, WC_Spaces.
Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the WebCenter application is deployed. |
Module: Oracle WebCenter
Use with WLST: Online
setPDKJavaProducer(appName, name, url, [serviceId], [proxyHost, [proxyPort]], [subscriberId], [sharedKey], [timeout], [establishSession], [externalApp], [mapUser], [server], [applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the WebCenter application in which to perform this operation. |
name
|
Name of an existing PDK-Java producer. |
url
|
URL for the Oracle PDK-Java producer. Use the following syntax:
Where:
For example:
|
serviceId
|
Optional. Service ID of the producer.
PDK-Java enables you to deploy multiple producers under a single adapter servlet. Producers are identified by their unique service ID. A service ID is required only if the service ID is not appended to the URL end point. For example the following URL endpoint requires
However, the following URL endpoint, does not require a service ID:
The service ID is used to look up a file called |
proxyHost
|
Optional. Host name or IP address of the proxy server.
A proxy is required if the WebCenter application and the remote portlet producer are separated by a firewall and an HTTP proxy is needed for communication with the producer. |
proxyPort
|
Optional. Port number on which the proxy server listens. |
subscriberId
|
Optional. Consumer's identifier, if required.
When a producer is registered with an application, a call is made to the producer. During the call, the consumer (WebCenter application in this instance) passes the value for Subscriber ID to the producer. If the producer does not see the expected value for Subscriber ID, it might reject the registration call. |
sharedKey
|
Optional. The shared key is used for message authentication with the remote producer. Message authentication ensures that the incoming messages are sent from a host with a shared key. You should enable sessions using the sharedKey argument, as well as the establishSession argument. |
timeout
|
Optional. Timeout setting for communications with the producer, in seconds. For example, the maximum time the producer may take to register, deregister, or display portlets on WebCenter pages.
Individual portlets may define their own timeout period, which takes precedence over the value expressed here. |
establishSession
|
Optional. Enable a user session when executing portlets from this producer. Valid values are 1 (true) and 0 (false). You should enable sessions using the establishSession argument, as well as the sharedKey argument.
When sessions are enabled ( |
externalApp
|
Optional. Name of the external application associated with this producer. |
mapUser
|
Optional. Flag indicating whether the mapped user name from the external application should be passed to the producer. Valid values are 1 (true) and 0 (false). |
server
|
Optional. Name of the managed server where the WebCenter application is deployed. For example, WC_Spaces.
Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the WebCenter application is deployed. |
Module: Oracle WebCenter
Use with WLST: Online
Deregisters an Oracle PDK-Java producer and deletes the associated connection, for a named WebCenter application.
deregisterPDKJavaProducer(appName, name, [server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the WebCenter application in which to perform this operation. |
name
|
Name of an existing PDK-Java producer. |
server
|
Optional. Name of the managed server where the WebCenter application is deployed. For example, WC_Spaces.
Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the WebCenter application is deployed. |
The following example deregisters the wc-WebClipping producer, and deletes the associated connection.
wls:/weblogic/serverConfig> deregisterPDKJavaProducer(appName='webcenter', name='wc-WebClipping') Already in Domain Runtime Tree Producer wc-WebClipping has been deregistered. Already in Domain Runtime Tree "wc-WebClipping" successfully deleted Already in Domain Runtime Tree "wc-WebClipping-urlconn" successfully deleted
Module: Oracle WebCenter
Use with WLST: Online
Lists details for one or more Oracle PDK-Java producers registered with a named WebCenter application.
listPDKJavaProducers(appName, [name],[verbose], [server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the WebCenter application in which to perform this operation. |
name
|
Optional. Name of an existing PDK-Java portlet producer. If omitted, connection details for all PDK-Java producers configured for this WebCenter application are listed. |
verbose
|
Optional. Displays PDK-Java producer connection details in verbose mode. Valid options are 1 (true) and 0 (false). When set to 1, listPDKJavaProducers lists all connection properties. When set to 0, listPDKJavaProducers lists connection names only. This argument defaults to 1.
If you set this argument to |
server
|
Optional. Name of the managed server where the WebCenter application is deployed. For example, WC_Spaces.
Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the WebCenter application is deployed. |
The following example lists all the connection properties (verbose mode) for the JPDKSamples producer.
wls:/weblogic/serverConfig> listPDKJavaProducers(appName='webcenter', name='JPDKSamples', verbose=1) ---------------------- wc-WebClipping ---------------------- Service Id: None Shared Key: None External Application Id: None Subscriber Id: None URL: http://myhost.com:9999/portalTools/webClipping/providers/webClipping ---------------------- wc-OmniPortlet ---------------------- Service Id: None Shared Key: None External Application Id: None Subscriber Id: None URL: http://myhost:9999/portalTools/omniPortlet/providers/omniPortlet
Module: Oracle WebCenter
Use with WLST: Online
registerPageletProducer(appName, name, url, [server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the WebCenter application for which to perform this operation. |
name
|
Connection name. The name must be unique (across all connection types) within the WebCenter application.
The name you specify here appears in Oracle Composer under the Mash-ups >Pagelet Producers folder (by default). |
url
|
URL required to access the server providing WebCenter Pagelet producer services. Use the syntax:
The URL must include a fully-qualified domain name. For example:
If pagelets carry secure data, the URL registered must use the
|
server
|
Optional. Name of the managed server where the WebCenter application is deployed. For example, WC_Spaces.
Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the WebCenter application is deployed. |
Module: Oracle WebCenter
Use with WLST: Online
setPageletProducer(appName, name, [url, server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the WebCenter application in which to perform this operation. |
name
|
Name of an existing WebCenter Pagelet producer connection. |
url
|
Optional. URL required to access the server providing WebCenter Pagelet producer services. Use the syntax:
The URL must include a fully-qualified domain name. For example:
|
server
|
Optional. Name of the managed server where the WebCenter application is deployed. For example, WC_Spaces.
Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the WebCenter application is deployed. |
Module: Oracle WebCenter
Use with WLST: Online
Lists connection details for one or all WebCenter Pagelet producers registered with a named WebCenter application.
listPageletProducers(appName, [name],[verbose], [server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the WebCenter application in which to perform this operation. |
name
|
Optional. Name of an existing WebCenter Pagelet producer connection. Use this argument to view connection details for a specific pagelet producer.
If omitted, connection details for all WebCenter Pagelet producers configured for this WebCenter application are listed. |
verbose
|
Optional. Displays WebCenter Pagelet producer connection details in verbose mode. Valid options are 1 (true) and 0 (false). When set to 1, listPageletProducers lists all connection properties. When set to 0, listPageletProducers lists connection names only. This argument defaults to 1.
If you set this argument to |
server
|
Optional. Name of the managed server where the WebCenter application is deployed. For example, WC_Spaces.
Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the WebCenter application is deployed. |
The following example lists connection names and details for all WebCenter Pagelet producers currently registered for a WebCenter application name MyWebCenterApp:
wls:/weblogic/serverConfig> listPageletProducers(appName='MyWebCenterApp', verbose=1) ---------------------- MyPageletProducer ---------------------- URL: http://myhost.com:7001 ---------------------- TestPageletProducer ---------------------- URL: http://testhost.com:7002 ----------------------
The following example displays details for a single WebCenter Pagelet producer connection named MyPageletProducer:
wls:/weblogic/serverConfig> listPageletProducers(appName='webcenter', name='MyPageletProducer', verbose=1) ---------------------- MyPageletProducer ---------------------- URL: http://myhost.com:7001
Module: Oracle WebCenter
Use with WLST: Online
Deregisters a WebCenter Pagelet producer currently registered with a named WebCenter application.
deregisterPageletProducer(appName, name, [server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the WebCenter application in which to perform this operation. |
name
|
Name of an existing WebCenter Pagelet producer connection. |
server
|
Optional. Name of the managed server where the WebCenter application is deployed. For example, WC_Spaces.
Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the WebCenter application is deployed. |
Module: Oracle WebCenter
Use with WLST: Online
Refreshes the metadata stored for a named producer to reflect the portlets that are currently offered by that producer.
refreshProducer(appName, producerName, [server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the WebCenter application in which the producer is registered. |
producerName
|
Name of an existing producer. |
server
|
Optional. Name of the managed server where the WebCenter application is deployed. For example, WC_Spaces.
Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the WebCenter application is deployed. |
Module: Oracle WebCenter
Use with WLST: Online
Registers several out-of-the-box producers provided with Oracle WebCenter: OmniPortlet, Web Clipping, and WSRP Tools.
registerOOTBProducers(producerHost, producerPort, appName, [server, applicationVersion])
| Argument | Definition |
|---|---|
producerHost
|
Host name or IP address of the server hosting out-of-the-box producers. |
producerPort
|
Port number for the server hosting out-of-the-box producers. |
appName
|
Name of the WebCenter application in which the out-of-the-box producers are to be registered. |
server
|
Optional. Name of the managed server where the WebCenter application is deployed. For example, WC_Spaces.
Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the WebCenter application is deployed. |
The following example registers out-of-the-box producers in a WebCenter application named myApp.
wls:/weblogic/serverConfig> registerOOTBProducers(producerHost='myhost.com', producerPort=9999, appName='myApp') Registering Out-of-the-Box Producers Registering producers at http://myhost.com:9999 Registering Omniportlet Created connection wc-OmniPortlet-urlconn Created connection wc-OmniPortlet Producer connection wc-OmniPortlet has been registered. Registering WebClipping Created connection wc-WebClipping-urlconn Created connection wc-WebClipping Producer connection wc-WebClipping has been registered. Registering WSRP Tools Created connection wc-WSRPTools-wsconn Created connection wc-WSRPTools Producer connection wc-WSRPTools has been registered.
Module: Oracle WebCenter
Use with WLST: Online
Deregisters out-of-the-box producers provided with Oracle WebCenter: OmniPortlet, Web Clipping, and WSRP Tools.
deregisterOOTBProducers(appName, [server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the WebCenter application in which the out-of-the-box producers are currently registered. |
server
|
Optional. Name of the managed server where the WebCenter application is deployed. For example, WC_Spaces.
Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the WebCenter application is deployed. |
The following example deregisters out-of-the-box WebCenter producers, and deletes their associated connections, in an application named myApp.
wls:/weblogic/serverConfig> deregisterOOTBProducers(appName='myApp')
Deregistering Out-of-the-Box Producers
Deregistering Omniportlet
Producer wc-OmniPortlet has been deregistered.
wc-OmniPortlet successfully deleted
wc-OmniPortlet-urlconn successfully deleted
Deregistering WebClipping
Producer wc-WebClipping has been deregistered.
wc-WebClipping successfully deleted
wc-WebClipping-urlconn successfully deleted
Deregistering WSRP Tools
Producer wc-WSRPTools has been deregistered.
wc-WSRPTools successfully deleted
wc-WSRPTools-wsconn successfully deleted
Module: Oracle WebCenter
Use with WLST: Online
Registers the sample producers provided with Oracle WebCenter with a named WebCenter application. There are two sample producers — WSRP Samples and JPDK Samples.
registerSampleProducers(producerHost, producerPort, appName, [server, applicationVersion])
| Argument | Definition |
|---|---|
producerHost
|
Host name or IP address of the server hosting the sample producers. |
producerPort
|
Port number for the server hosting the sample producers. |
appName
|
Name of the WebCenter application in which the sample producers are to be registered. |
server
|
Optional. Name of the managed server where the WebCenter application is deployed. For example, WC_Spaces.
Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the WebCenter application is deployed. |
Module: Oracle WebCenter
Use with WLST: Online
Deregisters the Oracle WebCenter sample producers (WSRP Samples and JPDK Samples) from a named WebCenter application.
deregisterSampleProducers(appName, [server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the WebCenter application in which the sample producers are currently registered. If a value is not specified, this argument defaults to webcenter. |
server
|
Optional. Name of the managed server where the WebCenter application is deployed. For example, WC_Spaces.
Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the WebCenter application is deployed. |
Use the commands listed in Table 10-23 to manage proxy settings for the RSS service.
Configuration changes made using these WebCenter WLST commands are only effective after your restart the Managed Server on which the WebCenter application is deployed. For details, see Oracle Fusion Middleware Administrator's Guide for Oracle WebCenter.
| Use this command... | To... | Use with WLST... |
|---|---|---|
|
Return the proxy host and proxy port used by the RSS service. |
Online |
|
|
Specify the proxy host and proxy port used by the RSS service. |
Online |
|
|
Delete proxy host and proxy port settings. |
Online |
Module: Oracle WebCenter
Use with WLST: Online
Returns the proxy host and proxy port used by the RSS service. Depending on your network configuration, proxy details may be required to display external RSS news feeds in your WebCenter application.
getRssProxyConfig(appName, [server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the WebCenter application in which to perform this operation. |
server
|
Optional. Name of the managed server where the WebCenter application is deployed. For example, WC_Spaces.
Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the WebCenter application is deployed. |
Module: Oracle WebCenter
Use with WLST: Online
Specifies the proxy host and port for the RSS service. Depending on your network configuration, proxy details may be required to display external RSS news feeds in your WebCenter application.
setRssProxyConfig(appName, proxyHost, proxyPort, [server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the WebCenter application in which to perform this operation. |
proxyHost
|
Host name of the proxy server. |
proxyPort
|
Port on which the proxy server is running. |
server
|
Optional. Name of the managed server where the WebCenter application is deployed. For example, WC_Spaces.
Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the WebCenter application is deployed. |
Module: Oracle WebCenter
Use with WLST: Online
unsetRssProxyConfig(appName, [server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the WebCenter application in which to perform this operation. |
server
|
Optional. Name of the managed server where the WebCenter application is deployed. For example, WC_Spaces.
Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the WebCenter application is deployed. |
Use the commands listed in Table 10-24 to manage Oracle Secure Enterprise Search (SES) connections and other Oracle SES search related properties for WebCenter applications.
Configuration changes made using these WebCenter WLST commands are only effective after your restart the Managed Server on which the WebCenter application is deployed. For details, see Oracle Fusion Middleware Administrator's Guide for Oracle WebCenter.
Table 10-24 Search - Oracle SES WLST Commands
| Use this command... | To... | Use with WLST... |
|---|---|---|
|
Create a connection to an Oracle SES instance for a WebCenter application. |
Online |
|
|
Edit an existing Oracle SES search connection. |
Online |
|
|
List individual or all Oracle SES search connections that are configured for a specific WebCenter application. |
Online |
|
|
Configure search settings for an existing Oracle SES search connection. |
Online |
|
|
List Oracle SES properties for a WebCenter application. |
Online |
|
|
Create a federation trusted entity on an Oracle (SES) instance. |
Online |
Module: Oracle WebCenter
Use with WLST: Online
Creates a connection to an Oracle Secure Enterprise Search (SES) instance for a WebCenter application.
createSESConnection(appName, name, url, appUser, appPassword,[default], [server], [applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the WebCenter application in which to perform this operation. |
name
|
Connection name. The name must be unique (across all connection types) within the WebCenter application. |
url
|
Web Services URL that Oracle Secure Enterprise Search exposes to enable Search requests.
Use the format: |
appUser
|
User name that the WebCenter application uses to authenticate itself as a trusted application to Oracle Secure Enterprise Search so that it may perform searches on behalf of WebCenter users.
The specified user must be present in both the Oracle Identity Management server configured for the WebCenter application and the Oracle Identity Management server configured for Oracle SES. |
appPassword
|
Password for the user name specified. |
default
|
Optional. Configures WebCenter Search service to actively use the search connection. Valid options are 1 (true) and 0 (false).
Setting to |
server
|
Optional. Name of the managed server where the WebCenter application is deployed. For example, WC_Spaces.
Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the WebCenter application is deployed. |
The following example creates a new search connection that points to the SES instance http://myhost.com:7777/search/query/OracleSearch and makes this connection the active SES search connection for a WebCenter application named app1.
wls:/weblogic/serverConfig> createSESConnection(appName='app1', name='SESConn1', url='http://myhost.com:7777/search/query/OracleSearch', appUser='wpadmin', appPassword='password', default=1)
Module: Oracle WebCenter
Use with WLST: Online
setSESConnection(appName, name, [url], [appUser],[appPassword],[default], [server], [applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the WebCenter application in which to perform this operation. |
name
|
Name of an existing search connection. |
url
|
Optional. Web Services URL that Oracle Secure Enterprise Search exposes to enable Search requests.
Use the format: |
appUser
|
Optional. User name that the WebCenter application uses to log in to Oracle Secure Enterprise Search so that it may perform searches on behalf of WebCenter users. |
appPassword
|
Optional. Password that the WebCenter application uses to log in to Oracle Secure Enterprise Search so that it may perform searches on behalf of WebCenter users. |
default
|
Optional. Configures WebCenter Search service to actively use the search connection. Valid options are 1 (true) and 0 (false).
Setting to |
server
|
Optional. Name of the managed server where the WebCenter application is deployed. For example, WC_Spaces.
Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the WebCenter application is deployed. |
The following example modifies the URL of a search connection named SESConn1 and makes the connection the active SES search connection for a WebCenter application named app1.
wls:/weblogic/serverConfig> setSESConnection(appName='app1', name='SESConn1', url='http://myhost.com:7777/search/query/OracleSearch', appUser='wpadmin', appPassword='password', default=1)
Module: Oracle WebCenter
Use with WLST: Online
Lists the names of all Oracle Secure Enterprise Search (SES) search connections configured for a WebCenter application.
listSESConnections(appName, [verbose], [name], [server], [applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the WebCenter application for which to perform this operation. |
verbose
|
Optional. Displays search connection details in verbose mode. Valid options are 1 (true) and 0 (false). When set to 1, listSESConnections lists all of the SES search connections that are configured for a WebCenter application, along with their details. When set to 0, listSESConnections lists connection names only. This argument defaults to 0.
If you set this argument to |
name
|
Optional. Name of an existing search connection. You can use this argument to view details about a specific connection. |
server
|
Optional. Name of the managed server where the WebCenter application is deployed. For example, WC_Spaces.
Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the WebCenter application is deployed. |
The following example displays connection details for all SES search connections configured for a WebCenter application named WebCenterApp.
wls:/weblogic/serverConfig> listSESConnections(appName='WebCenterApp', verbose=1)
The following example displays connection details for an SES search connection named SESConn1.
wls:/weblogic/serverConfig> listSESConnections(appName='WebCenterApp', verbose=1, name='SESConn1')
Module: Oracle WebCenter
Use with WLST: Online
Configures search settings for an existing Oracle Secure Enterprise Search (SES) search connection. If a parameter is not specified it is not modified.
setSearchSESConfig(appName,[connectionName],[dataGroup],[topNRows], [server], [applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the WebCenter application in which to perform this operation. |
connectionName
|
Optional. Names the search connection that the Search service must use. |
dataGroup
|
Optional. Names the Secure Enterprise Search data group in which to search. If a value is not provided, everything in the Oracle Secure Enterprise Search instance will be searched. |
topNRows
|
Optional. Number of top N rows of search results for gathering refinement data. |
server
|
Optional. Name of the managed server where the WebCenter application is deployed. For example, WC_Spaces.
Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the WebCenter application is deployed. |
The following example specifies that the Search service must use the SES search connection named SESConn1, and to search the data group named group2.
wls:/weblogic/serverConfig> setSearchSESConfig (appName='webcenter',connectionName='SESConn1', dataGroup='group2', topNRows=200);
The following example changes the maximum number of search results that the Search service returns. No connection name is specified, in this example, so this configuration change is applied to the current default (or active) search connection.
wls:/weblogic/serverConfig> setSearchSESConfig(appName='webcenter', topNRows=500);
Already in Domain Runtime Tree
Restart is needed for the service connection changes to take effect.
Module: Oracle WebCenter
Use with WLST: Online
listSearchSESConfig(appName, [server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the WebCenter application for which to perform this operation. |
server
|
Optional. Name of the managed server where the WebCenter application is deployed. For example, WC_Spaces.
Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the WebCenter application is deployed. |
The following example displays SES search configuration information for a WebCenter application named webcenter.
wls:/weblogic/serverConfig> listSearchSESConfig(appName='webcenter')
Already in Domain Runtime Tree
-----------------
Search SES Config
-----------------
connectionName: SESConn1
dataGroup: group2
topNRows: 200
Module: Oracle WebCenter
Use with WLST: Online
Creates a federation trusted entity on an Oracle Secure Enterprise Search (SES) instance for a given entity name and password.
createFederationTrustedEntity(appName, sesUrl, sesPassword, entityName, entityPassword, desc, [server], [applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the WebCenter application for which to perform this operation. |
sesUrl
|
Web Service URL for the Oracle SES Administration API.
Use the format: |
sesPassword
|
Password for the Oracle SES administrative user (eqsys). |
entityName
|
Entity name. |
entityPassword
|
Entity password. |
desc
|
Short description of the entity.
Alternatively, specify an empty string |
server
|
Optional. Name of the managed server where the WebCenter application is deployed. For example, WC_Spaces.
Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the WebCenter application is deployed. |
The following example creates a federation trusted entity named myentity on the Oracle SES instance http://myseshost.com:7777:
wls:/weblogic/serverConfig> createFederationTrustedEntity(appName='webcenter', sesUrl='http://myseshost.com:7777/search/api/admin/AdminService', sesPassword='password', entityName='myentity', entityPassword='password', desc='This is a sample entity')
Use the commands listed in Table 10-25 to manage Oracle Secure Enterprise Search (SES) crawlers for WebCenter applications.
There is no need to restart your WebCenter application after running crawler WLST commands.
Table 10-25 Search - Oracle SES Crawler WLST Commands
| Use this command... | To... | Use with WLST... |
|---|---|---|
|
Create a crawler for WebCenter Spaces objects on an Oracle SES instance. |
Online |
|
|
Create a documents crawler for a WebCenter application, on an Oracle SES instance. |
Online |
|
|
Create a discussions crawlers and an announcement crawler for a WebCenter application, on an Oracle SES instance. |
Online |
|
|
Return the WebCenter Spaces crawler configured for a WebCenter Spaces application, on an Oracle SES instance. |
Online |
|
|
Return the documents crawler configured for a WebCenter application, on an Oracle SES instance. |
Online |
|
|
Return the discussion and announcement crawlers configured for a WebCenter application, on an Oracle SES instance. |
Online |
|
|
Start the WebCenter Spaces crawler configured for a WebCenter Spaces application, on an Oracle SES instance. |
Online |
|
|
Start the documents crawler configured for a WebCenter application, on an Oracle SES instance. |
Online |
|
|
Start the discussion and announcement crawlers configured for a WebCenter application, on an Oracle SES instance. |
Online |
|
|
Stop the WebCenter Spaces crawler configured for a WebCenter Spaces application, on an Oracle SES instance. |
Online |
|
|
Stop the documents crawler configured for a WebCenter application, on an Oracle SES instance. |
Online |
|
|
Stop discussion and announcement crawlers configured for a WebCenter application, on an Oracle SES instance. |
Online |
|
|
Delete the WebCenter Spaces crawler configured for a WebCenter Spaces application, on an Oracle SES instance. |
Online |
|
|
Delete the documents crawler configured for a WebCenter application, on an Oracle SES instance. |
Online |
|
|
Delete discussion and announcement crawlers configured for a WebCenter application, on an Oracle SES instance. |
Online |
Module: Oracle WebCenter
Use with WLST: Online
Creates a crawler for WebCenter Spaces objects on an Oracle SES instance. The command creates a WebCenter datasource and specifies a schedule for crawling WebCenter Spaces objects (such as Spaces, lists, pages, and people).
createSpacesCrawler(appName, host, port, sesUrl, sesPassword, crawlUser, crawlPassword, scratchDir, authUserIdFormat, crawlingMode, recrawlPolicy, freqType, startHour, hoursBetweenLaunches, startDayOfWeek, startDayOfMonth, daysBetweenLaunches, weeksBetweenLaunches, monthsBetweenLaunches, [server, applicationVersion])
| Argument | Definition |
|---|---|
appName |
Name of the WebCenter Spaces application in which to perform this operation. For WebCenter Spaces, the name is always webcenter. |
host |
Host name of the machine where the WebCenter application is running. |
port |
Port number used to access the WebCenter application. |
sesUrl |
Web Service URL for the Oracle SES Administration API. Use the format: http://<host>:<port>/search/api/admin/AdminService |
sesPassword |
Password for the Oracle SES administrative user (eqsys). |
crawlUser |
Crawl administration user in WebCenter Spaces.
This user must exist in WebCenter Spaces and in your back-end identity management server with appropriate permissions and roles. For example: |
crawlPassword |
Password for the WebCenter Spaces user that is specified in the crawlUser argument. |
scratchDir |
Local directory where Oracle SES can write temporary status logs. The directory must be on the system where Oracle SES is installed. |
authUserIdFormat |
Format of the user ID in the active identity plug-in. For example, username, email, nickname, user_name. |
crawlingMode |
Mode for crawling URLs in the source. Valid values are: ACCEPT_ALL, INDEX_ONLY, EXAMINE_URL:
ACCEPT_ALL—Automatically Accept All URLs for Indexing: Crawls and indexes all URLs in the source. It also extracts and indexes any links found in those URLs. Previously crawled URLs are only reindexed if they have changed. EXAMINE_URL—Examine URLs Before Indexing: Crawls but does not index any URLs in the source. It also crawls any links found in those URLs. INDEX_ONLY—Index Only: Crawls and indexes all URLs in the source. It does not extract any links found in those URLs. Select this option for a source previously crawled using EXAMINE_URL. |
recrawlPolicy |
Specifies whether to crawl all documents or only documents that have changed. Valid values are PROCESS_ALL and PROCESS_CHANGED:
PROCESS_ALL—All documents are crawled. Use this option to force a full crawl. PROCESS_CHANGED—Only crawl documents that have changed since the previous crawl. This setting can significantly speed up the crawling process. |
freqType |
Frequency of scheduled crawls. Valid values are: MANUAL, MONTHLY, WEEKLY, DAILY, HOURLY.
To schedule crawls MONTHLY, WEEKLY, DAILY, or HOURLY, specify additional arguments as follows: MONTHLY: startHour, startDayOfTheMonth, monthsBetweenLaunches WEEKLY: startHour, startDayOfTheWeek, weeksBetweenLaunches DAILY: startHour, daysBetweenLaunches HOURLY: hoursBetweenLaunches If regular crawls are not required, choose |
startHour |
Time to start the crawl. Any number between 1 and 24.
For example, enter 2 for 2:00am, 14 for 2:00pm, and so on. |
hoursBetweenLaunches |
Number of hours between crawls.
Only valid when |
startDayOfWeek |
Day on which to start a weekly crawl. For example, MONDAY, TUESDAY, and so on.
Only valid when |
startDayOfMonth |
Day of the month on which to start a monthly crawl. For example, enter 1 for 1st day of the month, 2 for 2nd day of the month, and so on.
Only valid when |
daysBetweenLaunches |
Number of days between crawls.
Only valid when |
weeksBetweenLaunches |
Number of weeks between crawls.
Only valid when |
monthsBetweenLaunches |
Number of months between crawls.
Only valid when |
server
|
Optional. Name of the managed server where the WebCenter application is deployed. For example, WC_Spaces.
Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the WebCenter application is deployed. |
The following example creates a WebCenter Spaces crawler on the SES instance http://myseshost.com:7777 for a WebCenter Spaces application (webcenter) located at http://myhost.com:8888/webcenter/spaces:
createSpacesCrawler(appName='webcenter', host='myhost.com', port='8888', sesUrl='http://myseshost.com:7777/search/api/admin/AdminService', sesPassword='sespassword', crawlUser='mycrawladmin', crawlPassword='password', scratchDir'/tmp', authUserIdFormat='username', crawlingMode='ACCEPT_ALL', recrawlPolicy= 'PROCESS_ALL', freqType='MANUAL', startHour=1, hoursBetweenLaunches=1, startDayOfWeek='MONDAY', startDayOfMonth=1, daysBetweenLaunches =1, weeksBetweenLaunches=1, monthsBetweenLaunches=1)
Module: Oracle WebCenter
Use with WLST: Online
Creates a documents crawler for a WebCenter application, on an Oracle SES instance.
The command creates an Oracle Content Server datasource and specifies a schedule for crawling documents in Oracle Universal Content Server (UCM).
createDocumentsCrawler(appName, host, port, sesUrl, sesPassword, configUrl, user, password, scratchDir, httpEndpoint, displayUrl, realm, authUserIdFormat, pipelineName, crawlingMode, recrawlPolicy, freqType, startHour, hoursBetweenLaunches, startDayOfWeek, startDayOfMonth, daysBetweenLaunches, weeksBetweenLaunches, monthsBetweenLaunches, [server, applicationVersion])
| Argument | Definition |
|---|---|
appName |
Name of the WebCenter application in which to perform this operation. |
host |
Host name of the machine where the WebCenter application is running. |
port |
Port number used to access the WebCenter application. |
sesUrl |
Web Service URL for the Oracle SES Administration API. Use the format: http://<host>:<port>/search/api/admin/AdminService |
sesPassword |
Password for the Oracle SES administrative user (eqsys). |
configUrl |
URL of the XML configuration file providing details of the source, such as the data feed type, location, security attributes, and so on.Use the URL format: http://<host>:<port>/cs /idcplg? IdcService=SES_CRAWLER_DOWNLOAD_CONFIG &source=<sourcename> |
user |
Administrative user for Oracle Content Server (OCS). For example, sysadmin.
If the authentication type is Oracle SSO, then enter a user ID (and password) of a user in the identity management server fronted by Oracle SSO. This user must be granted the same permissions as |
password |
Password for the administrative OCS user specified. |
scratchDir |
Local directory where Oracle SES can write temporary status logs. The directory must be on the system where Oracle SES is installed. |
httpEndpoint |
HTTP endpoint for Oracle Content Server authorization. For example: http://<host>:<port>/idc/idcplg |
displayUrl |
HTTP host information string to prefix the relative access URL to form the complete display URL. For example: http://<host>:<port>/idc |
realm |
Realm of the application serving the control and data feed. This parameter is relevant when the feeds are accessed over HTTP and is mandatory when the authentication type is BASIC.
For example, |
authUserIdFormat |
Format of the user ID (in active identity plug-in) that is used by Oracle Content Server authorization API. For example, username, email, nickname, user_name. |
pipelineName |
Document service pipeline created for this source in Oracle SES. |
crawlingMode |
Mode for crawling URLs in the source. Valid values are: ACCEPT_ALL, INDEX_ONLY, EXAMINE_URL:
ACCEPT_ALL—Automatically Accept All URLs for Indexing: Crawls and indexes all URLs in the source. It also extracts and indexes any links found in those URLs. Previously crawled URLs are only reindexed if they have changed. EXAMINE_URL—Examine URLs Before Indexing: Crawls but does not index any URLs in the source. It also crawls any links found in those URLs. INDEX_ONLY—Index Only: Crawls and indexes all URLs in the source. It does not extract any links found in those URLs. Select this option for a source previously crawled using EXAMINE_URL |
recrawlPolicy |
Specifies whether to crawl all documents or only documents that have changed. Valid values are PROCESS_ALL and PROCESS_CHANGED:
PROCESS_ALL—All documents are crawled. Use this option to force a full crawl. PROCESS_CHANGED—Only crawl documents that have changed since the previous crawl. This setting can significantly speed up the crawling process. |
freqType |
Frequency of scheduled crawls. Valid values are: MANUAL, MONTHLY, WEEKLY, DAILY, HOURLY.
To schedule crawls MONTHLY, WEEKLY, DAILY, or HOURLY, specify additional arguments as follows: MONTHLY: startHour, startDayOfTheMonth, monthsBetweenLaunches WEEKLY: startHour, startDayOfTheWeek, weeksBetweenLaunches DAILY: startHour, daysBetweenLaunches HOURLY: hoursBetweenLaunches If regular crawls are not required, choose |
startHour |
Time to start the crawl. Any number between 1 and 24.
For example, enter 2 for 2:00am, 14 for 2:00pm, and so on. |
hoursBetweenLaunches |
Number of hours between crawls.
Only valid when |
startDayOfWeek |
Day on which to start a weekly crawl. For example, MONDAY, TUESDAY, and so on.
Only valid when |
startDayOfMonth |
Day of the month on which to start a monthly crawl. For example, enter 1 for 1st day of the month, 2 for 2nd day of the month, and so on.
Only valid when |
daysBetweenLaunches |
Number of days between crawls.
Only valid when |
weeksBetweenLaunches |
Number of weeks between crawls.
Only valid when |
monthsBetweenLaunches |
Number of months between crawls.
Only valid when |
server
|
Optional. Name of the managed server where the WebCenter application is deployed. For example, WC_Spaces.
Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the WebCenter application is deployed. |
The following example creates a documents crawler on the Oracle SES instance http://myseshost.com:7777 for a WebCenter Spaces application (webcenter) located at http://myhost.com:8888/webcenter/spaces:
createDocumentsCrawler(appName='webcenter', host='myhost.com', port='8888', sesUrl='http://myseshost.com:7777/search/api/admin/AdminService', sesPaswword='password', configUrl='http://myucmhost.com:9044/cs/idcplg?IdcService=SES_CRAWLER_DOWNLOAD_ CONFIG&source=mysource', user='adminuser', password='password', scratchDir='/scratch', httpEndpoint='http://myucmhost.com:9044/cs/idcplg', displayUrl='http://myucmhost:9044/cs', realm='jazn.com', authUserIdFormat='username', pipelineName='My UCM Pipeline', crawlingMode='ACCEPT_ALL', recrawlPolicy='PROCESS_ALL', freqType='MANUAL', startHour=1, hoursBetweenLaunches=1, startDayOfWeek='MONDAY', startDayOfMonth=1, daysBetweenLaunches=1, weeksBetweenLaunches=1, monthsBetweenLaunches=1)
Module: Oracle WebCenter
Use with WLST: Online
Creates a discussion forum crawler and an announcements crawler for a WebCenter application, on an Oracle Secure Enterprise Search (SES) instance.
The command creates two Oracle SES database sources (one for discussion forums and one for announcements) and specifies a crawl schedule. The discussion forums source is named <appname_host_port>_forums with a view of FORUMCRAWLER_VW, and the announcements source is named <appname_host_port>_announcements with a view of ANNOUNCEMENTS_VW.
createDiscussionsCrawler(appName, host, port, sesUrl, sesPassword, dbConnString, user, password, authUserIdFormat, crawlingMode, recrawlPolicy, freqType, startHour, hoursBetweenLaunches, startDayOfWeek, startDayOfMonth, daysBetweenLaunches, weeksBetweenLaunches, monthsBetweenLaunches, [server, applicationVersion])
| Argument | Definition |
|---|---|
appName |
Name of the WebCenter application in which to perform this operation. |
host |
Host name of the machine where the WebCenter application is running. |
port |
Port number used to access the WebCenter application. |
sesUrl |
Web Service URL for the Oracle SES Administration API. Use the format: http://<host>:<port>/search/api/admin/AdminService |
sesPassword |
Password for the Oracle SES administrative user (eqsys). |
dbConnString |
Connection URL for the database on which Oracle WebCenter Discussions Server is installed. Use the format:
Oracle: IBM DB2: Microsoft SQL Server: |
user |
Administrative user for the database on which the Oracle WebCenter Discussions Server is installed.
Oracle: The user IBM DB2: The user Microsoft SQL Server: The user |
password |
Password for the administrative discussions server user specified. |
authUserIdFormat |
Format of the user ID (in active identity plug-in), that is used by the discussions server authorization API. For example, username, email, nickname, user_name. |
crawlingMode |
Mode for crawling URLs in the source. Valid values are: ACCEPT_ALL, INDEX_ONLY, EXAMINE_URL:
ACCEPT_ALL—Automatically Accept All URLs for Indexing: Crawls and indexes all URLs in the source. It also extracts and indexes any links found in those URLs. Previously crawled URLs are only reindexed if they have changed. EXAMINE_URL—Examine URLs Before Indexing: Crawls but does not index any URLs in the source. It also crawls any links found in those URLs. INDEX_ONLY—Index Only: Crawls and indexes all URLs in the source. It does not extract any links found in those URLs. Select this option for a source previously crawled using EXAMINE_URL. |
recrawlPolicy |
Specifies whether to crawl all documents or only documents that have changed. Valid values are PROCESS_ALL and PROCESS_CHANGED:
PROCESS_ALL—All documents are crawled. Use this option to force a full crawl. PROCESS_CHANGED—Only crawl documents that have changed since the previous crawl. This setting can significantly speed up the crawling process. |
freqType |
Frequency of scheduled crawls. Valid values are: MANUAL, MONTHLY, WEEKLY, DAILY, HOURLY.
To schedule crawls MONTHLY, WEEKLY, DAILY, or HOURLY, specify additional arguments as follows: MONTHLY: startHour, startDayOfTheMonth, monthsBetweenLaunches WEEKLY: startHour, startDayOfTheWeek, weeksBetweenLaunches DAILY: startHour, daysBetweenLaunches HOURLY: hoursBetweenLaunches If regular crawls are not required, choose |
startHour |
Time to start the crawl. Any number between 1 and 24.
For example, enter 2 for 2:00am, 14 for 2:00pm, and so on. |
hoursBetweenLaunches |
Number of hours between crawls.
Only valid when |
startDayOfWeek |
Day on which to start a weekly crawl. For example, MONDAY, TUESDAY, and so on.
Only valid when |
startDayOfMonth |
Day of the month on which to start a monthly crawl. For example, enter 1 for 1st day of the month, 2 for 2nd day of the month, and so on.
Only valid when |
daysBetweenLaunches |
Number of days between crawls.
Only valid when |
weeksBetweenLaunches |
Number of weeks between crawls.
Only valid when |
monthsBetweenLaunches |
Number of months between crawls.
Only valid when |
server
|
Optional. Name of the managed server where the WebCenter application is deployed. For example, WC_Spaces.
Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the WebCenter application is deployed. |
The following example creates a discussion forum crawler and an announcements crawler on the Oracle SES instance http://myseshost.com:7777 for a WebCenter Spaces application (webcenter) located at http://myhost.com:8888/webcenter/spaces:
createDiscussionsCrawler(appName='webcenter', host='myhost.com', port='8888', sesUrl='http://myseshost.com:7777/search/api/admin/AdminService', sesPaswword='password', dbConnString='jdbc:oracle:thin:@myjivedbhost.com:1521/mysid', user='app_discussions_crawler', password='password', authUserIdFormat='nickname', crawlingMode='ACCEPT_ALL', recrawlPolicy='PROCESS_ALL', freqType='MANUAL', startHour=1, hoursBetweenLaunches=1,startDayOfWeek='MONDAY', startDayOfMonth=1, daysBetweenLaunches=1, weeksBetweenLaunches=1, monthsBetweenLaunches=1)
Module: Oracle WebCenter
Use with WLST: Online
Returns the WebCenter Spaces crawler configured for a WebCenter Spaces application, on an Oracle SES instance.
listSpacesCrawler(appName, sesUrl, sesPassword, host, port, [verbose], [server], [applicationVersion]
| Argument | Definition |
|---|---|
appName |
Name of the WebCenter application in which to perform this operation. For WebCenter Spaces, the name is always webcenter. |
sesUrl |
Web Service URL for the Oracle SES Administration API. Use the format: http://<host>:<port>/search/api/admin/AdminService |
sesPassword |
Password for the Oracle SES administrative user (eqsys). |
host |
Host name of the machine where WebCenter Spaces is running. |
port |
Port number used to access WebCenter Spaces. |
verbose |
Optional. Valid options are 1 (true) and 0 (false). When set to 1, listSpacesCrawlers returns the WebCenter Spaces crawler configured for a WebCenter Spaces application in Oracle SES, along with details. When set to 0, only source names are listed. This argument defaults to 0. |
server
|
Optional. Name of the managed server where the WebCenter Spaces application is deployed. For example, WC_Spaces.
Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the WebCenter application is deployed. |
The following example returns the WebCenter Spaces crawler configured in the Oracle SES instance http://myseshost.com:7777 for a WebCenter Spaces application named webcenter located at http://myhost.com:8888/webcenter/spaces:
listSpacesCrawler(appName='webcenter', sesUrl='http://myseshost.com:7777/search/api/admin/AdminService', sesPassword'password', host='myhost.com', port='8888')
Module: Oracle WebCenter
Use with WLST: Online
Returns the document crawler configured for a WebCenter application, on an Oracle SES instance.
listDocumentsCrawler(appName, sesUrl, sesPassword, host, port, [verbose], [server], [applicationVersion])
| Argument | Definition |
|---|---|
appName |
Name of the WebCenter application in which to perform this operation. |
sesUrl |
Web Service URL for the Oracle SES Administration API. Use the format: http://<host>:<port>/search/api/admin/AdminService |
sesPassword |
Password for the Oracle SES administrative user (eqsys). |
host |
Host name of the machine where the WebCenter application is running. |
port |
Port number used to access the WebCenter application. |
verbose |
Optional. Valid options are 1 (true) and 0 (false). When set to 1, listDocumentsCrawlers returns the documents crawler that is configured for a WebCenter application in Oracle SES, along with details. When set to 0, only source names are listed. This argument defaults to 0. |
server
|
Optional. Name of the managed server where the WebCenter application is deployed. For example, WC_Spaces.
Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the WebCenter application is deployed. |
The following example returns the documents crawler configured in the Oracle SES instance http://myseshost.com:7777 for a WebCenter Spaces application named webcenter located at http://myhost.com:8888/webcenter/spaces:
listDocumentsCrawler(appName='webcenter', sesUrl='http://myseshost.com:7777/search/api/admin/AdminService', sesPassword'password', host='myhost.com', port='8888')
Module: Oracle WebCenter
Use with WLST: Online
Returns the discussion and announcement crawlers configured for a WebCenter application, on an Oracle SES instance.
listDiscussionsCrawler(appName, sesUrl, sesPassword, host, port, [verbose], [server], [applicationVersion]
| Argument | Definition |
|---|---|
appName |
Name of the WebCenter application in which to perform this operation. |
sesUrl |
Web Service URL for the Oracle SES Administration API. Use the format: http://<host>:<port>/search/api/admin/AdminService |
sesPassword |
Password for the Oracle SES administrative user (eqsys). |
host |
Host name of the machine where the WebCenter application is running. |
port |
Port number used to access the WebCenter application. |
verbose |
Optional. Valid options are 1 (true) and 0 (false). When set to 1, listDocumentsCrawlers returns discussion and announcement crawlers that are configured for a WebCenter application in Oracle SES, along with details. When set to 0, only source names are listed. This argument defaults to 0. |
server
|
Optional. Name of the managed server where the WebCenter application is deployed. For example, WC_Spaces.
Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the WebCenter application is deployed. |
The following example returns discussion and announcement crawlers configured in the Oracle SES instance http://myseshost.com:7777 for a WebCenter Spaces application named webcenter located at http://myhost.com:8888/webcenter/spaces:
listDiscussionsCrawler(appName='webcenter', sesUrl='http://myseshost.com:7777/search/api/admin/AdminService', sesPassword'password', host='myhost.com', port='8888')
Module: Oracle WebCenter
Use with WLST: Online
Starts the WebCenter Spaces crawler configured for a WebCenter Spaces application, on an Oracle SES instance.
startSpacesCrawler(appName, sesUrl, sesPassword, host, port, [server], [applicationVersion])
| Argument | Definition |
|---|---|
appName |
Name of the WebCenter application in which to perform this operation. For WebCenter Spaces, the name is always webcenter. |
sesUrl |
Web Service URL for the Oracle SES Administration API. Use the format: http://<host>:<port>/search/api/admin/AdminService |
sesPassword |
Password for the Oracle SES administrative user (eqsys). |
host |
Host name of the machine where the WebCenter Spaces application is running. |
port |
Port number used to access WebCenter Spaces. |
server
|
Optional. Name of the managed server where the WebCenter application is deployed. For example, WC_Spaces.
Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the WebCenter application is deployed. |
The following example starts the WebCenter Spaces crawler configured on the Oracle SES instance http://myseshost.com:7777 for a WebCenter Spaces application named webcenter located at http://myhost.com:8888/webcenter/spaces:
startSpacesCrawler(appName='webcenter', sesUrl'http://myseshost.com:7777/search/api/admin/AdminService', sesPassword='password', host='myhost.com', port='8888')
Module: Oracle WebCenter
Use with WLST: Online
Starts the documents crawler configured for a WebCenter application, on an Oracle SES instance.
startDocumentsCrawler(appName, sesUrl, sesPassword, host, port, [server], [applicationVersion]
| Argument | Definition |
|---|---|
appName |
Name of the WebCenter application in which to perform this operation. |
sesUrl |
Web Service URL for the Oracle SES Administration API. Use the format: http://<host>:<port>/search/api/admin/AdminService |
sesPassword |
Password for the Oracle SES administrative user (eqsys). |
host |
Host name of the machine where the WebCenter application is running. |
port |
Port number used to access the WebCenter application. |
server
|
Optional. Name of the managed server where the WebCenter application is deployed. For example, WC_Spaces.
Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the WebCenter application is deployed. |
The following example starts the document crawler configured on the Oracle SES instance http://myseshost.com:7777 for a WebCenter Spaces application named webcenter located at http://myhost.com:8888/webcenter/spaces:
startDocumentsCrawler(appName='webcenter', sesUrl'http://myseshost.com:7777/search/api/admin/AdminService', sesPassword='password', host='myhost.com', port='8888')
Module: Oracle WebCenter
Use with WLST: Online
Starts the discussion and announcement crawlers configured for a WebCenter application, on an Oracle SES instance.
startDiscussionsCrawler(appName, sesUrl, sesPassword, host, port, [server], [applicationVersion])
| Argument | Definition |
|---|---|
appName |
Name of the WebCenter application in which to perform this operation. |
sesUrl |
Web Service URL for the Oracle SES Administration API. Use the format: http://<host>:<port>/search/api/admin/AdminService |
sesPassword |
Password for the Oracle SES administrative user (eqsys). |
host |
Host name of the machine where the WebCenter application is running. |
port |
Port number used to access the WebCenter application. |
server
|
Optional. Name of the managed server where the WebCenter application is deployed. For example, WC_Spaces.
Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the WebCenter application is deployed. |
The following example starts the discussion and announcement crawlers configured on the Oracle SES instance http://myseshost.com:7777 for a WebCenter Spaces application named webcenter located at http://myhost.com:8888/webcenter/spaces:
startDiscussionsCrawler(appName='webcenter', sesUrl'http://myseshost.com:7777/search/api/admin/AdminService', sesPassword='password', host='myhost.com', port='8888')
Module: Oracle WebCenter
Use with WLST: Online
Stops the WebCenter Spaces crawler configured for a WebCenter Spaces application, on an Oracle SES instance.
stopSpacesCrawler(appName, sesUrl, sesPassword, host, port, [server], [applicationVersion])
| Argument | Definition |
|---|---|
appName |
Name of the WebCenter application in which to perform this operation. For WebCenter Spaces, the name is always webcenter. |
sesUrl |
Web Service URL for the Oracle SES Administration API. Use the format: http://<host>:<port>/search/api/admin/AdminService |
sesPassword |
Password for the Oracle SES administrative user (eqsys). |
host |
Host name of the machine where the WebCenter Spaces application is running. |
port |
Port number used to access WebCenter Spaces. |
server
|
Optional. Name of the managed server where the WebCenter application is deployed. For example, WC_Spaces.
Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the WebCenter application is deployed. |
The following example stops the WebCenter Spaces crawler configured on the Oracle SES instance http://myseshost.com:7777 for a WebCenter Spaces application named webcenter located at http://myhost.com:8888/webcenter/spaces:
stopSpacesCrawler(appName='webcenter',sesUrl'http://myseshost.com:7777/search/api/admin/AdminService', sesPassword='password', host='myhost.com', port='8888')
Module: Oracle WebCenter
Use with WLST: Online
Stops the documents crawler configured for a WebCenter application, on an Oracle SES instance.
stopDocumentsCrawler(appName, sesUrl, sesPassword, host, port, [server], [applicationVersion])
| Argument | Definition |
|---|---|
appName |
Name of the WebCenter application in which to perform this operation. |
sesUrl |
Web Service URL for the Oracle SES Administration API. Use the format: http://<host>:<port>/search/api/admin/AdminService |
sesPassword |
Password for the Oracle SES administrative user (eqsys). |
host |
Host name of the machine where the WebCenter application is running. |
port |
Port number used to access the WebCenter application. |
server
|
Optional. Name of the managed server where the WebCenter application is deployed. For example, WC_Spaces.
Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the WebCenter application is deployed. |
The following example stops the document crawler configured on the Oracle SES instance http://myseshost.com:7777 for a WebCenter Spaces application named webcenter located at http://myhost.com:8888/webcenter/spaces:
stopDocumentsCrawler(appName='webcenter',sesUrl'http://myseshost.com:7777/search/api/admin/AdminService', sesPassword='password', host='myhost.com', port='8888')
Module: Oracle WebCenter
Use with WLST: Online
Stops the discussion and announcement crawlers configured for a WebCenter application, on an Oracle SES instance.
stopDiscussionsCrawler(appName, sesUrl, sesPassword, host, port, [server], [applicationVersion])
| Argument | Definition |
|---|---|
appName |
Name of the WebCenter application in which to perform this operation. |
sesUrl |
Web Service URL for the Oracle SES Administration API. Use the format: http://<host>:<port>/search/api/admin/AdminService |
sesPassword |
Password for the Oracle SES administrative user (eqsys). |
host |
Host name of the machine where the WebCenter application is running. |
port |
Port number used to access the WebCenter application. |
server
|
Optional. Name of the managed server where the WebCenter application is deployed. For example, WC_Spaces.
Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the WebCenter application is deployed. |
The following example stops the discussion and announcement crawlers configured on the Oracle SES instance http://myseshost.com:7777 for a WebCenter Spaces application named webcenter located at http://myhost.com:8888/webcenter/spaces:
stopDiscussionsCrawler(appName='webcenter',sesUrl'http://myseshost.com:7777/search/api/admin/AdminService', sesPassword='password', host='myhost.com', port='8888')
Module: Oracle WebCenter
Use with WLST: Online
Deletes the WebCenter Spaces crawler configured for a WebCenter application, on an Oracle SES instance.
deleteSpacesCrawler(appName, sesUrl, sesPassword, host, port,[server],[applicationVersion])
| Argument | Definition |
|---|---|
appName |
Name of the WebCenter application in which to perform this operation. For WebCenter Spaces, the name is always webcenter. |
sesUrl |
Web Service URL for the Oracle SES Administration API. Use the format: http://<host>:<port>/search/api/admin/AdminService |
sesPassword |
Password for the Oracle SES administrative user (eqsys). |
host |
Host name of the machine where the WebCenter Spaces application is running. |
port |
Port number used to access WebCenter Spaces. |
server
|
Optional. Name of the managed server where the WebCenter application is deployed. For example, WC_Spaces.
Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the WebCenter application is deployed. |
The following example deletes the WebCenter Spaces crawler configured on the Oracle SES instance http://myseshost.com:7777 for a WebCenter Spaces application named webcenter located at http://myhost.com:8888/webcenter/spaces:
deleteSpacesCrawler(appName='webcenter',sesUrl'http://myseshost.com:7777/search/api/admin/AdminService', sesPassword='password', host='myhost.com', port='8888')
Module: Oracle WebCenter
Use with WLST: Online
Deletes the documents crawler configured for a WebCenter application, on an Oracle SES instance.
deleteDocumentsCrawler(appName, sesUrl, sesPassword, host, port, [server], [applicationVersion])
| Argument | Definition |
|---|---|
appName |
Name of the WebCenter application in which to perform this operation. |
sesUrl |
Web Service URL for the Oracle SES Administration API. Use the format: http://<host>:<port>/search/api/admin/AdminService |
sesPassword |
Password for the Oracle SES administrative user (eqsys). |
host |
Host name of the machine where the WebCenter application is running. |
port |
Port number used to access the WebCenter application. |
server
|
Optional. Name of the managed server where the WebCenter application is deployed. For example, WC_Spaces.
Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the WebCenter application is deployed. |
The following example deletes the document crawler configured on the Oracle SES instance http://myseshost.com:7777 for a WebCenter Spaces application named webcenter located at http://myhost.com:8888/webcenter/spaces:
deleteDocumentsCrawler(appName='webcenter',sesUrl'http://myseshost.com:7777/search/api/admin/AdminService', sesPassword='password', host='myhost.com', port='8888')
Module: Oracle WebCenter
Use with WLST: Online
Deletes the discussion and announcement crawlers configured for a WebCenter application, on an Oracle SES instance.
deleteDiscussionsCrawler(appName, sesUrl, sesPassword, host, port, [server], [applicationVersion])
| Argument | Definition |
|---|---|
appName |
Name of the WebCenter application in which to perform this operation. |
sesUrl |
Web Service URL for the Oracle SES Administration API. Use the format: http://<host>:<port>/search/api/admin/AdminService |
sesPassword |
Password for the Oracle SES administrative user (eqsys). |
host |
Host name of the machine where the WebCenter application is running. |
port |
Port number used to access the WebCenter application. |
server
|
Optional. Name of the managed server where the WebCenter application is deployed. For example, WC_Spaces.
Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the WebCenter application is deployed. |
The following example deletes the discussion and announcement crawlers configured on the Oracle SES instance http://myseshost.com:7777 for a WebCenter Spaces application named webcenter located at http://myhost.com:8888/webcenter/spaces:
deleteDiscussionsCrawler(appName='webcenter',sesUrl'http://myseshost.com:7777/search/api/admin/AdminService', sesPassword='password', host='myhost.com', port='8888')
Use the commands listed in Table 10-26 to manage search settings and crawl options for WebCenter Spaces and other WebCenter portal applications.
Configuration changes made using these WebCenter WLST commands are effective immediately; no restart is required.
Table 10-26 WebCenter Spaces Crawler WLST Commands
| Use This Command... | To... | Use with WLST... |
|---|---|---|
|
Modify search settings for a WebCenter application. |
Online |
|
|
List search properties for a WebCenter application. |
Online |
|
|
Specify crawl properties for a WebCenter application. |
Online |
|
|
Return the current crawl settings for a WebCenter application. |
Online |
Module: Oracle WebCenter
Use with WLST: Online
Modifies search settings for a WebCenter application. If a parameter is not specified it is not modified.
setSearchConfig(appName,[numSavedSearches],[numResultsRegion],[numResultsMain], [executionTimeout],[prepareTimeout],[showAllExecutionTimeout], [server], [applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the WebCenter application in which to perform this operation. |
numSavedSearches
|
Optional. The number of saved searches to display in the Saved Searches drop down (on main search page). |
numResultsRegion
|
Optional. The number of saved searches displayed in a Saved Search task flow. |
numResultsMain
|
Optional. The number of search results displayed, per service, for searches submitted from the main search page. |
executionTimeout
|
Optional. The maximum time that a service is allowed to execute a search (in ms). The value for this argument must be a valid number. |
prepareTimeout
|
Optional. The maximum time that a service is allowed to initialize a search (in ms). The value for this argument must be a valid number. |
showAllExecutionTimeout
|
Optional. The maximum time that a service is allowed to display search all results (in ms). The value for this argument must be a valid number. |
server
|
Optional. Name of the managed server where the WebCenter application is deployed. For example, WC_Spaces.
Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the WebCenter application is deployed. |
The following example specifies that saved searches display five search results per service. Additionally, that a seven second search execution timeout is required.
wls:/weblogic/serverConfig> setSearchConfig(appName='webcenter', numResultsRegion=5, executionTimeout=7000);
The following example increases the number of saved searches in the Saved Searches drop down list to eight.
wls:/weblogic/serverConfig> setSearchConfig(appName='webcenter', numSavedSearches=8);
The following example sets the search execution timeout to five seconds and allows each service fifteen seconds to display search results before timing out.
wls:/weblogic/serverConfig> setSearchConfig(appName='webcenter', executionTimeout=5000, showAllExecutionTimeout=15000);
Module: Oracle WebCenter
Use with WLST: Online
listSearchConfig(appName, [server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the WebCenter application for which to perform this operation. |
server
|
Optional. Name of the managed server where the WebCenter application is deployed. For example, WC_Spaces.
Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the WebCenter application is deployed. |
Module: Oracle WebCenter
Use with WLST: Online
Specifies crawl properties for WebCenter applications.
WebCenter applications can be crawled by Oracle SES to provide a faster, more unified search experience across WebCenter objects, specifically: Spaces, lists, pages, people (profiles), wikis, blogs, documents, discussions, and announcements. Three distinct crawlers make this possible:
WebCenter Spaces Crawler (for Spaces, lists, pages, and people)
Documents Crawler (for documents, wikis, blogs)
Discussions Crawler (for discussions and announcements).
Use this command to enable or disable Oracle SES crawlers in WebCenter applications:
WebCenter Spaces—To use Oracle SES crawlers in WebCenter Spaces, you must enable all three crawlers.
Other WebCenter Portal applications—To use Oracle SES crawlers in WebCenter Portal applications, you must enable both the documents and discussions crawlers. The WebCenter Spaces crawler is not applicable.
(WebCenter Spaces only) You can also use this command to specify an interval between full crawls for the WebCenter Spaces crawler. During a full crawl, all of the WebCenter Spaces crawler content is re-read. Out-of-the-box, full crawls for the WebCenter Spaces crawler occur every seven days but you can specify a different frequency to suit your installation.
Note that incremental crawls, for all three crawlers, are initiated by a scheduler running from Oracle SES. During these incremental crawls, only content added or updated since the previous crawl is processed.
setSpacesCrawlProperties(appName, [fullCrawlIntervalInHours, spacesCrawlEnabled, documentCrawlEnabled, discussionsCrawlEnabled, server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the WebCenter Spaces application. |
fullCrawlIntervalInHours
|
Optional. Number of hours between full crawls. The default is 168 hours or 7 days. |
spacesCrawlEnabled
|
Optional. Specifies whether the WebCenter Spaces Crawler is enabled in Oracle SES. Valid values are 1 (true) and 0 (false). This argument defaults to 0.
When set to |
documentCrawlEnabled
|
Optional. Specifies whether the Documents Crawler is enabled in Oracle SES. Valid values are 1 (true) and 0 (false). This argument defaults to 0.
When set to |
discussionsCrawlEnabled
|
Optional. Specifies whether the Discussions Crawler is enabled in Oracle SES. Valid values are 1 (true) and 0 (false). This argument defaults to 0.
When set to |
server
|
Optional. Name of the managed server where the WebCenter application is deployed. For example, WC_Spaces.
Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the WebCenter application is deployed. |
The following example enables Oracle SES crawlers in WebCenter Spaces and specifies that WebCenter Spaces runs a full crawl through the WebCenter Spaces Crawler every 8 days:
wls:/weblogic/serverConfig>setSpacesCrawlProperties(appName='webcenter', fullCrawlIntervalInHours=192, spacesCrawlEnabled=1, documentCrawlEnabled=1, discussionsCrawlEnabled=1)
Module: Oracle WebCenter
Use with WLST: Online
Returns the current crawl settings for a WebCenter application, such as the number of hours between full crawls (WebCenter Spaces crawler), and whether Oracle SES crawlers are enabled.
getSpacesCrawlProperties(appName, [server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the WebCenter application. |
server
|
Optional. Name of the managed server where the WebCenter application is deployed. For example, WC_Spaces.
Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the WebCenter application is deployed. |
The following example returns the current crawl settings for WebCenter Spaces.
wls:/weblogic/serverConfig>getSpacesCrawlProperties(appName='webcenter')
WebCenter Spaces Crawl Properties:-----------------fullCrawlIntervalInHours: 124spacesCrawlEnabled: 1documentCrawlEnabled: 1discussionsCrawlEnabled: 1
Use the commands listed in Table 10-27 to manage BPEL server connections for WebCenter applications.
Configuration changes made using these WebCenter WLST commands are only effective after your restart the Managed Server on which the WebCenter application is deployed. For details, see Oracle Fusion Middleware Administrator's Guide for Oracle WebCenter.
| Use this command... | To... | Use with WLST... |
|---|---|---|
|
Create a connection to a BPEL server for a WebCenter application. |
Online |
|
|
Edit an existing BPEL server connection. |
Online |
|
|
List all of the BPEL server connections that are configured for a WebCenter application. |
Online |
|
|
Enable an existing BPEL server connection for the Worklist service. |
Online |
|
|
Disable a BPEL server connection currently used by the Worklist service. |
Online |
|
|
List individual or all BPEL server connections configured for the Worklist service. |
Online |
Module: Oracle WebCenter
Use with WLST: Online
Creates a connection to a BPEL server for a named WebCenter application. BPEL server connections can be used by the application's Worklist service and WebCenter Spaces workflows.
To configure the Worklist service to actively use a new BPEL server connection, use the addWorklistConnection command. See addWorklistConnection.
To specify the BPEL server connection that WebCenter Spaces uses for its internal workflows, use the setSpacesWorkflowConnectionName command. See setSpacesWorkflowConnectionName.
createBPELConnection(appName, name, url, [policy, recipientKeyAlias, linkUrl, server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the WebCenter application in which to perform this operation. |
name
|
Connection name. The name must be unique (across all connection types) within the WebCenter application. |
url
|
URL required to access the BPEL server.
Use the format: The BPEL server URL must be unique within the WebCenter application. |
policy
|
Optional. SAML token policy this connection uses for authentication. Enter any valid policy. Valid values include:
If you omit this argument, the connection defaults to |
recipientKeyAlias |
Optional. Recipient key alias to be used for message protected SAML policy authentication. Only required when the BPEL server connection is using a SAML token policy for authentication and the application's Worklist service is using multiple BPEL server connections.
The default is null. See also "Configuring WS-Security for WebCenter Applications and Components" in the Oracle Fusion Middleware Administrator's Guide for Oracle WebCenter. |
linkUrl |
Optional. URL used to link to the BPEL server. Only required if it is different to the url argument. For example, when SSO or HTTPS is configured.
Use the format: The default is null. For performance reasons, in an HTTPS or SSO environment, |
server
|
Optional. Name of the managed server where the WebCenter application is deployed. For example, WC_Spaces.
Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the WebCenter application is deployed. |
The following example creates a connection named WebCenter Worklist with the default security policy:
wls:/weblogic/serverConfig> createBPELConnection(appName='webcenter', name='WebCenter Worklist', url='http://myhost.com:8001', policy='oracle/wss10_saml_token_client_policy)
The following example creates a connection that uses a message protected security policy, and defines a specific link URL:
wls:/weblogic/serverConfig> createBPELConnection(appName='webcenter', name='WebCenter Worklist',url='http://myhost.com:8001', policy='oracle/wss10_ saml_token_with_message_protection_client_policy', recipientKeyAlias='myalias', linkUrl='http://mySSO.com:7777')
The following example creates a connection to be used in an environment that supports Global Policy Attachments (GPA):
wls:/weblogic/serverConfig> createBPELConnection(appName='webcenter', name='WebCenter Worklist', url='http://myhost.com:8001' policy='GPA')
Module: Oracle WebCenter
Use with WLST: Online
Edits an existing BPEL server connection.
To configure the Worklist service to actively use an existing BPEL server connection, use the addWorklistConnection command. See addWorklistConnection.
To specify the BPEL server connection used for Webcenter Spaces workflows, use the setSpacesWorkflowConnectionName command. See setSpacesWorkflowConnectionName.
setBPELConnection(appName, name, [url, policy, recipientKeyAlias, linkUrl, server, applicationVersion])
| Argument | Definition |
|---|---|
appName |
Name of the WebCenter application in which to perform this operation. |
name
|
Existing BPEL server connection name. |
url
|
Optional. URL required to access the BPEL server.
Use the format: The BPEL server URL must be unique within the WebCenter application. |
policy
|
Optional. SAML token policy this connection uses for authentication. Enter any valid policy. Valid values include:
If you omit this argument, the connection defaults to |
recipientKeyAlias |
Optional. Recipient key alias to be used for message protected SAML policy authentication. Only required when the BPEL server connection is using a SAML token policy for authentication and the application's Worklist service is using multiple BPEL server connections.
The default is null. See also "Configuring WS-Security for WebCenter Applications and Components" in the Oracle Fusion Middleware Administrator's Guide for Oracle WebCenter. |
linkUrl |
Optional. URL used to link to the BPEL server. Only required if it is different to the url argument. For example, when SSO or https is configured. Use the format: protocol://host:port
For example, The default is null. For performance reasons, in an HTTPS or SSO environment, the Link URL specifies user access to BPEL worklist items, through HTTPS or SSO Web servers, whereas the BPEL SOAP URL specifies direct access to BPEL Web services, without redirection through HTTPS or SSO Web servers. |
server
|
Optional. Name of the managed server where the WebCenter application is deployed. For example, WC_Spaces.
Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the WebCenter application is deployed. |
The following example updates the BPEL server URL, security policy, recipient key alias, and link url for a connection named WebCenter Worklist.
wls:/weblogic/serverConfig> setBPELConnection(appName='webcenter', name='WebCenter Worklist',url='http://myhost.com:6666', policy='oracle/wss10_ saml_token_with_message_protection_client_policy', recipientKeyAlias='myalias', linkUrl='http://mySSO.com:7777')
The following example changes the security policy to use Global Policy Attachments (GPA):
wls:/weblogic/serverConfig> setBPELConnection(appName='webcenter', name='WebCenter Worklist', policy='GPA')
Module: Oracle WebCenter
Use with WLST: Online
Without any arguments, this command lists all the BPEL connections that are configured for a specific WebCenter application. All BPEL connections are listed, even connections not currently used.
listBPELConnections(appName, [verbose], [name], [server], [applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the WebCenter application for which to list BPEL server connections. |
verbose
|
Optional. Displays BPEL server connection details in verbose mode. Valid options are 1 (true) and 0 (false). When set to 1, listBPELConnections lists all of the BPEL server connections that are configured, along with their details. When set to 0, listBPELConnections lists connection names only. This argument defaults to 0.
If you set this argument to |
name
|
Optional. Name of an existing BPEL server connection. You can use this argument to view details about a specific connection.
To list all the connections, omit the |
server
|
Optional. Name of the managed server where the WebCenter application is deployed. For example, WC_Spaces.
Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the WebCenter application is deployed. |
The following example lists the names of all the BPEL server connections that are configured for a WebCenter application.
wls:/weblogic/serverConfig> listBPELConnections(appName='webcenter')
------------------
WebCenter Worklist
------------------
------------------
Human Resources Worklist
------------------
The following example lists the names and details of all of the BPEL server connections that are configured for a WebCenter application.
wls:/weblogic/serverConfig> listBPELConnections(appName='webcenter', verbose=1)
------------------
WebCenter Worklist
------------------
Connection Name: WebCenter Worklist
PolicyURI:oracle/wss10_saml_token_client_policy
URL:http://myhost.com:8001
------------------
Human Resources Worklist
------------------
Connection Name: Human Resources Worklist
PolicyURI:oracle/wss10_saml_token_client_policy
URL:http://myhost.com:8888
------------------
Module: Oracle WebCenter
Use with WLST: Online
Enable an existing BPEL server connection for Worklist services. The Worklist service supports multiple connections so that WebCenter users can monitor and manage assignments and notifications from a range of BPEL servers.
The name must specify an existing BPEL server connection.
addWorklistConnection(appName, name,[verbose, server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the WebCenter application in which to perform this operation. |
name
|
Name of an existing BPEL server connection. |
verbose
|
Optional. Displays output indicating whether a matching BPEL server connection exists and provides connection details. 1 turns verbose mode on; 0 turns verbose mode off. This argument defaults to 0. |
server
|
Optional. Name of the managed server where the WebCenter application is deployed. For example, WC_Spaces.
Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the WebCenter application is deployed. |
The following example enables the Human Resources Worklist connection for the Worklist service.
wls:/weblogic/serverConfig> addWorklistConnection(appName='webcenter', name='Human Resources Worklist', verbose=1) Human Resources Worklist successfully added to WorkList ------------------ Human Resources Worklist ------------------ Connection Name: Human Resources Worklist PolicyURI:oracle/wss10_saml_token_client_policy URL:http://myhost.com:8888
The following example also enables the Human Resources Worklist connection for the Worklist service.
wls:/weblogic/serverConfig> addWorklistConnection(appName='webcenter', name='Human Resources Worklist', verbose=1) Human Resources Worklist successfully added to WorkList ------------------ Human Resources Worklist ------------------ Connection Name: Human Resources Worklist PolicyURI:oracle/oracle/wss10_saml_token_client_policy URL:http://myhost.com:8888
Module: Oracle WebCenter
Use with WLST: Online
Disables a BPEL server connection that is currently used by the Worklist service. Connection details are retained but the Worklist service no longer uses the connection specified.
removeWorklistConnection(appName, name, [server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the WebCenter application in which to perform this operation. |
name
|
Name of an existing BPEL server connection. |
server
|
Optional. Name of the managed server where the WebCenter application is deployed. For example, WC_Spaces.
Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the WebCenter application is deployed. |
Module: Oracle WebCenter
Use with WLST: Online
Without any arguments, this command lists all of the BPEL server connections that are configured for the Worklist service, in a named WebCenter application.
listWorklistConnections(appName, [verbose],[name], [server], [applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the WebCenter application for which to perform this operation. |
verbose
|
Optional. Displays BPEL server connection details in verbose mode. Valid options are 1 (true) and 0 (false). When set to 1, listWorklistConnections lists all of the BPEL server connections that are configured for the Worklist service, along with their details. When set to 0, listWorklistConnections lists connection names only. This argument defaults to 0.
If you set this argument to |
name
|
Optional. Name of an existing BPEL server connection. You can use this argument to view details about a specific connection.
To list all connections, omit the |
server
|
Optional. Name of the managed server where the WebCenter application is deployed. For example, WC_Spaces.
Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the WebCenter application is deployed. |
The following example lists the names of all of the BPEL server connections that are configured for the Worklist service.
wls:/weblogic/serverConfig> listWorklistConnections(appName='webcenter')
------------------
WebCenter Worklist
------------------
The following example lists both the names and connection details of all of the BPEL server connections that are configured for the Worklist service.
wls:/weblogic/serverConfig> listWorklistConnections(appName='webcenter', verbose=1)
------------------
WebCenter Worklist
------------------
Connection Name: WebCenter Worklist
PolicyURI:oracle/wss10_saml_token_client_policy
URL:http://myhost.com:8001
The following example lists connection details of a named BPEL server connection—MyWorklist. As the Worklist service is not currently configured to use MyWorklist, an appropriate message displays.
wls:/weblogic/serverConfig> listWorklistConnections(appName='webcenter', verbose=1, name='MyWorklist') ------------------ The following connection is not in the ADF Worklist:MyWorklist
Use the commands listed in Table 10-28 to manage WebCenter Spaces workflow settings and metadata.
Table 10-28 WebCenter Spaces Workflow WLST Commands
| Use This Command... | To... | Use with WLST... |
|---|---|---|
|
Return the name of the BPEL server connection that WebCenter Spaces is using for internal workflows. |
Online |
|
|
Specify the BPEL server connection used for Webcenter Spaces workflows. |
Online |
|
|
Migrate metadata for individual Spaces (in MDS) and Space security data to the 'WebCenter Spaces cache'. |
Online |
Module: Oracle WebCenter
Use with WLST: Online
Returns the name of the BPEL server connection that WebCenter Spaces is currently using for internal workflows (Space membership notifications, Space subscription requests, and so on).
getSpacesWorkflowConnectionName(appName, [server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the WebCenter Spaces application—always webcenter. |
server
|
Optional. Name of the managed server where the WebCenter application is deployed. For example, WC_Spaces.
Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the WebCenter application is deployed. |
Module: Oracle WebCenter
Use with WLST: Online
Specifies the BPEL server connection that Webcenter Spaces uses for internal workflows. WebCenter Spaces uses a BPEL server included with the Oracle SOA Suite to host internal workflows, such as Space membership notifications, Space subscription requests, and so on. The connection name specified here must be a valid BPEL server connection.
Note:
Configuration changes made using this WLST command are only effective after your restart the Managed Server on which the WebCenter Spaces deployed. For details, see Oracle Fusion Middleware Administrator's Guide for Oracle WebCenter.setSpacesWorkflowConnectionName(appName, name, [server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the WebCenter Spaces application—always webcenter. |
name
|
Name of an existing BPEL connection. |
server
|
Optional. Name of the managed server where the WebCenter application is deployed. For example, WC_Spaces.
Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the WebCenter application is deployed. |
Module: Oracle WebCenter
Use with WLST: Online
Migrates metadata for individual Spaces (in MDS) and Space security data (in a policy store) to the 'WebCenter Spaces cache'.
WebCenter Spaces 11.1.1.2.0 (and later) uses tables (referred to as the WebCenter Spaces cache) to store Space metadata and security-related data. When you migrate from WebCenter Spaces 11.1.1.1.0 to 11.1.1.2.0, you must run the refreshGroupSpaceCache command so that all your existing Space data is migrated to the new 'WebCenter Spaces cache'.
refreshGroupSpaceCache(appName, [spaceNames, syncMode, updateType, cleanCache])
| Argument | Definition |
|---|---|
appName
|
Name of the WebCenter application in which to perform this operation. |
spaceNames
|
Optional. Names of one or more Spaces (group spaces) that you want to refresh.
To refresh all the Spaces in MDS, enter To refresh selective Spaces, enter one or more Space names separated with a comma, for example: spaceNames=' |
updateType
|
Optional. Indicates the type of data to refresh. Valid values are: security, metadata, all. The default value is security.
|
syncMode
|
Optional. Indicates whether to refresh the WebCenter Spaces in synchronous or asynchronous mode.
Valid values are When set to When set to Synchronous mode is recommended. |
cleanCache |
Optional. Indicates whether to clear the WebCenter Spaces cache. Valid values are 1 and 0. The default value is 0.
When set to Always set this value to Use the |
The following examples update the cache to include all Space-related metadata (in MDS) and security data (in the policy store) in synchronous mode:
wls:/weblogic/serverConfig>refreshGroupSpaceCache(appName='webcenter', spaceNames='', syncMode=1, updateType='all', cleanCache=0)
wls:/weblogic/serverConfig>refreshGroupSpaceCache(appName='webcenter')
The following example updates the WebCenter Spaces cache to include Space-related metadata (in MDS) and security data (in the policy store) for two Spaces MyGroupSpace1 and MyGroupSpace2. The cache refreshes in synchronous mode.
wls:/weblogic/serverConfig>refreshGroupSpaceCache(appName='webcenter', spaceNames='MyGroupSpace1,MyGroupSpace2')
Use the commands listed in Table 10-29 to configure options for searching a WebCenter application's identity store.
Table 10-29 WebCenter Identity Store WLST Commands
| Use this command... | To... | Use with WLST... |
|---|---|---|
|
Modify configuration options for searching a WebCenter applications's identity store. |
Online |
|
|
List current configuration options for searching a WebCenter application's identity store. |
Online |
Module: Oracle WebCenter
Use with WLST: Online
Modifies configuration options for searching a WebCenter application's identity store. Use these settings to optimize identity store searches (for users and roles) in a WebCenter application.
Identity store search parameters are stored in adf-config.xml. If a search parameter is not specified, it is not modified.
setWebCenterIdStoreSearchConfig(appName,[narrowSearchTimeout, broadSearchTimeout, maxSearchFilters, maxFetchRecords, server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the WebCenter application in which to perform this operation. |
narrowSearchTimeout
|
Optional. The maximum time allowed (in ms) for small, simple searches, such as fetching a single user from the identity store. The out-of-the-box default is 30000ms. |
broadSearchTimeout
|
Optional. The maximum time allowed (in ms) to return large result sets, such as returning users and roles that match a name pattern. The out-of-the-box default is 60000. |
maxSearchFilters
|
Optional. The number of search filters allowed for the WebCenter application's identity store. The maximum allowed, out-of-the-box, is 100.
Some identity store searches are executed using search filters which are converted into LDAP search calls. If your associated LDAP server limits the search condition, you can set the |
maxFetchRecords
|
Optional. The maximum number of records to be returned from each search query. The out-of-the-box default is 100.
The value of this setting will impact the performance of your LDAP server so take this into consideration when increasing the search result limit. Note that the LDAP server imposes its own search result limit, so the actual limit that is used will be the lesser of these two values. |
server
|
Optional. Name of the managed server where the WebCenter application is deployed. For example, WC_Spaces.
Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the WebCenter application is deployed. |
The following example increases both identity store search timeouts.
wls:/weblogic/serverConfig>setWebCenterIdStoreSearchConfig(appName='webcenter', narrowSearchTimeout=60000, broadSearchTimeout=100000);
The following example limits the maximum number of records returned to 100.
wls:/weblogic/serverConfig>setWebCenterIdStoreSearchConfig(appName='webcenter', maxFetchRecords=100);
Module: Oracle WebCenter
Use with WLST: Online
Lists current configuration options for searching the WebCenter application's identity store.
Identity store search parameters are stored in adf-config.xml.
listWebCenterIdStoreSearchConfig(appName,[server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the WebCenter application in which to perform this operation. |
server
|
Optional. Name of the managed server where the WebCenter application is deployed. For example, WC_Spaces.
Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the WebCenter application is deployed. |
The following example displays identity store search configuration information for a WebCenter application named webcenter.
wls:/weblogic/serverConfig>listWebCenterIdStoreSearchConfig(appName='webcenter');
----------------- User role search configuration parameters ----------------- Narrow search timeout : 30000 Broad search timeout : 60000 Maximum search filters : 100 Maximum records to fetch : 200
Use the commands listed in Table 10-30 to export and import WebCenter Spaces and producer metadata associated with WebCenter Portal applications.
Table 10-30 Import and Export WLST Commands
| Use this command... | To... | Use with WLST... |
|---|---|---|
|
Export WebCenter Spaces to a WebCenter export archive. |
Online |
|
|
Import WebCenter Spaces from a WebCenter export archive. |
Online |
|
|
Export one or more Spaces to a WebCenter export archive. |
Online |
|
|
Export one or more Space templates to a WebCenter export archive. |
Online |
|
|
Import one or more Spaces or Space templates from a WebCenter export archive. |
Online |
|
|
Take a Space offline or brings a Space online. |
Online |
|
|
Export a single resource to a WebCenter export archive (.EAR). |
Online |
|
|
Import a single resources from a WebCenter export archive (.EAR). |
Online |
|
|
Export portlet client metadata and producer customizations and personalizations to a WebCenter export archive. WebCenter Portal applications only. |
Online |
|
|
Import portlet client metadata and producer customizations and personalizations from a WebCenter export archive. WebCenter Portal applications only. |
Online |
|
|
Import translations for WebCenter Spaces. |
Online |
|
|
Display names of producers where metadata imports have failed and reasons for those failures |
Online |
|
|
Attempt to import outstanding producer metadata |
Online |
Module: Oracle WebCenter
Use with WLST: Online
(WebCenter Spaces only) Exports a WebCenter Spaces application to a WebCenter export archive (.EAR) using the filename provided.
exportWebCenterApplication(appName, fileName, [exportCustomizations, exportSecurity, exportData, server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the WebCenter Spaces application in which to perform this operation. |
fileName
|
Name of the export archive EAR file to which you want the export to be written. |
exportCustomizations
|
Optional. Valid values are 1 (true) and 0 (false). When set to 1, all application customizations are exported. When set to 0, application customizations are not exported, that is, default task flows are exported without any customizations. This argument defaults to 1. |
exportSecurity
|
Optional. Valid values are 1 (true) and 0 (false). When set to 1, policy-store.xml contains application roles and permissions, as well as user details and their role assignments. When set to 0, policy-store.xml contains application roles and permissions only. User details are not exported. This argument defaults to 0. |
exportData
|
Optional. Valid values are 1 (true) and 0 (false). When set to 1, data stored in the WebCenter Spaces database for lists, events, tags, and links is exported. When set to 0, this data is not exported. This argument defaults to 0. |
server
|
Optional. Name of the managed server where the WebCenter application is deployed. For example, WC_Spaces.
Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the WebCenter application is deployed. |
The following example exports a WebCenter Spaces application and all possible data to a file named myExport.ear.
wls:/weblogic/serverConfig> exportWebCenterApplication(appName='webcenter', fileName='myExport.ear', exportCustomizations=1, exportSecurity=1, exportData=1)
The following example exports a test application with the intention of importing the resultant EAR to an alternative system with a different user base. In this case, security policies (which might reference users or roles specific to the originating server) are not required. Additionally, data created during testing (such as lists, Space events, links, tags) is not required.
wls:/weblogic/serverConfig> exportWebCenterApplication(appName='webcenter', fileName='export.ear')
Module: Oracle WebCenter
Use with WLST: Online
(WebCenter Spaces only) Imports a WebCenter Spaces application from a WebCenter export archive file to a server.
After importing WebCenter Spaces you will need to restart the managed server where the application is deployed.
importWebCenterApplication(appName, fileName, [server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the WebCenter Spaces application in which to perform this operation. |
fileName
|
Name of the WebCenter export archive that you want to import. |
server
|
Optional. Name of the managed server where the WebCenter application is deployed. For example, WC_Spaces.
Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the WebCenter application is deployed. |
Module: Oracle WebCenter
Use with WLST: Online
(WebCenter Spaces only) Exports one or more Spaces to a WebCenter export archive (.EAR), using the filename specified.
All Space-related data, application customizations, and security information is included in the export archive.
You must take the Spaces offline, even if only temporarily, to prevent data conflicts during the export process.
Note:
You cannot use this command to export Home Spaces.exportGroupSpaces(appName, fileName, names, [forceOffline, server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the WebCenter Spaces application in which to perform this operation—always webcenter. |
fileName
|
Name of the local file to which the export will be written. |
names
|
Names of the Spaces that you want to export. Separate multiple Space names with a comma. |
forceOffline
|
Optional. Specifies whether to take the Spaces offline before starting export process. Valid values are 1 and 0.
The defaults is 0. |
server
|
Optional. Name of the managed server where the WebCenter application is deployed. For example, WC_Spaces.
Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the WebCenter application is deployed. |
The following example exports two Spaces (mySpace1 and mySpace2) from a WebCenter Spaces application named webcenter.
wls:/weblogic/serverConfig> exportGroupSpaces(appName='webcenter', fileName='myExport.ear', names='mySpace1, mySpace2')
The following example takes mySpace1 and mySpace2 offline and then exports both Spaces to myExport.ear:
wls:/weblogic/serverConfig> exportGroupSpaces(appName='webcenter', fileName='myExport.ear', names='mySpace1, mySpace2', forceOffline=1))
Module: Oracle WebCenter
Use with WLST: Online
(WebCenter Spaces only) Exports one or more Space templates to a WebCenter export archive (.EAR), using the filename specified.
exportGroupSpaceTemplates(appName, fileName, names, [server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the WebCenter Spaces application in which to perform this operation—always webcenter. |
fileName
|
Name of the local file to which the export will be written. |
names
|
Names of the Space templates that you want to export. Separate multiple template names with a comma. |
server
|
Optional. Name of the managed server where the WebCenter application is deployed. For example, WC_Spaces.
Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the WebCenter application is deployed. |
Module: Oracle WebCenter
Use with WLST: Online
(WebCenter Spaces only) Imports one or more Spaces or Space templates from a WebCenter export archive.
importGroupSpaces(appName, fileName, [importCustomizations,importSecurity, importData, parentSpace, forceOffline, server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the WebCenter Spaces application in which to perform this operation—always webcenter. |
fileName
|
Name of the WebCenter archive file that you want to import. |
importCustomizations
|
Optional. Indicates whether to import customizations from the WebCenter export archive. Valid values are 1 and 0.
When set to 0, customizations are not imported, that is, default task flows are imported without any customizations and the default Space settings are used. This argument defaults to 1. |
importSecurity
|
Optional. Indicates whether to import Space member details from the WebCenter export archive. Valid values are 1 and 0.
When set to 1, roles and permissions for the Space, as well as member details and their role assignments are imported. When set to 0, only the roles and permissions are imported. This option is useful when migrating between stage and production environments and where member details, added during the testing phase, are no longer required. This argument defaults to 1. |
importData
|
Optional. Indicates whether to import data from the WebCenter export archive. Valid values are 1 and 0.
When set to When set to |
forceOffline
|
Optional. Takes the Space(s) offline before import. Valid values are 1 and 0.
When set to 1, all Space(s) are taken offline. This argument defaults to 0. |
parentSpace
|
Optional. Name of the parent Space under which to place Spaces in the WebCenter archive. If specified, imported Spaces become children of the parent Space.
This argument defaults to null. When no parent is specified, archived Spaces are imported as root Spaces.Note: If the WebCenter archive contains Space templates, this argument is ignored. |
server
|
Optional. Name of the managed server where the WebCenter application is deployed. For example, WC_Spaces.
Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the WebCenter application is deployed. |
Module: Oracle WebCenter
Use with WLST: Online
Exports a single portal resource to a WebCenter export archive (.EAR), using the filename specified.
exportWebCenterResource(appName, fileName, resourceType, resourceGUID, [spaceName, server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the WebCenter application in which to perform this operation. |
fileName
|
Name of the local file to which the export will be written. |
resourceType
|
Type of resource to export. Valid values include: pageTemplate, contentPresenter, pageStyle, navigation, resourceCatalog, skin, taskFlow, mashupStyle. |
resourceGUID
|
Unique ID (GUID) of the resource to export. |
spaceName
|
Optional. (WebCenter Spaces only) Name of the Space containing the resource to export.Use this argument to export resources that are owned by a particular Space. Omit this argument if you want to export application-level resources for WebCenter Spaces or to export resources for a WebCenter Portal application.
This argument defaults to null (application-level resources exported). |
server
|
Optional. Name of the managed server where the WebCenter application is deployed. For example, WC_Spaces.
Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the WebCenter application is deployed. |
The following example exports a page template from MySpace to a local file named myPageTemplateExport.ear:
wls:/weblogic/serverConfig> exportWebCenterResource(appName='webcenter', fileName='myPageTemplateExport.ear', resourceType='pageTemplate', resourceGUID='gsr47d9a5ac_7398_439a_97d2_8b54ce905f7e, spaceName='MySpace')
The following example exports a skin from a WebCenter Portal application named myPortalApp to a local file named mySkinExport.ear:
wls:/weblogic/serverConfig> exportWebCenterResource(appName='myPortalApp', fileName='mySkinExport.ear', resourceType='skin', resourceGUID='gsr47d9a5ac_7398_439a_97d2_8b54ce905f7e)
Module: Oracle WebCenter
Use with WLST: Online
Imports a single portal resource from a WebCenter export archive (.EAR), using the filename specified.
importWebCenterResource(appName, fileName, resourceType, [spaceName, server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the WebCenter application in which to perform this operation. |
fileName
|
Name of the WebCenter archive file that you want to import. |
resourceType
|
Type of resource to import. Valid values include: pageTemplate, contentPresenter, pageStyle, navigation, resourceCatalog, skin, taskFlow, mashupStyle. |
spaceName
|
Optional. (WebCenter Spaces only) Name of the Space into which the resource is to be imported.
Omit this argument if you want to import application-level resources for WebCenter Spaces or to import resources for a WebCenter Portal application. This argument defaults to null (application-level resources imported). |
server
|
Optional. Name of the managed server where the WebCenter application is deployed. For example, WC_Spaces.
Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the WebCenter application is deployed. |
The following example imports a page template from a WebCenter archive named myPageTemplateExport.ear to MySpace in WebCenter Spaces:
wls:/weblogic/serverConfig> importWebCenterResource(appName='webcenter',fileName='myPageTemplateExport.ear', spaceName='MySpace', resourceType='pageTemplate')
The following example imports a skin from a WebCenter archive named mySkinExport.ear to a WebCenter Portal application named myPortalApp:
wls:/weblogic/serverConfig> importWebCenterResource(appName='myPortalApp',fileName='mySkinExport.ear', resourceType='skin')
Module: Oracle WebCenter
Use with WLST: Online
Exports portlet client metadata and producer customizations and personalizations, for a WebCenter Portal application. This command exports metadata for all the application's producers to a named export archive (.EAR file). You cannot opt to export metadata for specific producers.
Only use this command to migrate producer data associated with WebCenter Portal applications. Do not use this command for WebCenter Spaces.
exportPortletClientMetadata(appName, fileName, [exportPersonalizations, server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the WebCenter Portal application in which to perform this operation. |
fileName
|
Name of the export archive (.EAR) to which you want the export to be written. |
exportPersonalizations
|
Optional. Valid values are 1 (true) and 0 (false). When set to 1, personalizations for all producers are exported. When set to 0, personalizations are not exported. This argument defaults to 1. |
server
|
Optional. Name of the managed server where the WebCenter application is deployed. For example, WC_Spaces.
Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the WebCenter application is deployed. |
The following example exports portlet client metadata and producer customizations and personalizations to an export archive named myExport.ear. Personalizations are not exported.
wls:/weblogic/serverConfig> exportPortletClientMetadata(appName='myApp', fileName='myExport.ear', exportPersonalizations=0)
Module: Oracle WebCenter
Use with WLST: Online
Imports portlet client metadata and producer customizations and personalizations from a named WebCenter export archive.
Producer personalizations are optional on export. Producer personalizations are imported if the export archive specified includes personalizations.
Only use this command to migrate producer data for a WebCenter Portal application. Do not use this command for WebCenter Spaces.
importPortletClientMetadata(appName, fileName, [server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the WebCenter Portal application in which to perform this operation. |
fileName
|
Name of the WebCenter export archive that you want to import. |
server
|
Optional. Name of the managed server where the WebCenter application is deployed. For example, WC_Spaces.
Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the WebCenter application is deployed. |
Module: Oracle WebCenter
Use with WLST: Online
WebCenter Spaces only. Imports translated content (XLF files) to MDS and the WebCenter repository for use in WebCenter Spaces.
importWebCenterTranslations(appName, server, mdsRootDir, [applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the WebCenter Spaces application in which to perform this operation—always webcenter. |
server
|
Name of the target managed server on which WebCenter Spaces is deployed. For example, WC_Spaces. |
mdsRootDir
|
MDS root directory on the file system that contains translated XLF files. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the WebCenter application is deployed. |
Module: Oracle WebCenter
Use with WLST: Online
setSpaceState(appName, spaceName, offline, [server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the WebCenter application in which to perform this operation. For WebCenter Spaces, the name is always webcenter. |
spaceName
|
Name of the Space you want to take offline or bring online. |
offline
|
Specifies whether to take the Space offline or bring it back online. Valid values are 1 and 0:
|
server
|
Optional. Name of the managed server where the WebCenter application is deployed. For example, WC_Spaces.
Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the WebCenter application is deployed. |
Module: Oracle WebCenter
Use with WLST: Online
Lists outstanding producer imports for a named WebCenter application.Producer import fails if a producer used by the application is not available when the application first starts after deployment.
showProducerImportFailures(appName, [server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the WebCenter application in which to perform this operation. For WebCenter Spaces, the name is always webcenter. |
server
|
Name of the managed server on which the application is deployed. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the WebCenter application is deployed. |
Module: Oracle WebCenter
Use with WLST: Online
Imports outstanding producer metadata.Producer import can fail if a producer used by the application is not available when the application first starts after deployment. Use this command to import metadata for any producers for which metadata import previously failed.
retryAllFailedProducerImports(appName, [server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the WebCenter application in which to perform this operation. For WebCenter Spaces, the name is always webcenter. |
server
|
Name of the managed server on which the WebCenter application is deployed. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the WebCenter application is deployed. |
Use the commands listed in Table 10-31 when upgrading from a previous WebCenter release.
See also, Oracle Fusion Middleware Upgrade Guide for Oracle SOA Suite, WebCenter, and ADF.
Table 10-31 WebCenter Upgrade WLST Commands
| Use this command... | To... | Use with WLST... |
|---|---|---|
|
Upgrade a WebCenter domain. |
Offline |
|
|
Upgrade WebCenter permissions. |
Online |
|
|
Upgrade a WebCenter application. |
Online |
Module: Oracle WebCenter
Use with WLST: Offline
upgradeWebCenterDomain(domainDirName, [oracleHome], [upgradeCustomSpaces])
| Argument | Definition |
|---|---|
domainDirName
|
Full path to the Domain's home directory.
For example, |
oracleHome
|
Optional. Path to WebCenter's Oracle home directory.
For example, |
upgradeCustomSpaces
|
Optional. Determines whether to upgrade the custom.webcenter.spaces shared library. Valid values are 1 (true) and 0 (false).
Set to The default value is |
Module: Oracle WebCenter
Use with WLST: Online
Upgrades WebCenter Spaces permissions.
This command creates additional application roles and grants some additional permissions that are requirement for WebCenter Spaces 11.1.1.4.0.
Module: Oracle WebCenter
Use with WLST: Online
upgradeWebCenterApplication(appName, [server], [applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the WebCenter application in which to perform this operation. For WebCenter Spaces, the name is always webcenter. |
server
|
Optional. Name of the managed server where the WebCenter application is deployed. For example, WC_Spaces.
Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the WebCenter application is deployed. |