Skip Headers
Oracle® Fusion Middleware WebLogic Scripting Tool Command Reference
11g Release 1 (10.3.6)

Part Number E13813-12
Go to Documentation Home
Home
Go to Book List
Book List
Go to Table of Contents
Contents
Go to Master Index
Master Index
Go to Feedback page
Contact Us

Go to previous page
Previous
Go to next page
Next
PDF · Mobi · ePub

10 WebCenter Portal Custom WLST Commands

This chapter describes WebLogic Scripting Tool (WLST) commands for Oracle WebCenter Portal. These commands enable you to configure WebCenter Portal applications and components from the command-line. For additional details about WebCenter Portal 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 Portal WLST commands are only effective after you restart the Managed Server on which the WebCenter Portal application is deployed. The only exceptions are WLST commands for External Applications, Portlet Producers, and WebCenter Portal Import and Export.

WebCenter Portal WLST commands are described in the following sections:

WebCenter Portal WLST Command Categories

WebCenter Portal WLST commands are grouped into the following categories (Table 10-1).

Most configuration changes made using WebCenter Portal WLST commands are only effective after you restart the Managed Server on which the WebCenter Portal application is deployed. The only exceptions are the External Applications, Portlet Producers, and WebCenter Portal Import and Export WLST commands.

Table 10-1 WLST Command Categories

Command Category Description

General

Manage WebCenter Portal connections.

Analytics

Manage Analytics Collector connections and configure the Analytics Collector (on WC_Utilities).

Activity Graph

Manage Activity Graph metadata and provider configuration (on WC_Utilities).

Activity Stream

Archive and restore activity stream data generated for a WebCenter Portal application.

Content Repository

Manage content repository connections and configure the Documents service.

Discussions and Announcements

Manage discussions server connections and configure the Discussion and Announcement services.

External Applications

Manage external application connections.

Instant Messaging and Presence

Manage instant messaging and presence server connections and configure the Instant Messaging and Presence service.

Mail

Manage mail server connections and configure the Mail service.

Notifications

Manage settings for the Notifications service.

Personal Events

Manage personal event server connections.

Personalization

Manage personalization server connections.

Portlet Producers

Manage portlet producers.

RSS News Feeds

Manage proxy settings for the RSS service.

Search - Oracle SES Search

Manage Oracle Secure Enterprise Search (SES) connections and other search-related properties.

Search - Oracle SES Search Crawlers

Manage Oracle Secure Enterprise Search (SES) crawlers.

Search - WebCenter Portal Search

Manage search crawlers for the Spaces application.

Worklists

Manage BPEL server connections.

Spaces Application

Manage Spaces workflow settings and space metadata.

WebCenter Portal Identity Store

Configure options for searching a WebCenter Portal application's identity store.

WebCenter Portal Import and Export

Export and import Spaces applications, individual spaces and space templates, as well as producer metadata.


General

Use the General commands, listed in Table 10-2, to manage WebCenter Portal connections.

Configuration changes made using these WebCenter Portal WLST commands are only effective after restarting the Managed Server on which the WebCenter Portal 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...

deleteConnection

Delete any WebCenter Portal connection.

Online

setWebCenterServiceFrameworkConfig

Set WebCenter Portal Service Framework configuration properties.

Online

getWebCenterServiceFrameworkConfig

Return WebCenter Portal Framework configuration properties.

Online

webcenterErrorOccurred

Return status information for the last WebCenter Portal command executed.

Online

getWebCenterConnectionTypes

List all the WebCenter Portal connection types.

Online

cloneWebCenterManagedServer

Clone a WebCenter Portal Managed Server.

Online


deleteConnection

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

Deletes a named WebCenter Portal 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 cannot be used to delete WebCenter Portal connections for the Personalization service. Instead, use deleteWCPSCMISConnection, deleteWCPSActivityGraphConnection, deleteWCPSPeopleConnection, or deleteWCPSCustomConnection.

Syntax

deleteConnection(appName, name, [server, applicationVersion])
Argument Definition
appName

Name of the WebCenter Portal application in which to perform this operation.

name

Connection name.

server

Optional. Name of the managed server where the WebCenter Portal 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 Portal application is deployed.


Example

The following example deletes a WebCenter Portal connection.

wls:/weblogic/serverConfig> deleteConnection(appName='webcenter', name='MyConnection')

setWebCenterServiceFrameworkConfig

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

Sets WebCenter Portal Service Framework configuration properties, such as the Resource Action Handler class and display as popup properties.

Syntax

setWebCenterServiceFrameworkConfig(appName, [resourceActionHandlerClassName],
[resourceActionHandlerDisplayInPopup], [server], [applicationVersion])
Argument Definition
appName

Name of the WebCenter Portal application in which to perform this operation. For the Spaces application, 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 Portal 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 Portal application is deployed.


Example

The following example sets the WebCenter Portal 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 Portal service framework configuration.
Resource Action Handler class: my.company.ResourceActionHandler
To effect connection changes, you must restart the managed server on which the 
WebCenter Portal application is deployed.
   

The following example sets only the WebCenter Portal 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 Portal service framework configuration.
Resource Action Handler Display In Popup: true

To effect connection changes, you must restart the managed server on which the WebCenter Portal application is deployed.

getWebCenterServiceFrameworkConfig

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

Returns WebCenter Portal Service Framework configuration property settings, such as:

  • resourceActionHandlerClassName: Class currently used by the WebCenter Portal 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).

Syntax

getWebCenterServiceFrameworkConfig(appName, [server], [applicationVersion])
Argument Definition
appName

Name of the WebCenter Portal application in which to perform this operation. For the Spaces application, the name is always webcenter.

server

Optional. Name of the managed server where the WebCenter Portal 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 Portal application is deployed.


Example

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

webcenterErrorOccurred

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

Returns the status of last WebCenter Portal command executed.

Use the webcenterErrorOccurred command to determine the status of the last WebCenter Portal command executed. The command returns 1 if an error occurred or 0 otherwise.

Syntax

webcenterErrorOccurred ()

Example

The following example returns 1 if an error occurred:

wls:/mydomain/serverConfig> webcenterErrorOccurred()

getWebCenterConnectionTypes

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

Lists all the WebCenter Portal connection types.

Syntax

getWebCenterConnectionTypes (appName, [server, applicationVersion])
Argument Definition
appName

Name of the WebCenter Portal application in which to perform this operation. For the Spaces application, the name is always webcenter.

server

Optional. Name of the managed server where the WebCenter Portal 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 Portal application is deployed.


Example

The following example returns WebCenter Portal connection types for an application named webcenter:

wls:/mydomain/serverConfig> getWebCenterConnectionTypes(appName='webcenter')

cloneWebCenterManagedServer

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

Creates a new managed server with the same resources as a specified, base managed server.

Syntax

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 1, additional progress information displays during the creation process which is useful for diagnostic purposes.

The default is 0.


Example

The following example creates a clone of the WC_CustomPortal managed server. The new managed server is named WC_CustomPortal2:

wls:/weblogic/serverConfig> cloneWebCenterManagedServer(baseManagedServer='WC_CustomPortal', newManagedServer='WC_CustomPortal2', newManagedServerPort=1234)

Analytics

Analytics Collector Connections

Use the commands listed in Table 10-3 to manage Analytics Collector connections for a WebCenter Portal application. Events raised in WebCenter Portal 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 Portal WLST commands are only effective after your restart the Managed Server on which the WebCenter Portal 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...

createAnalyticsCollectorConnection

Create a connection to an Analytics Collector for a WebCenter Portal application.

Online

setAnalyticsCollectorConnection

Edit an existing Analytics Collector connection.

Online

listAnalyticsCollectorConnections

List all of the Analytics Collector connections that are configured for a WebCenter Portal application.

Online

setDefaultAnalyticsCollectorConnection

Specify the default (or active) Analytics Collector connection for a WebCenter Portal application.

Online

listDefaultAnalyticsCollectorConnection

Return connection details for the Analytics Collector being used by a WebCenter Portal 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...

setAnalyticsCollectorConfig

Set Analytics Collector options, and cluster options if operating a clustered environment.

Online

listAnalyticsCollectorConfig

Return Analytics Collector settings.

Online

listAnalyticsEventTypes

List events currently registered with the Analytics Collector.

Online


createAnalyticsCollectorConnection

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

Creates a connection to an Analytics Collector for a named WebCenter Portal application.

Events raised in WebCenter Portal 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 Portal application, only one Analytics Collector connection is used - the default (or active) connection where default=1.

Syntax

createAnalyticsCollectorConnection(appName, connectionName, [isUnicast, collectorhost, 
clusterName, collectorPort, isEnabled, timeout, default, server,
applicationVersion])
Argument Definition
appName

Name of the WebCenter Portal application in which to perform this operation. For the Spaces application, the name is always webcenter.

connectionName

Connection name. The name must be unique across all connection types within the WebCenter Portal 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 isUnicast='1'.

clusterName

Optional. Name of the cluster where a clustered Analytics Collector is running.

Only required for multicast communication, that is, where isUnicast=0.

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 isEnabled=1 and default=1.

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 isUnicast=0.

default

Optional. Indicates whether this connection is the default (or active) Analytics Collector connection for the WebCenter Portal application. Valid values are 1 (true) and 0 (false). When set to 1, the WebCenter Portal 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 Portal 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 Portal 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 Portal application is deployed.


Example

The following example creates a connection named MyAnalyticsCollector for a WebCenter Portal 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 Portal 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)

setAnalyticsCollectorConnection

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

Edits an existing Analytics Collector connection for a named WebCenter Portal application.

Events raised in WebCenter Portal 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 Portal application, only one Analytics Collector connection is used - the default (or active) connection.

Syntax

setAnalyticsCollectorConnection(appName, connectionName, [isUnicast, collectorHost, clusterName, collectorPort, isEnabled, timeout, default, server, applicationVersion])
Argument Definition
appName

Name of the WebCenter Portal application in which to perform this operation. For the Spaces application, the name is always webcenter.

connectionName

Connection name. The name must be unique (across all connection types within the WebCenter Portal 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 isUnicast=1.

clusterName

Optional. Name of the cluster where a clustered Analytics Collector is running.

Only required for multicast communication, that is, where isUnicast=0.

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 isEnabled=1 and default=1.

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 isUnicast=0.

default

Optional. Indicates whether this connection is the default (or active) Analytics Collector connection for the WebCenter Portal application. Valid values 1 (true) and 0 (false). When set to 1, the WebCenter Portal 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 Portal 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 Portal 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 Portal application is deployed.


Example

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)

listAnalyticsCollectorConnections

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

Lists connection names and details for all Analytics Collector connections that are configured for a named WebCenter Portal application.

Syntax

listAnalyticsCollectorConnections(appName, [server, applicationVersion])
Argument Definition
appName

Name of the WebCenter Portal application in which to perform this operation.

server

Optional. Name of the managed server where the WebCenter Portal 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 Portal application is deployed.


Examples

The following example lists connection names and details for all the Analytics Collector connections that are currently configured for an application named webcenter.

wls:/weblogic/serverConfig>listAnalyticsCollectorConnections(appName='webcenter')

setDefaultAnalyticsCollectorConnection

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

Specifies the default Analytics Collector connection for a named WebCenter Portal application.

The default Analytics Collector connection is used to send events raised in WebCenter Portal 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 Portal application, only one Analytics Collector connection is used - the default (or active) connection.

Syntax

setDefaultAnalyticsCollectorConnection(appName, name, [server, applicationVersion])
Argument Definition
appName

Name of the WebCenter Portal 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 Portal 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 Portal application is deployed.


Example

The following example configures the connection MyAnalyticsCollector for events raised in an application named webcenter:

wls:/weblogic/serverConfig> setDefaultAnalyticsCollectorConnection
(appName='webcenter', name='myAnalyticsCollector')

listDefaultAnalyticsCollectorConnection

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

Return details about the Analytics Collector connection that is currently configured for a WebCenter Portal application.

While you can register multiple Analytics Collector connections for a WebCenter Portal application, only one Analytics Collector connection is used—the default (or active) connection.

Syntax

listDefaultAnalyticsCollectorConnection(appName, [server, applicationVersion])
Argument Definition
appName

Name of the WebCenter Portal application in which to perform this operation.

server

Optional. Name of the managed server where the WebCenter Portal 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 Portal application is deployed.


Examples

The following example returns details about the Analytics Collector connection that is currently configured for a WebCenter Portal application named webcenter:

wls:/weblogic/serverConfig>listDefaultAnalyticsCollectorConnection(appName='webcenter')

setAnalyticsCollectorConfig

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

Configure the Analytics Collector deployed on the WC_Utilities managed server. Additionally, in a clustered environment, use this commands to set cluster settings.

Syntax

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.

  • Broadcast - use the standard network broadcast channel.

  • Multicast - use a special fixed multicast address.

clusterEnabled

Optional. Indicates whether the Analytics Collector is deployed in a cluster. Valid values are 1 (true) and 0 (false).

If set to 1, clusterName must also be defined.

clusterName

Optional. Name of the Analytics Collector cluster.

Only required when clusterEnabled=1

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 (hostName). In a clustered environment, WebCenter Portal applications use the heartbeat to determine which Analytics Collectors are available.

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.


Example

The following example changes the default port to 31315:

wls:/weblogic/serverConfig>setAnalyticsCollectorConnection(appName='analytics-collector', defaultPort=31315)

listAnalyticsCollectorConfig

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

Returns Analytics Collector settings.

Syntax

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.


Examples

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

listAnalyticsEventTypes

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

Lists all the events currently registered with the Analytics Collector.

Syntax

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.


Examples

The following command lists all the events currently registered with the Analytics Collector for use by a WebCenter Portal 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
...

Activity Graph

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...

exportAGMetadata

Export Activity Graph metadata definitions to an XML file.

Online

importAGMetadata

Import Activity Graph metadata definitions from an XML file.

Online

exportAGProviderConfiguration

Export provider configuration, for a given provider, to an Activity Graph metadata definition file.

Online

deleteAllAGMetadata

Delete all the Activity Graph metadata that is defined for a WebCenter application.

Online

deleteAGAction

Delete the metadata for an action registered with Activity Graph.

Online

deleteAGNodeClass

Delete the metadata for a node class registered with Activity Graph.

Online

deleteAGSimilarityCalculation

Delete the metadata for a similarity calculation registered with Activity Graph.

Online

deleteAGRankCalculation

Delete the metadata for a rank calculation registered with Activity Graph.

Online

deleteAGProviderAssignment

Delete the metadata for a provider assignment registered with Activity Graph.

Online

deleteAGQRPPRegistration

Delete the metadata for a QRPP registered with Activity Graph.

Online

deleteAGProviderConfiguration

Delete the metadata for a provider configuration registered with Activity Graph.

Online

renameAGAction

Change the URN of an action registered with Activity Graph.

Online

renameAGNodeClass

Change the URN of a node class registered with Activity Graph.

Online

setAGProperty

Set a system property for Activity Graph.

Online

getAGProperty

Return the current setting for a given Activity Graph property.

Online

setAGPasswordCredential

Set credentials (user name and password) for an Activity Graph property.

Online


exportAGMetadata

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

Exports Activity Graph metadata definitions to an XML file.

Syntax

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.


Example

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')

importAGMetadata

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

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.

Syntax

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.


Example

The following example imports Activity Graph metadata definitions from a file name import-metadata.xml:

wls:/weblogic/serverConfig> importAGMetadata(appName='activitygraph-engines', definitionFilePath='metadata/import-metadata.xml')

exportAGProviderConfiguration

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

Exports provider configuration, for a given provider, to an Activity Graph metadata definition file.

Syntax

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.


Example

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')

deleteAllAGMetadata

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

Deletes all the Activity Graph metadata that is defined for a WebCenter Portal 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.

Syntax

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.


Example

The following example deletes all existing Activity Graph metadata:

wls:/weblogic/serverConfig> deleteAllAGMetadata(appName='activitygraph-engines')

deleteAGAction

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

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.

Syntax

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.


Example

The following example deletes Activity Graph metadata for the connect action:

wls:/weblogic/serverConfig> deleteAGAction(appName='activitygraph-engines', urn='connect')

deleteAGNodeClass

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

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.

Syntax

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.


Example

The following example deletes Activity Graph metadata for the node class WC.wiki-page action:

wls:/weblogic/serverConfig> deleteAGNodeClass(appName='activitygraph-engines', urn='WC.wiki-page')

deleteAGSimilarityCalculation

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

Deletes the metadata for a similarity calculation that is currently registered with Activity Graph. The delete operation is immediate and non-reversible.

Syntax

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.


Example

The following example deletes Activity Graph metadata for the similarity calculation item-edit:

wls:/weblogic/serverConfig> deleteAGSimilarityCalculation(appName='activitygraph-engines', urn='item-edit')

deleteAGRankCalculation

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

Deletes the metadata for a rank calculation that is currently registered with Activity Graph. The delete operation is immediate and non-reversible.

Syntax

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.


Example

The following example deletes Activity Graph metadata for the activity-rank calculation:

wls:/weblogic/serverConfig> deleteAGRankCalculation(appName='activitygraph-engines', urn='activity-rank')

deleteAGProviderAssignment

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

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.

Syntax

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.


Example

The following example deletes Activity Graph metadata for the provider assignment specified:

wls:/weblogic/serverConfig> deleteAGRProviderAssignment(appName='activitygraph-engines', actionURN='connect', 
srcClassURN='WC.user', trgClassURN='WC.user')

deleteAGQRPPRegistration

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

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.

Syntax

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.


Example

The following example deletes Activity Graph metadata for a QRPP named Event store metadata QRPP:

wls:/weblogic/serverConfig> deleteAGQRPPRegistration(appName='activitygraph-engines', urn='Event store metadata QRPP')

deleteAGProviderConfiguration

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

Deletes the metadata for a provider configuration. The delete operation is immediate and non-reversible.

Syntax

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.


Example

The following example deletes configuration information for the Activity Graph provider oracle.webcenter.activitygraph.analytics:

wls:/weblogic/serverConfig> deleteAGProviderConfiguration(appName='activitygraph-engines', urn='oracle.webcenter.activitygraph.analytics')

renameAGAction

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

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.

Syntax

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.


Example

The following example changes the connect action URN to people-connect:

wls:/weblogic/serverConfig> renameAGAction(appName='activitygraph-engines',  currentURN='connect', newURN='connect')

renameAGNodeClass

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

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.

Syntax

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.


Example

The following example changes the WC.user node class URN to WC.people:

wls:/weblogic/serverConfig> renameAGNodeClass(appName='activitygraph-engines',  currentURN='WC.user', newURN='WC.people')

setAGProperty

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

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 (oracle.webcenter.activitygraph.providers.datasources.ses.soap.admin.url and oracle.webcenter.activitygraph.providers.datasources.ses.soap.query.url)

  • Engine configuration (oracle.webcenter.activitygraph.rankengine.enabled)

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).

Syntax

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.


Example

The following example enables the Rank Engine:

wls:/weblogic/serverConfig> setAGProperty(appName='activitygraph-engines', 
propertyName='oracle.webcenter.activitygraph.rankengine.enabled', 
propertyValue='true', propertyType='boolean')

getAGProperty

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

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.

Syntax

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.


Example

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')

setAGPasswordCredential

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

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.

Syntax

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.


Example

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')

Activity Stream

Use the commands listed in Table 10-6 to archive and restore activity stream data generated for a WebCenter Portal application.

Configuration changes made using these WebCenter Portal WLST commands are only effective after your restart the Managed Server on which the WebCenter Portal 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...

archiveASByDate

Archive activity stream data that is older than a specified date.

Online

archiveASByDeletedObjects

Archive activity stream data associated with deleted objects.

Online

archiveASByClosedSpaces

Archive activity stream data associated with Spaces that are currently closed.

Online

archiveASByInactiveSpaces

Archive activity stream data associated with Spaces that have been inactive since a specified date.

Online

restoreASByDate

Restore archived activity stream data from a specified date into production tables.

Online

truncateASArchive

Truncates activity stream archive data.

Online


archiveASByDate

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

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.

Syntax

archiveASByDate(appName, year, month, day, [server, applicationVersion])
Argument Definition
appName

Name of the WebCenter Portal 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 Portal 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 Portal application is deployed.


Example

The following example archives activity stream data that is older than October 1, 2009:

wls:/weblogic/serverConfig> archiveASByDate(appName='webcenter', year=2009, month=10, day=1)

archiveASByDeletedObjects

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

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.

Syntax

archiveASByDeletedObjects(appName, [server, applicationVersion])
Argument Definition
appName

Name of the WebCenter Portal application in which to perform this operation.

server

Optional. Name of the managed server where the WebCenter Portal 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 Portal application is deployed.


Example

The following example archives activity stream data associated with deleted objects:

wls:/weblogic/serverConfig> archiveASByDeletedObjects(appName='webcenter')

archiveASByClosedSpaces

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

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.

Syntax

archiveASByClosedSpaces(appName, [server, applicationVersion])
Argument Definition
appName

Name of the WebCenter Portal application in which to perform this operation.

server

Optional. Name of the managed server where the WebCenter Portal 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 Portal application is deployed.


Example

The following example archives activity stream data associated with Spaces that are currently closed:

wls:/weblogic/serverConfig> archiveASByClosedSpaces(appName='webcenter')

archiveASByInactiveSpaces

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

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.

Syntax

archiveASByInactiveSpaces(appName, year, month, day, [server, applicationVersion])
Argument Definition
appName

Name of the WebCenter Portal 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 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 Spaces application is deployed.


Example

The following example archives activity stream data associated with spaces that have been inactive (no activities have occurred, regardless of open or closed status) since October 1, 2009:

wls:/weblogic/serverConfig> archiveASByInactiveSpaces(appName='webcenter', year=2009, month=10, day=1)

restoreASByDate

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

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.

Syntax

restoreASByDate(appName, year, month, day, [server, applicationVersion])
Argument Definition
appName

Name of the WebCenter Portal 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 Portal 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 Portal application is deployed.


Example

The following example restores activity stream data archived since October 1, 2009:

wls:/weblogic/serverConfig>restoreASByDate(appName='webcenter', year=2009, month=10, day=1)

truncateASArchive

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

Truncates activity stream archive data.

Syntax

truncateASArchive(appName, [server, applicationVersion])
Argument Definition
appName

Name of the WebCenter Portal application in which to perform this operation.

server

Optional. Name of the managed server where the WebCenter Portal 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 Portal application is deployed.


Example

The following example truncates activity stream archive data:

wls:/weblogic/serverConfig>truncateASArchive(appName='webcenter')

Content Repository

Use the commands listed in Table 10-7 to manage content repository connections and configure the Documents service for a WebCenter Portal application.

Configuration changes made using these WebCenter Portal WLST commands are only effective after your restart the Managed Server on which the WebCenter Portal 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...

createJCRContentServerConnection

Create a connection to an Oracle WebCenter Content repository.

Online

setJCRContentServerConnection

Edit an existing Oracle WebCenter Content repository connection.

Online

listJCRContentServerConnections

List individual or all Oracle WebCenter Content repository connections that are configured for a WebCenter Portal application.

Online

createJCRPortalConnection

Create an Oracle Portal repository connection.

Online

setJCRPortalConnection

Edit an existing Oracle Portal repository connection.

Online

listJCRPortalConnections

List all Oracle Portal connections that are configured for a WebCenter Portal application.

Online

createJCRFileSystemConnection

Create a connection to a file system.

Online

setJCRFileSystemConnection

Edit an existing file system repository connection.

Online

listJCRFileSystemConnections

List individual or all file system connections configured for a WebCenter Portal application.

Online

createJCRSharePointConnection

Create a Microsoft SharePoint 2007 repository connection.

Online

setJCRSharePointConnection

Edit a Microsoft SharePoint 2007 repository connection.

Online

listJCRSharePointConnections

List all Microsoft SharePoint 2007 connections that are configured for a WebCenter Portal application.

Online

listDocumentsSpacesProperties

List properties for the back-end Content Server that is being used by the Spaces application.

Online

setDocumentsSpacesProperties

Modify properties for the back-end Content Server used by the Spaces application.

Online

deleteDocumentsSpacesProperties

Delete properties for the back-end Content Server used by the Spaces application.

Online


createJCRContentServerConnection

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

Creates a connection to an Oracle WebCenter Content repository for a named WebCenter Portal application.

Syntax

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 Portal application in which to perform this operation.

name

Connection name. The name must be unique (across all connection types) within the WebCenter Portal application.

socketType

Specifies whether Oracle WebCenter Content's 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:

  • socket—Use an intradoc socket connection to connect to the Content Server. The client IP address must be added to the list of authorized addresses in the Content Server. In this case, the client is the machine on which Oracle WebCenter Portal is running.

  • socketssl—Use an intradoc socket connection to connect to the Content Server. that is secured using the SSL protocol. The client's certificates must be imported in the server's trust store for the connection to be allowed. Because this is the most secure option, this is the recommended option whenever identity propagation is required (for example, in the Spaces application).

  • web—Use an HTTP(S) connection to connect to the Content Server. Note that for the Spaces application, this option is not suitable for the active connection, that is, the back-end Content Server. repository that is being used to store space-specific documents and Home space documents, because it does not allow identity propagation.

  • jaxws—Use a Java API for XML Web Services connection to connect to the Content Server.

url

Optional. 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, http://mycontentserver/cms/idcplg.

serverHost

Optional. Host name of the machine where the Content Server is running. Required if socketType is set to socket or socketssl.

serverPort

Optional. Port on which the Content Server listens. Required if socketType is set to socket or socketssl:

  • Socket—Port specified for the incoming provider in the server.

  • Socket SSL—Port specified for the sslincoming provider in the server.

This property corresponds to the IntradocServerPort setting in the Content Server configuration file, which defaults to port 4444.

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 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 the Content Server. Use the format /<context_root>. For example, /cs.

When specified, several Oracle WebCenter Content features based on iFrame are available in the WebCenter Portal application. This includes:

  • Associating a content profile with files when uploading new or updated files to Content Server.

    For more information, see "Uploading New Files" and "Uploading a New Version of an Existing File" in Oracle Fusion Middleware User's Guide for Oracle WebCenter.

  • Using the document review functionality available in Oracle AutoVue.

    For more information, see "Reviewing and Collaborating on Documents Using AutoVue" in Oracle Fusion Middleware User's Guide for Oracle WebCenter.

  • Editing advanced document properties.

    For more information, see "Working with File Properties" in Oracle Fusion Middleware User's Guide for Oracle WebCenter.

  • Viewing folder and file workflow details.

    For more information, see "Viewing Workflow Information" in Oracle Fusion Middleware User's Guide for Oracle WebCenter.

  • Previewing files in a slide viewer.

    For more information, see "Opening a File" in Oracle Fusion Middleware User's Guide for Oracle WebCenter.

  • Site Studio integration

    For more information, see Oracle Fusion Middleware User's Guide for Oracle WebCenter.

webContextRoot is only applicable when IDENTITY_PROPAGATION is used for authentication, that is, when extAppId is set to an empty string.

Note: To fully enable these Oracle WebCenter Content features you must access the WebCenter Portal application through Oracle HTTPS Server (OHS) to expose Content Server and the WebCenter Portal application under the same host and port. Both the WebCenter Portal application and Content Server must also use single sign on. For information about setting up OHS to front-end WebCenter Portal applications, see "Content Server - Configuration" in Oracle Fusion Middleware Administrator's Guide for Oracle WebCenter.

If your WebCenter Portal application is connected to multiple Content Servers, Oracle recommends that each Content 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 Content Server content changes (in minutes). WebCenter Portal 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 Content Server binary documents. Documents larger than this size are not cached by WebCenter Portal. 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 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 Content Server administrator specified in adminUsername. Required when socketType is set to web.

extAppId

Optional. External application used to authenticate users against the 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 extAppId is set to an empty string, the authentication method used is IDENTITY_PROPAGATION. With this method, the WebCenter Portal application and Content Server use the same identity store to authenticate users. Note that extAppID is mandatory when socketType is set to web.

timeout

Optional. Length of time allowed to log in to 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 the Spaces application, the primary connection is used to store space-specific content and Home space content.

server

Optional. Name of the managed server where the WebCenter Portal 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 Portal application is deployed.


Examples

The following example creates a socket-based connection to an Oracle WebCenter Content repository 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 WebCenter Content 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 WebCenter Content repository:

wls:/weblogic/serverConfig> createJCRContentServerConnection(appName='webcenter', 
name='myContentServerConnection', socketType='jaxws', url='http://myhost.com:9044/idcnativews', clientSecurityPolicy='oracle/wss10_saml_token_client_policy')

setJCRContentServerConnection

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

Edits an existing Oracle WebCenter Content repository connection. This command requires that you specify values for appName and name, plus one additional argument.

Syntax

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 Portal application in which to perform this operation.

name

Name of an existing Oracle WebCenter Content repository connection.

socketType

Optional. Specifies whether the Oracle WebCenter Content's 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:

  • socket—Use an intradoc socket connection to connect to the Content Server. The client IP address must be added to the list of authorized addresses in the Content Server. In this case, the client is the machine on which Oracle WebCenter Portal is running.

  • socketssl—Use an intradoc socket connection to connect to the Content Server that is secured using the SSL protocol. The client's certificates must be imported in the server's trust store for the connection to be allowed. Because this is the most secure option, this is the recommended option whenever identity propagation is required (for example, in the Spaces application).

  • web—Use an HTTP(S) connection to connect to the Content Server. Note that for the Spaces application, this option is not suitable for the back-end Content Server repository that is being used to store space-specific documents and Home space documents, because it does not allow identity propagation.

  • jaxws—Use a Java API for XML Web Services connection to connect to the Content Server.

url

Optional. 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, http://mycontentserver/cms/idcplg.

serverHost

Optional. Host name of the machine where the Content Server is running. Required if socketType is set to socket or socketssl.

serverPort

Optional. Port on which the Content Server listens. Required if socketType is set to socket or socketssl:

  • Socket—Port specified for the incoming provider in the server.

  • Socket SSL—Port specified for the sslincoming provider in the server.

For example, 4444

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 the Content Server. Use the format /<context_root>. For example, /cs.

When specified, several Oracle WebCenter Content features based on iFrame, such as previewing files in a slide viewer, are available in the WebCenter Portal application.

Note: To fully enable these features you must access the WebCenter Portal application through Oracle HTTPS Server (OHS) to expose Content Server and the WebCenter Portal application under the same host and port. In addition, both the WebCenter Portal application and the Content Server must use single sign on. For information about setting up OHS to front-end WebCenter Portal applications, see "Content Server - Configuration" in Oracle Fusion Middleware Administrator's Guide for Oracle WebCenter.

webContextRoot is only applicable when IDENTITY_PROPAGATION is used for authentication, that is, when extAppId is set to an empty string.

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 Content Server content changes (in minutes). WebCenter Portal 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 Content Server binary documents. Documents larger than this size are not cached by WebCenter Portal. 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 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 Content Server administrator specified in adminUsername. Required when socketType is set to web.

extAppId

Optional. External application used to authenticate users against the 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 extAppId is set to an empty string, the authentication method used is IDENTITY_PROPAGATION. With this method, the WebCenter Portal application and Content Server use the same identity store to authenticate users.

timeout

Optional. Length of time allowed to log in to 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 the Spaces application, the primary connection is used to store space-specific content and Home space content.

server

Optional. Name of the managed server where the WebCenter Portal 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 Portal application is deployed.


Examples

The following example edits a socket-based connection to an Oracle WebCenter Content repository.

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 WebCenter Content repository.

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 WebCenter Content repository:

wls:/weblogic/serverConfig> setJCRContentServerConnection(appName='webcenter', 
socketType='jaxws', url='http://myhost.com:9044/idcnativews', 
clientSecurityPolicy='oracle/wss10_saml_token_client_policy')

listJCRContentServerConnections

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

Without any arguments, this command lists all of the Oracle WebCenter Content repository connections that are configured for a named WebCenter Portal application.

Syntax

listJCRContentServerConnections(appName, [verbose], 
[name, server, applicationVersion])
Argument Definition
appName

Name of the WebCenter Portal 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 WebCenter Content repository connections that are configured for a WebCenter Portal 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 WebCenter Content repository connection. When specified you can view connection details for a specific Oracle WebCenter Content repository 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 Portal 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 Portal application is deployed.


Examples

The following example lists Oracle WebCenter Content repository connections configured for an application named webcenter.

wls:/weblogic/serverConfig> listJCRContentServerConnections(appName='webcenter')

The following example lists all properties of the Oracle WebCenter Content repository connection named myContentServerConnection1. The connection named myContentServerConnection1 must exist and be an Oracle WebCenter Content repository 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')

createJCRPortalConnection

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

Creates an Oracle Portal repository connection.

Syntax

createJCRPortalConnection(appName, name, dataSource, [extAppId, isPrimary, timeout, server, applicationVersion])
Argument Definition
appName

Name of the WebCenter Portal application in which to perform this operation.

name

Connection name. The name must be unique (across all connection types) within the WebCenter Portal 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 Portal application is deployed.

extAppId

Optional. External application used to authenticate 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 extAppId is set to an empty string, the authentication method used is IDENTITY_PROPAGATION. With this method, the WebCenter Portal application and Oracle Portal use the same identity store to authenticate users.

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 the Spaces application, the primary connection must be an Oracle WebCenter Content repository connection.

server

Optional. Name of the managed server where the WebCenter Portal 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 Portal application is deployed.


Example

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)

setJCRPortalConnection

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

Edits an existing Oracle Portal connection. This command requires that you specify values for either the dataSource or isPrimary argument.

Syntax

setJCRPortalConnection(appName, name, [dataSource, extAppId, timeout, isPrimary, server, applicationVersion])
Argument Definition
appName

Name of the WebCenter Portal 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 Portal application is deployed.

extAppId

Optional. External application used to authenticate 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 extAppId is set to an empty string, the authentication method used is IDENTITY_PROPAGATION. With this method, the WebCenter Portal application and Oracle Portal use the same identity store to authenticate users.

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 the Spaces application, the primary connection must be an Oracle WebCenter Content repository connection.

server

Optional. Name of the managed server where the WebCenter Portal 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 Portal application is deployed.


Example

The following example edits Oracle Portal repository connection details.

wls:/weblogic/serverConfig> setJCRPortalConnection(appName='webcenter', 
name='myPortalConnection', dataSource='/newPortalDS', extAppId='myExtApp', 
isPrimary=0)

listJCRPortalConnections

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

Without any arguments, this command lists all of the Oracle Portal connections that are configured for a named WebCenter Portal application.

Syntax

listJCRPortalConnections(appName, [verbose, name, server, applicationVersion])
Argument Definition
appName

Name of the WebCenter Portal 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 Portal 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 Portal 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 Portal application is deployed.


Example

The following example lists all of the Oracle Portal connections that are configured for a WebCenter Portal application.

wls:/weblogic/serverConfig> listJCRPortalConnections(appName='webcenter', 
verbose=1, name='myPortalConnection')

createJCRFileSystemConnection

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

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.

Syntax

createJCRFileSystemConnection(appName, name, path, [isPrimary, server, 
applicationVersion])
Argument Definition
appName

Name of the WebCenter Portal application in which to perform this operation.

name

Connection name. The name must be unique (across all connection types) within the WebCenter Portal 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 the Spaces application, the primary connection must be an Oracle WebCenter Content repository connection.

server

Optional. Name of the managed server where the WebCenter Portal 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 Portal application is deployed.


Example

The following example creates a connection to a file system repository.

wls:/weblogic/serverConfig> createJCRFileSystemConnection(appName='webcenter', 
name='FSAConnection', path='C:/ProjectDocuments')

setJCRFileSystemConnection

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

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.

Syntax

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 the Spaces application, the primary connection must be an Oracle WebCenter Content repository connection.

server

Optional. Name of the managed server where the WebCenter Portal 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 Portal application is deployed.


Example

The following example edits connection details for a file system repository.

wls:/weblogic/serverConfig> setJCRFileSystemConnection(appName='webcenter', 
name='FSAConnection', path='C:/ProjectDocuments')

listJCRFileSystemConnections

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

Without any arguments, this command lists all of the file system connections that are configured for a named WebCenter Portal application.

Note:

File system connections must not be used in production or enterprise application deployments. This feature is provided for development purposes only.

Syntax

listJCRFileSystemConnections(appName, [verbose, name, server, 
applicationVersion])
Argument Definition
appName

Name of the WebCenter Portal 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 Portal 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 Portal 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 Portal application is deployed.


Examples

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)

createJCRSharePointConnection

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

Creates a connection to a Microsoft SharePoint 2007 repository.

Syntax

createJCRSharePointConnection(appName, name, url, [likeLimit, extAppId, timeout, isPrimary, server, applicationVersion])
Argument Definition
appName

Name of the WebCenter Portal application in which to perform this operation.

name

Connection name. The name must be unique (across all connection types) within the WebCenter Portal application.

url

Web address of the SharePoint site to which you want to connect.

For example, if the SharePoint site address is http://mysharepoint.mycompany.com, enter this value for the url argument.

likeLimit

Optional. Number of characters the LIKE operator matches. The default is 64.

The SharePoint query language can use a LIKE keyword to constrain URL queries (document paths) that match a search pattern. By default, the LIKE operator supports a pattern match on strings up to 64 characters. Use this argument to specify a different character limit (any positive integer between 1 and 64) or enter likeLimit=0 to disable the LIKE limit, that is, always send the full query string to the Microsoft SharePoint server.

As Oracle recommends the default value (64), there is no need to specify this argument when you create a connection using the WLST command createJCRSharePointConnection.

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 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, the SharePoint repository connection will not work.

extAppId can be set or changed at any time using the setJCRSharePointConnection command.

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 the Spaces application, the primary connection must be an Oracle WebCenter Content repository connection.

server

Optional. Name of the managed server where the WebCenter Portal 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 Portal application is deployed.


Example

The following example creates a connection to a Microsoft SharePoint site.

wls:/weblogic/serverConfig> createJCRSharePointConnection(appName='webcenter', name='MySPConnection', url='http://mysharepoint.mycompany.com', extAppId='myExtApp')

setJCRSharePointConnection

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

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.

Syntax

setJCRSharePointConnection(appName, name, [url, likeLimit, extAppId, timeout, isPrimary, server, applicationVersion])
Argument Definition
appName

Name of the WebCenter Portal 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 http://mysharepoint.mycompany.com, enter this value for the url argument.

likeLimit

Optional. Number of characters the LIKE operator matches. The default is 64.

The SharePoint query language can use a LIKE keyword to constrain URL queries (document paths) that match a search pattern. By default, the LIKE operator supports a pattern match on strings up to 64 characters. Use this argument to specify a different character limit (any positive integer between 1 and 64) or enter likeLimit=0 to disable the LIKE limit, that is, always send the full query string to the Microsoft SharePoint server.

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 likeLimit='' or likeLimit=64.

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 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 the Spaces application, the primary connection must be an Oracle WebCenter Content repository connection.

server

Optional. Name of the managed server where the WebCenter Portal 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 Portal application is deployed.


Example

The following example edits SharePoint repository connection details.

wls:/weblogic/serverConfig> setJCRSharePointConnection(appName='webcenter', name='MySPConnection', url='http://mysharepoint.mycompany.com', extAppId='myExtApp')

listJCRSharePointConnections

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

Without any arguments, this command lists all of the SharePoint connections that are configured for a named WebCenter Portal application.

Syntax

listJCRSharePointConnections(appName, [verbose, name, server, applicationVersion])
Argument Definition
appName

Name of the WebCenter Portal 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 Portal 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 Portal 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 Portal application is deployed.


Example

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)

listDocumentsSpacesProperties

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

Lists properties for the back-end Oracle WebCenter Content repository that is being used by the Spaces application to store space-specific documents and Home space documents. This command is only valid for the Spaces application.

Syntax

listDocumentsSpacesProperties(appName, [server, applicationVersion])
Argument Definition
appName

Name of the Spaces application in which to perform this operation—always webcenter.

server

Optional. Name of the managed server where the 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 Spaces application is deployed.


Example

The following example lists properties for the back-end Oracle WebCenter Content repository that is being used by a Spaces application (named webcenter) to store space-specific 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"

setDocumentsSpacesProperties

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

Modifies properties for the back-end Oracle WebCenter Content repository that is being used by the Spaces application to store Space-related data. This command is only valid for the Spaces application.

Syntax

setDocumentsSpacesProperties(appName, [spacesRoot, adminUserName, 
applicationName, server, applicationVersion])
Argument Definition

appName

Name of the Spaces application in which to perform this operation—always webcenter.

spacesRoot

Optional. Root folder under which the Spaces application 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 and applicationName arguments.

adminUserName

Optional. User name of the content repository administrator. For example: sysadmin. This user will be used to create and maintain folders for Spaces application content and manage content access rights.

Administrative privileges are required for this connection so that operations can be performed on behalf of Spaces users.

Note that if you provide a value for this argument, you must also provide values for the spacesRoot and applicationName arguments.

applicationName

Optional. Unique Spaces application identifier. This name is used to separate data when multiple 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 spacesRoot and adminUserName arguments.

The name specified here is also used to name document-related workflows, as follows:

<applicationName><WorkflowName>

<applicationName><WorkflowStepName>

When naming workflows, only the first 14 characters of the Application Name are used.

server

Optional. Name of the managed server where the WebCenter Portal 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 Portal application is deployed.


Examples

The following example modifies connection properties for the back-end Oracle WebCenter Content repository that is being used by the Spaces application to store space-specific 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 WebCenter Content repository that is being used by the Spaces application to store space-specific documents and Home space documents.

wls:/weblogic/serverConfig> setDocumentsSpacesProperties(appName='webcenter', 
adminUserName='sysadmin')

deleteDocumentsSpacesProperties

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

Deletes properties for the back-end Oracle WebCenter Content repository used by the Spaces application, that is the adminUserName, applicationName, and spacesRoot. This command is only valid for the Spaces application.

Syntax

deleteDocumentsSpacesProperties(appName, [server, applicationVersion])
Argument Definition
appName

Name of the 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 Portal application is deployed.


Example

The following example deletes connection properties (adminUserName, applicationName, spacesRoot) of the back-end Oracle WebCenter Content repository that is being used by the Spaces application.

wls:/weblogic/serverConfig> deleteDocumentsSpacesProperties(appName='webcenter')

Discussions and Announcements

Use the commands listed in Table 10-8 to manage discussions server connections for WebCenter Portal applications.

Configuration changes made using these WebCenter Portal WLST commands are only effective after your restart the Managed Server on which the WebCenter Portal 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...

createDiscussionForumConnection

Create a new discussions server connection for a WebCenter Portal application.

Online

setDiscussionForumConnection

Edit an existing discussions server connection.

Online

setDefaultDiscussionForumConnection

Specify the default connection for the Discussions and Announcements services.

Online

listDiscussionForumConnections

List all of the discussions server connections that are configured for an application.

Online

listDefaultDiscussionForumConnection

List the default discussions server connection for an application.

Online

setDiscussionForumConnectionProperty

Set an additional discussions server connection property.

Online

deleteDiscussionForumConnectionProperty

Delete a discussions server connection property.

Online

setDiscussionForumServiceProperty

Specify defaults for the Discussions service.

Online

removeDiscussionForumServiceProperty

Remove defaults for the Discussions service.

Online

listDiscussionForumServiceProperties

List Discussions service properties.

Online

setAnnouncementServiceProperty

Specify defaults for the Announcements service.

Online

removeAnnouncementServiceProperty

Remove defaults for the Announcements service.

Online

listAnnouncementServiceProperties

List Announcements service properties.

Online

addDiscussionsServerAdmin

Grant system administrator permissions on the discussions server to a user or a group.

Online

syncDiscussionServerPermissions

Synchronizes discussion server permissions for subspaces that inherit security from their parent.

Online

setDiscussionsServerProperty

Set discussions server properties.

Online

getDiscussionsServerProperty

Return discussions server property values.

Online

removeDiscussionsServerProperty

Remove current discussions server property values.

Online


createDiscussionForumConnection

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

Creates a new discussions server connection for a named WebCenter Portal 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 Portal application, only one connection is used for discussion and announcement services - the default (or active) connection.

Syntax

createDiscussionForumConnection(appName, name, url, adminUser, 
[timeout, default, policyURIForAuthAccess, policyURIForPublicAccess, recipientKeyAlias]) 

Argument Definition
appName

Name of the WebCenter Portal application in which to perform this operation.

name

Connection name. The name must be unique (across all connection types) within the WebCenter Portal 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 Portal users.

This account is mostly used for managing discussions and announcements in the Spaces application. It is not necessary for this user to be a super admin. However, the user must have administrative privileges on the current application root category for the Spaces application, that is, the category (on the discussions server) under which all Space-related discussions and announcements are stored.

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 OWCDiscussionsServiceAuthenticated endpoint in the discussions server. Out-of-the-box, the default service policy is WSS 1.0 SAML Token Service Policy (oracle/wss10_saml_token_service_policy).

Valid client policy values include:

  • oracle/wss10_saml_token_client_policy (WSS 1.0 SAML Token Client Policy)

  • oracle/wss11_saml_token_with_message_protection_client_policy (WSS 1.1 SAML Token with Message Protection Client Policy)

  • GPA (Global Policy Attachment) - Use GPA if your environment supports Global Policy Attachments. In addition, ensure that the default policy is detached from the OWCDiscussionsServiceAuthenticated endpoint in the discussions server using the WLST command detachWebServicePolicy or Enterprise Manager.

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 oracle/no_authentication_client_policy.

The client policy specified must be compatible with the service policy that is configured for the OWCDiscussionsServicePublic endpoint in the discussions server. Out-of-the-box, a service policy is not configured for public access (oracle/no_authentication_client_policy).

Valid client policy values include:

  • oracle/no_authentication_client_policy (None)

  • oracle/wss11_with_message_protection_client_policy (WSS 1.1 Message Protection Client Policy)

  • GPA (Global Policy Attachment) - Use GPA if your environment supports Global Policy Attachments. In addition, you must ensure that the default policy attached to the OWCDiscussionsServicePublic endpoint in the discussions server is set to oracle/no_authentication_service_policy.

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 Portal 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 1 (true) and 0 (false). When set to 1, the Discussions service and the Announcements service both use this connection. When set to 0, the connection is not used. The default is 0.

server

Optional. Name of the managed server where the WebCenter Portal 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 Portal application is deployed.


Example

The following example creates a discussions server connection for a WebCenter Portal 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)

setDiscussionForumConnection

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

Edits an existing discussions server connection. Use this command to update connection attributes.

The connection is created using the createDiscussionForumConnection command.

Syntax

setDiscussionForumConnection(appName, name, [url, adminUser, policyURIForAuthAccess, policyURIForPublicAccess, recipientKeyAlias, timeout, default, server, applicationVersion])
Argument Definition
appName

Name of the WebCenter Portal 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 Portal users.

This account is mostly used for managing discussions and announcements in the Spaces application. It is not necessary for this user to be a super admin. However, the user must have administrative privileges on the current root category for the Spaces application, that is, the category (on the discussions server) under which all Spaces discussion forums are stored.

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 OWCDiscussionsServiceAuthenticated endpoint in the discussions server. Out-of-the-box, the default service policy is WSS 1.0 SAML Token Service Policy (oracle/wss10_saml_token_service_policy).

Valid client policy values include:

  • oracle/wss10_saml_token_client_policy (WSS 1.0 SAML Token Client Policy)

  • oracle/wss11_saml_token_with_message_protection_client_policy (WSS 1.1 SAML Token with Message Protection Client Policy)

  • GPA (Global Policy Attachment) - Use GPA if your environment supports Global Policy Attachments. In addition, ensure that the default policy is detached from the OWCDiscussionsServiceAuthenticated endpoint in the discussions server using the WLST command detachWebServicePolicy or Enterprise Manager.

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 oracle/no_authentication_client_policy.

The client policy specified must be compatible with the service policy that is configured for the OWCDiscussionsServicePublic endpoint in the discussions server. Out-of-the-box, a service policy is not configured for public access (oracle/no_authentication_client_policy).

Valid client values include:

  • oracle/no_authentication_client_policy (None)

  • oracle/wss11_with_message_protection_client_policy (WSS 1.1 Message Protection Client Policy)

  • GPA (Global Policy Attachment) - Use GPA if your environment supports Global Policy Attachments. In addition, you must ensure that the default policy attached to the OWCDiscussionsServicePublic endpoint in the discussions server is set to oracle/no_authentication_service_policy.

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 Portal 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 1 (true) and 0 (false). When set to 1, the Discussion and Announcement services use this connection. When set to 0, the connection is not used. The default is 0.

To specify that the Discussion and Announcements service use this connection, change the value from 0 to 1.

To disable this connection, use the removeDiscussionForumServiceProperty command:

removeDiscussionForumServiceProperty('appName='webcenter', property='selected.connection')

Note: While you can register multiple discussions server connections for a WebCenter Portal 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 Portal 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 Portal application is deployed.


Example

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)

setDiscussionForumConnectionProperty

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

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

application.root.category.id

(Spaces application 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.


Syntax

setDiscussionForumConnectionProperty(appName, name, key, value, [secure, server, 
applicationVersion])
Argument Definition
appName

Name of the WebCenter Portal 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 1 if you are storing passwords.

server

Optional. Name of the managed server where the WebCenter Portal 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 Portal application is deployed.


Example

The following example configures the category used to store discussion forums 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)

deleteDiscussionForumConnectionProperty

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

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.

Syntax

deleteDiscussionForumConnectionProperty(appName, name, key, [server, 
applicationVersion])
Argument Definition
appName

Name of the WebCenter Portal 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 Portal 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 Portal application is deployed.


Example

The following example deletes a discussions server connection property named myProperty1.

wls:/weblogic/serverConfig> deleteDiscussionForumConnectionProperty
(appName='webcenter', name='MyDiscussionServer', key='myProperty1')

listDiscussionForumConnections

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

Lists all of the discussions server connections that are configured for a named WebCenter Portal application.

Syntax

listDiscussionForumConnections(appName, [verbose, name, server, applicationVersion])
Argument Definition
appName

Name of the WebCenter Portal 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 Portal 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 Portal 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 Portal application is deployed.


Examples

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')

listDefaultDiscussionForumConnection

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

Names the discussions server connection that the Discussions service and the Announcements service are using, in a named WebCenter Portal application. While you can register multiple discussions server connections for a WebCenter Portal application, the Discussions/Announcements service only uses one connection—known as the default (or active) connection.

Syntax

listDefaultDiscussionForumConnection(appName, [verbose, server, applicationVersion])
Argument Definition
appName

Name of the WebCenter Portal 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 Portal 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 Portal application is deployed.


Examples

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)

setDefaultDiscussionForumConnection

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

Specifies the default discussions server connection for the Discussions service and the Announcements service, in a named WebCenter Portal application.

While you can register multiple discussions server connections with a WebCenter Portal application, the Discussions/Announcements services only uses one connection—this is known as the default (or active) connection.

Syntax

setDefaultDiscussionForumConnection(appName, name, [server, 
applicationVersion])
Argument Definition
appName

Name of the WebCenter Portal 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 Portal 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 Portal application is deployed.


Example

The following example makes a connection named myDiscussionServer the default (or active) connection for the Discussions and Announcement services.

wls:/weblogic/serverConfig> setDefaultDiscussionForumConnection
(appName='webcenter', name='myDiscussionServer')

setDiscussionForumServiceProperty

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

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

topics.fetch.size

Maximum number of topics fetched by the Discussions service and displayed in the topics view.

forums.fetch.size

Maximum number of forums fetched by the Discussions service and displayed in the forums view.

recentTopics.fetch.size

Maximum number of topics fetched by the Discussions service and displayed in the recent topics view.

watchedTopics.fetch.size

Maximum number of topics fetched by the Discussions service and displayed in the watched topics view.

watchedForums.fetch.size

Maximum number of forums fetched by the Discussions service and displayed in the watched forums view.

application.root.category.id

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.

ForumGatewayManager.AUTO_START

Communication through mail distribution lists can be published as discussion forum posts. This parameter starts or stops the gateway for this communication.

For the Spaces application, the default value is 1, which means that as soon as you configure mail server settings through administration, the gateway starts. Set this to 0, and restart the managed server, to stop the gateway and disable this feature.

For WebCenter Portal applications, the default value is 0. Set this to 1, and restart the managed server, to start the gateway and enable this feature.


Syntax

setDiscussionForumServiceProperty(appName, property, value, [server, 
applicationVersion])
Argument Definition
appName

Name of the WebCenter Portal 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 Portal 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 Portal application is deployed.


Example

The following example changes the default number of topics displayed in topics view.

wls:/weblogic/serverConfig>setDiscussionForumServiceProperty
(appName='webcenter', property='topics.fetch.size', value='30')

removeDiscussionForumServiceProperty

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

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.

Syntax

removeDiscussionForumServiceProperty(appName, property, [server, 
applicationVersion])
Argument Definition
appName

Name of the WebCenter Portal application in which to perform this operation.

property

Name of the configuration property.

server

Optional. Name of the managed server where the WebCenter Portal 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 Portal application is deployed.


Example

The following example clears the current topics.fetch.size property for the Discussions service, in an application named webcenter.

wls:/weblogic/serverConfig> removeDiscussionForumServiceProperty
(appName='webcenter', property='topics.fetch.size')

listDiscussionForumServiceProperties

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

Lists all configurable properties for the Discussions service.

Syntax

listDiscussionForumServiceProperties(appName, [server, applicationVersion])
Argument Definition
appName

Name of the WebCenter Portal application in which to perform this operation.

server

Optional. Name of the managed server where the WebCenter Portal 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 Portal application is deployed.


Example

The following example lists configuration properties for the Discussions service, in an application named webcenter.

wls:/weblogic/serverConfig> listDiscussionForumServiceProperties(appName='webcenter')

setAnnouncementServiceProperty

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

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

miniview.page_size

Maximum number of announcements displayed in the Announcements mini view.

mainview.page_size

Maximum number of announcements displayed in the Announcements main view.

linksview.page_size

Maximum number of announcements displayed in the Announcements links view.

announcements.expiration.days

Number of days that announcements display and remain editable.


Syntax

setAnnouncementServiceProperty(appName, property, value, [server, applicationVersion})
Argument Definition
appName

Name of the WebCenter Portal 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 Portal 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 Portal application is deployed.


Example

The following example changes the default number of days that announcements display, in an application named webcenter.

wls:/weblogic/serverConfig> setAnnouncementServiceProperty(appName='webcenter', 
property='announcements.expiration.days', value='21')

removeAnnouncementServiceProperty

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

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.

Syntax

removeAnnouncementServiceProperty(appName, property, [server, 
applicationVersion])
Argument Definition
appName

Name of the WebCenter Portal application in which to perform this operation.

property

Name of the configuration property.

server

Optional. Name of the managed server where the WebCenter Portal 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 Portal application is deployed.


Example

The following example clears the announcements.expiration.days property for the Announcements service, in an application named webcenter.

wls:/weblogic/serverConfig> removeAnnouncementServiceProperty
(appName='webcenter', property='announcements.expiration.days')

listAnnouncementServiceProperties

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

Lists all configurable properties for the Announcements service.

Syntax

listAnnouncementServiceProperties(appName, [server, applicationVersion])
Argument Definition
appName

Name of the WebCenter Portal application in which to perform this operation.

server

Optional. Name of the managed server where the WebCenter Portal 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 Portal application is deployed.


Example

The following example lists configuration properties for the Announcements service, in an application named webcenter.

wls:/weblogic/serverConfig> listAnnouncementServiceProperties(appName='webcenter')

addDiscussionsServerAdmin

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

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.

Syntax

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.


Example

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')

syncDiscussionServerPermissions

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

(Spaces application only) Synchronizes discussion server permissions for subspaces that inherit security from their parent.

When you update Discussions or Announcement permissions for space hierarchies in the Spaces application, the subspaces do not automatically inherit the corresponding permission change on WebCenter Portal's 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 discussions server permissions as their parent.

Note:

To execute discussion server WLST commands, such as syncDiscussionServerPermissions, the user used to connect to the Admin Server must also have administrative privileges on the discussion server.

Syntax

syncDiscussionServerPermissions(appName, [server, applicationVersion])
Argument Definition
appName

Name of the Spaces application in which to perform this operation—always webcenter.

server

Optional. Name of the managed server where the WebCenter Portal 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 Portal application is deployed.


Example

The following example synchronizes Discussions and Announcement permissions in the Spaces application, that is, subspaces inherit the same discussions server permissions as their parent:

wls:/weblogic/serverConfig> syncDiscussionServerPermissions(appName='webcenter')

setDiscussionsServerProperty

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

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 as setDiscussionsServerProperty, the user used to connect to the Admin Server must also have administrative privileges on the discussion server.

Syntax

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.

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.


Example

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') 

getDiscussionsServerProperty

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

Returns the current value of a discussions server property.

Note:

To execute discussion server WLST commands, such as getDiscussionsServerProperty, the user used to connect to the Admin Server must also have administrative privileges on the discussion server.

Syntax

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.


Example

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=', )

removeDiscussionsServerProperty

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

Removes the current values that is set for a discussions server property.

Note:

To execute discussion server WLST commands, such as removeDiscussionsServerProperty, the user used to connect to the Admin Server must also have administrative privileges on the discussion server.

Syntax

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.


Example

The following example removes the current value for the 'SSO mode' property on the discussions server:

wls:/weblogic/serverConfig> removeDiscussionsServerProperty

(appName='owc_discussions', key='owc_discussions.sso.mode')

External Applications

Use the commands listed in Table 10-12 to manage external application connections for WebCenter Portal applications.

Configuration changes made using these WebCenter Portal WLST commands are immediately available in the WebCenter Portal application.

Table 10-12 External Application WLST Commands

Use this command... To... Use with WLST...

createExtAppConnection

Create an external application connection, for a named WebCenter Portal application.

Online

setExtAppConnection

Edit an existing external application connection.

Online

listExtAppConnections

List individual or all external applications that are configured for a specific WebCenter Portal application.

Online

addExtAppField

Add another login field for a specific external application connection.

Online

setExtAppField

Edit the value and display-to-user setting for a specific external application login field.

Online

removeExtAppField

Remove an external application login field.

Online

addExtAppCredential

Specify shared or public credentials for an external application.

Online

setExtAppCredential

Edit shared or public credentials for an external application.

Online

removeExtAppCredential

Remove shared or public credentials currently configured for an external application.

Online


createExtAppConnection

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

Creates an external application connection, for a named WebCenter Portal application.

Syntax

createExtAppConnection(appName, name, [displayName, url, authMethod, 
userFieldName, pwdFieldName, server, applicationVersion])
Argument Definition
appName

Name of the WebCenter Portal application in which to perform this operation.

name

Connection name. The name must be unique (across all connection types) within the WebCenter Portal application.

displayName

Optional. External application display name. A user friendly name for the application that WebCenter Portal users will recognize. The display name must be unique across all external applications within the WebCenter Portal 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: http://login.yahoo.com/config/login

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 authMethod is GET or POST and a login url is specified. Not required if BASIC authentication method is selected.

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 authMethod is GET or POST and a login url is specified. Not required if BASIC authentication method is selected.

server

Optional. Name of the managed server where the WebCenter Portal 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 Portal application is deployed.


Example

The following example creates a connection for an external application named My Yahoo!, in a WebCenter Portal 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')

setExtAppConnection

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

Edits an existing external application connection.

Syntax

setExtAppConnection(appName, name, [displayName], [url], [authMethod], 
[userFieldName], [pwdFieldName], [server, applicationVersion])
Argument Definition
appName

Name of the WebCenter Portal 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 Portal users will recognize. The display name must be unique across all external applications within the WebCenter Portal 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 authMethod is GET or POST and a login URL is specified but can be left blank if BASIC authentication method is selected.

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 authMethod is GET or POST, but can be left blank if BASIC authentication method is selected.

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.


Example

The following example updates the display name attribute for an external application named yahoo.

wls:/weblogic/serverConfig> setExtAppConnection(appName='webcenter', 
name='yahoo', displayName='My Favorite Yahoo!')

listExtAppConnections

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

When used with only the appName argument, this command lists the names of all the external applications currently configured for a specific WebCenter application.

Syntax

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 0, do not specify the name argument.

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 Portal 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 Portal application is deployed.


Examples

The following example lists the names of all the external applications currently used by a WebCenter Portal 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
 
 

addExtAppField

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

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.

Syntax

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 0, you must specify the fieldValue.

server

Optional. Name of the managed server where the WebCenter Portal 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 Portal application is deployed.


Example

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)

setExtAppField

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

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.

Syntax

setExtAppField(appName, name, fieldName, [fieldValue], [displayToUser], [server, 
applicationVersion])
Argument Definition
appName

Name of the WebCenter Portal 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 0, fieldValue must be specified.

server

Optional. Name of the managed server where the WebCenter Portal 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 Portal application is deployed.


Example

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)

removeExtAppField

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

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

Syntax

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 Portal 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 Portal application is deployed.


Example

The following example removes the additional login field named Account from an external application named ABC.

wls:/weblogic/serverConfig> removeExtAppField(appName='webcenter, name='ABC', 
fieldName='Account')

addExtAppCredential

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

Configures shared user or public user credentials for a specific external application.

When shared credentials are specified, every user accessing the WebCenter Portal application is authenticated using the user name and password defined here. WebCenter Portal users are not presented with a login form.

Public users accessing this application through WebCenter Portal are logged in using the public credentials defined here.

If credentials already exists, a warning indicates that the setExtAppCredential command should be used instead.

Syntax

addExtAppCredential(appName, name, type, username, password, [field, server, 
applicationVersion]) 
Argument Definition
appName

Name of the WebCenter Portal 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 Portal 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 Portal application is deployed.


Example

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')

setExtAppCredential

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

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.

Syntax

setExtAppCredential(appName, name, type, [username], [password], [field], 
[server, applicationVersion])
Argument Definition
appName

Name of the WebCenter Portal 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 Portal 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 Portal application is deployed.


Example

The following example changes the public user's login credentials for an external application named ABC.

wls:/weblogic/serverConfig> setExtAppCredential(appName='webcenter',name='ABC', 
type='PUBLIC', username='username.example', password='password.example', 
field='Account:username.example')

removeExtAppCredential

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

Removes shared user or public user credentials currently configured for an external application.

If credentials do not exist, an error displays.

Syntax

removeExtAppCredential(appName, name, type, [server, applicationVersion])
Argument Definition
appName

Name of the WebCenter Portal 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 Portal 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 Portal application is deployed.


Example

The following example removes shared credentials specified for an external application named ABC.

wls:/weblogic/serverConfig> removeExtAppCredential(appName='webcenter', 
name='ABC', type='SHARED')

Instant Messaging and Presence

Use the commands listed in Table 10-13, to manage instant messaging and presence server connections.

Configuration changes made using these WebCenter Portal WLST commands are only effective after your restart the Managed Server on which the WebCenter Portal 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...

createIMPConnection

Create a new instant messaging and presence server connection for a WebCenter Portal application.

Online

setIMPConnection

Edit an existing instant messaging and presence server connection.

Online

setIMPConnectionProperty

Modify instant messaging and presence server connection properties.

Online

deleteIMPConnectionProperty

Delete an instant messaging and presence server connection property.

Online

listIMPAdapters

List which presence servers the WebCenter Portal application supports.

Online

listIMPConnections

List all of the instant messaging and presence server connections that are configured for an application.

Online

listDefaultIMPConnection

List the default instant messaging and presence server connection that is configured for an application.

Online

setDefaultIMPConnection

Set a specified connection as the default instant messaging and presence server connection.

Online

setIMPServiceProperty

Specify defaults for the Instant Messaging and Presence service.

Online

removeIMPServiceProperty

Remove defaults for the Instant Messaging and Presence service.

Online

listIMPServiceProperties

List Instant Messaging and Presence service properties.

Online

createIMPExtAppConnection

Create an external application suitable for instant messaging and presence server connection.

Online


createIMPConnection

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

Creates an instant messaging and presence server connection for a named WebCenter Portal application.

Use the listIMPAdapters command to find out which types of instant messaging and presence servers are supported. Out-of-the-box, WebCenter Portal applications support Microsoft Live Communications Server 2005 (LCS), and Microsoft Communications Server 2007 (OCS), and Microsoft Lync 2010.

While you can register multiple presence server connections for a WebCenter Portal application, only one connection is used for instant messaging and presence services—the default (or active) connection.

Syntax

createIMPConnection(appName, name, adapter, url, [appId, poolName, 
userDomain, timeout, default, server, applicationVersion])
Argument Definition
appName

Name of the WebCenter Portal application in which to perform this operation.

name

Connection name. The name must be unique (across all connection types) within the WebCenter Portal application.

adapter

Adapter name. Specify the adapter that matches your instant messaging and presence server. Valid values are LCS and OCS

Choose LCS for Microsoft Live Communications Server 2005.

Choose OCS2007 for Microsoft Office Communications Server 2007 and Microsoft Lync.

url

URL of the sever hosting instant messaging and presence services.

For example: http://myocshost.com:8888

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 Lync server. This argument is mandatory for LCS, OCS and Lync server connections.

The external application you configure for instant messaging and presence services must use authMethod=POST, and specify an additional field with fieldName='Account' and displaytoUser=1. If an external application does not exist yet, use the WLST command createIMPExtAppConnection to create an external application that automatically has all the required additional fields.

See also addExtAppField and setExtAppField.

poolName

Optional. Pool name that is required to create an LCS, OCS, or Lync connection. Refer to Microsoft Live Communications Server, Microsoft Office Communications Server, or Microsoft Lync Server documentation for details on pool names.

This argument is mandatory for LCS, OCS, and Lync server connections.

userDomain

Optional. (OCS and Lync connections only.) Active Directory domain on the OCS/Lync server.

This argument is mandatory for OCS/Lync 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 Portal 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 Portal application is deployed.


Examples

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='OCS2007', url='http://myocshost.com/owc/ocs', 
appId='OCSExtApp', userDomain='OCS', poolName='pool01.myocshost.com', timeout=60, default=1)

The following example creates an instant messaging and presence server connection to a Microsoft Lync Server named myLyncServer.

wls:/weblogic/serverConfig>createIMPConnection(appName='webcenter', 
name='myLyncServer', adapter='OCS2007', 
url='http://mylynchost.com:8888' appId='LyncExtApp', userDomain='LYNC', poolName='pool05.mylynchost.com', timeout=60, default=1))

setIMPConnection

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

Edits an existing instant messaging and presence server connection. Use this command to update connection attributes.

The connection is created using the createIMPConnection command.

Syntax

setIMPConnection(appName, name, [adapter, url, appId, poolName, 
userDomain, timeout, default, server, applicationVersion]) 
Argument Definition
appName

Name of the WebCenter Portal 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, and OCS2007.

Choose LCS for Microsoft Live Communications Server.

Choose OCS2007 for Microsoft Office Communications Server and Microsoft Lync Server.

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 Lync server. This argument is mandatory for LCS, OCS and Lync server connections.

The external application you configure for instant messaging and presence services must use authMethod=POST, and specify an additional field with fieldName='Account' and displaytoUser=1. If an external application does not exist yet, use the WLST command createIMPExtAppConnection to create an external application that automatically has all the required additional fields.

See also addExtAppField and setExtAppField.

poolName

Optional. (LCS, OCS, and Lync) Pool name that is required to create an LCS, OCS, or Lync connection. Refer to Microsoft Live Communications Server, Microsoft Office Communications Server or Microsoft Lync Server documentation for details on pool names.

This argument is mandatory for LCS, OCS, and Lync server connections.

userDomain

Optional. (OCS and Lync only.) Active Directory domain on the OCS server.

This argument is mandatory for OCS/Lync 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 0 to 1.

To disable this connection, use the removeIMPServiceProperty command:

removeIMPServiceProperty('appName='webcenter', property='selected.connection')

While you can register multiple presence server connections for a WebCenter Portal 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 Portal 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 Portal application is deployed.


Examples

The following example sets attributes on an existing instant messaging and presence server connection.

wls:/weblogic/serverConfig>setIMPConnection(appName='webcenter', 
name='myOCSPresenceServer', adapter='OCS2007', url='http://myocshost.com/owc/ocs', 
timeout=120, 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='pool3.myhost.com')

setIMPConnectionProperty

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

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.)

Do not use the setIMPConnectionProperty to set connection properties available through createIMPConnection or setIMPConnection. Attempting to do so, has no effect.

Syntax

setIMPConnectionProperty(appName, name, key, value, [secure, server, 
applicationVersion])
Argument Definition
appName

Name of the WebCenter Portal 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 Portal 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 Portal application is deployed.


Example

The following example adds a custom instant messaging and presence server connection property called admin.user with a default value admin.

wls:/weblogic/serverConfig> setIMPConnectionProperty(appName='webcenter', 
name='MyLCSPresenceServer', key='admin.user', value='admin')

deleteIMPConnectionProperty

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

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.

Syntax

deleteIMPConnectionProperty(appName, name, key, [server, applicationVersion])
Argument Definition
appName

Name of the WebCenter Portal 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 Portal 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 Portal application is deployed.


Example

The following example deletes an instant messaging and presence server connection property named admin.user.

wls:/weblogic/serverConfig> deleteIMPConnectionProperty(appName='webcenter', 
name='MyLCSPresenceServer', key='admin.user')

listIMPAdapters

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

Lists which types of instant messaging and presence servers WebCenter Portal supports. Out-of-the-box, WebCenter Portal applications support Microsoft Live Communications Server 2005 (LCS), Microsoft Office Communications Server 2007 (OCS) and Microsoft Lync 2010.

Syntax

listIMPAdapters() 

Example

The following example lists which presence servers are supported.

wls:/weblogic/serverConfig> listIMPAdapters()

listIMPConnections

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

Lists all of the instant messaging and presence server connections that are configured for a named WebCenter Portal application.

Syntax

listIMPConnections(appName,[verbose], [name], [server, applicationVersion)
Argument Definition
appName

Name of the WebCenter Portal 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 Portal 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 Portal 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 Portal application is deployed.


Examples

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')

listDefaultIMPConnection

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

Lists the connection that the Instant Messaging and Presence service is using, in a named WebCenter Portal application. While you can register multiple presence server connections for a WebCenter Portal 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.

Syntax

listDefaultIMPConnection(appName, verbose, [server, applicationVersion])
Argument Definition
appName

Name of the WebCenter Portal 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 Portal 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 Portal application is deployed.


Example

The following example lists the name and details of the connection that the Instant Messaging and Presence service is using, in an application named webcenter.

wls:/weblogic/serverConfig>listDefaultIMPConnection(appName='webcenter', verbose=1)

setDefaultIMPConnection

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

Specifies the default connection for the Instant Messaging and Presence service, in a named WebCenter Portal application. While you can register multiple presence server connections with a WebCenter Portal 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.

Syntax

setDefaultIMPConnection(appName, name, [server, applicationVersion])
Argument Definition
appName

Name of the WebCenter Portal 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 Portal 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 Portal application is deployed.


Example

The following example makes a connection named myPresenceServer the default (or active) connection for the Instant Messaging and Presence service.

wls:/weblogic/serverConfig>setDefaultIMPConnection(appName='webcenter', name='myPresenceServer') 

setIMPServiceProperty

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

Specifies default values for the Instant Messaging and Presence service.

Configurable properties for the Instant Messaging and Presence service are listed in Table 10-14, "Instant Messaging and Presence Service Configuration Properties".

Table 10-14 Instant Messaging and Presence Service Configuration Properties

Configuration Property Description

selected.connection

Connection used by the Instant Messaging and Presence service.

rtc.cache.time

Cache timeout for instant messaging and presence data. The default is 60 seconds.

resolve.display.name.from.user.profile

Determines what to display if user display names are missing. When set to 0, and display name information is unavailable, only the user name displays in the application. When set to 1, and display name information is unavailable, display names are read from user profile data. Setting this option to 1 will impact performance. The default setting is 0.

Display names are not mandatory in presence data. If the WebCenter Portal application does not always provide display names by default and you consider this information important, set resolve.display.name.from.user.profile to 1 so that display names always display.

im.address.resolver.class

Resolver implementation used to map user names to IM addresses and IM addresses to user names.

The default setting is oracle.webcenter.collab.rtc.IMPAddressResolverImpl. This implementation looks for IM addresses in the following places and in the order specified:

  • User Preferences

  • User Credentials

  • User Profiles

im.address.profile.attribute

User profile attribute used to determine a user's IM address. The default setting is BUSINESS_EMAIL.


Syntax

setIMPServiceProperty(appName, property, value, [server, applicationVersion])
Argument Definition
appName

Name of the WebCenter Portal 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 Portal 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 Portal application is deployed.


Example

The following example changes the default cache timeout for instant messaging and presence data, in an application named webcenter.

wls:/weblogic/serverConfig>setIMPServiceProperty(appName='webcenter', 
property='rtc.cache.time', value='30')

removeIMPServiceProperty

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

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-14, "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.

Syntax

removeIMPServiceProperty(appName, property, [server, applicationVersion])
Argument Definition
appName

Name of the WebCenter Portal application in which to perform this operation.

property

Name of the configuration property.

server

Optional. Name of the managed server where the WebCenter Portal 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 Portal application is deployed.


Example

The following example clears the cache expiration value for the Instant Messaging and Presence service, in an application named webcenter.

wls:/weblogic/serverConfig> removeIMPServiceProperty(appName='webcenter', 
property='rtc.cache.time')

listIMPServiceProperties

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

Lists all configurable properties for the Instant Messaging and Presence service.

Syntax

listIMPServiceProperties(appName, [server, applicationVersion])
Argument Definition
appName

Name of the WebCenter Portal application in which to perform this operation.

server

Optional. Name of the managed server where the WebCenter Portal 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 Portal application is deployed.


Example

The following example lists configuration properties for the Instant Messaging and Presence service, in an application named webcenter.

wls:/weblogic/serverConfig> listIMPServiceProperties(appName='webcenter') 

createIMPExtAppConnection

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

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.

Syntax

createIMPExtAppConnection(appName, name, [displayName, server, applicationVersion])
Argument Definition
appName

Name of the WebCenter Portal application in which to perform this operation.

name

Connection name. The name must be unique (across all connection types) within the WebCenter Portal application.

displayName

Optional. External application display name. A user friendly name for the application that WebCenter Portal users will recognize. The display name must be unique across all external applications within the WebCenter Portal application.

server

Optional. Name of the managed server where the WebCenter Portal 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 Portal application is deployed.


Example

The following example creates an external application named IMPxApp suitable for instant messaging and presence server connections.

wls:/weblogic/serverConfig> createIMPExtAppConnection(appName='webcenter',
name='IMPxApp', displayName='IMP Ext App') 

Mail

Use the commands listed in Table 10-15 to manage mail server connections for a WebCenter Portal application.

You can register multiple mail server connections:

Configuration changes made using these WebCenter Portal WLST commands are only effective after your restart the Managed Server on which the WebCenter Portal application is deployed. For details, see Oracle Fusion Middleware Administrator's Guide for Oracle WebCenter.

Table 10-15 Mail WLST Commands

Use this command... To... Use with WLST...

createMailConnection

Create a mail server connection for a WebCenter Portal application.

Online

setMailConnection

Edit an existing mail server connection.

Online

setMailConnectionProperty

Set mail server connection properties.

Online

deleteMailConnectionProperty

Delete a mail server connection property.

Online

listMailConnections

List all of the mail server connections that are configured for an application.

Online

listDefaultMailConnection

List the default mail server connection that is configured for an application.

Online

setDefaultMailConnection

Set a specified connection as the default mail server connection.

Online

setMailServiceProperty

Specify defaults for the Mail service.

Online

removeMailServiceProperty

Remove defaults for the Mail service.

Online

listMailServiceProperties

List Mail service properties.

Online

createMailExtApp

Create an external application suitable for mail connections.

Online


createMailConnection

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

Creates a mail server connection for a WebCenter Portal application.

WebCenter Portal 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:

  • Spaces application supports multiple mail connections. The mail connection configured with default=1 is the default connection for mail services in Spaces. All additional connections are offered as alternatives; Spaces users can choose which one they want to use through user preferences.

  • Framework applications only use one mail connection—the connection configured with default=1. Any additional connections are ignored.

Syntax

createMailConnection(appName, name, [imapHost, imapPort, smtpHost, smtpPort, 
imapSecured, smtpSecured, appId, timeout, default, server, applicationVersion]) 
Argument Definition
appName

Name of the WebCenter Portal application in which to perform this operation.

name

Connection name. The name must be unique (across all connection types) within the WebCenter Portal 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 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

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.

  • Spaces supports multiple mail connections. The mail connection configured with default=1 is the default connection for mail services in the Spaces application. Additional connections, configured with default=0, are offered as alternatives; Spaces users can choose which one they want to use through user preferences.

  • Framework applications only use one mail connection—the connection configured with default=1. Any additional connections are ignored.

server

Optional. Name of the managed server where the WebCenter Portal 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 Portal application is deployed.


Examples

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)

setMailConnection

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

Edits an existing mail connection. Use this command to update connection attributes.

The connection is created using the createMailConnection command.

(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 spacedistribution lists for the Spaces application. 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, spacedistribution lists are not created or maintained. The mail server must be a Microsoft Exchange Server.

Syntax

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 Portal 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 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

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 spacedistribution 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 spacedistribution 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.

  • Spaces supports multiple mail connections. The mail connection configured with default=1 is the default connection for mail services in the Spaces application. Additional connections, configured with default=0, are offered as alternatives; Spaces users can choose which one they want to use through user preferences.

  • Framework applications only use one mail connection—the connection configured with default=1. Any additional connections are ignored.

A connection does not cease to be the default connection for the Mail service if you change the default value from 0 to 1.

To stop using a default connection, use the removeMailServiceProperty command as follows:

removeMailServiceProperty('appName='webcenter', property='selected.connection')

server

Optional. Name of the managed server where the WebCenter Portal 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 Portal application is deployed.


Examples

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)

setMailConnectionProperty

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

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-16, "Additional Mail Connection Properties".

Table 10-16 Additional Mail Connection Properties

Additional
Connection Property
Description

charset

Characterset used on the connection.

The default charset is UTF-8. To use a different characterset, such as ISO-8859-1, set the charset connection property.

Various IMAP properties

Any valid IMAP connection property. For example, mail.imap.connectionpoolsize.

A list of valid IMAP properties are available at: http://java.sun.com/products/javamail/javadocs/com/sun/mail/imap/package-summary.html

Various SMTP properties

Any valid SMTP connection property. For example, mail.smtp.timeout.

A list of valid SMTP properties are available at: http://java.sun.com/products/javamail/javadocs/com/sun/mail/smtp/package-summary.html


Note:

Do not use the setMailConnectionProperty to set connection properties available through createMailConnection or setMailConnection. Attempting to do so, has no effect.

Syntax

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.


Example

The following example adds a custom mail server connection property called myProperty1 with a default value propertyValue1.

wls:/weblogic/serverConfig> setMailConnectionProperty(appName='webcenter', 
name='myMailServer', key='myProperty1', value='propertyValue1')

deleteMailConnectionProperty

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

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.

Syntax

deleteMailConnectionProperty(appName, name, key, [server], 
[applicationVersion])
Argument Definition
appName

Name of the WebCenter Portal 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 Portal 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 Portal application is deployed.


Example

The following example deletes a mail server connection property named mailProperty1.

wls:/weblogic/serverConfig> deleteMailConnectionProperty(appName='webcenter', 
name='myMailServer', key='mailProperty1')

listMailConnections

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

Lists all of the mail server connections that are configured for a named WebCenter Portal application.

Syntax

listMailConnection(appName, [verbose, name, server, applicationVersion])
Argument Definition
appName

Name of the WebCenter Portal 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 Portal 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 Portal 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 Portal application is deployed.


Example

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')

listDefaultMailConnection

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

Lists the default mail server connection that the Mail service is using, in a named WebCenter Portal application.

You can register multiple mail server connections but there can only be one default connection:

  • Spaces application supports multiple mail connections. The mail connection configured with default=1 is the default connection for mail services in the Spaces application. All additional connections are offered as alternatives; Spaces users can choose which one they want to use through user preferences.

  • Framework applications only use one mail connection—the connection configured with default=1. Any additional connections are ignored.

Syntax

listDefaultMailConnection(appName,[verbose], [server], [applicationVersion])
Argument Definition
appName

Name of the WebCenter Portal 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 Portal 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 Portal application is deployed.


Example

The following example lists the name and details of the mail server connection that the Mail service is using, in an application named webcenter.

wls:/weblogic/serverConfig> listDefaultMailConnection(appName='webcenter', verbose=1)

setDefaultMailConnection

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

Specifies the default mail server connection for the Mail service, in a named WebCenter Portal application.

You can register multiple mail server connections but there can only be one default connection:

  • Spaces application supports multiple mail connections. The mail connection configured with default=1 is the default connection for mail services in the Spaces application. All additional connections are offered as alternatives; Spaces users can choose which one they want to use through user preferences.

  • Framework applications only use one mail connection—the connection configured with default=1. Any additional connections are ignored.

Syntax

setDefaultMailConnection(appName, name, [server], [applicationVersion])
Argument Description
appName

Name of the WebCenter Portal application in which to perform this operation.

name

Name of an existing mail connection.

server

Optional. Name of the managed server where the WebCenter Portal 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 Portal application is deployed.


Example

The following example configures the Mail service to use a connection named myMailServer.

wls:/weblogic/serverConfig>setDefaultMailConnection(appName='webcenter', name='myMailServer')

setMailServiceProperty

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

Specifies default values for the Mail service.

Configurable properties for the Mail service are listed in Table 10-17, "Mail Service Configuration Properties".

Table 10-17 Mail Service Configuration Properties

Configuration Property Description

address.delimiter

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 lastname, firstname and, in such cases, a semi-colon is required.

mail.emailgateway.polling.frequency

The frequency, in seconds, that spacedistribution lists are checked for new incoming emails. The default is 1800 seconds (30 minutes).

Email communication through spacedistribution 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.

mail.messages.fetch.size

Maximum number of messages displayed in mail inboxes.

resolve.email.address.to.name

Determines whether user email addresses are resolved to WebCenter Portal user names when LDAP is configured. Valid values are 1 (true) and 0 (false). The default value is 0.

When set to 1, WebCenter Portal user names display instead of email addresses in Mail task flows.

Set this property to 1 if the Instant Messaging and Presence service requires user names to obtain presence status because presence information cannot be obtained when the Mail service provides email addresses. Setting this value to 1 does impact application performance so you must take this into consideration when setting this property.


Syntax

setMailServiceProperty(appName, property, value, [server], [applicationVersion])
Argument Definition
appName

Name of the WebCenter Portal 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 Portal 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 Portal application is deployed.


Example

The following example increases the default number of messages displayed in mail inboxes to 100, in an application named webcenter.

wls:/weblogic/serverConfig>setMailServiceProperty(appName='webcenter', 
property='mail.messages.fetch.size', value='100')

removeMailServiceProperty

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

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-17, "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.

Syntax

removeMailServiceProperty(appName, property, [server], [applicationVersion])
Argument Definition
appName

Name of the WebCenter Portal application in which to perform this operation.

property

Name of the configuration property.

server

Optional. Name of the managed server where the WebCenter Portal 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 Portal application is deployed.


Example

The following example clears the current mail.messages.fetch.size setting for the Mail service, in an application named webcenter.

wls:/weblogic/serverConfig>removeMailServiceProperty(appName='webcenter', property='mail.messages.fetch.size')

listMailServiceProperties

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

Lists all configurable properties for the Mail service.

Syntax

listMailServiceProperties(appName, [server], [applicationVersion])
Argument Definition
appName

Name of the WebCenter Portal application in which to perform this operation.

server

Optional. Name of the managed server where the WebCenter Portal 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 Portal application is deployed.


Example

The following example lists configuration properties for the Mail service, in an application named webcenter.

wls:/weblogic/serverConfig>listMailServiceProperties(appName='webcenter')  

createMailExtApp

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

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

Syntax

createMailExtAppConnection(appName, name, [displayName, server, applicationVersion])
Argument Definition
appName

Name of the WebCenter Portal application in which to perform this operation. For the Spaces application, the name is always webcenter.

name

Connection name. The name must be unique (across all connection types) within the WebCenter Portal application.

displayName

Optional. External application display name. A user friendly name for the application that WebCenter Portal users will recognize. The display name must be unique across all external applications within the WebCenter Portal application.

server

Optional. Name of the managed server where the WebCenter Portal 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 Portal application is deployed.


Example

The following example creates an external application named MailxApp suitable for mail server connections.

wls:/weblogic/serverConfig> createMailExtAppConnection(appName='webcenter', name='MailxApp', displayName='Mail Ext App')

Notifications

Use the commands listed in Table 10-18 to manage settings for the Notifications service in a WebCenter Portal application.

Configuration changes made using these WebCenter Portal WLST commands are only effective after your restart the Managed Server on which the WebCenter Portal application is deployed. For details, see Oracle Fusion Middleware Administrator's Guide for Oracle WebCenter.

Table 10-18 Notifications WLST Commands

Use this command... To... Use with WLST...

setNotificationsConfig

Specify the connection used for routing notifications raised in a WebCenter Portal application.

Online

getNotificationsConfig

Return details about the connection that is used to send notifications raised in a WebCenter Portal application.

Online


setNotificationsConfig

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

Specifies the connection used for routing notifications raised in a WebCenter Portal application.

Use an existing mail server or BPEL server connection. If the WebCenter Portal 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.

Syntax

setNotificationsConfig(appName, type, name, [senderMailAddress, senderSMSAddress, server, applicationVersion])
Argument Definition
appName

Name of the WebCenter Portal application in which to perform this operation. For the Spaces application, 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:

  • Mail server connection—The external application associated with the mail server connection must contain shared credentials.

  • BPEL server connection—Oracle User Messaging Service (UMS) must be available on the BPEL server.

senderMailAddress

Optional. Mail address from which all mail notifications are sent.

Use the format:

<email_alias><<email_address>> or <email address>.

For example, WebCenter Notification<notifications@webcenter.com> or notifications@webcenter.com.

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, 28734.

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 Portal 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 Portal application is deployed.


Example

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')

getNotificationsConfig

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

Returns details about the connection that is used to send notifications raised in a WebCenter Portal application.

Syntax

getNotificationsConfig(appName, [server, applicationVersion])
Argument Definition
appName

Name of the WebCenter Portal application in which to perform this operation. For the Spaces application, the name is always webcenter.

server

Optional. Name of the managed server where the WebCenter Portal 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 Portal application is deployed.


Example

The following example returns details about the connection used by the Notifications service in the Spaces application:

wls:/weblogic/serverConfig>getNotificationsConfig(appName='webcenter')

ConnectionType:    BPEL
ConnectionName:    WebCenter-Worklist
SenderMailAddress: notifications@webcenter.com
SenderSMSAddress:  28776

Personal Events

Use the commands listed in Table 10-19 to manage personal events server connections for a WebCenter Portal application.

Configuration changes made using these WebCenter Portal WLST commands are only effective after your restart the Managed Server on which the WebCenter Portal application is deployed. For details, see Oracle Fusion Middleware Administrator's Guide for Oracle WebCenter.

Table 10-19 Personal Events WLST Commands

Use this command... To... Use with WLST...

createPersonalEventConnection

Create a personal events server connection for a named WebCenter Portal application.

Online

setPersonalEventConnection

Edit an existing personal events server connection.

Online

listPersonalEventConnections

List all of the personal events server connections that are configured for a named WebCenter Portal application

Online


createPersonalEventConnection

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

Creates a personal events server connection for a named WebCenter Portal 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 Portal application, only one connection is used for personal events services - the default (or active) connection.

Syntax

createPersonalEventConnection(appName, name, webServiceUrl, adapterName, appId, [default, server, applicationVersion])
Argument Definition
appName

Name of the WebCenter Portal application in which to perform this operation. For the Spaces application, the name is always webcenter.

name

Connection name. The name must be unique (across all connection types within the WebCenter Portal application.

webServiceUrl

URL of the Web service exposing the event application.

Use the format <protocol>://<host>:<port>/<appWebServiceInterface>/<WSName>

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 1.

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.


Example

The following example creates a connection named MyPEConnection for the Spaces application (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 Spaces application. 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')

setPersonalEventConnection

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

Edits a personal events server connection for a named WebCenter Portal application.

Syntax

setPersonalEventConnection(appName, name, [webServiceUrl, adapterName, appId, default, server, applicationVersion])
Argument Definition
appName

Name of the WebCenter Portal application in which to perform this operation. For the Spaces application, 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 <protocol>://<host>:<port>/<appWebServiceInterface>/<WSName>

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 1.

While you can register multiple connections for a WebCenter Portal 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 Portal 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 Portal application is deployed.


Example

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 the Spaces application.

wls:/weblogic/serverConfig>setPersonalEventConnection(appName='webcenter', name='MyPEConnection', default=1)

listPersonalEventConnections

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

Lists all of the personal events server connections that are configured for a named WebCenter Portal application.

Syntax

listPersonalEventConnections(appName, [verbose, name, server, applicationVersion])
Argument Definition
appName

Name of the WebCenter Portal 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 Portal application, along with their details. When set to 0, only connection names are listed. This argument defaults to 0.

When set to 0, do not specify the name argument.

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 Portal 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 Portal application is deployed.


Example

The following example lists connection names and details for all of the personal events server connections currently configured for the Spaces application.

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')

Personalization

Use the commands listed in Table 10-20 to manage personalization connections for a WebCenter Portal application.

Configuration changes made using these WebCenter Portal WLST commands are only effective after your restart the Managed Server on which WebCenter Portal's Personalization service is deployed. For details, see Oracle Fusion Middleware Administrator's Guide for Oracle WebCenter.

Table 10-20 Personalization WLST Commands

Use this command... To... Use with WLST...

createWCPSCMISConnection

Create a CMIS connection for the WebCenter Portal's Personalization service.

Online

createWCPSActivityGraphConnection

Create an Activity Graph connection for the WebCenter Portal's Personalization service.

Online

createWCPSPeopleConnection

Create a People connection for the WebCenter Portal's Personalization service.

Online

createWCPSCustomConnection

Create a custom connection for the WebCenter Portal's Personalization service.

Online

setWCPSConnectionProperty

Modify properties of an existing connection for the WebCenter Portal's Personalization service.

Online

listWCPSCMISConnection

List CMIS connections configured for the WebCenter Portal's Personalization service.

Online

listWCPSActivityGraphConnection

List Activity Graph connections configured for the WebCenter Portal's Personalization service.

Online

listWCPSPeopleConnection

List People connections configured for the WebCenter Portal's Personalization service.

Online

listWCPSCustomConnection

List custom connections configured for the WebCenter Portal's Personalization service.

Online

deleteWCPSCMISConnection

Create a CMIS connection for the WebCenter Portal's Personalization service.

Online

deleteWCPSActivityGraphConnection

Create an Activity Graph connection for the WebCenter Portal's Personalization service.

Online

deleteWCPSPeopleConnection

Create a People connection for the WebCenter Portal's Personalization service.

Online

deleteWCPSCustomConnection

Create a custom connection for the WebCenter Portal's Personalization service.

Online


createWCPSCMISConnection

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

Creates a CMIS (Content Management Interoperability Service) connection for the Personalization service.

Syntax

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 WebCenter Content repository connection.

host

Hostname of the server hosting the CMIS REST service.

Typically, the machine name of the WC_Spaces managed server.

port

Port of the server hosting the CMIS REST service.

Typically, the port number of the WC_Spaces managed server.

scheme

Optional. HTTP scheme for accessing the CMIS REST service. Valid options are http and https. Defaults to http.

namespace

Optional. WebCenter Portal's 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 Personalization in WebCenter Portal' 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 Personalization in WebCenter Portal' 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 WebCenter Portal's Personalization service.

This parameter is only required in a nondefault deployment configuration. No value is required for a default deployment where the WC_Utilities server hosts Personalization services.


Example

The following example creates a CMIS connection:

wls:/weblogic/serverConfig>createWCPSCMISConnection(name='Repos1CMISConnection', 
repositoryId='ucm11g-server', host='myhost.com', port=8888, scheme='http', isDefault=1)

createWCPSActivityGraphConnection

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

Creates an Activity Graph connection for the Personalization service.

Syntax

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 WC_Spaces managed server.

port

Port of the server hosting the Activity Graph service.

Typically, the port number of the WC_Spaces managed server.

scheme

Optional. HTTP scheme for accessing the Activity Graph service. Valid options are http and https. Defaults to http.

namespace

Optional. WebCenter Portal's 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 Personalization in WebCenter Portal' 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 Personalization in WebCenter Portal' in the Oracle Fusion Middleware Administrator's Guide for Oracle WebCenter.

server

Optional. Name of the Managed Server hosting the WebCenter Portal's Personalization service.

This parameter is only required in a nondefault deployment configuration. No value is required for a default deployment where the WC_Utilities server hosts Personalization services.


Example

The following example creates an Activity Graph connection in a particular namespace:

wls:/weblogic/serverConfig> createWCPSActivityGraphConnection(name='AGConnection', host='myhost.com', port=8888, namespace='myNamespace')

createWCPSPeopleConnection

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

Creates a People connection for the Personalization service.

Syntax

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 WC_Spaces managed server.

port

Port of the server hosting the People Connection service.

Typically, the port number of the WC_Spaces managed server.

scheme

Optional. HTTP scheme for accessing the People Connection service. Valid options are http and https. Defaults to http.

namespace

Optional. WebCenter Portal's 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 Personalization in WebCenter Portal' 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 Personalization in WebCenter Portal' in the Oracle Fusion Middleware Administrator's Guide for Oracle WebCenter.

server

Optional. Name of the Managed Server hosting WebCenter Portal's Personalization service.

This parameter is only required in a nondefault deployment configuration. No value is required for a default deployment where the WC_Utilities server hosts Personalization services.


Example

The following example creates a People connection in the default namespace:

wls:/weblogic/serverConfig> createWCPSPeopleConnection(name='PeopleConnection', host='myhost.com', port=8888)

createWCPSCustomConnection

Use with WLST: Online

Description

Creates a connection of a specific type for the Personalization service.

Custom connection types are used with custom data providers and property locators.

Syntax

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 Portal's 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 WebCenter Portal's Personalization service.

This parameter is only required in a nondefault deployment configuration. No value is required for a default deployment where the WC_Utilities server hosts Personalization services.


Example

The following example creates an Activity Graph connection in a particular namespace:

wls:/weblogic/serverConfig> createWCPSCustomConnection(name='CustomConnection', type='my.connection.type', properties={ 'prop1': 'value1', 'prop2', value2' })

listWCPSCMISConnection

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

Lists all CMIS (Content Management Interoperability Service) connections configured for the Personalization service or lists a single connection.

Syntax

listWCPSCMISConnections([server], [verbose], [name], [namespace])
Argument Definition
server

Optional. Name of the Managed Server hosting WebCenter Portal's Personalization service.

This parameter is only required in a nondefault deployment configuration. No value is required for a default deployment where the WC_Utilities server hosts Personalization services.

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 Portal's 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.


Example

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

listWCPSActivityGraphConnection

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

Lists all Activity Graph connections configured for the Personalization service or lists a single connection.

Syntax

listWCPSActivityGraphConnections([server], [verbose], [name], [namespace])
Argument Definition
server

Optional. Name of the Managed Server hosting WebCenter Portal's Personalization service.

This parameter is only required in a nondefault deployment configuration. No value is required for a default deployment where the WC_Utilities server hosts Personalization services.

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 Portal's 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.


Example

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

listWCPSPeopleConnection

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

Lists all People connections configured for the Personalization service or lists a single connection.

Syntax

listWCPSPeopleConnections([server], [verbose], [name], [namespace])
Argument Definition
server

Optional. Name of the Managed Server hosting WebCenter Portal's Personalization service.

This parameter is only required in a nondefault deployment configuration. No value is required for a default deployment where the WC_Utilities server hosts Personalization services.

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 Portal's 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.


Example

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

listWCPSCustomConnection

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

Lists all connections of a particular type configured for the Personalization service or lists a single connection.

Custom connection types are used with custom data providers and property locators.

Syntax

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 WebCenter Portal's Personalization service.

This parameter is only required in a nondefault deployment configuration. No value is required for a default deployment where the WC_Utilities server hosts Personalization services.

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 Portal's 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.


Example

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

deleteWCPSCMISConnection

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

Deletes a CMIS (Content Management Interoperability Service) connection configured for the Personalization service.

Syntax

deleteWCPSCMISConnection(name, [namespace, server])
Argument Definition
name

Connection name.

namespace

Optional. WebCenter Portal's 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 WebCenter Portal's Personalization service.

This parameter is only required in a nondefault deployment configuration. No value is required for a default deployment where the WC_Utilities server hosts Personalization services.


Example

The following example deletes a CMIS connection:

wls:/weblogic/serverConfig>deleteWCPSCMISConnection(name='ReposCMISConnection')

deleteWCPSActivityGraphConnection

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

Deletes an Activity Graph connection configured for the Personalization service.

Syntax

deleteWCPSActivityGraphConnection(name, [namespace, server])
Argument Definition
name

Connection name.

namespace

Optional. WebCenter Portal's 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 WebCenter Portal's Personalization service.

This parameter is only required in a nondefault deployment configuration. No value is required for a default deployment where the WC_Utilities server hosts Personalization services.


Example

The following example deletes an Activity Graph connection:

wls:/weblogic/serverConfig>deleteWCPSActivityGraphConnection(name='AGConnection')

deleteWCPSPeopleConnection

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

Deletes a People connection configured for the Personalization service.

Syntax

deleteWCPSPeopleConnection(name, [namespace, server])
Argument Definition
name

Connection name.

namespace

Optional. WebCenter Portal's 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 WebCenter Portal's Personalization service.

This parameter is only required in a nondefault deployment configuration. No value is required for a default deployment where the WC_Utilities server hosts Personalization services.


Example

The following example deletes a People connection:

wls:/weblogic/serverConfig>deleteWCPSPeopleConnection(name='PeopleConnection')

deleteWCPSCustomConnection

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

Deletes a custom connection configured for the Portal's Personalization service.

Syntax

deleteWCPSCustomConnection(name, type, [namespace, server])
Argument Definition
name

Connection name.

type

Custom connection type.

namespace

Optional. WebCenter Portal's 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 WebCenter Portal's Personalization service.

This parameter is only required in a nondefault deployment configuration. No value is required for a default deployment where the WC_Utilities server hosts Personalization services.


Example

The following example deletes a custom connection:

wls:/weblogic/serverConfig>deleteWCPSCustomConnection(name='CustomConnection', type='my.connection.type')

setWCPSConnectionProperty

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

Add, modify, or delete properties of an existing connection for the 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.

Syntax

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 Portal's 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 WebCenter Portal's Personalization service.

This parameter is only required in a nondefault deployment configuration. No value is required for a default deployment where the WC_Utilities server hosts Personalization services.


Example

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)

Portlet Producers

Use the commands listed in Table 10-21 to manage portlet producers used in WebCenter Portal applications.

All configuration changes made using these WebCenter Portal WLST commands are immediately available in the WebCenter Portal application.

Table 10-21 Producer WLST Commands

Use this command... To... Use with WLST...

registerWSRPProducer

Create and register a WSRP producer.

Online

setWSRPProducer

Edit WSRP producer registration details.

Online

listWSRPProducers

List WSRP producer registration details.

Online

deregisterWSRPProducer

Deregister a WSRP producer, and delete the associated WSRP and Web Service connections.

Online

listWSRPProducerRegistrationProperties

List registration properties supported by a WSRP producer.

Online

listWSRPProducerUserCategories

List any user categories that the WSRP producer might support.

Online

mapWSRPProducerUserCategory

Map a role that is defined in the specified application to a user category supported by a WSRP producer.

Online

registerPDKJavaProducer

Create and register an Oracle PDK-Java producer.

Online

setPDKJavaProducer

Edit PDK-Java producer registration details.

Online

listPDKJavaProducers

List registered Oracle PDK-Java producers.

Online

deregisterPDKJavaProducer

Deregister an Oracle PDK-Java producer, deleting the associated connection.

Online

registerPageletProducer

Create and register a pagelet producer.

Online

setPageletProducer

Edit pagelet producer registration details.

Online

listPageletProducers

List pagelet producer registration details.

Online

deregisterPageletProducer

Deregister a pagelet producer, deleting the associated connection.

Online

refreshProducer

Refresh the metadata stored for the named producer to reflect the portlets currently offered by that producer.

Online

registerOOTBProducers

Register out-of-the-box producers provided with Oracle WebCenter Portal.

Online

deregisterOOTBProducers

Deregister out-of-the-box producers provided with Oracle WebCenter Portal.

Online

registerSampleProducers

Register the sample producers provided with Oracle WebCenter Portal.

Online

deregisterSampleProducers

Deregister sample producers.

Online


registerWSRPProducer

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

Creates a connection to a WSRP portlet producer and registers the WRSP producer with a named WebCenter Portal 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.

Syntax

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 Portal application in which to perform this operation.

name

Connection name. The name must be unique (across all connection types) within the WebCenter Portal 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:

http://host_name:port_number/context_root/portlets/wsrp2?WSDL

http://host_name:port_number/context_root/portlets/wsrp1?WSDL

http://host_name:port_number/context_root/portlets/?WSDL (WSRP 1.0 for backward compatibility)

Where:

  • host_name is the server where your producer is deployed

  • port_number is the HTTP listener port number

  • context_root is the Web application's context root

  • portlets[/wsrp(1|2)]?WSDL is static text. The text entered here depends on how the producer is deployed.

For example:

http://myhost.com:7778/MyPortletApp/portlets/wsrp2?WSDL

proxyHost

Optional. Host name or IP address of the proxy server.

A proxy is required when the WebCenter Portal 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 Portal 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 enforcePolicyURI=1, valid values are:

  • USERNAME_WITHOUT_PASSWORD
    (oracle/wss10_username_id_propagation_with_msg_protection_client_policy)—This policy provides message protection (integrity and confidentiality) and identity propagation for outbound SOAP requests in accordance with the WS-Security 1.0 standard. Credentials (user name only) are included in outbound SOAP request messages through a WS-Security UsernameToken header. No password is included.

    Message protection is provided using WS-Security 1.0's Basic128 suite of asymmetric key technologies. Specifically, RSA key mechanisms for message confidentiality, SHA-1 hashing algorithm for message integrity, and AES-128 bit encryption.

  • USERNAME_WITH_PASSWORD
    (oracle/wss10_username_token_with_message_protection_client_policy)—This policy provides message protection (integrity and confidentiality) and authentication for outbound SOAP requests in accordance with the WS-Security v1.0 standard. Both plain text and digest mechanisms are supported.

    This policy uses WS-Security's Basic 128 suite of asymmetric key technologies. Specifically, RSA key mechanism for message confidentiality, SHA-1 hashing algorithm for message integrity, and AES-128 bit encryption.

    Use this token profile if the WSRP producer has a different identity store. You will need to define an external application pertaining to the producer and associate the external application with this producer.

  • SAML_TOKEN_WITH_MSG_INTEGRITY
    (wss10_saml_token_with_message_integrity_client_policy)—This policy provides message-level integrity protection and SAML-based authentication for outbound SOAP requests in accordance with the WS-Security 1.0 standard. A SAML token, included in the SOAP message, is used in SAML-based authentication with sender vouches confirmation.

    This policy uses WS-Security's Basic 128 suite of asymmetric key technologies and SHA-1 hashing algorithm for message integrity.

    When this policy is selected, the recipient key alias (recptAlias) must be disabled.

  • SAML_TOKEN_WITH_MSG_PROTECTION
    (oracle/wss10_saml_token_with_message_protection_client_policy)—This policy provides message-level protection (integrity and confidentiality) and SAML-based authentication for outbound SOAP requests in accordance with the WS-Security 1.0 standard. The Web service consumer includes a SAML token in the SOAP header and the confirmation type is sender-vouches.

    This policy uses WS-Security's Basic 128 suite of asymmetric key technologies. Specifically, RSA key mechanisms for message confidentiality, SHA-1 hashing algorithm for message integrity, and AES-128 bit encryption. and SHA-1 hashing algorithm for message integrity.

tokenType
continued...
  • WSS11_SAML_TOKEN_WITH_MSG_PROTECTION
    (oracle/wss11_saml_token_with_message_protection_client_policy)—This policy provides message-level protection (integrity and confidentiality) and SAML token population for outbound SOAP requests in accordance with the WS-Security 1.1 standard. A SAML token, included in the SOAP message, is used in SAML-based authentication with sender vouches confirmation. This policy uses the symmetric key technology for signing and encryption, and WS-Security's Basic 128 suite of asymmetric key technologies for endorsing signatures.

  • WSS10_SAML_TOKEN_ONLY (oracle/wss10_saml_token_client_policy)—This policy provides SAML-based authentication for outbound SOAP request messages in accordance with the WS-Security 1.0 standard. The policy propagates user identity and is typically used in intra departmental deployments where message protection and integrity checks are not required.

    This policy does not require any keystore configuration.

If the argument enforcePolicyURI=0, you can specify any valid Oracle Web Services Manager (OWSM) policy URI for the tokenType 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: SAML_TOKEN_WITH_MSG_PROTECTION, SAML_TOKEN_WITH_MSG_INTEGRITY, WSS10_SAML_TOKEN_ONLY, WSS11_SAML_TOKEN_WITH_MSG_PROTECTION.

defUser

Optional. User name to assert to the remote producer when the user is not authenticated with the WebCenter Portal 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 Portal 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: USERNAME_WITHOUT_PASSWORD, SAML_TOKEN_WITH_MSG_PROTECTION, SAML_TOKEN_WITH_MSG_INTEGRITY, WSS10_SAML_TOKEN_ONLY, WSS11_SAML_TOKEN_WITH_MSG_PROTECTION.

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 tokenType is SAML_TOKEN_WITH_MSG_INTEGRITY.

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 0, users can specify any Oracle Web Services Manager (OWSM) policy URI. The user must ensure that the OWSM policy specified is valid.

The default value is 1.

server

Optional. Name of the managed server where the WebCenter Portal 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 Portal application is deployed.


Examples

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')

setWSRPProducer

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

Edits registration details for an existing WSRP producer.

Syntax

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 Portal 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:

http://host_name:port_number/context_root/portlets/wsrp2?WSDL

http://host_name:port_number/context_root/portlets/wsrp1?WSDL

http://host_name:port_number/context_root/portlets/?WSDL (WSRP 1.0 for backward compatibility)

Where:

  • host_name is the server where your producer is deployed

  • port_number is the HTTP listener port number

  • context_root is the Web application's context root

  • portlets[/wsrp(1|2)]?WSDL is static text. The text entered here depends on how the producer is deployed.

For example:

http://myhost:7778/MyPortletApp/portlets/wsrp2?WSDL

proxyHost

Optional. Host name or IP address of the proxy server.

A proxy is required when the WebCenter Portal 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 Portal pages.

This argument defaults to 30.

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 enforcePolicyURI=1, valid values are:

  • USERNAME_WITHOUT_PASSWORD

    (oracle/wss10_username_id_propagation_with_msg_protection_client_policy)—This policy provides message protection (integrity and confidentiality) and identity propagation for outbound SOAP requests in accordance with the WS-Security 1.0 standard. Credentials (user name only) are included in outbound SOAP request messages through a WS-Security UsernameToken header. No password is included.

    Message protection is provided using WS-Security 1.0's Basic 128 suite of asymmetric key technologies. Specifically, RSA key mechanisms for message confidentiality, SHA-1 hashing algorithm for message integrity, and AES-128 bit encryption.

  • USERNAME_WITH_PASSWORD

    (oracle/wss10_username_token_with_message_protection_client_policy)—This policy provides message protection (integrity and confidentiality) and authentication for outbound SOAP requests in accordance with the WS-Security v1.0 standard. Both plain text and digest mechanisms are supported.

    This policy uses WS-Security's Basic 128 suite of asymmetric key technologies. Specifically, RSA key mechanism for message confidentiality, SHA-1 hashing algorithm for message integrity, and AES-128 bit encryption.

    Use this token profile if the WSRP producer has a different identity store. You will need to define an external application pertaining to the producer and associate the external application with this producer.

  • SAML_TOKEN_WITH_MSG_INTEGRITY

    (wss10_saml_token_with_message_integrity_client_policy)—This policy provides message-level integrity and SAML-based authentication for outbound SOAP requests in accordance with the WS-Security 1.0 standard. A SAML token, included in the SOAP message, is used in SAML-based authentication with sender vouches confirmation.

    This policy uses WS-Security's Basic 128 suite of asymmetric key technologies and SHA-1 hashing algorithm for message integrity.

    When this policy is selected, the recipient key alias (recptAlias) must be disabled.

  • SAML_TOKEN_WITH_MSG_PROTECTION

    (oracle/wss10_saml_token_with_message_protection_client_policy)—This policy provides message-level protection (integrity and confidentiality) and SAML-based authentication for outbound SOAP requests in accordance with the WS-Security 1.0 standard. The Web service consumer includes a SAML token in the SOAP header and the confirmation type is sender-vouches.

    This policy uses WS-Security's Basic 128 suite of asymmetric key technologies. Specifically, RSA key mechanisms for message confidentiality, SHA-1 hashing algorithm for message integrity, and AES-128 bit encryption. and SHA-1 hashing algorithm for message integrity.

tokenType
continued...
  • WSS11_SAML_TOKEN_WITH_MSG_PROTECTION

    (oracle/wss11_saml_token_with_message_protection_client_policy)—This policy enables message-level protection (integrity and confidentiality) and SAML token population for outbound SOAP requests in accordance with the WS-Security 1.1 standard. A SAML token, included in the SOAP message, is used in SAML-based authentication with sender vouches confirmation. This policy uses the symmetric key technology for signing and encryption, and WS-Security's Basic 128 suite of asymmetric key technologies for endorsing signatures.

  • WSS10_SAML_TOKEN_ONLY

    (oracle/wss10_saml_token_client_policy)—This policy includes SAML-tokens in outbound SOAP request messages in accordance with the WS-Security 1.0 standard. The policy propagates user identity and is typically used in intra departmental deployments where message protection and integrity checks are not required.

    This policy does not require any keystore configuration.

If the argument enforcePolicyURI=0, you can specify any valid Oracle Web Services Manager (OWSM) policy URI for the tokenType 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: SAML_TOKEN_WITH_MSG_PROTECTION, SAML_TOKEN_WITH_MSG_INTEGRITY, WSS10_SAML_TOKEN_ONLY, WSS11_SAML_TOKEN_WITH_MSG_PROTECTION.

defUser

Optional. User name to assert to the remote producer when the user is not authenticated with the WebCenter Portal 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 Portal 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: USERNAME_WITHOUT_PASSWORD, SAML_TOKEN_WITH_MSG_PROTECTION, SAML_TOKEN_WITH_MSG_INTEGRITY, WSS10_SAML_TOKEN_ONLY, WSS11_SAML_TOKEN_WITH_MSG_PROTECTION.

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 tokenType is SAML_TOKEN_WITH_MSG_INTEGRITY.

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 0, users can specify any Oracle Web Services Manager (OWSM) policy URI. The user must ensure that the OWSM policy specified is valid.

The default value is 1.

server

Optional. Name of the managed server where the WebCenter Portal 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 Portal application is deployed.


Example

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='')

listWSRPProducers

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

Lists WSRP producer registration details.

Syntax

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 Portal 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 0, do not specify the names argument.

server

Optional. Name of the managed server where the WebCenter Portal 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 Portal application is deployed.


Example

The following example lists all the WSRP producers registered with an application named myApp:

wls:/weblogic/serverConfig> listWSRPProducers(appName='myApp', verbose=0)


----------------------
WSRPSamples-connection
----------------------

The following example lists detailed connection information for a WSRP producer registered as WSRPSamples-connection with an application named myApp:

wls:/weblogic/serverConfig> listWSRPProducers(appName='myApp', name='WSRPSamples-connection', verbose=1)


----------------------
WSRPSamples-connection
----------------------
Connection Name: WSRPSamples-connection
Web Service Connection Name: WSRPSamples-connection-wsconn
Proxy Host: None
Proxy Port: None
Timeout: 0
WSDL URL: http://pspencer-lnx.uk.oracle.com:7777/portletapp/portlets/wsrp2?WSDL

deregisterWSRPProducer

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

Deregisters a WSRP producer, and deletes the associated WSRP and Web Service connections.

Syntax

deregisterWSRPProducer(appName, name, [server], [applicationVersion])
Argument Definition
appName

Name of the WebCenter Portal application where the producer is registered.

name

Name of an existing WSRP producer.

server

Optional. Name of the managed server where the WebCenter Portal 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 Portal application is deployed.


Example

The following example deregisters the WSRPSamples producer in an application named webcenter.

wls:/weblogic/serverConfig> deregisterWSRPProducer(appName='webcenter', 
name='WSRPSamples')

listWSRPProducerRegistrationProperties

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

Lists registration properties supported by a WSRP portlet producer.

Syntax

listWSRPProducerRegistrationProperties(appName, url,[proxyHost, [proxyPort], 
[server], [applicationVersion])
Argument Definition
appName 

Name of the WebCenter Portal application in which to perform this operation.

url

WSRP producer URL. The syntax will vary according to your WSRP implementation, for example:

http://host_name:port_number/context_root/portlets/wsrp2?WSDL

http://host_name:port_number/context_root/portlets/wsrp1?WSDL

http://host_name:port_number/context_root/portlets/?WSDL (WSRP 1.0 for backward compatibility)

Where:

  • host_name is the server where your producer is deployed

  • port_number is the HTTP listener port number

  • context_root is the Web application's context root

  • portlets[/wsrp(1|2)]?WSDL is static text. The text entered here depends on how the producer is deployed.

For example:

http://myhost:7778/MyPortletApp/portlets/wsrp2?WSDL

proxyHost

Optional. Host name or IP address of the proxy server.

A proxy is required when the WebCenter Portal 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 Portal 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 Portal application is deployed.


Example

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

listWSRPProducerUserCategories

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

Lists any user categories that a WSRP producer might support. WebCenter Portal users can use the WLST command mapWSRPProducerUserCategory to map application roles to a producer's user category.

Syntax

listWSRPProducerUserCategories(appName, name, [server], [applicationVersion])
Argument Definition
appName 

Name of the WebCenter Portal application in which to perform this operation.

name

Name of an existing WSRP producer.

server

Optional. Name of the managed server where the WebCenter Portal 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 Portal application is deployed.


Example

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

mapWSRPProducerUserCategory

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

Maps a role that is defined in the specified WebCenter Portal application to a user category supported by a WSRP producer. The user categories may be found using listWSRPProducerUserCategories.

Syntax

mapWSRPProducerUserCategory(appName, name, localRole, producerUserCategory, 
[server], [applicationVersion])
Argument Definition
appName 

Name of the WebCenter Portal application in which to perform this operation.

name

Name of an existing WSRP producer.

localRole

Name of the WebCenter Portal application role to be mapped.

producerUserCategory

WSRP producer user category to which the WebCenter Portal role will be mapped.

server

Optional. Name of the managed server where the WebCenter Portal 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 Portal application is deployed.


Example

The following example maps the application role admin to the WSRP user category wrsp-admin.

wls:/weblogic/serverConfig> mapWSRPProducerUserCategory(appName='webcenter', 
name='WSRPProducer1', localRole='admin', producerUserCategory='wsrp-admin')

registerPDKJavaProducer

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

Creates a connection to an Oracle PDK-Java portlet producer and registers the Oracle PDK-Java producer with a named WebCenter Portal application.

Syntax

registerPDKJavaProducer(appName, name, url, [serviceId], [proxyHost, 
[proxyPort]], [subscriberId], [sharedKey], [timeout], 
[establishSession],[externalApp], [mapUser], [server], [applicationVersion])
Argument Definition
appName

Name of the WebCenter Portal application for which to perform this operation.

name

Connection name. The name must be unique (across all connection types) within the WebCenter Portal application.

url

URL for the Oracle PDK-Java producer. Use the following syntax:

http://host_name:port_number/context_root/providers

Where:

  • host_name is the server where the producer is deployed

  • port_number is the HTTP Listener port number

  • context_root is the Web application's context root.

  • providers is static text. The text entered here depends on how the producer is deployed.

For example:

http://myHost:7778/myEnterprisePortlets/providers

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 sample as the service ID:

http://domain.us.oracle.com:7778/axyz/providers

However, the following URL endpoint, does not require a service ID:

http://domain.us.oracle.com:7778/axyz/providers/sample

The service ID is used to look up a file called <service_id>.properties, which defines the characteristics of the producer, such as whether to display its test page. Use any value to create the service ID.

proxyHost

Optional. Host name or IP address of the proxy server.

A proxy is required if the WebCenter Portal 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 Portal 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 Portal pages.

This argument defaults to 30.

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 (1), the server maintains session-specific information, such as the user name. Message authentication uses sessions, so if a shared key is specified, this option should also be enabled. For sessionless communication between the producer and the server, specify 0.

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 Portal 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 Portal application is deployed.


Example

The following example creates and registers an Oracle PDK-Java producer named JPDKSamples, for an application named webcenter.

wls:/weblogic/serverConfig> registerPDKJavaProducer(appName='webcenter', 
name='JPDKSamples', url='http://myhost:9999/jpdk/providers/sample')

setPDKJavaProducer

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

Edits registration details for an existing PDK-Java producer.

Syntax

setPDKJavaProducer(appName, name, url, [serviceId], [proxyHost, [proxyPort]], 
[subscriberId], [sharedKey], [timeout], [establishSession], [externalApp], 
[mapUser], [server], [applicationVersion])
Argument Definition
appName

Name of the WebCenter Portal 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:

http://host_name:port_number/context_root/providers

Where:

  • host_name is the server where the producer is deployed

  • port_number is the HTTP Listener port number

  • context_root is the Web application's context root.

  • providers is static text. The text entered here depends on how the producer is deployed.

For example:

http://myHost:7778/myEnterprisePortlets/providers

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 sample as the service ID:

http://domain.us.oracle.com:7778/axyz/providers

However, the following URL endpoint, does not require a service ID:

http://domain.us.oracle.com:7778/axyz/providers/sample

The service ID is used to look up a file called <service_id>.properties, which defines the characteristics of the producer, such as whether to display its test page. Use any value to create the service ID.

proxyHost

Optional. Host name or IP address of the proxy server.

A proxy is required if the WebCenter Portal 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 Portal 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 Portal 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 (1), the server maintains session-specific information, such as the user name. Message authentication uses sessions, so if a shared key is specified, this option should also be enabled. For sessionless communication between the producer and the server, set to 0.

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 Portal 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 Portal application is deployed.


Example

The following example changes a PDK-Java producer registered with MyApp to use a proxy server.

wls:/weblogic/serverConfig> setPDKJavaProducer(appName='MyApp', 
name='MyProducer', url='http://myhost.com/jpdk/providers/sample', 
proxyHost='myproxy.com', proxyPort=80)

deregisterPDKJavaProducer

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

Deregisters an Oracle PDK-Java producer and deletes the associated connection, for a named WebCenter Portal application.

Syntax

deregisterPDKJavaProducer(appName, name, [server, applicationVersion]) 
Argument Definition
appName

Name of the WebCenter Portal 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 Portal 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 Portal application is deployed.


Example

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

listPDKJavaProducers

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

Lists details for one or more Oracle PDK-Java producers registered with a named WebCenter Portal application.

Syntax

listPDKJavaProducers(appName, [name],[verbose], [server, applicationVersion])
Argument Definition
appName

Name of the WebCenter Portal 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 Portal 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 0, do not specify the name argument.

server

Optional. Name of the managed server where the WebCenter Portal 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 Portal application is deployed.


Example

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

registerPageletProducer

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

Registers a pagelet producer with a named WebCenter Portal application.

Syntax

registerPageletProducer(appName, name, url, [server, applicationVersion])
Argument Definition
appName

Name of the WebCenter Portal application for which to perform this operation.

name

Connection name. The name must be unique (across all connection types) within the WebCenter Portal application.

The name you specify here appears in Composer under the Mash-ups >Pagelet Producers folder (by default).

url

URL required to access WebCenter Portal's Pagelet Producer. Use the syntax:

protocol://host.domain:port_number/pagelets

The URL must include a fully-qualified domain name. For example:

http://myhost.example.com:7778/pagelets

If pagelets carry secure data, the URL registered must use the https protocol. For example:

https://myhost.com:7779/pagelets

Note: In the Spaces application, if the Pagelet Producer URL is protected by Oracle Access Manager (OAM), the URL to the pagelet catalog must be excluded (mapped directly without access control), or the catalog will appear to be empty when using REST. The pagelet catalog URL is: http://<proxy_host>:<proxy_port>/api/v2/ensemble/pagelets

server

Optional. Name of the managed server where the WebCenter Portal 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 Portal application is deployed.


Example

The following example registers a pagelet producer with an application named webcenter.

wls:/weblogic/serverConfig> registerPageletProducer(appName='webcenter', 
name='MyPageletProducer', url='http://myhost.com:7001/pagelets')

setPageletProducer

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

Edits connection details for an existing pagelet producer.

Syntax

setPageletProducer(appName, name, [url, server, applicationVersion])
Argument Definition
appName

Name of the WebCenter Portal application in which to perform this operation.

name

Name of an existing pagelet producer connection.

url

Optional. URL required to access WebCenter Portal's Pagelet Producer. Use the syntax:

protocol://host.domain:port_number/pagelets

The URL must include a fully-qualified domain name. For example:

http://myhost.example.com:7778/pagelets

Note: In the Spaces application, if the Pagelet Producer URL is protected by Oracle Access Manager (OAM), the URL to the pagelet catalog must be excluded (mapped directly without access control), or the catalog will appear to be empty when using REST. The pagelet catalog URL is: http://<proxy_host>:<proxy_port>/api/v2/ensemble/pagelets

server

Optional. Name of the managed server where the WebCenter Portal 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 Portal application is deployed.


Example

The following example updates administrator user name and password details for an existing pagelet producer named MyPageletProducer:

wls:/weblogic/serverConfig> setPageletProducer(appName='webcenter', 
name='MyPageletProducer', url='http://mypagelethost.com:7778/pagelets')

listPageletProducers

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

Lists connection details for one or all pagelet producers registered with a named WebCenter Portal application.

Syntax

listPageletProducers(appName, [name],[verbose], [server, applicationVersion])
Argument Definition
appName

Name of the WebCenter Portal application in which to perform this operation.

name

Optional. Name of an existing pagelet producer connection. Use this argument to view connection details for a specific pagelet producer.

If omitted, connection details for all pagelet producers configured for this WebCenter Portal application are listed.

verbose

Optional. Displays 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 0, do not specify the name argument.

server

Optional. Name of the managed server where the WebCenter Portal 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 Portal application is deployed.


Example

The following example lists connection names and details for all pagelet producers currently registered for a WebCenter Portal application name MyWebCenterApp:

wls:/weblogic/serverConfig> listPageletProducers(appName='MyWebCenterApp', verbose=1)
----------------------
MyPageletProducer
----------------------
URL: http://myhost.com:7001/pagelets
----------------------
TestPageletProducer
----------------------
URL: http://testhost.com:7002/pagelets
----------------------

The following example displays details for a single pagelet producer connection named MyPageletProducer:

wls:/weblogic/serverConfig> listPageletProducers(appName='webcenter', 
name='MyPageletProducer', verbose=1)
----------------------
MyPageletProducer
----------------------
URL: http://myhost.com:7001/pagelets

deregisterPageletProducer

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

Deregisters a pagelet producer currently registered with a named WebCenter Portal application.

Syntax

deregisterPageletProducer(appName, name, [server, applicationVersion]) 
Argument Definition
appName

Name of the WebCenter Portal application in which to perform this operation.

name

Name of an existing pagelet producer connection.

server

Optional. Name of the managed server where the WebCenter Portal 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 Portal application is deployed.


Example

The following example deregisters a pagelet producer connection named MyPageletProducer currently configured for a WebCenter Portal application name MyWebCenterApp:

wls:/weblogic/serverConfig> deregisterPageletProducer(appName='MyWebCenterApp', 
name='MyPageletProducer')

refreshProducer

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

Refreshes the metadata stored for a named producer to reflect the portlets that are currently offered by that producer.

Syntax

refreshProducer(appName, producerName, [server, applicationVersion])
Argument Definition
appName

Name of the WebCenter Portal application in which the producer is registered.

producerName

Name of an existing producer.

server

Optional. Name of the managed server where the WebCenter Portal 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 Portal application is deployed.


Example

The following example refreshes the WSRPSamples producer in an application named webcenter.

wls:/weblogic/serverConfig> refreshProducer(appName='webcenter', 
producerName='WSRPSamples')
Producer WSRPSamples has been refreshed.

registerOOTBProducers

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

Registers several out-of-the-box producers provided with Oracle WebCenter Portal: OmniPortlet, Web Clipping, and WSRP Tools.

Syntax

registerOOTBProducers(producerHost, producerPort, appName, [server, 
applicationVersion])
Argument Definition
producerHost

Host name or IP address of the server hosting out-of-the-box producers.

In a cluster fronted by a load balancer, enter the host name of the load balancer.

producerPort

Port number for the server hosting out-of-the-box producers.

In a cluster, fronted by a load balancer, enter the port number of the load balancer.

appName

Name of the WebCenter Portal application in which the out-of-the-box producers are to be registered.

server

Optional. Name of the managed server where the WebCenter Portal 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 Portal application is deployed.


Example

The following example registers out-of-the-box producers in a WebCenter Portal 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.

deregisterOOTBProducers

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

Deregisters out-of-the-box producers provided with Oracle WebCenter Portal: OmniPortlet, Web Clipping, and WSRP Tools.

Syntax

deregisterOOTBProducers(appName, [server, applicationVersion])
Argument Definition
appName

Name of the WebCenter Portal application in which the out-of-the-box producers are currently registered.

server

Optional. Name of the managed server where the WebCenter Portal 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 Portal application is deployed.


Example

The following example deregisters out-of-the-box WebCenter Portal 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

registerSampleProducers

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

Registers the sample producers provided with Oracle WebCenter Portal with a named WebCenter Portal application. There are two sample producers — WSRP Samples and JPDK Samples.

Syntax

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 Portal application in which the sample producers are to be registered.

server

Optional. Name of the managed server where the WebCenter Portal 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 Portal application is deployed.


Example

The following example registers Oracle WebCenter Portal sample producers in an application named myApp.

wls:/weblogic/serverConfig> registerSampleProducers(producerHost='myhost.com', 
producerPort=9999, appName='myApp')

deregisterSampleProducers

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

Deregisters the Oracle WebCenter Portal sample producers (WSRP Samples and JPDK Samples) from a named WebCenter Portal application.

Syntax

deregisterSampleProducers(appName, [server, applicationVersion])
Argument Definition
appName

Name of the WebCenter Portal 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 Portal 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 Portal application is deployed.


Example

The following example deregisters sample producers from a WebCenter Portal application named myApp.

wls:/weblogic/serverConfig> deregisterSampleProducers(appName='myApp') 

RSS News Feeds

Use the commands listed in Table 10-22 to manage proxy settings for the RSS service.

Configuration changes made using these WebCenter Portal WLST commands are only effective after your restart the Managed Server on which the WebCenter Portal application is deployed. For details, see Oracle Fusion Middleware Administrator's Guide for Oracle WebCenter.

Table 10-22 RSS WLST Commands

Use this command... To... Use with WLST...

getRssProxyConfig

Return the proxy host and proxy port used by the RSS service.

Online

setRssProxyConfig

Specify the proxy host and proxy port used by the RSS service.

Online

unsetRssProxyConfig

Delete proxy host and proxy port settings.

Online


getRssProxyConfig

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

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 Portal application.

Syntax

getRssProxyConfig(appName, [server, applicationVersion])
Argument Definition
appName

Name of the WebCenter Portal application in which to perform this operation.

server

Optional. Name of the managed server where the WebCenter Portal 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 Portal application is deployed.


Example

The following example returns the proxy host and proxy port used by the RSS service in a WebCenter Portal application named webcenter.

wls:/weblogic/serverConfig> getRssProxyConfig(appName='webcenter')

setRssProxyConfig

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

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 Portal application.

Syntax

setRssProxyConfig(appName, proxyHost, proxyPort, [server, applicationVersion])
Argument Definition
appName

Name of the WebCenter Portal 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 Portal 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 Portal application is deployed.


Example

The following example sets the proxy host and proxy port used by the RSS service in a WebCenter Portal application named webcenter.

wls:/weblogic/serverConfig> setRssProxyConfig(appName='webcenter', 
proxyHost='www-proxy.example.com', proxyPort='80')

unsetRssProxyConfig

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

Deletes the current proxy host and proxy port settings.

Syntax

unsetRssProxyConfig(appName, [server, applicationVersion])
Argument Definition
appName

Name of the WebCenter Portal application in which to perform this operation.

server

Optional. Name of the managed server where the WebCenter Portal 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 Portal application is deployed.


Example

The following example deletes the proxy host and proxy port settings used by the RSS service in a WebCenter Portal application named webcenter.

wls:/weblogic/serverConfig> unsetRssProxyConfig(appName='webcenter')

Search - Oracle SES Search

Use the commands listed in Table 10-23 to manage Oracle Secure Enterprise Search (SES) connections and other Oracle SES search related properties for WebCenter Portal applications.

Configuration changes made using these WebCenter Portal WLST commands are only effective after your restart the Managed Server on which the WebCenter Portal application is deployed. For details, see Oracle Fusion Middleware Administrator's Guide for Oracle WebCenter.

Table 10-23 Search - Oracle SES WLST Commands

Use this command... To... Use with WLST...

createSESConnection

Create a connection to an Oracle SES instance for a WebCenter Portal application.

Online

setSESConnection

Edit an existing Oracle SES search connection.

Online

listSESConnections

List individual or all Oracle SES search connections that are configured for a specific WebCenter Portal application.

Online

setSearchSESConfig

Configure search settings for an existing Oracle SES search connection.

Online

listSearchSESConfig

List Oracle SES properties for a WebCenter Portal application.

Online

createFederationTrustedEntity

Create a federation trusted entity on an Oracle (SES) instance.

Online


createSESConnection

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

Creates a connection to an Oracle Secure Enterprise Search (SES) instance for a WebCenter Portal application.

Syntax

createSESConnection(appName, name, url, appUser, appPassword,[default], 
[server], [applicationVersion])
Argument Definition
appName

Name of the WebCenter Portal application in which to perform this operation.

name

Connection name. The name must be unique (across all connection types) within the WebCenter Portal application.

url

Web Services URL that Oracle Secure Enterprise Search exposes to enable Search requests.

Use the format: http://<host>:<port>/search/query/OracleSearch

appUser

User name that the WebCenter Portal application uses to authenticate itself as a trusted application to Oracle Secure Enterprise Search so that it may perform searches on behalf of WebCenter Portal users.

The specified user must be present in both the Oracle Identity Management server configured for the WebCenter Portal application and the Oracle Identity Management server configured for Oracle SES.

appPassword

Password for the user name specified.

default

Optional. Configures WebCenter Portal's Search service to actively use the search connection. Valid options are 1 (true) and 0 (false).

Setting to 1 replaces any other search connection that is being used. Setting to 0 does not change the current Search service configuration. This argument defaults to 0.

server

Optional. Name of the managed server where the WebCenter Portal 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 Portal application is deployed.


Example

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 Portal 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)

setSESConnection

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

Edits an existing Oracle Secure Enterprise Search (SES) search connection.

Syntax

setSESConnection(appName, name, [url], [appUser],[appPassword],[default], 
[server], [applicationVersion])
Argument Definition
appName

Name of the WebCenter Portal 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: http://<host>:<port>/search/query/OracleSearch

appUser

Optional. User name that the WebCenter Portal application uses to log in to Oracle Secure Enterprise Search so that it may perform searches on behalf of WebCenter Portal users.

appPassword

Optional. Password that the WebCenter Portal application uses to log in to Oracle Secure Enterprise Search so that it may perform searches on behalf of WebCenter Portal users.

default

Optional. Configures WebCenter Portal's Search service to actively use the search connection. Valid options are 1 (true) and 0 (false).

Setting to 1 replaces any other search connection that is being used. Setting to 0 does not change the current Search service configuration. This argument defaults to 0.

server

Optional. Name of the managed server where the WebCenter Portal 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 Portal application is deployed.


Example

The following example modifies the URL of a search connection named SESConn1 and makes the connection the active SES search connection for a WebCenter Portal 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)

listSESConnections

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

Lists the names of all Oracle Secure Enterprise Search (SES) search connections configured for a WebCenter Portal application.

Syntax

listSESConnections(appName, [verbose], [name], [server], [applicationVersion])
Argument Definition
appName

Name of the WebCenter Portal 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 Portal 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 0, do not specify the name argument.

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 Portal 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 Portal application is deployed.


Examples

The following example displays connection details for all SES search connections configured for a WebCenter Portal 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')

setSearchSESConfig

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

Configures search settings for an existing Oracle Secure Enterprise Search (SES) search connection. If a parameter is not specified it is not modified.

Syntax

setSearchSESConfig(appName,[connectionName],[dataGroup],[topNRows], [server], 
[applicationVersion])
Argument Definition
appName

Name of the WebCenter Portal 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 Portal 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 Portal application is deployed.


Example

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.

listSearchSESConfig

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

Lists SES search settings for a WebCenter Portal application.

Syntax

listSearchSESConfig(appName, [server, applicationVersion])
Argument Definition
appName

Name of the WebCenter Portal application for which to perform this operation.

server

Optional. Name of the managed server where the WebCenter Portal 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 Portal application is deployed.


Example

The following example displays SES search configuration information for a WebCenter Portal application named webcenter.

wls:/weblogic/serverConfig> listSearchSESConfig(appName='webcenter')
Already in Domain Runtime Tree
-----------------
Search SES Config
-----------------
connectionName:  SESConn1
dataGroup:  group2
topNRows:  200

createFederationTrustedEntity

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

Creates a federation trusted entity on an Oracle Secure Enterprise Search (SES) instance for a given entity name and password.

Syntax

createFederationTrustedEntity(appName, sesUrl, sesPassword, entityName, entityPassword, desc,  [server], [applicationVersion])
Argument Definition
appName

Name of the WebCenter Portal application for 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).

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 Portal 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 Portal application is deployed.


Example

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')

Search - Oracle SES Search Crawlers

Use the commands listed in Table 10-24 to manage Oracle Secure Enterprise Search (SES) crawlers for WebCenter Portal applications.

There is no need to restart your WebCenter Portal application after running crawler WLST commands.

Table 10-24 Search - Oracle SES Crawler WLST Commands

Use this command... To... Use with WLST...

createSpacesCrawler

Create a crawler for Spaces objects on an Oracle SES instance.

Online

createDocumentsCrawler

Create a documents crawler for a WebCenter Portal application, on an Oracle SES instance.

Online

createDiscussionsCrawler

Create a discussions crawlers and an announcement crawler for a WebCenter Portal application, on an Oracle SES instance.

Online

listSpacesCrawler

Return the Spaces crawler configured for a Spaces application, on an Oracle SES instance.

Online

listDocumentsCrawler

Return the documents crawler configured for a WebCenter Portal application, on an Oracle SES instance.

Online

listDiscussionsCrawler

Return the discussion and announcement crawlers configured for a WebCenter Portal application, on an Oracle SES instance.

Online

startSpacesCrawler

Start the Spaces crawler configured for a Spaces application, on an Oracle SES instance.

Online

startDocumentsCrawler

Start the documents crawler configured for a WebCenter Portal application, on an Oracle SES instance.

Online

startDiscussionsCrawler

Start the discussion and announcement crawlers configured for a WebCenter Portal application, on an Oracle SES instance.

Online

stopSpacesCrawler

Stop the Spaces crawler configured for a Spaces application, on an Oracle SES instance.

Online

stopDocumentsCrawler

Stop the documents crawler configured for a WebCenter Portal application, on an Oracle SES instance.

Online

stopDiscussionsCrawler

Stop discussion and announcement crawlers configured for a WebCenter Portal application, on an Oracle SES instance.

Online

deleteSpacesCrawler

Delete the Spaces crawler configured for a Spaces application, on an Oracle SES instance.

Online

deleteDocumentsCrawler

Delete the documents crawler configured for a WebCenter Portal application, on an Oracle SES instance.

Online

deleteDiscussionsCrawler

Delete discussion and announcement crawlers configured for a WebCenter Portal application, on an Oracle SES instance.

Online


createSpacesCrawler

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

Creates a crawler for Spaces objects on an Oracle SES instance. The command creates a WebCenter Portal datasource and specifies a schedule for crawling Spaces objects (such as spaces, lists, pages, and people).

Syntax

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 Spaces application in which to perform this operation. For the Spaces application, the name is always webcenter.

host

Host name of the machine where the Spaces application is running.

port

Port number used to access the Spaces 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 the Spaces application.

This user must exist in the Spaces application and in your back-end identity management server with appropriate permissions and roles. For example: mycrawladmin)

crawlPassword

Password for the 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. The default mode is ACCEPT_ALL. 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 MANUAL and then use the startSpacesCrawler command to initiate a crawl manually.

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 freqType='HOURLY'.

startDayOfWeek

Day on which to start a weekly crawl. For example, MONDAY, TUESDAY, and so on.

Only valid when freqType='WEEKLY'.

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 freqType='MONTHLY'.

daysBetweenLaunches

Number of days between crawls.

Only valid when freqType='DAILY'.

weeksBetweenLaunches

Number of weeks between crawls.

Only valid when freqType='WEEKLY'.

monthsBetweenLaunches

Number of months between crawls.

Only valid when freqType='MONTHLY'.

server

Optional. Name of the managed server where the WebCenter Portal 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 Portal application is deployed.


Example

The following example creates a Spaces crawler on the SES instance http://myseshost.com:7777 for a 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)

createDocumentsCrawler

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

Creates a documents crawler for a WebCenter Portal application, on an Oracle SES instance.

The command creates an Oracle WebCenter Content repository datasource and specifies a schedule for crawling documents in the Oracle WebCenter Content repository.

Syntax

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 Portal application in which to perform this operation.

host

Host name of the machine where the WebCenter Portal application is running.

port

Port number used to access the WebCenter Portal 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 WebCenter Content's Content Server. 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 sysadmin. If it is not possible to grant those permissions, then delete the "remote" user corresponding to this user in Content Server, and create a "local" version of the user (same name) in Content Server.

password

Password for the administrative 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 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, jazn.com

authUserIdFormat

Format of the user ID (in active identity plug-in) that is used by 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. The default mode is ACCEPT_ALL. 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 MANUAL and then use the startDocumentsCrawler command to initiate a crawl manually.

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 freqType='HOURLY'.

startDayOfWeek

Day on which to start a weekly crawl. For example, MONDAY, TUESDAY, and so on.

Only valid when freqType='WEEKLY'.

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 freqType='MONTHLY'.

daysBetweenLaunches

Number of days between crawls.

Only valid when freqType='DAILY'.

weeksBetweenLaunches

Number of weeks between crawls.

Only valid when freqType='WEEKLY'.

monthsBetweenLaunches

Number of months between crawls.

Only valid when freqType='MONTHLY'.

server

Optional. Name of the managed server where the WebCenter Portal 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 Portal application is deployed.


Example

The following example creates a documents crawler on the Oracle SES instance http://myseshost.com:7777 for a 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)

createDiscussionsCrawler

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

Creates a discussion forum crawler and an announcements crawler for a WebCenter Portal 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.

Syntax

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 Portal application in which to perform this operation.

host

Host name of the machine where the WebCenter Portal application is running.

port

Port number used to access the WebCenter Portal 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 WebCenter Portal's discussions server is installed. Use the format:

Oracle: jdbc:oracle:thin:@<host>:<port>/<oracle-sid>

IBM DB2: jdbc:db2://<host>:<port>/<database_name>

Microsoft SQL Server: jdbc:sqlserver://<host_or_IP_address>:<port>/<database_name>

user

Administrative user for the database on which WebCenter Portal's discussions server is installed.

Oracle: The user MyPrefix_DISCUSSIONS_CRAWLER is created during WebCenter Portal's discussions server installation.

IBM DB2: The user MyPrefix_DC is created during WebCenter Portal's discussions server installation (where MyPrefix is five characters)

Microsoft SQL Server: The user MyPrefix_DISCUSSIONS_CRAWLER is created during WebCenter Portal's discussions server installation.

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. The default mode is ACCEPT_ALL. 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 MANUAL and then use the startDiscussionsCrawler command to initiate a crawl manually.

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 freqType='HOURLY'.

startDayOfWeek

Day on which to start a weekly crawl. For example, MONDAY, TUESDAY, and so on.

Only valid when freqType='WEEKLY'.

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 freqType='MONTHLY'.

daysBetweenLaunches

Number of days between crawls.

Only valid when freqType='DAILY'.

weeksBetweenLaunches

Number of weeks between crawls.

Only valid when freqType='WEEKLY'.

monthsBetweenLaunches

Number of months between crawls.

Only valid when freqType='MONTHLY'.

server

Optional. Name of the managed server where the WebCenter Portal 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 Portal application is deployed.


Example

The following example creates a discussion forum crawler and an announcements crawler on the Oracle SES instance http://myseshost.com:7777 for a 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)

listSpacesCrawler

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

Returns the Spaces crawler configured for a Spaces application, on an Oracle SES instance.

Syntax

listSpacesCrawler(appName, sesUrl, sesPassword, host, port, [verbose],
[server], [applicationVersion]
Argument Definition

appName

Name of the WebCenter Portal application in which to perform this operation. For the Spaces application, 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 Spaces application is running.

port

Port number used to access the Spaces application.

verbose

Optional. Valid options are 1 (true) and 0 (false). When set to 1, listSpacesCrawlers returns the Spaces crawler configured for a 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 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 Portal application is deployed.


Example

The following example returns the Spaces crawler configured in the Oracle SES instance http://myseshost.com:7777 for a 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')

Already in Domain Runtime Tree 
----------------- 
Spaces Crawlers 
----------------- 
webcenter_myhost.com_8888_spaces

listDocumentsCrawler

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

Returns the document crawler configured for a WebCenter Portal application, on an Oracle SES instance.

Syntax

listDocumentsCrawler(appName, sesUrl, sesPassword, host, port, [verbose],
[server], [applicationVersion])
Argument Definition

appName

Name of the WebCenter Portal 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 Portal application is running.

port

Port number used to access the WebCenter Portal 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 Portal 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 Portal 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 Portal application is deployed.


Example

The following example returns the documents crawler configured in the Oracle SES instance http://myseshost.com:7777 for a 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')

Already in Domain Runtime Tree 
----------------- 
Documents Crawlers 
----------------- 
webcenter_myhost.com_8888_documents 

listDiscussionsCrawler

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

Returns the discussion and announcement crawlers configured for a WebCenter Portal application, on an Oracle SES instance.

Syntax

listDiscussionsCrawler(appName, sesUrl, sesPassword, host, port,
[verbose],  [server], [applicationVersion]
Argument Definition

appName

Name of the WebCenter Portal 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 Portal application is running.

port

Port number used to access the WebCenter Portal 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 Portal 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 Portal 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 Portal application is deployed.


Example

The following example returns discussion and announcement crawlers configured in the Oracle SES instance http://myseshost.com:7777 for a 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')

Already in Domain Runtime Tree
-----------------
Discussions Crawler
-----------------
webcenter_myhost.com_8888_forums
webcenter_myhost.com_8888_announcements

startSpacesCrawler

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

Starts the Spaces crawler configured for a Spaces application, on an Oracle SES instance.

Syntax

startSpacesCrawler(appName, sesUrl, sesPassword, host, port, [server],
[applicationVersion])
Argument Definition

appName

Name of the WebCenter Portal application in which to perform this operation. For the Spaces application, 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 Spaces application is running.

port

Port number used to access the Spaces application.

server

Optional. Name of the managed server where the 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 Spaces application is deployed.


Example

The following example starts the Spaces crawler configured on the Oracle SES instance http://myseshost.com:7777 for a 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') 

startDocumentsCrawler

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

Starts the documents crawler configured for a WebCenter Portal application, on an Oracle SES instance.

Syntax

startDocumentsCrawler(appName, sesUrl, sesPassword, host, port, [server],
[applicationVersion]
Argument Definition

appName

Name of the WebCenter Portal 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 Portal application is running.

port

Port number used to access the WebCenter Portal application.

server

Optional. Name of the managed server where the WebCenter Portal 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 Portal application is deployed.


Example

The following example starts the document crawler configured on the Oracle SES instance http://myseshost.com:7777 for a 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') 

startDiscussionsCrawler

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

Starts the discussion and announcement crawlers configured for a WebCenter Portal application, on an Oracle SES instance.

Syntax

startDiscussionsCrawler(appName, sesUrl, sesPassword, host, port,  [server],
[applicationVersion])
Argument Definition

appName

Name of the WebCenter Portal 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 Portal application is running.

port

Port number used to access the WebCenter Portal application.

server

Optional. Name of the managed server where the WebCenter Portal 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 Portal application is deployed.


Example

The following example starts the discussion and announcement crawlers configured on the Oracle SES instance http://myseshost.com:7777 for a 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') 

stopSpacesCrawler

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

Stops the Spaces crawler configured for a Spaces application, on an Oracle SES instance.

Syntax

stopSpacesCrawler(appName, sesUrl, sesPassword, host, port, [server],
[applicationVersion])
Argument Definition

appName

Name of the WebCenter Portal application in which to perform this operation. For the Spaces application, 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 Spaces application is running.

port

Port number used to access the Spaces application.

server

Optional. Name of the managed server where the 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 Spaces application is deployed.


Example

The following example stops the Spaces crawler configured on the Oracle SES instance http://myseshost.com:7777 for a 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') 

stopDocumentsCrawler

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

Stops the documents crawler configured for a WebCenter Portal application, on an Oracle SES instance.

Syntax

stopDocumentsCrawler(appName, sesUrl, sesPassword, host, port, [server], 
[applicationVersion])
Argument Definition

appName

Name of the WebCenter Portal 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 Portal application is running.

port

Port number used to access the WebCenter Portal application.

server

Optional. Name of the managed server where the WebCenter Portal 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 Portal application is deployed.


Example

The following example stops the document crawler configured on the Oracle SES instance http://myseshost.com:7777 for a 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') 

stopDiscussionsCrawler

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

Stops the discussion and announcement crawlers configured for a WebCenter Portal application, on an Oracle SES instance.

Syntax

stopDiscussionsCrawler(appName, sesUrl, sesPassword, host, port,
[server], [applicationVersion])
Argument Definition

appName

Name of the WebCenter Portal 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 Portal application is running.

port

Port number used to access the WebCenter Portal application.

server

Optional. Name of the managed server where the WebCenter Portal 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 Portal application is deployed.


Example

The following example stops the discussion and announcement crawlers configured on the Oracle SES instance http://myseshost.com:7777 for a 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') 

deleteSpacesCrawler

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

Deletes the Spaces crawler configured for a Spaces application, on an Oracle SES instance.

Syntax

deleteSpacesCrawler(appName, sesUrl, sesPassword, host, port,[server],[applicationVersion])
Argument Definition

appName

Name of the application in which to perform this operation. For the Spaces application, 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 Spaces application is running.

port

Port number used to access the Spaces application.

server

Optional. Name of the managed server where the 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 application is deployed.


Example

The following example deletes the Spaces crawler configured on the Oracle SES instance http://myseshost.com:7777 for a 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') 

deleteDocumentsCrawler

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

Deletes the documents crawler configured for a WebCenter Portal application, on an Oracle SES instance.

Syntax

deleteDocumentsCrawler(appName, sesUrl, sesPassword, host, port, [server], 
[applicationVersion])
Argument Definition

appName

Name of the WebCenter Portal 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 Portal application is running.

port

Port number used to access the WebCenter Portal application.

server

Optional. Name of the managed server where the WebCenter Portal 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 Portal application is deployed.


Example

The following example deletes the document crawler configured on the Oracle SES instance http://myseshost.com:7777 for a 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') 

deleteDiscussionsCrawler

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

Deletes the discussion and announcement crawlers configured for a WebCenter Portal application, on an Oracle SES instance.

Syntax

deleteDiscussionsCrawler(appName, sesUrl, sesPassword, host, port,  [server],
[applicationVersion])
Argument Definition

appName

Name of the WebCenter Portal 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 Portal application is running.

port

Port number used to access the WebCenter Portal application.

server

Optional. Name of the managed server where the WebCenter Portal 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 Portal application is deployed.


Example

The following example deletes the discussion and announcement crawlers configured on the Oracle SES instance http://myseshost.com:7777 for a 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') 

Search - WebCenter Portal Search

Use the commands listed in Table 10-25 to manage search settings and crawl options for the Spaces application and other WebCenter Portal applications.

Configuration changes made using these WebCenter Portal WLST commands are effective immediately; no restart is required.

Table 10-25 WebCenter Portal Search WLST Commands

Use This Command... To... Use with WLST...

setSearchConfig

Modify search settings for a WebCenter Portal application.

Online

listSearchConfig

List search properties for a WebCenter Portal application.

Online

setSpacesCrawlProperties

Specify crawl properties for a WebCenter Portal application.

Online

getSpacesCrawlProperties

Return the current crawl settings for a WebCenter Portal application.

Online


setSearchConfig

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

Modifies search settings for a WebCenter Portal application. If a parameter is not specified it is not modified.

Syntax

setSearchConfig(appName,[numSavedSearches],[numResultsRegion],[numResultsMain], 
[executionTimeout],[prepareTimeout],[showAllExecutionTimeout], 
[server], [applicationVersion])
Argument Definition
appName

Name of the WebCenter Portal 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 Portal 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 Portal application is deployed.


Examples

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);

listSearchConfig

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

Lists search settings for a WebCenter Portal application.

Syntax

listSearchConfig(appName, [server, applicationVersion])
Argument Definition
appName

Name of the WebCenter Portal application for which to perform this operation.

server

Optional. Name of the managed server where the WebCenter Portal 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 Portal application is deployed.


Example

The following example displays search configuration information for a WebCenter Portal application named webcenter.

wls:/weblogic/serverConfig> listSearchConfig(appName='webcenter')

setSpacesCrawlProperties

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

Specifies crawl properties for WebCenter Portal applications.

WebCenter Portal applications can be crawled by Oracle SES to provide a faster, more unified search experience across WebCenter Portal objects, specifically: spaces, lists, pages, people (profiles), wikis, blogs, documents, discussions, and announcements. Three distinct crawlers make this possible:

  • 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 Portal applications:

  • Spaces application—To use Oracle SES crawlers in the Spaces application, you must enable all three crawlers.

  • Framework applications—To use Oracle SES crawlers in WebCenter Portal applications, you must enable both the documents and discussions crawlers. The Spaces crawler is not applicable.

(Spaces application only) You can also use this command to specify an interval between full crawls for the Spaces crawler. During a full crawl, all of the Spaces crawler content is re-read. Out-of-the-box, full crawls for the 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.

Syntax

setSpacesCrawlProperties(appName, [fullCrawlIntervalInHours, spacesCrawlEnabled, documentCrawlEnabled, discussionsCrawlEnabled, server, applicationVersion])
Argument Definition
appName

Name of the WebCenter Portal application.

fullCrawlIntervalInHours

Optional. (Spaces application only) Number of hours between full crawls. The default is 168 hours or 7 days.

spacesCrawlEnabled

Optional. Specifies whether the Spaces Crawler is enabled in Oracle SES. Valid values are 1 (true) and 0 (false). This argument defaults to 0.

When set to 0, WebCenter Portal's internal search adapters return search results.

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 0, WebCenter Portal's internal search adapters return search results.

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 0, WebCenter Portal's internal search adapters return search results.

server

Optional. Name of the managed server where the WebCenter Portal 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 Portal application is deployed.


Example

The following example enables Oracle SES crawlers in the Spaces application and specifies that the Spaces application runs a full crawl through the Spaces Crawler every 8 days:

wls:/weblogic/serverConfig>setSpacesCrawlProperties(appName='webcenter', fullCrawlIntervalInHours=192, spacesCrawlEnabled=1, documentCrawlEnabled=1, discussionsCrawlEnabled=1)

getSpacesCrawlProperties

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

Returns the current crawl settings for a WebCenter Portal application, such as the number of hours between full crawls (Spaces crawler), and whether Oracle SES crawlers are enabled.

Syntax

getSpacesCrawlProperties(appName, [server, applicationVersion])
Argument Definition
appName

Name of the WebCenter Portal application.

server

Optional. Name of the managed server where the WebCenter Portal 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 Portal application is deployed.


Example

The following example returns the current crawl settings for the Spaces application.

wls:/weblogic/serverConfig>getSpacesCrawlProperties(appName='webcenter')

Spaces Crawl Properties:-----------------fullCrawlIntervalInHours: 124spacesCrawlEnabled:       1documentCrawlEnabled:     1discussionsCrawlEnabled:  1

Worklists

Use the commands listed in Table 10-26 to manage BPEL server connections for WebCenter Portal applications.

Configuration changes made using these WebCenter Portal WLST commands are only effective after your restart the Managed Server on which the WebCenter Portal application is deployed. For details, see Oracle Fusion Middleware Administrator's Guide for Oracle WebCenter.

Table 10-26 Worklist Commands

Use this command... To... Use with WLST...

createBPELConnection

Create a connection to a BPEL server for a WebCenter Portal application.

Online

setBPELConnection

Edit an existing BPEL server connection.

Online

listBPELConnections

List all of the BPEL server connections that are configured for a WebCenter Portal application.

Online

addWorklistConnection

Enable an existing BPEL server connection for the Worklist service.

Online

removeWorklistConnection

Disable a BPEL server connection currently used by the Worklist service.

Online

listWorklistConnections

List individual or all BPEL server connections configured for the Worklist service.

Online


createBPELConnection

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

Creates a connection to a BPEL server for a named WebCenter Portal application. BPEL server connections can be used by the application's Worklist service and 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 Spaces uses for its internal workflows, use the setSpacesWorkflowConnectionName command. See setSpacesWorkflowConnectionName.

Syntax

createBPELConnection(appName, name, url, [policy, recipientKeyAlias, linkUrl, server, applicationVersion])
Argument Definition
appName

Name of the WebCenter Portal application in which to perform this operation.

name

Connection name. The name must be unique (across all connection types) within the WebCenter Portal application.

url

URL required to access the BPEL server.

Use the format: protocol://host:port

The BPEL server URL must be unique within the WebCenter Portal application.

policy

Optional. SAML token policy this connection uses for authentication. Enter any valid policy. Valid values include:

  • oracle/wss10_saml_token_client_policy—use to access the BPEL server with the default, non message protected policy.

  • oracle/wss10_saml_token_with_message_protection_client_policy—use to access the BPEL server with a message protected policy. If selected, you must configure keys stores both in your WebCenter Portal application and in the BPEL application.

  • GPA—use if your environment supports Global Policy Attachments (GPA).

If you omit this argument, the connection defaults to oracle/wss10_saml_token_client_policy.

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 Portal 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

The default is null.

For performance reasons, in an HTTPS or SSO environment, linkUrl specifies user access to BPEL worklist items, through HTTPS or SSO Web servers, whereas 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 Portal 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 Portal application is deployed.


Examples

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')

setBPELConnection

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

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.

Syntax

setBPELConnection(appName, name, [url, policy, recipientKeyAlias, linkUrl, server, applicationVersion])
Argument Definition
appName

Name of the WebCenter Portal 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: <protocol>://<host>:<port>

The BPEL server URL must be unique within the WebCenter Portal application.

policy

Optional. SAML token policy this connection uses for authentication. Enter any valid policy. Valid values include:

  • oracle/wss10_saml_token_client_policy—use to access the BPEL server with the default, non message protected policy.

  • oracle/wss10_saml_token_with_message_protection_client_policy—use to access the BPEL server with a message protected policy. If selected, you must configure keys stores both in your WebCenter Portal application and in the BPEL application.

  • GPA—use if your environment supports Global Policy Attachments (GPA).

If you omit this argument, the connection defaults to oracle/wss10_saml_token_client_policy.

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 Portal 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, http://mySSO.host.com:7777

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 Portal 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 Portal application is deployed.


Examples

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')

listBPELConnections

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

Without any arguments, this command lists all the BPEL connections that are configured for a specific WebCenter Portal application. All BPEL connections are listed, even connections not currently used.

Syntax

listBPELConnections(appName, [verbose], [name], [server], [applicationVersion]) 
Argument Definition
appName

Name of the WebCenter Portal 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 0, do not specify the name argument.

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 name argument.

server

Optional. Name of the managed server where the WebCenter Portal 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 Portal application is deployed.


Examples

The following example lists the names of all the BPEL server connections that are configured for a WebCenter Portal 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 Portal 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
  ------------------

addWorklistConnection

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

Enable an existing BPEL server connection for Worklist services. The Worklist service supports multiple connections so that WebCenter Portal users can monitor and manage assignments and notifications from a range of BPEL servers.

The name must specify an existing BPEL server connection.

Syntax

addWorklistConnection(appName, name,[verbose, server, applicationVersion])
Argument Definition
appName

Name of the WebCenter Portal 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 Portal 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 Portal application is deployed.


Examples

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

removeWorklistConnection

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

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.

Syntax

removeWorklistConnection(appName, name, [server, applicationVersion])
Argument Definition
appName

Name of the WebCenter Portal 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 Portal 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 Portal application is deployed.


Example

The following example disables the BPEL server connection named WebCenter Worklist for the Worklist service.

wls:/weblogic/serverConfig> removeWorklistConnection(appName='webcenter', 
name='WebCenter Worklist')
  WebCenter Worklist successfully removed from WorkList

listWorklistConnections

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

Without any arguments, this command lists all of the BPEL server connections that are configured for the Worklist service, in a named WebCenter Portal application.

Syntax

listWorklistConnections(appName, [verbose],[name], [server], 
[applicationVersion])
Argument Definition
appName

Name of the WebCenter Portal 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 0, do not specify the name argument.

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 name argument.

server

Optional. Name of the managed server where the WebCenter Portal 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 Portal application is deployed.


Examples

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

Spaces Application

Use the commands listed in Table 10-27 to manage workflow settings and metadata for the Spaces application.

Table 10-27 Spaces Application WLST Commands

Use This Command... To... Use with WLST...

getSpacesWorkflowConnectionName

Return the name of the BPEL server connection that the Spaces application is using for internal workflows.

Online

setSpacesWorkflowConnectionName

Specify the BPEL server connection used for Spaces workflows.

Online

refreshGroupSpaceCache

Migrate metadata for individual spaces (in MDS) and space security data to the 'Spaces Cache'.

Online

refreshSpaceTemplateCache

Migrate metadata for individual space templates (in MDS) and space template security data to the 'Space Templates Cache'.

Online


getSpacesWorkflowConnectionName

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

Returns the name of the BPEL server connection that the Spaces application is currently using for internal workflows (spacemembership notifications, spacesubscription requests, and so on).

Syntax

getSpacesWorkflowConnectionName(appName, [server, applicationVersion])
Argument Definition
appName

Name of the Spaces application—always webcenter.

server

Optional. Name of the managed server where the 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 Spaces application is deployed.


Example

The following example names the BPEL server connection that the Spaces application is currently using for internal workflow.

wls:/weblogic/serverConfig> getSpacesWorkflowConnectionName(appName='webcenter')
WorkflowConfigConnectionName: WebCenter-Worklist

setSpacesWorkflowConnectionName

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

Specifies the BPEL server connection that the Spaces application uses for internal workflows. The Spaces application uses a BPEL server included with the Oracle SOA Suite to host internal workflows, such as spacemembership notifications, spacesubscription 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 Spaces application is deployed. For details, see Oracle Fusion Middleware Administrator's Guide for Oracle WebCenter.

Syntax

setSpacesWorkflowConnectionName(appName, name, [server, applicationVersion])
Argument Definition
appName

Name of the Spaces application—always webcenter.

name

Name of an existing BPEL connection.

server

Optional. Name of the managed server where the 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 Spaces application is deployed.


Example

The following example specifies that the Spaces application uses the BPEL server connection named WebCenter-Worklist for its internal workflows.

wls:/weblogic/serverConfig>setSpacesWorkflowConnectionName(appName='webcenter', 
name='WebCenter-Worklist')

refreshGroupSpaceCache

<