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

Part Number E13813-15
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 or Portal Framework applications and components from the command-line. For additional details about Oracle WebCenter Portal configuration, see Oracle Fusion Middleware Administering Oracle WebCenter Portal.

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 these WLST commands are only effective after you restart the Managed Server on which WebCenter Portal or your own Portal Framework application is deployed. There are some exceptions, including WLST commands for External Applications, Portlet Producers, and Lifecycle.

Oracle WebCenter Portal's custom WLST commands are described in the following sections:

Overview of Oracle WebCenter Portal WLST Command Categories

Oracle WebCenter Portal's WLST commands are grouped into the several categories (Table 10-1).

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

Table 10-1 WLST Command Categories

Command Category Description

General

Manage connections for WebCenter Portal and Portal Framework applications.

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.

Content Repository

Manage content repository connections and configure document services.

Discussions and Announcements

Manage discussions server connections and configure discussions and announcements.

External Applications

Manage external application connections.

Instant Messaging and Presence

Manage instant messaging and presence server connections and configure instant messaging and presence.

Mail

Manage mail server connections and configure mail.

Notifications

Manage settings for notifications.

People Connections

Manage profile information.

Personal Events

Manage personal event server connections.

Personalization

Manage personalization server connections.

Portlet Producers

Manage portlet producers.

Proxy Server

Manage proxy settings for RSS and activity stream.

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 WebCenter Portal and Portal Framework applications.

Worklists

Manage BPEL server connections.

WebCenter Portal Application

Manage WebCenter Portal workflow settings and portal metadata.

Identity Store

Configure options while searching an application's identity store.

Lifecycle

Export and import application metadata, individual portals, portal templates, portal assets, and portlet producer metadata.

Upgrade

Upgrade from a previous Oracle WebCenter Portal release.


General

Use the General commands, listed in Table 10-2, to manage connections, and perform other general tasks.

Configuration changes made using these WLST commands are only effective after restarting the Managed Server on which WebCenter Portal or your own Portal Framework application is deployed. For details, see Oracle Fusion Middleware Administering Oracle WebCenter Portal.

Table 10-2 General WLST Commands

Use This Command... To... Use with WLST...

deleteConnection

Delete any connection.

Online

getWebCenterConnectionTypes

List all connection types.

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 Oracle WebCenter Portal command executed.

Online


deleteConnection

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

Deletes a named connection currently configured for WebCenter Portal or your own Portal Framework application.

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 and when you delete a PDK-Java producer connection, its associated URL connection remains.

Note:

deleteConnection cannot be used to delete connections configured for personalization services. Instead, use deleteWCPSCMISConnection, deleteWCPSActivityGraphConnection, deleteWCPSPeopleConnection, or deleteWCPSCustomConnection.

Syntax

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

Name of the application in which to perform this operation.

For WebCenter Portal, the application name is always webcenter.

For Portal Framework applications, specify the appropriate name.

name

Connection name.

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 a connection configured for WebCenter Portal (webcenter):

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

setWebCenterServiceFrameworkConfig

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

Sets configuration properties for Oracle WebCenter Portal's services framework, 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 application in which to perform this operation.

For WebCenter Portal, the application name is always webcenter.

For Portal Framework applications, specify the appropriate name.

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 application is deployed. For example, WC_Spaces.

Required when applications with the same name are deployed to different 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 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 
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 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 application in which to perform this operation.

For WebCenter Portal, the application name is always webcenter.

For Portal Framework applications, specify the appropriate name.

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 returns the service framework resource action handler class and display as popup properties, for WebCenter Portal (webcenter):

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 Oracle WebCenter Portal connection types.

Syntax

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

Name of the application in which to perform this operation.

For WebCenter Portal, the application name is always webcenter.

For Portal Framework applications, specify the appropriate name.

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 returns connection types for WebCenter Portal (webcenter):

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

Analytics

This section includes the following sub sections:

Analytics Collector Connections

Use the commands listed in Table 10-3 to manage analytics collector connections for WebCenter Portal and Portal Framework applications. Events raised in these portal applications using OpenUsage APIs can be sent to an analytics collector for use by analytics and activity graph.

Connection configuration changes made using these Oracle WebCenter Portal WLST commands are only effective after your restart the Managed Server on which the application is deployed. For details, see Oracle Fusion Middleware Administering Oracle WebCenter Portal.

Table 10-3 Analytics Collector Connection WLST Commands

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

createAnalyticsCollectorConnection

Create a connection to an analytics collector for WebCenter Portal or a Portal Framework application.

Online

setAnalyticsCollectorConnection

Edit an existing analytics collector connection.

Online

listAnalyticsCollectorConnections

List all of the analytics collector connections that are configured for WebCenter Portal or a Portal Framework application.

Online

setDefaultAnalyticsCollectorConnection

Specify the default (or active) analytics collector connection for WebCenter Portal or a Portal Framework application.

Online

listDefaultAnalyticsCollectorConnection

Return connection details for the analytics collector being used by WebCenter Portal and Portal Framework 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 application.

Events raised in WebCenter Portal or a Portal Framework application using OpenUsage APIs can be sent to an analytics collector for use by analytics and activity graph.

While you can register multiple analytics collector connections for an 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 application in which to perform this operation.

For WebCenter Portal, the name is always webcenter.

For Portal Framework applications, specify the appropriate name.

connectionName

Connection name. The name must be unique across all connection types within 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 application.

Valid values are 1 (true) and 0 (false). When set to 1, the 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 an application, only one connection is used by analytics and activity graph—the default (or active) connection.

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 creates a connection named MyAnalyticsCollector for WebCenter Portal (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 WebCenter Portal. 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 application.

Events raised in WebCenter Portal or a Portal Framework application using OpenUsage APIs can be sent to an analytics collector for use by analytics and activity graph.

While you can register multiple analytics collector connections for an 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 application in which to perform this operation.

For WebCenter Portal, the name is always webcenter.

For Portal Framework applications, specify the appropriate name.

connectionName

Connection name. The name must be unique across all connection types within 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 are 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 application.

Valid values are 1 (true) and 0 (false). When set to 1, the 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 an application, only one connection is used by analytics and activity graph—the default (or active) connection.

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

Syntax

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

Name of the application in which to perform this operation.

For WebCenter Portal, the application name is always webcenter.

For Portal Framework applications, specify the appropriate name.

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.


Examples

The following example lists connection names and details for all the analytics collector connections that are currently configured for WebCenter Portal (webcenter):

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

------------------ 
MyAnalyticsCollector 
------------------ 
ClusterName/HostName: localhost 
Port: 31314 
Timeout: 30 
Unicast: 1 (true) 
Enabled: 1 (true) 

------------------
 TestAnalyticsCollector
------------------ 
ClusterName/HostName: localhost
Port: 32456 
Timeout: 456 
Unicast: 1 (true) 
Enabled: 1 (true) 
------------------

setDefaultAnalyticsCollectorConnection

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

Specifies the default analytics collector connection for a named application.

The default analytics collector connection is used to send events raised in WebCenter Portal or a Portal Framework application using OpenUsage APIs to an analytics collector for use by analytics and activity graph

While you can register multiple analytics collector connections for an 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 application in which to perform this operation.

For WebCenter Portal, the application name is always webcenter.

For Portal Framework applications, specify the appropriate name.

name

Name of an existing analytics collector connection.

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 configures the connection MyAnalyticsCollector for events raised in WebCenter Portal (webcenter):

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

The following example resets the default connection name:

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

listDefaultAnalyticsCollectorConnection

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

Return details about the analytics collector connection that is currently configured for a named application.

While you can register multiple analytics collector connections for an application, only one analytics collector connection is used—the default (or active) connection.

Syntax

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

Name of the application in which to perform this operation.

For WebCenter Portal, the application name is always webcenter.

For Portal Framework applications, specify the appropriate name.

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.


Examples

The following example returns details about the analytics collector connection that is currently configured for a WebCenter Portal (webcenter):

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

------------------ 
MyAnalyticsCollector 
------------------ 
ClusterName/HostName: localhost 
Port: 31314 
Timeout: 30 
Unicast: 1 (true) 
Enabled: 1 (true) 
------------------ 

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, heartbeatFrequency, server, applicationVersion])
Argument Definition
appName

Name of the analytics collector application in which to perform this operation--always analytics-collector.

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

heartbeatFrequency

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 and Portal Framework 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>setAnalyticsCollectorConfig(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 in which to perform this operation--always analytics-collector.

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 a standalone analytics collector:

CollectorHost = localhost
CollectorDefaultPort = 31314
CollectorMaximumPort = 31314
BroadcastType = Multicast
ClusterEnabled = 
ClusterName = 
ClusterBroadcastFrequency = 55

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

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

For WebCenter Portal, the application name is always webcenter.

For Portal Framework applications, specify the appropriate name.

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.


Examples

The following command lists all the events currently registered with the analytics collector for use by WebCenter Portal (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 system properties and metadata for activity graph.

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 Activity Graph" in the Oracle Fusion Middleware Administering Oracle WebCenter Portal.

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

urn

URN for the activity graph provider to export. For example:

oracle.webcenter.activitygraph.providers.analytics

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.providers.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.providers.analytics')

deleteAllAGMetadata

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

Deletes all the activity graph metadata that is defined for WebCenter Portal or a Portal Framework 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 that you want 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 that you want 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:

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 that you want 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 that you want 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 that you want 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 that you want 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.providers.analytics:

wls:/weblogic/serverConfig> deleteAGProviderConfiguration(appName='activitygraph-engines', urn='oracle.webcenter.activitygraph.providers.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='people-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)

  • Rank engine configuration (oracle.webcenter.activitygraph.rankengine.enabled)

See also, "Managing Activity Graph" in the Oracle Fusion Middleware Administering Oracle WebCenter Portal 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=1, 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 Activity Graph" in the Oracle Fusion Middleware Administering Oracle WebCenter Portal 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 Activity Graph" in the Oracle Fusion Middleware Administering Oracle WebCenter Portal 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='eqsys', password='mypassword')

Activity Stream

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

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

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 portals that are currently closed.

Online

archiveASByInactiveSpaces

Archive activity stream data associated with portals 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

archiveASBySpace

Archive activity stream data associated with a portal.

Online

archiveASAllSpaces

Archive activity stream data associated with all portals.

Online

archiveASByUser

Archive activity stream data associated with a user.

Online

archiveASAllUsers

Archive activity stream data associated with all users.

Online

archiveASByDeletedActors

Archive activity stream data associated with deleted actors.

Online

showASStatistics

Report activity stream statistics.

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

For WebCenter Portal, the application name is always webcenter.

For Portal Framework applications, specify the appropriate name.

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 application is deployed. For example, WC_Spaces.

Required when applications with the same name are deployed to different 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 archives activity stream data that is older than October 1, 2009 for WebCenter Portal (webcenter):

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

For WebCenter Portal, the application name is always webcenter.

For Portal Framework applications, specify the appropriate name.

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 archives activity stream data associated with deleted objects from WebCenter Portal (webcenter):

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

archiveASByClosedSpaces

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

Archives activity stream data associated with portals that are currently closed.

This command moves data from production tables to archive tables, except for WC_ACTOR_DETAIL as 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 portals that are closed) are deleted.

Syntax

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

Name of the application in which to perform this operation.

For WebCenter Portal, the application name is always webcenter.

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 archives activity stream data associated with portals that are currently marked as closed in WebCenter Portal (webcenter):

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

archiveASByInactiveSpaces

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

Archives activity stream data associated with portals that have been inactive since a specified date. An inactive portals an open or closed portal 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 portals that have been inactive since the specified date) are deleted.

Syntax

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

Name of the application in which to perform this operation.

For WebCenter Portal, the application name is always webcenter.

year

Year the portal became inactive. For example, 2009.

month

Month the portal became inactive. For example, enter 1 for January, 2 for February, and so on.

day

Day of the month the portal became inactive.

server

Optional. Name of the managed server where WebCenter Portal is deployed. For example, WC_Spaces.

Required when applications with the same name are deployed to different 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 archives activity stream data associated with portals 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 as 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 application in which to perform this operation.

For WebCenter Portal, the application name is always webcenter.

For Portal Framework applications, specify the appropriate name.

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 application is deployed. For example, WC_Spaces.

Required when applications with the same name are deployed to different 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 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 application in which to perform this operation.

For WebCenter Portal, the application name is always webcenter.

For Portal Framework applications, specify the appropriate name.

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 truncates activity stream archive data:

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

archiveASBySpace

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

Archives activity stream data associated with a named portal, only keeping a fixed number of activities.

This command moves data from production tables to archive tables.

Syntax

archiveASBySpace(appName, space, cnt, [server, applicationVersion])
Argument Definition
appName

Name of the application in which to perform this operation.

For WebCenter Portal, the application name is always webcenter.

space

Name of the portal whose data you want to archive. For example, MySalesPortal.

cnt

Number of portal activities you want to keep in the production table. For example, 2000.

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 keeps the last 2000 activities associated with the portal MySalesPortal and archives the rest:

wls:/weblogic/serverConfig> archiveASBySpace(appName='webcenter', space='MySalesPortal', cnt=2000)

archiveASAllSpaces

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

Archives activity stream data for all portals, only keeping a fixed number of activities.

This command moves data from production tables to archive tables.

Syntax

archiveASAllSpaces(appName, cnt, [server, applicationVersion])
Argument Definition
appName

Name of the application in which to perform this operation.

For WebCenter Portal, the application name is always webcenter.

cnt

Number of portal activities you want to keep in the production table. For example, 2000.

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 keeps the last 2000 activities for each portal in production tables and archives the remaining activity stream data:

wls:/weblogic/serverConfig> archiveASAllSpaces(appName='webcenter', cnt=2000)

archiveASByUser

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

Archives activity stream data associated with a single user, only keeping a fixed number of activities.

This command moves data from production tables to archive tables.

Syntax

archiveASByUser(appName, actor, cnt, [server, applicationVersion])
Argument Definition
appName

Name of the application in which to perform this operation.

For WebCenter Portal, the application name is always webcenter.

For Portal Framework applications, specify the appropriate name.

actor

Name of the user whose data you want to archive. For example, Monty.

cnt

Number of user activities you want to keep in the production table. For example, 2000.

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 keeps the last 2000 activities associated with the user Monty and archives the rest:

wls:/weblogic/serverConfig> archiveASByUser(appName='webcenter', actor='Monty', cnt=2000)

archiveASAllUsers

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

Archives activity stream data for all users, only keeping a fixed number of activities.

This command moves data from production tables to archive tables.

Syntax

archiveASAllUsers(appName, cnt, [server, applicationVersion])
Argument Definition
appName

Name of the application in which to perform this operation.

For WebCenter Portal, the application name is always webcenter.

For Portal Framework applications, specify the appropriate name.

cnt

Number of user activities you want to keep in the production table. For example, 2000.

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 keeps the last 2000 activities for user in production tables and archives the remaining activity stream data:

wls:/weblogic/serverConfig> archiveASAllUsers(appName='webcenter', cnt=2000)

archiveASByDeletedActors

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

Archives activity stream data associated with deleted users (actors).

This command moves data from production tables to archive tables.Rows in WC_AS_ACTOR_DETAIL that satisfy the criteria (in this case, deleted actors) are deleted.

Syntax

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

Name of the application in which to perform this operation.

For WebCenter Portal, the application name is always webcenter.

For Portal Framework applications, specify the appropriate name.

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 archives activity stream data associated with deleted users for WebCenter Portal (webcenter):

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

showASStatistics

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

Reports various activity stream statistics:

  • Number of activities for top "N" portals, ordered by activity count

  • Number of activities for top "N" users, order ed by activity count

  • Number of activities after a specific date

  • Number of activities after a specific date for top "N" portals, ordered by activity count

  • number of activities after a specified date for top "N" users, ordered by activity count

Syntax

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

Name of the application in which to perform this operation.

For WebCenter Portal, the application name is always webcenter.

For Portal Framework applications, specify the appropriate name.

year

Year from which to report activity stream statistics.

For example, 2009.

month

Month from which to report activity stream statistics.

For example, enter 1 for January, 2 for February, and so on.

day

Day of the month from which to report activity stream statistics.

cnt

Number of portals or users included in the report. For example, 50.

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 reports activity stream statistics for the top 50 portals and top 50 users in WebCenter Portal (webcenter) since 6/12/2012:

wls:/weblogic/serverConfig> showASStatistics(appName='webcenter', year=2012, month=7, day=18, cnt=3)

============================================================
 Cutoff Date = 7/18/12 12:23 PM 
 Top Count = 3 

 1. Portals with most activity count are: 
 Portal Finance Count =10 
 Portal Photography Count =9 
 Portal Sport Count =7 

 2. Users with most activity count are: 
 User Monty Count =30 
 User Pat Count =20 
 User Dave Count =10 

 3. Total Activities after 7/18/12 12:23 PM =80 

 4. Portals with most activity count after specific date, are: 
 Portal Photography Count =9 
 Portal Finance Count =6 
 Portal Sport Count =6 

 5. Users with most activity count after specific date, are: 
 User Monty Count =10 
 User Dave Count =8 
 User Monica Count =7 

Content Repository

Use the commands listed in Table 10-7 to manage content repository connections and configure document services for WebCenter Portal and Portal Framework applications.

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

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

Online

listDocumentsSpacesProperties

List properties for the back-end Content Server that is being used by WebCenter Portal.

Online

setDocumentsSpacesProperties

Modify properties for the back-end Content Server used by WebCenter Portal.

Online

deleteDocumentsSpacesProperties

Delete properties for the back-end Content Server used by WebCenter Portal.

Online


createJCRContentServerConnection

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

Creates a connection to an Oracle WebCenter Content repository for a named 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 application in which to perform this operation.

For WebCenter Portal, the application name is always webcenter.

For Portal Framework applications, specify the appropriate name.

name

Connection name. The name must be unique (across all connection types) within the 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, socketssl, and jaxws. 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. This is the most secure option, and the recommended option whenever identity propagation is required (for example, in WebCenter Portal).

  • web—Use an HTTP(S) connection to connect to the Content Server. Note that for WebCenter Portal, this option is not suitable for the active connection, that is, the back-end Content Server. repository that is being used to store portal-specific documents and Home portal 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 application. This includes:

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

    For more information, see "Uploading Files" and "Uploading a New Version of an Existing File" in Oracle Fusion Middleware Using Oracle WebCenter Portal.

  • Using the document review functionality available in Oracle AutoVue.

    For more information, see "Collaborating on Documents Using Oracle AutoVue" in Oracle Fusion Middleware Using Oracle WebCenter Portal.

  • Editing advanced document properties.

    For more information, see "Working with File Properties" in Oracle Fusion Middleware Using Oracle WebCenter Portal.

  • Viewing folder and file workflow details.

    For more information, see "Working with Workflow-Enabled Content" in Oracle Fusion Middleware Using Oracle WebCenter Portal.

  • Previewing files in a slide viewer.

    For more information, see "Opening a File" in Oracle Fusion Middleware Using Oracle WebCenter Portal.

  • Site Studio integration

    For more information, see Oracle Fusion Middleware Using Oracle WebCenter Portal.

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 WebCenter Portal (or your Portal Framework application) through Oracle HTTPS Server (OHS) to expose Content Server and the application under the same host and port. Both the application and Content Server must also use single sign on. For information about setting up OHS to front-end WebCenter Portal and Portal Framework applications, see "Configuring Content Server" in Oracle Fusion Middleware Administering Oracle WebCenter Portal.

If your 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

Leave the field blank if your environment supports Global Policy Attachments (GPA).

cacheInvalidationInterval

Optional. Time between checks for external Content Server content changes (in minutes). WebCenter Portal automatically clears items that have changed from the cache. The minimum interval is 2 minutes.

By default, cache invalidation is disabled (specified as 0) which means that no periodic checks are made for content changes.

binaryCacheMaxEntrySize

Optional. Maximum cacheable size (in bytes) for Content Server binary documents. Documents larger than this size are not cached by WebCenter Portal or Portal Framework applications.

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.

Most documents stored in Content Server are considered binary content, that is, images, plain text, Word documents, and so on. The only exception is Site Studio content which is stored in data files (CDF files) and cache separately in a Virtual Content Repository (VCR) cache (or node 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 application and Content Server use the same identity store to authenticate users. Note that extAppID is mandatory when socketType is set to web.

timeout

Length of time allowed to log in to the Content Server (in ms) before issuing a connection timeout message, and the RIDC socket timeout used for all service requests for connection types web, socket and socketssl.

If the timeout property is not set, the following values are used:

  • Login timeout - the default concurrency timeout for the oracle.webcenter.content resource is used (30s or 30000ms). Refer to "Configuring Concurrency Management" in Oracle Fusion Middleware Performance and Tuning Guide for more information.

  • RIDC socket timeout - the default RIDC socket timeout (60s or 60000ms) is used for all service requests for connection types socket, socketssl, or web.

If the timeout property is set and the connection type is socket, socketssl, or web, Oracle recommends that you do not specify a value less than 60000ms as this would reduce the RIDC socket timeout and increase the likelihood that long running requests will time out. For example, timeouts may occur during long running searches, long file uploads, or long copy operations.

isPrimary

Optional. Valid string values are 1 (true) and 0 (false).

1 specifies that this connection is the primary connection used for document services.

This argument defaults to 0. When omitted or set to 0, the primary connection used for documents does not change.

In WebCenter Portal, the primary connection is used to store portal-specific content and Home portal content.

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.


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

For WebCenter Portal, the application name is always webcenter.

For Portal Framework applications, specify the appropriate name.

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. This is the most secure option, and the recommended option whenever identity propagation is required (for example, in WebCenter Portal).

  • web—Use an HTTP(S) connection to connect to the Content Server. Note that for WebCenter Portal, this option is not suitable for the active connection, that is, the back-end Content Server. repository that is being used to store portal-specific documents and Home portal 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 WebCenter Portal or the Portal Framework application.

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

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

Leave the field blank if your environment supports Global Policy Attachments (GPA).

cacheInvalidationInterval

Optional. Time between checks for external Content Server content changes (in minutes). WebCenter Portal automatically clears items that have changed from the cache. The minimum interval is 2 minutes.

By default, cache invalidation is disabled (specified as 0) which means that no periodic checks are made for content changes.

binaryCacheMaxEntrySize

Optional. Maximum cacheable size (in bytes) for Content Server binary documents. Documents larger than this size are not cached by WebCenter Portal or the Portal Framework application. 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 application and Content Server use the same identity store to authenticate users.

timeout

Length of time allowed to log in to the Content Server (in ms) before issuing a connection timeout message, and the RIDC socket timeout used for all service requests for connection types web, socket and socketssl.

If the timeout property is not set, the following values are used:

  • Login timeout - the default concurrency timeout for the oracle.webcenter.content resource is used (30s or 30000ms). Refer to "Configuring Concurrency Management" in Oracle Fusion Middleware Performance and Tuning Guide for more information.

  • RIDC socket timeout - the default RIDC socket timeout (60s or 60000ms) is used for all service requests for connection types socket, socketssl, or web.

If the timeout property is set and the connection type is socket, socketssl, or web, Oracle recommends that you do not specify a value less than 60000ms as this would reduce the RIDC socket timeout and increase the likelihood that long running requests will time out. For example, timeouts may occur during long running searches, long file uploads, or long copy operations.

isPrimary

Optional. Valid string values are 1 (true) and 0 (false).

1 specifies that this connection is the primary connection used for document services in the application.

This argument defaults to 0. When omitted or set to 0, the primary connection used for documents does not change.

In WebCenter Portal, the primary connection is used to store portal-specific content and Home portal content.

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.


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

Syntax

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

Name of the application in which to perform this operation.

For WebCenter Portal, the application name is always webcenter.

For Portal Framework applications, specify the appropriate name.

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 the named 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 application is deployed. For example, WC_Spaces.

Required when applications with the same name are deployed to different 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 example lists Oracle WebCenter Content repository connections configured for WebCenter Portal (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 displays.

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 for a named application.

Syntax

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

Name of the application in which to perform this operation.

For WebCenter Portal, the application name is always webcenter.

For Portal Framework applications, specify the appropriate name.

name

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

dataSource

JNDI DataSource location used to connect to the portal. For example: jdbc/MyPortalDS

The datasource must be on the server where the 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 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, the default concurrency timeout for the oracle.webcenter.content resource is used (30s or 30000ms). Refer to "Configuring Concurrency Management" in Oracle Fusion Middleware Performance and Tuning Guide for more information.

isPrimary

Optional. Valid string values are 1 (true) and 0 (false).

1 specifies that this connection is the primary connection used for document services in the application.

This argument defaults to 0. When omitted or set to 0, the primary connection used for documents does not change.

In WebCenter Portal, the primary connection must be an Oracle WebCenter Content repository connection.

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

For WebCenter Portal, the application name is always webcenter.

For Portal Framework applications, specify the appropriate name.

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 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 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, the default concurrency timeout for the oracle.webcenter.content resource is used (30s or 30000ms). Refer to "Configuring Concurrency Management" in Oracle Fusion Middleware Performance and Tuning Guide for more information.

isPrimary

Optional. Valid string values are 1 (true) and 0 (false).

1 specifies that this connection is the primary connection used for document services in the application.

This argument defaults to 0. When omitted or set to 0, the primary connection used for documents does not change.

In WebCenter Portal, the primary connection must be an Oracle WebCenter Content repository connection.

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

Syntax

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

Name of the application in which to perform this operation.

For WebCenter Portal, the application name is always webcenter.

For Portal Framework applications, specify the appropriate name.

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 the 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 application is deployed. For example, WC_Spaces.

Required when applications with the same name are deployed to different 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 lists all of the Oracle Portal connections that are configured for a WebCenter Portal (webcenter):

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

For WebCenter Portal, the application name is always webcenter.

For Portal Framework applications, specify the appropriate name.

name

Connection name. The name must be unique (across all connection types) within the 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 expose content under that folder in your application, 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 for document services.

When set to 0, and when the specified connection is the primary connection used for document services, the primary connection is reset. If this parameter is not set, the primary connection used for document services does not change. This argument has no default.

In WebCenter Portal, the primary connection must be an Oracle WebCenter Content repository connection.

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

Name of the application in which to perform this operation.

For WebCenter Portal, the application name is always webcenter.

For Portal Framework applications, specify the appropriate name.

name

Name for the connection to be used for document services.

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 expose content under that folder in your application, 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 for document services.

When set to 0, and when the specified connection is the primary connection used for document services, the primary connection is reset. If this parameter is not set, the primary connection used for document services does not change. This argument has no default.

In WebCenter Portal, the primary connection must be an Oracle WebCenter Content repository connection.

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

For WebCenter Portal, the application name is always webcenter.

For Portal Framework applications, specify the appropriate name.

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 named 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 application is deployed. For example, WC_Spaces.

Required when applications with the same name are deployed to different 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 example lists all of the file system connections that are configured for WebCenter Portal (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 for a named application.

Syntax

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

Name of the application in which to perform this operation.

For WebCenter Portal, the application name is always webcenter.

For Portal Framework applications, specify the appropriate name.

name

Connection name. The name must be unique (across all connection types) within the 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, the default concurrency timeout for the oracle.webcenter.content resource is used (30s or 30000ms). Refer to "Configuring Concurrency Management" in Oracle Fusion Middleware Performance and Tuning Guide for more information.

isPrimary

Optional. Valid values are 1 (true) and 0 (false).

1 specifies that this connection is the primary connection used for document services.

The argument defaults to 0. If this parameter is omitted, the primary connection used for document services does not change.

In WebCenter Portal, the primary connection must be an Oracle WebCenter Content repository connection.

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

For WebCenter Portal, the application name is always webcenter.

For Portal Framework applications, specify the appropriate name.

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, the default concurrency timeout for the oracle.webcenter.content resource is used (30s or 30000ms). Refer to "Configuring Concurrency Management" in Oracle Fusion Middleware Performance and Tuning Guide for more information.

isPrimary

Optional. Valid values are 1 (true) and 0 (false).

1 specifies that this connection is the primary connection used for documents services.

When set to 0, and the specified connection is the primary connection used for document services, the primary connection is reset. If this parameter is not set, the primary connection used for documents does not change.

This argument has no default.

In WebCenter Portal, the primary connection must be an Oracle WebCenter Content repository connection.

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

Syntax

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

Name of the application in which to perform this operation.

For WebCenter Portal, the application name is always webcenter.

For Portal Framework applications, specify the appropriate name.

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 an 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 application is deployed. For example, WC_Spaces.

Required when applications with the same name are deployed to different 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 lists the names of all the SharePoint connections that are configured for WebCenter Portal (webcenter):

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

The following example lists connection details for all of the SharePoint connections that are configured for WebCenter Portal (webcenter):

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 WebCenter Portal to store portal-specific documents and Home portal documents. This command is only valid for WebCenter Portal.

Syntax

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

Name of the application in which to perform this operation.

For WebCenter Portal, the application name is always webcenter.

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 lists properties for the back-end Oracle WebCenter Content repository that is being used by a WebCenter Portal instance (webcenter) to store portal-specific documents and Home portal 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 WebCenter Portal to store portal-related data. This command is only valid for WebCenter Portal.

Syntax

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

Name of the application in which to perform this operation.

For WebCenter Portal, the application name is always webcenter.

spacesRoot

Optional. Root folder under which WebCenter Portal 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 WebCenter Portal content and manage content access rights.

Administrative privileges are required for this connection so that operations can be performed on behalf of WebCenter Portal 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 WebCenter Portal application identifier. This name is used to separate data when multiple WebCenter Portal 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 application is deployed. For example, WC_Spaces.

Required when applications with the same name are deployed to different 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 example modifies connection properties for the back-end Oracle WebCenter Content repository that is being used by WebCenter Portal to store portal-related 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 WebCenter Portal to store portal-related 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 WebCenter Portal, that is the adminUserName, applicationName, and spacesRoot. This command is only valid for WebCenter Portal.

Syntax

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

Name of the application in which to perform this operation.

For WebCenter Portal, the application name is always webcenter.

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 connection properties (adminUserName, applicationName, spacesRoot) of the back-end Oracle WebCenter Content repository that is being used by WebCenter Portal:

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 and Portal Framework applications.

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

Table 10-8 Discussion and Announcement WLST Commands

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

createDiscussionForumConnection

Create a new discussions server connection for a named application.

Online

setDiscussionForumConnection

Edit an existing discussions server connection.

Online

setDefaultDiscussionForumConnection

Specify the default connection for discussions and announcements.

Online

listDiscussionForumConnections

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

Online

listDefaultDiscussionForumConnection

List the default discussions server connection for a named application.

Online

setDiscussionForumConnectionProperty

Set an additional discussions server connection property.

Online

deleteDiscussionForumConnectionProperty

Delete a discussions server connection property.

Online

setDiscussionForumServiceProperty

Specify defaults for discussions.

Online

removeDiscussionForumServiceProperty

Remove defaults for discussions.

Online

listDiscussionForumServiceProperties

List discussions settings.

Online

setAnnouncementServiceProperty

Specify defaults for announcements.

Online

removeAnnouncementServiceProperty

Remove defaults for announcements.

Online

listAnnouncementServiceProperties

List announcements settings.

Online

addDiscussionsServerAdmin

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

Online

addDiscussionsCategoryAdmin

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

Online

syncDiscussionServerPermissions

Synchronizes discussion server permissions for subportals 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 application.

Discussions and announcements both require a discussions server connection. Discussions and announcements both use the same discussions server connection.

While you can register multiple discussions server connections for an 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, server, applicationVersion]) 

Argument Definition
appName

Name of the application in which to perform this operation.

For WebCenter Portal, the application name is always webcenter.

For Portal Framework applications, specify the appropriate name.

name

Connection name. The name must be unique (across all connection types) within the 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 discussions and announcements to perform administrative operations on behalf of WebCenter Portal users.

This account is mostly used for managing discussions and announcements in the out-of-the-box WebCenter Portal 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 WebCenter Portal, that is, the category (on the discussions server) under which all portal-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 Announcements and Discussions" in the Oracle Fusion Middleware Administering Oracle WebCenter Portal.

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" in the Oracle Fusion Middleware Administering Oracle WebCenter Portal.

timeout

Optional. Length of time (in seconds) discussions 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 discussions and announcements.

Valid options are 1 (true) and 0 (false).

When set to 1, discussions and announcements 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 application is deployed. For example, WC_Spaces.

Required when applications with the same name are deployed to different 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 creates a discussions server connection for WebCenter Portal:

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

For WebCenter Portal, the application name is always webcenter.

For Portal Framework applications, specify the appropriate name.

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 discussions to perform administrative operations on behalf of WebCenter Portal users.

This account is mostly used for managing discussions and announcements in the out-of-the-box WebCenter Portal 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 WebCenter Portal, that is, the category (on the discussions server) under which all portal-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 Announcements and Discussions" in the Oracle Fusion Middleware Administering Oracle WebCenter Portal.

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 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" in the Oracle Fusion Middleware Administering Oracle WebCenter Portal.

timeout

Optional. Length of time (in seconds) discussions and announcements 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 discussions and announcements. Required only if more than one connection is defined.

Valid options are 1 (true) and 0 (false). When set to 1, discussions and announcements use this connection. When set to 0, the connection is not used. The default is 0.

To specify that discussion and announcements 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 an application, only one connection is used for discussions and announcements— the default (or active) connection.

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 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 Server Connection Properties".

Table 10-9 Additional Discussion Server Connection Properties

Additional
Connection Property
Description

application.root.category.id

(WebCenter Portal 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 in the category with the ID 3.

linkURL

URL used to link users to the discussions server's Admin Console. Only required if it is different to the url argument specified using the createDiscussionForumConnection or setDiscussionForumConnection command. For example, when SSO or HTTPS is configured.

Use the following format to specify an alternative public external URL: protocol://host:port

For example: http://example.com:7777


Syntax

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

Name of the application in which to perform this operation.

For WebCenter Portal, the application name is always webcenter.

For Portal Framework applications, specify the appropriate name.

name

Name of an existing discussions server connection.

key

Name of the connection property. See also, Table 10-9, "Additional Discussion Server Connection Properties".

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 application is deployed. For example, WC_Spaces.

Required when applications with the same name are deployed to different 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 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 configures an alternative, public external URL so users can access the discussions server's Admin Console:

wls:/weblogic/serverConfig>setDiscussionForumConnectionProperty
(appName='webcenter', name='MyDiscussionServer', key='linkURL', value='http://example.com:7777')

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

For WebCenter Portal, the application name is always webcenter.

For Portal Framework applications, specify the appropriate name.

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 application is deployed. For example, WC_Spaces.

Required when applications with the same name are deployed to different 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 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 the discussions server connections that are configured for a named application.

Syntax

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

Name of the application in which to perform this operation.

For WebCenter Portal, the application name is always webcenter.

For Portal Framework applications, specify the appropriate name.

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 an 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 application is deployed. For example, WC_Spaces.

Required when applications with the same name are deployed to different 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 example lists the names of all of the discussions server connections that are currently configured for WebCenter Portal:

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

The following example lists connection names and details for all of the discussions server connections currently configured for WebCenter Portal:

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 discussions and announcements service are using, in a named application. While you can register multiple discussions server connections for an application, discussions and announcements only uses one connection—known as the default (or active) connection.

Syntax

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

Name of the application in which to perform this operation.

For WebCenter Portal, the application name is always webcenter.

For Portal Framework applications, specify the appropriate name.

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 application is deployed. For example, WC_Spaces.

Required when applications with the same name are deployed to different 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 example names the discussions server connection that discussions and announcements are using in WebCenter Portal:

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

The following example lists the name and details of the discussions server connection that discussions and announcements are using in WebCenter Portal:

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 discussions and announcements in a named application.

While you can register multiple discussions server connections with an application, discussions and announcements 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 application in which to perform this operation.

For WebCenter Portal, the application name is always webcenter.

For Portal Framework applications, specify the appropriate name.

name

Name of an existing discussions server connection.

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 makes a connection named myDiscussionServer the default (or active) connection for discussions and announcements in WebCenter Portal:

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

setDiscussionForumServiceProperty

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

Specifies default values for discussions, for a named application.

Configurable properties for discussions are listed in Table 10-10, "Discussions - Configurable Properties".

Table 10-10 Discussions - Configurable Properties

Configuration Property Description

topics.fetch.size

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

forums.fetch.size

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

recentTopics.fetch.size

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

watchedTopics.fetch.size

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

watchedForums.fetch.size

Maximum number of forums fetched by discussions 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 WebCenter Portal, 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 Portal Framework 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 application in which to perform this operation.

For WebCenter Portal, the application name is always webcenter.

For Portal Framework applications, specify the appropriate name.

property

Name of the configuration property.

value

Value for the property.

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 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 property. Use this command to remove any of the properties listed in Table 10-10, "Discussions - Configurable 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 application in which to perform this operation.

For WebCenter Portal, the application name is always webcenter.

For Portal Framework applications, specify the appropriate name.

property

Name of the configuration property.

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 clears the current topics.fetch.size property for discussions in WebCenter Portal:

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

Syntax

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

Name of the application in which to perform this operation.

For WebCenter Portal, the application name is always webcenter.

For Portal Framework applications, specify the appropriate name.

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 lists configuration properties for discussions in WebCenter Portal:

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

setAnnouncementServiceProperty

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

Specifies default values for announcements in a named application.

Configurable properties for announcements are listed in Table 10-11, "Announcements - Configurable Properties".

Table 10-11 Announcements - Configurable 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 application in which to perform this operation.

For WebCenter Portal, the application name is always webcenter.

For Portal Framework applications, specify the appropriate name.

property

Name of the configuration property.

value

Property value.

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 changes the default number of days that announcements display in WebCenter Portal:

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 an announcements property. Use this command to remove any of the properties listed in Table 10-11, "Announcements - Configurable 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 application in which to perform this operation.

For WebCenter Portal, the application name is always webcenter.

For Portal Framework applications, specify the appropriate name.

property

Name of the configuration property.

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 clears the announcements.expiration.days property for announcements in WebCenter Portal:

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 announcements, in a named application.

Syntax

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

Name of the application in which to perform this operation.

For WebCenter Portal, the application name is always webcenter.

For Portal Framework applications, specify the appropriate name.

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 lists configuration properties for announcements in WebCenter Portal:

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

addDiscussionsCategoryAdmin

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

Grants category administrator permissions on the discussions server to a user or a group for a specific category ID.

Syntax

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

Name of the discussions server application in which to perform this operation. For example, owc_discussions.

categoryId

The ID (number) of a category on the discussions server.

name

Name of the user or group to add as an administrator for the category 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 category administrator permissions on the discussions server to the user weblogic for a category with an ID=2:

addDiscussionsCategoryAdmin(appName='owc_discussions', categoryId=2, name='weblogic', type='USER')
    

The following example grants category administrator permissions on the discussions server to all users in the Sales user group for a category with an ID=2:

addDiscussionsCategoryAdmin(appName='owc_discussions', categoryId=2, name='Sales', type='GROUP')

syncDiscussionServerPermissions

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

(WebCenter Portal only) Synchronizes discussion server permissions for subportals that inherit security from their parent.

When you update discussions or announcement permissions for portal hierarchies in WebCenter Portal, the subportals do not automatically inherit the corresponding permission change on the discussions server. Therefore, whenever changes are made, you must run this command to synchronize discussions and announcement permissions within a portal hierarchy, such that subportals inherit the same discussions server permissions as their parent.

Note:

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

Syntax

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

Optional. Name of the application in which to perform this operation.

The default value is webcenter (the application name for WebCenter Portal).

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 synchronizes permissions for discussions and announcement in WebCenter Portal, that is, subportals 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 discussions server WLST commands, such as setDiscussionsServerProperty, the user used to connect to the Admin Server must also have administrative privileges on the discussions 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.

For example, owc_discussions.sso.mode, AuthFactory.className, UserManager.className, GroupManager.className, owc_discussions.setup.complete_11.1.1.2.0, and so on.

value

Value for the discussions server property.

server

Optional. Name of the managed server where the application is deployed. For example, WC_Collaboration.

Required when applications with the same name are deployed to different servers and also when you have a cluster.

applicationVersion

Optional. Version number of the deployed application. Required if more than one version of the application is deployed.


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

wls:/weblogic/serverConfig>setDiscussionsServerProperty(appName='owc_discussions', key='jiveURL', value='example.com:8890/owc_discussions')

getDiscussionsServerProperty

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

Returns the current value of a discussions server property.

Note:

To execute discussions server WLST commands, such as getDiscussionsServerProperty, the user used to connect to the Admin Server must also have administrative privileges on the discussions 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 examples return the current value for some key discussions server properties:

wls:/weblogic/serverConfig>getDiscussionsServerProperty(appName='owc_discussions', key='AuthFactory.className')

wls:/weblogic/serverConfig>getDiscussionsServerProperty(appName='owc_discussions', key='UserManager.className')

wls:/weblogic/serverConfig>getDiscussionsServerProperty(appName='owc_discussions', key='GroupManager.className')

wls:/weblogic/serverConfig>getDiscussionsServerProperty(appName='owc_discussions', key='owc_discussions.setup.complete_11.1.1.2.0')

removeDiscussionsServerProperty

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

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

Note:

To execute discussions 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 and Portal Framework applications.

Configuration changes made using these WLST commands are immediately available in the application, that is, you do not need to restart the managed server.

Table 10-12 External Application WLST Commands

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

createExtAppConnection

Create an external application connection, for a named application.

Online

setExtAppConnection

Edit an existing external application connection.

Online

listExtAppConnections

List individual or all external applications that are configured for a named 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 application.

Syntax

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

Name of the application in which to perform this operation.

For WebCenter Portal, the application name is always webcenter.

For Portal Framework applications, specify the appropriate name.

name

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

displayName

Optional. External application display name. A user friendly name for the external application that WebCenter Portal users will recognize. The display name must be unique across all external applications within WebCenter Portal or your Portal Framework 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 application is deployed. For example, WC_Spaces.

Required when applications with the same name are deployed to different 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 creates a connection for an external application named My Yahoo!, in WebCenter Portal (webcenter).

wls:/weblogic/serverConfig> createExtAppConnection(appName='webcenter', 
name='yahoo', displayName='My Yahoo!', url='http://login.yahoo.com/config/login', 
authMethod='POST', userFieldName='login', pwdFieldName='password')

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

For WebCenter Portal, the application name is always webcenter.

For Portal Framework applications, specify the appropriate name.

name

Name of an existing external application connection.

displayName

Optional. External application display name. A user-friendly name for the external application that WebCenter Portal users will recognize.

The display name must be unique across all external applications within WebCenter Portal or your Portal Framework 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 application is deployed. For example, WC_Spaces.

Required when applications with the same name are deployed to different 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 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 named WebCenter Portal or your Portal Framework application.

Syntax

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

Name of the application in which to perform this operation.

For WebCenter Portal, the application name is always webcenter.

For Portal Framework applications, specify the appropriate name.

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 WebCenter Portal or your Portal Framework 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 application is deployed. For example, WC_Spaces.

Required when applications with the same name are deployed to different 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 example lists the names of all the external applications currently used by WebCenter Portal (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 application in which to perform this operation.

For WebCenter Portal, the application name is always webcenter.

For Portal Framework applications, specify the appropriate name.

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 application is deployed. For example, WC_Spaces.

Required when applications with the same name are deployed to different 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

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

For WebCenter Portal, the application name is always webcenter.

For Portal Framework applications, specify the appropriate name.

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 application is deployed. For example, WC_Spaces.

Required when applications with the same name are deployed to different 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 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 application in which to perform this operation.

For WebCenter Portal, the application name is always webcenter.

For Portal Framework applications, specify the appropriate name.

name

Connection name.

fieldName

Login field that you want to remove.

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 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 WebCenter Portal (or a Portal Framework 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 external application through WebCenter Portal (or the Portal Framework application) 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 application in which to perform this operation.

For WebCenter Portal, the application name is always webcenter.

For Portal Framework applications, specify the appropriate name.

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 application is deployed. For example, WC_Spaces.

Required when applications with the same name are deployed to different 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 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 application in which to perform this operation.

For WebCenter Portal, the application name is always webcenter.

For Portal Framework applications, specify the appropriate name.

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 application is deployed. For example, WC_Spaces.

Required when applications with the same name are deployed to different 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 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 application in which to perform this operation.

For WebCenter Portal, the application name is always webcenter.

For Portal Framework applications, specify the appropriate name.

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 application is deployed. For example, WC_Spaces.

Required when applications with the same name are deployed to different 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 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 WLST commands are only effective after your restart the Managed Server on which WebCenter Portal or your Portal Framework application is deployed. For details, see Oracle Fusion Middleware Administering Oracle WebCenter Portal.

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 named 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 a named application supports.

Online

listIMPConnections

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

Online

listDefaultIMPConnection

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

Online

setDefaultIMPConnection

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

Online

setIMPServiceProperty

Specify defaults for instant messaging and presence.

Online

removeIMPServiceProperty

Remove defaults for instant messaging and presence.

Online

listIMPServiceProperties

List instant messaging and presence 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 application.

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

While you can register multiple presence server connections for WebCenter Portal or your own Portal Framework applications, 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 application in which to perform this operation.

For WebCenter Portal, the application name is always webcenter.

For Portal Framework applications, specify the appropriate name.

name

Connection name. The name must be unique (across all connection types) within the 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 instant messaging and presence 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 instant messaging and presence services.

Valid values are 1 (true) and 0 (false). The default for this argument is 0.

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.


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

For WebCenter Portal, the application name is always webcenter.

For Portal Framework applications, specify the appropriate name.

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 instant messaging and presence 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 instant messaging and presence services. Valid values are 1 (true) and 0 (false). The default for this argument is 0.

To specify that instant messaging and presence 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 an 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 application is deployed. For example, WC_Spaces.

Required when applications with the same name are deployed to different 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 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=1)

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

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

All known, additional connection properties are listed in Table 10-14, "Additional Instant Messaging and Presence Connection Properties".

Table 10-14 Additional Instant Messaging and Presence Connection Properties

Additional
Connection Property
Description

presence.url

URL to the presence server This must be supplied if presence is deployed on a separate server.

contacts.url

URL to the contact management service. This must be supplied if the contact management service is deployed on a separate server.

call.url

URL for the third-party call server. If no value is supplied, then this uses the same value as base.connection.url.

call.method

Supports values sip and pstn:

When set to sip, the IMP service forwards the user's SIP address to the third-party call service. The third-party call service must decide on the routing of the call.

When set to pstn, the user's phone number is based on the user's profile attribute (BUSINESS_PHONE). You can use the connection property call.number.attribute to change this default profile attribute (BUSINESS_PHONE) to any other attribute.

call.domain

The domain name of the pstn gateway. If no domain name is supplied, then this uses the domain value specified when the connection was created. Supply a domain name only when call.method is set to pstn.

contact.number.attribute

The attribute used to read users' phone numbers from the user profile. The default is BUSINESS_PHONE. Supply this attribute value only when call.method is set to pstn.

primary.domain

If the WebCenter user identity is qualified with a domain (for example, john.doe@oracle.com), and if the presence server domain is different (for example, john.doe@example.com) then specify the primary domain oracle.com here.

If the user identity is qualified with a domain and the presence server uses the same oracle.com domain, then it is not necessary that you specify the primary.domain.


Note:

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

For WebCenter Portal, the application name is always webcenter.

For Portal Framework applications, specify the appropriate name.

name

Name of an existing presence server connection.

key

Name of the connection property. See Table 10-14, "Additional Instant Messaging and Presence Connection Properties".

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 application is deployed. For example, WC_Spaces.

Required when applications with the same name are deployed to different 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 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 application in which to perform this operation.

For WebCenter Portal, the application name is always webcenter.

For Portal Framework applications, specify the appropriate name.

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 application is deployed. For example, WC_Spaces.

Required when applications with the same name are deployed to different 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 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 Oracle WebCenter Portal supports. Out-of-the-box, WebCenter Portal and Portal Framework applications support Microsoft Live Communications Server 2005 R2 (LCS), Microsoft Office Communications Server 2007 SP1 (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 application.

Syntax

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

Name of the application in which to perform this operation.

For WebCenter Portal, the application name is always webcenter.

For Portal Framework applications, specify the appropriate name.

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 the named 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 application is deployed. For example, WC_Spaces.

Required when applications with the same name are deployed to different 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 example lists all the instant messaging and presence server connections that are configured for WebCenter Portal (webcenter):

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

The following example lists all the instant messaging and presence server connections that are configured for WebCenter Portal 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 instant messaging and presence is using, in a named application. While you can register multiple presence server connections for WebCenter Portal or your own Portal Framework applications, instant messaging and presence 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 application in which to perform this operation.

For WebCenter Portal, the application name is always webcenter.

For Portal Framework applications, specify the appropriate name.

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 application is deployed. For example, WC_Spaces.

Required when applications with the same name are deployed to different 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 lists the name and details of the connection that instant messaging and presence is using in WebCenter Portal (webcenter):

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

setDefaultIMPConnection

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

Specifies the default connection for instant messaging and presence in a named application. While you can register multiple presence server connections with an application, instant messaging and presence 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 application in which to perform this operation.

For WebCenter Portal, the application name is always webcenter.

For Portal Framework applications, specify the appropriate name.

name

Name of an existing instant messaging and presence connection.

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 makes a connection named myPresenceServer the default (or active) connection for instant messaging and presence in WebCenter Portal (webcenter):

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

setIMPServiceProperty

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

Specifies default values for instant messaging and presence.

Configurable properties for instant messaging and presence are listed in Table 10-15, "Instant Messaging and Presence - Configurable Properties".

Table 10-15 Instant Messaging and Presence - Configurable Properties

Configuration Property Description

selected.connection

Connection used by instant messaging and presence.

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

For WebCenter Portal, the application name is always webcenter.

For Portal Framework applications, specify the appropriate name.

property

Name of the configuration property.

value

Value for the property.

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 changes the default cache timeout for instant messaging and presence data in WebCenter Portal (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 property. Use this command to remove any of the properties listed in Table 10-15, "Instant Messaging and Presence - Configurable 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 instant messaging and presence:

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

For WebCenter Portal, the application name is always webcenter.

For Portal Framework applications, specify the appropriate name.

property

Name of the configuration property.

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 clears the cache expiration value for instant messaging and presence in WebCenter Portal:

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 instant messaging and presence.

Syntax

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

Name of the application in which to perform this operation.

For WebCenter Portal, the application name is always webcenter.

For Portal Framework applications, specify the appropriate name.

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 lists configuration properties for instant messaging and presence in WebCenter Portal (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 application in which to perform this operation.

For WebCenter Portal, the application name is always webcenter.

For Portal Framework applications, specify the appropriate name.

name

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

displayName

Optional. External application display name. A user friendly name for the application that users will recognize.

The display name must be unique across all external applications within the 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 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-16 to manage mail server connections for a named application.

You can register multiple mail server connections:

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

Table 10-16 Mail WLST Commands

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

createMailConnection

Create a mail server connection for a named 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 a named application.

Online

listDefaultMailConnection

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

Online

setDefaultMailConnection

Set a specified connection as the default mail server connection.

Online

setMailServiceProperty

Specify defaults for mail.

Online

removeMailServiceProperty

Remove defaults for mail.

Online

listMailServiceProperties

List properties for mail.

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

WebCenter Portal and Portal Framework applications support the Microsoft Exchange Server or any mail server that supports IMAP4 and SMTP. The most important mail server connection attributes are: imapHost, imapPort, imapSecured, smtpHost, smtpPort, and smtpSecured

You can register multiple mail server connections:

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

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

For WebCenter Portal, the application name is always webcenter.

For Portal Framework applications, specify the appropriate name.

name

Connection name. The name must be unique (across all connection types) within the 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 mail 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 mail 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 mail. Valid values are 1 (true) and 0 (false). This argument defaults to 0.

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

  • Portal 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 application is deployed. For example, WC_Spaces.

Required when applications with the same name are deployed to different 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 example creates an external application suitable for a mail server connection, and then creates a mail server connection named myMailConnection for WebCenter Portal (webcenter):

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

wls:/weblogic/serverConfig> reateMailConnection(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.

(WebCenter Portal only.) This command enables you to set additional, optional, LDAP server attributes that cannot be set using createMailConnection. When LDAP details are defined, mail creates, edits, and deletes portal distribution lists in WebCenter Portal. Portal distribution lists are named after their portal (excluding non-java identifiers) and assigned a domain (derived from the domain attribute, for example, @mycompany.com). If LDAP details are not provided, portal distribution 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 application in which to perform this operation.

For WebCenter Portal, the application name is always webcenter.

For Portal Framework applications, specify the appropriate name.

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 mail 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 portal distribution lists.

For example, if the domain attribute is set to mycompany.com, the Finance Project portal will maintain a distribution list named FinanceProject@mycompany.com.

defaultUser

Optional. Comma-delimited list of user names to whom you want to grant moderation capabilities. These users become members of every portal distribution list that is created. The users specified must exist in the Base LDAP schema (specified in the ldapBaseDN argument).

timeout

Optional. Length of time (in seconds) that mail 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 mail.

Valid values are 1 (true) and 0 (false). This argument defaults to 0. 1 specifies that this connection is the default connection for mail.

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

  • Portal Framework application 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 mail 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 application is deployed. For example, WC_Spaces.

Required when applications with the same name are deployed to different 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 example sets individual attributes for a mail server connection configured for WebCenter Portal (webcenter):

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 for 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='mycompany.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-17, "Additional Mail Connection Properties".

Table 10-17 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 listed in documentation for the com.sun.mail.imap package at: http://javamail.java.net/nonav/docs/api

Various SMTP properties

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

A list of valid SMTP properties are listed in the documentation for the com.sun.mail.smtp package at: http://javamail.java.net/nonav/docs/api


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

For WebCenter Portal, the application name is always webcenter.

For Portal Framework applications, specify the appropriate name.

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 application is deployed. For example, WC_Spaces.

Required when applications with the same name are deployed to different 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 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 application in which to perform this operation.

For WebCenter Portal, the application name is always webcenter.

For Portal Framework applications, specify the appropriate name.

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 application is deployed. For example, WC_Spaces.

Required when applications with the same name are deployed to different 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 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 application.

Syntax

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

Name of the application in which to perform this operation.

For WebCenter Portal, the application name is always webcenter.

For Portal Framework applications, specify the appropriate name.

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 an 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 application is deployed. For example, WC_Spaces.

Required when applications with the same name are deployed to different 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 lists the names of mail server connections that are currently configured for WebCenter Portal:

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

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 mail is using in a named application.

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

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

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

For WebCenter Portal, the application name is always webcenter.

For Portal Framework applications, specify the appropriate name.

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 application is deployed. For example, WC_Spaces.

Required when applications with the same name are deployed to different 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 lists the name and details of the mail server connection that mail is using in WebCenter Portal:

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 mail in a named application.

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

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

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

For WebCenter Portal, the application name is always webcenter.

For Portal Framework applications, specify the appropriate name.

name

Name of an existing mail connection.

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 configures mail to use a connection named myMailServer.for the default connection in WebCenter Portal:

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

setMailServiceProperty

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

Specifies default values for mail.

Configurable properties for mail are listed in Table 10-18, "Mail - Configurable Properties".

Table 10-18 Mail - Configurable 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 portal distribution lists are checked for new incoming emails. The default is 1800 seconds (30 minutes).

Email communication through portal distribution lists can be published as discussion forum posts on a discussions server. For details, see "Publishing Portal Mail in a Discussion Forum" in Oracle Fusion Middleware Building Portals with Oracle WebCenter Portal.

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 requires user names to obtain presence status because presence information cannot be obtained when mail provides email addresses. Setting this value to 1 does impact application performance so you must take this into consideration when setting this property.

mail.recipient.limit

Restricts the number of recipients to a message. For example, setting this value to '500' limits the number of recipients to 500.


Syntax

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

Name of the application in which to perform this operation.

For WebCenter Portal, the application name is always webcenter.

For Portal Framework applications, specify the appropriate name.

property

Name of the configuration property

value

Value for the property.

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 increases the default number of messages displayed in mail inboxes to 100, in WebCenter Portal (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 property. Use this command to remove any of the properties listed in Table 10-18, "Mail - Configurable Properties".

Take care when using this command as removing values for these properties might cause unexpected behavior.

Note:

Use this command syntax to stop mail 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 application in which to perform this operation.

For WebCenter Portal, the application name is always webcenter.

For Portal Framework applications, specify the appropriate name.

property

Name of the configuration property.

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 clears the current mail.messages.fetch.size setting for mail, in WebCenter Portal:

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

Syntax

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

Name of the application in which to perform this operation.

For WebCenter Portal, the application name is always webcenter.

For Portal Framework applications, specify the appropriate name.

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 lists configurable properties for mail in WebCenter Portal:

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

For WebCenter Portal, the application name is always webcenter.

For Portal Framework applications, specify the appropriate name.

name

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

displayName

Optional. External application display name. A user friendly name for the external application that portal users will recognize. The display name must be unique across all external applications within the 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 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-19 to manage settings for the notifications in a named application.

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

Table 10-19 Notifications WLST Commands

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

setNotificationsConfig

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

Online

getNotificationsConfig

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

Online


setNotificationsConfig

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

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

Use an existing mail server or BPEL server connection. If the 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 notifications 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 notifications 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 application in which to perform this operation.

For WebCenter Portal, the application name is always webcenter.

For Portal Framework applications, specify the appropriate name.

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 application is deployed. For example, WC_Spaces.

Required when applications with the same name are deployed to different 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 specifies that notifications in WebCenter Portal (webcenter) 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 named application.

Syntax

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

Name of the application in which to perform this operation.

For WebCenter Portal, the application name is always webcenter.

For Portal Framework applications, specify the appropriate name.

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 returns details about the connection used by notifications service in WebCenter Portal:

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

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

People Connections

Use the commands listed in Table 10-20 to manage user profile information in WebCenter Portal or your Portal Framework application.

Configuration changes made using these WLST commands are only effective after your restart the Managed Server on which WebCenter Portal or your Portal Framework application is deployed. For details, see Oracle Fusion Middleware Administering Oracle WebCenter Portal.

Table 10-20 People Connection WLST Commands

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

startSyncProfiles

Synchronize profile information in the LDAP store, with the WebCenter Portal database schema.

Online

syncProfile

Synchronize profile information for a specific user.

Online

stopSyncProfiles

Stop the profile synchronization process.

Online

isSyncProfilesRunning

Check whether profile synchronization is in progress.

Online

setProfileConfig

Set profile properties.

Online

getProfileConfig

Return current profile properties.

Online

listProfileConfig

List current profile properties.

Online

setProfilePhotoSync

Specify whether to synchronize user profile photos in LDAP.

Online

setProfileCacheNumberOfObjects

Deprecated.

Online

setProfileSyncLDAPReadBatchSize

Deprecated.

Online

setProfileCacheTimeToLive

Deprecated.

Online

printProfileConfig

Deprecated.

Online


startSyncProfiles

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

Synchronizes profile information in the LDAP store with the WebCenter Portal database schema.

Syntax

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

Name of the application in which to perform this operation.

For WebCenter Portal, the application name is always webcenter.

For Portal Framework applications, specify the appropriate name.

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 synchronizes user profiles for WebCenter Portal:

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

stopSyncProfiles

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

Stops the profile synchronization process, if currently in progress.

Syntax

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

Name of the application in which to perform this operation.

For WebCenter Portal, the application name is always webcenter.

For Portal Framework applications, specify the appropriate name.

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 stops the profile synchronization process for WebCenter Portal:

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

isSyncProfilesRunning

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

Checks whether profile synchronization is in progress.

Syntax

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

Name of the application in which to perform this operation.

For WebCenter Portal, the application name is always webcenter.

For Portal Framework applications, specify the appropriate name.

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 checks whether profile synchronization is in progress for WebCenter Portal:

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

syncProfile

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

Synchronizes profile information for a specific user in the LDAP store with the WebCenter Portal schema.

Syntax

syncProfile(appName, userName, [server, applicationVersion])
Argument Definition
appName

Name of the application in which to perform this operation.

For WebCenter Portal, the application name is always webcenter.

For Portal Framework applications, specify the appropriate name.

userName

Name of the user whose profile information you want to synchronize.

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 synchronizes profile information for a user named monty:

wls:/weblogic/serverConfig>syncProfile(appName='webcenter', userName='monty')

setProfileConfig

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

Sets profile properties for a named application. If you omit a parameter, the corresponding configuration remains unchanged.

Syntax

setProfileConfig(appName, ProfilePageVersion, ProfileCacheNumberOfObjects, ProfileCacheTimeToLive,ProfileSyncLDAPReadBatchSize, ProfileSyncHourOfDay, ProfileSyncFrequencyInDays,server, applicationVersion])
Argument Definition
appName

Name of the application in which to perform this operation.

For WebCenter Portal, the application name is always webcenter.

For Portal Framework applications, specify the appropriate name.

ProfilePageVersion

Optional. Specifies the profile page version to use.

Valid values for ProfilePageVersion are:

v1 - Use old-style profile pages (11.1.1.7.0 and earlier)

v2 - Use the new profile page format (introduced in 11.1.1.8.0)

The default value is v2.

ProfileCacheNumberOfObjects

Optional. Specifies the number of profile objects to keep in the profile cache.

Any value between 1 and 10, 000. The default value is 1000.

ProfileCacheTimeToLive

Optional. Specifies the length of time (in minutes) to keep a profile object in the cache.

Any value between 1 and 1440. The default value is 60.

ProfileSyncLDAPReadBatchSize

Optional. Specifies the LDAP read batch size that is used during profile synchronization.

Any value between 1 and 1,000. The default value is 1000.

ProfileSyncHourOfDay

Optional. Specifies when (the hour) to start profile synchronization.

Any value between 0 and 23. The default value is 23, equivalent to 11pm.

ProfileSyncFrequencyInDays

Optional. Specifies how often profile synchronization takes place (in days).

Any value greater than 0. The default value is 7.

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 sets new values for the ProfileCacheNumberOfObjects and ProfileCacheTimeToLive configuration settings.

All other settings remain unchanged:

wls:/weblogic/serverConfig>setProfileConfig(appName='webcenter',ProfileCacheNumberOfObjects=2000, ProfileCacheTimeToLive=120)

getProfileConfig

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

Returns current profile settings for a named application.

Syntax

getProfileConfig(appName, key, [server, applicationVersion])
Argument Definition
appName

Name of the application in which to perform this operation.

For WebCenter Portal, the application name is always webcenter.

For Portal Framework applications, specify the appropriate name.

key

Name of a profile property. Valid values include:

- ProfilePageVersion

- ProfileCacheNumberofObjects

- ProfileCacheTimeToLive

- ProfileSyncLDAPReadBatchSize

- ProfileSyncHourofDay

- ProfileSyncFrequenceyInDays

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 examples return current settings for various profile properties:

wls:/weblogic/serverConfig> getProfileConfig(appName='webcenter', key='ProfilePageVersion')
wls:/weblogic/serverConfig> getProfileConfig(appName='webcenter', key='ProfileCacheNumberOfObjects')
wls:/weblogic/serverConfig> getProfileConfig(appName='webcenter', key='ProfileCacheTimeToLive')
wls:/weblogic/serverConfig> getProfileConfig(appName='webcenter', key='ProfileSyncLDAPReadBatchSize')
wls:/weblogic/serverConfig> getProfileConfig(appName='webcenter', key='ProfileSyncHourOfDay')
wls:/weblogic/serverConfig> getProfileConfig(appName='webcenter', key='ProfileSyncFrequencyInDays')

listProfileConfig

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

Lists the current profile settings for a named application.

Syntax

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

Name of the application in which to perform this operation.

For WebCenter Portal, the application name is always webcenter.

For Portal Framework applications, specify the appropriate name.

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 lists current profile settings for WebCenter Portal (webcenter):

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

setProfileCacheNumberOfObjects

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

(Deprecated from 11.1.1.8.0. Use setProfileConfig instead.)

Sets the maximum number of profile objects to cache (in the profile cache).

Syntax

setProfileCacheNumberOfObjects(appName, noOfObjects, [server, applicationVersion]) 
Argument Definition
appName

Name of the application in which to perform this operation.

For WebCenter Portal, the application name is always webcenter.

For Portal Framework applications, specify the appropriate name.

noOfObjects

Number of profile objects to cache.

Any value between 1 and 10, 000. The default value is 1000.

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 increases the size of the cache to 2,000 profiles:

wls:/weblogic/serverConfig>setProfileCacheNumberOfObjects(appName='webcenter', noOfObjects=2000)

setProfileSyncLDAPReadBatchSize

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

(Deprecated from 11.1.1.8.0. Use setProfileConfig instead.)

Sets the profile synchronization LDAP batch read size.

Syntax

setProfileSyncLDAPReadBatchSize(appName, batchSize, [server, applicationVersion]) 
Argument Definition
appName

Name of the application in which to perform this operation.

For WebCenter Portal, the application name is always webcenter.

For Portal Framework applications, specify the appropriate name.

batchSize

LDAP batch read size. Any value between 1 and 1000.

The default value is 1000.

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 increases the batch size to 2000 LDAP profiles:

wls:/weblogic/serverConfig>setProfileSyncLDAPReadBatchSize(appName='webcenter', batchSize=800)

setProfileCacheTimeToLive

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

(Deprecated from 11.1.1.8.0. Use setProfileConfig instead.)

Sets the time (in minutes) for a profile to live in the profile cache.

Syntax

setProfileCacheTimeToLive(appName, timeToLive, [server, applicationVersion]) 
Argument Definition
appName

Name of the application in which to perform this operation.

For WebCenter Portal, the application name is always webcenter.

For Portal Framework applications, specify the appropriate name.

timeToLive

Time to live for profile objects (in minutes) in the profile cache. The default value is 60 minutes.

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 decreases the length of time profile objects are cached to 30 minutes:

wls:/weblogic/serverConfig>setProfileCacheTimeToLive(appName='webcenter', timeToLive=30)

setProfilePhotoSync

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

Specifies whether to synchronize the latest user profile photos in LDAP with WebCenter Portal's profile cache. When synchronization is enabled, profile photos are synchronized when the profile cache expires. When synchronization is disabled, profile photos are not synchronized with the WebCenter Portal's profile cache.

Note:

The WLST command setProfileCacheTimeToLive defines the length of time profile objects live in the cache.

Syntax

setProfilePhotoSync(appName, enablePhotoSync, [server, applicationVersion])
Argument Definition
appName

Name of the application in which to perform this operation.

For WebCenter Portal, the application name is always webcenter.

For Portal Framework applications, specify the appropriate name.

enablePhotoSync

Specifies whether to periodically synchronize user profile photos in LDAP. Valid values are 1 and 0.

  • 1 - Synchronize user profile photos periodically (after WebCenter Portal's profile cache expires).

  • 0 - Profile photos in LDAP are not automatically synchronized with WebCenter Portal's profile cache. WebCenter Portal users must manually upload new photos through their profile page.

The default value is 1.

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 enables profile photo synchronization in WebCenter Portal:

wls:/weblogic/serverConfig>setProfilePhotoSync(appName='webcenter', enablePhotoSync=1)

printProfileConfig

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

(Deprecated from 11.1.1.8.0. Use setProfileConfig instead.)

Prints profile cache configuration values.

Syntax

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

Name of the application in which to perform this operation.

For WebCenter Portal, the application name is always webcenter.

For Portal Framework applications, specify the appropriate name.

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 displays the current profile cache configuration for WebCenter Portal:

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

Personal Events

Use the commands listed in Table 10-21 to manage personal events server connections for a named application.

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

Table 10-21 Personal Events WLST Commands

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

createPersonalEventConnection

Create a personal events server connection for a named 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 application

Online


createPersonalEventConnection

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

Creates a personal events server connection for a named application.

Personal events supports connections to Microsoft Exchange Server 2003 and Microsoft Exchange Server 2007.While you can register multiple personal events connections for WebCenter Portal and Portal Framework applications, 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 application in which to perform this operation.

For WebCenter Portal, the application name is always webcenter.

For Portal Framework applications, specify the appropriate name.

name

Connection name. The name must be unique (across all connection types within the 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 personal event services. Valid values are 1 (true) and 0 (false). The default for this argument is 0.

To specify that personal events uses this connection, set the value to 1.

While you can register multiple connections for WebCenter Portal and Portal Framework applications, only one connection is used for personal event services—the default (or active) connection.

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 creates a connection named MyPEConnection for WebCenter Portal (webcenter). The connection points to a Microsoft Exchange Server 2007 and is designated as the default connection for personal event services:

wls:/weblogic/serverConfig>createPersonalEventConnection(appName='webcenter', 
name='MyPEConnection', webServiceUrl='http://myexchange.com/EWS/Services.wsdl', 
adapterName='MSEx2007', appId='ExtPEApp', default=1)

The following example creates a connection named MyPEConnection for a WebCenter Portal. 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 an existing personal events server connection configured for a named application.

Syntax

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

Name of the application in which to perform this operation.

For WebCenter Portal, the application name is always webcenter.

For Portal Framework applications, specify the appropriate name.

name

Name of an existing personal events server connection.

webServiceUrl

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 personal events. Valid values are 1 (true) and 0 (false). The default for this argument is 0.

To specify that personal events uses this connection, set the value to 1.

While you can register multiple connections for WebCenter Portal and Portal Framework applications, only one connection is used for personal event services— the default (or active) connection.

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 updates the web service URL for a connection named MyPEConnection.

wls:/weblogic/serverConfig>setPersonalEventConnection(appName='webcenter', name='MyPEConnection', webServiceUrl='http://myexchange.com/EWS/Services.wsdl')

The following example makes a connection named MyPEConnection the default connection for personal events services in WebCenter Portal.

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

Syntax

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

Name of the application in which to perform this operation.

For WebCenter Portal, the application name is always webcenter.

For Portal Framework applications, specify the appropriate name.

verbose

Optional. Displays connection details for personal events 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 named 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 application is deployed. For example, WC_Spaces.

Required when applications with the same name are deployed to different 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 lists connection names and details for all of the personal events server connections currently configured for WebCenter Portal (webcenter):

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-22 to manage personalization connections for a named application.

Configuration changes made using these WLST commands are only effective after your restart the Managed Server on which personalization is deployed. For details, see Oracle Fusion Middleware Administering Oracle WebCenter Portal.

Table 10-22 Personalization WLST Commands

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

createWCPSCMISConnection

Create a CMIS connection for the personalization.

Online

createWCPSActivityGraphConnection

Create an activity graph connection for the personalization.

Online

createWCPSPeopleConnection

Create a People connection for the personalization.

Online

createWCPSCustomConnection

Create a custom connection for the personalization.

Online

setWCPSConnectionProperty

Modify properties of an existing connection for the personalization.

Online

listWCPSCMISConnection

List CMIS connections configured for the personalization.

Online

listWCPSActivityGraphConnection

List activity graph connections configured for the personalization.

Online

listWCPSPeopleConnection

List People connections configured for the personalization.

Online

listWCPSCustomConnection

List custom connections configured for the personalization.

Online

deleteWCPSCMISConnection

Create a CMIS connection for the personalization.

Online

deleteWCPSActivityGraphConnection

Create an activity graph connection for the personalization.

Online

deleteWCPSPeopleConnection

Create a People connection for the personalization.

Online

deleteWCPSCustomConnection

Create a custom connection for the personalization.

Online


createWCPSCMISConnection

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

Creates a connection to a CMIS (Content Management Interoperability Service) provider for personalization services.

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 that is hosting the CMIS REST service.

Typically, the machine name of the WC_Spaces managed server.

port

Port of the server that is 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 (for SSL)

Defaults to http.

namespace

Optional. 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 for personalization services.

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 the Oracle Fusion Middleware Administering Oracle WebCenter Portal.

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 the Oracle Fusion Middleware Administering Oracle WebCenter Portal.

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

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.


Example

The following example creates a connection to a CMIS data provider:

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 a connection to an activity graph data provider for personalization services.

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 activity graph REST services.

Typically, the machine name of the WC_Spaces managed server.

port

Port of the server hosting activity graph services.

Typically, the port number of the WC_Spaces managed server.

scheme

Optional. HTTP scheme for accessing activity graph. Valid options are http and https. Defaults to http.

namespace

Optional. 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 activity graph REST services. Valid options are producer, consumer, and none. Defaults to none.

For more details, see 'Managing Personalization' in Oracle Fusion Middleware Administering Oracle WebCenter Portal.

pathTrim

Optional. Specifies the path parts to trim from URLs returned from activity graph REST services. Defaults to None.

For more details, see 'Managing Personalization' in Oracle Fusion Middleware Administering Oracle WebCenter Portal.

server

Optional. Name of the Managed Server hosting personalization.

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 connection to an activity graph data provider 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 connection to a people connections provider for personalization services.

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 connections REST service.

Typically, the machine name of the WC_Spaces managed server.

port

Port of the server hosting people connections.

Typically, the port number of the WC_Spaces managed server.

scheme

Optional. HTTP scheme for accessing people connection services.

Valid options are http and https. Defaults to http.

namespace

Optional. Namespace for the connection.

f not specified or set to none, the connection is available to all namespaces.

isDefault

Optional. Indicates whether this connection is the default for people connections.

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 connections REST service. Valid options are producer, consumer, and none. Defaults to none.

For more details, see 'Managing Personalization' in Oracle Fusion Middleware Administering Oracle WebCenter Portal.

pathTrim

Optional. Specifies the path parts to trim from URLs returned from people connections. Defaults to None.

For more details, see 'Managing Personalization' in Oracle Fusion Middleware Administering Oracle WebCenter Portal.

server

Optional. Name of the Managed Server hosting personalization services.

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 connection to a people connections provider in the default namespace:

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

createWCPSCustomConnection

Use with WLST: Online

Description

Creates a connection to a custom data provider for personalization services.

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

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 connection to a custom data provider with several properties:

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 personalization or lists a single connection.

Syntax

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

Optional. Name of the Managed Server hosting personalization.

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. Namespace for the connections 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 or lists a single connection.

Syntax

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

Optional. Name of the Managed Server hosting 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. 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 activity graph data provider connections:

wls:/weblogic/serverConfig> listWCPSActivityGraphConnections(verbose=0)

AG1Connection
AG2Connection

The following example lists the details of one activity graph data provider 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 personalization or lists a single connection.

Syntax

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

Optional. Name of the Managed Server hosting personalization.

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 connection names 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. 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 people connections for personalization:

wls:/weblogic/serverConfig> listWCPSPeopleConnections(verbose=0)

People1Connection
People2Connection

The following example lists the details of a single 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 personalization 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 personalization.

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. 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 for personalization:

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

Syntax

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

Connection name.

namespace

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

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 configured for personalization:

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

deleteWCPSActivityGraphConnection

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

Deletes an activity graph connection configured for personalization.

Syntax

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

Connection name.

namespace

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

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 configured for personalization:

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

deleteWCPSPeopleConnection

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

Deletes a people connection configured for personalization.

Syntax

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

Connection name.

namespace

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

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 configured for personalization:

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

deleteWCPSCustomConnection

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

Deletes a custom data provider connection configured for personalization.

Syntax

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

Connection name.

type

Custom connection type.

namespace

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

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 data provider connection configured for personalization:

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

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

The following example removes a property from a custom data provider connection:

wls:/weblogic/serverConfig> setWCPSConnectionProperty(connectionName='CustomConnection', 
connectionType='my.connection.type', propertyName='prop2', propertyValue=None)

Portlet Producers

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

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

Table 10-23 Portlet 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

listPortletClientConfig

List portlet client configuration for a named application.

Online

setPortletClientConfig

Edit portlet client configuration settings.

Online

getPortletClientConfig

Return portlet client configuration settings.

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

For WebCenter Portal, the application name is always webcenter.

For Portal Framework applications, specify the appropriate name.

name

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

The name you specify here will appear in 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 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 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 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 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 application is deployed. For example, WC_Spaces.

Required when applications with the same name are deployed to different 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 example registers a WSRP producer named WSRPSamples with WebCenter Portal (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 application in which to perform this operation.

For WebCenter Portal, the application name is always webcenter.

For Portal Framework applications, specify the appropriate name.

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 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 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 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 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 application is deployed. For example, WC_Spaces.

Required when applications with the same name are deployed to different 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

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 for a named application.

Syntax

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

Name of the application in which to perform this operation.

For WebCenter Portal, the application name is always webcenter.

For Portal Framework applications, specify the appropriate name.

name

Optional. Name of an existing WSRP producer. If omitted, connection details for all WSRP producers configured for this 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 application is deployed. For example, WC_Spaces.

Required when applications with the same name are deployed to different 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 lists all the WSRP producers registered with a Portal Framework 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 a Portal Framework 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://example.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 application in which to perform this operation.

For WebCenter Portal, the application name is always webcenter.

For Portal Framework applications, specify the appropriate name.

name

Name of an existing WSRP producer.

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 deregisters the WSRPSamples producer in WebCenter Portal (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 application in which to perform this operation.

For WebCenter Portal, the application name is always webcenter.

For Portal Framework applications, specify the appropriate name.

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 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 application is deployed. For example, WC_Spaces.

Required when applications with the same name are deployed to different 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 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, [pplicationVersion])
Argument Definition
appName

Name of the application in which to perform this operation.

For WebCenter Portal, the application name is always webcenter.

For Portal Framework applications, specify the appropriate name.

name

Name of an existing WSRP producer.

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

For WebCenter Portal, the application name is always webcenter.

For Portal Framework applications, specify the appropriate name.

name

Name of an existing WSRP producer.

localRole

Name of the application role to be mapped.

producerUserCategory

WSRP producer user category to which the WebCenter Portal or Portal Framework application role will be mapped.

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

Syntax

registerPDKJavaProducer(appName, name, url, [serviceId, proxyHost, proxyPort, subscriberId, sharedKey, timeout, establishSession, externalApp, mapUser, server, applicationVersion])
Argument Definition
appName

Name of the application in which to perform this operation.

For WebCenter Portal, the application name is always webcenter.

For Portal Framework applications, specify the appropriate name.

name

Connection name. The name must be unique (across all connection types) within the 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.example.com:7778/axyz/providers

However, the following URL endpoint, does not require a service ID:

http://domain.example.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 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 or Portal Framework 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 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 application is deployed. For example, WC_Spaces.

Required when applications with the same name are deployed to different 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 creates and registers an Oracle PDK-Java producer named JPDKSamples in WebCenter Portal (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 application in which to perform this operation.

For WebCenter Portal, the application name is always webcenter.

For Portal Framework applications, specify the appropriate name.

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.example.com:7778/axyz/providers

However, the following URL endpoint, does not require a service ID:

http://domain.example.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 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 or Portal Framework 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 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 application is deployed. For example, WC_Spaces.

Required when applications with the same name are deployed to different 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 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 application.

Syntax

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

Name of the application in which to perform this operation.

For WebCenter Portal, the application name is always webcenter.

For Portal Framework applications, specify the appropriate name.

name

Name of an existing PDK-Java producer.

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

Syntax

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

Name of the application in which to perform this operation.

For WebCenter Portal, the application name is always webcenter.

For Portal Framework applications, specify the appropriate name.

name

Optional. Name of an existing PDK-Java portlet producer. If omitted, connection details for all PDK-Java producers configured for this 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 application is deployed. For example, WC_Spaces.

Required when applications with the same name are deployed to different 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 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 application.

Syntax

registerPageletProducer(appName, name, url, [server, applicationVersion])
Argument Definition
appName

Name of the application in which to perform this operation.

For WebCenter Portal, the application name is always webcenter.

For Portal Framework applications, specify the appropriate name.

name

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

The name you specify here appears in Composer under the Mash-ups >Pagelet Producers folder (by default).

url

URL required to access the server where the Pagelet Producer is deployed. 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 WebCenter Portal, 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 application is deployed. For example, WC_Spaces.

Required when applications with the same name are deployed to different 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 registers a pagelet producer with WebCenter Portal (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 application in which to perform this operation.

For WebCenter Portal, the application name is always webcenter.

For Portal Framework applications, specify the appropriate name.

name

Name of an existing pagelet producer connection.

url

Optional. URL required to access the server where the Pagelet Producer is deployed. 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 WebCenter Portal, 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 application is deployed. For example, WC_Spaces.

Required when applications with the same name are deployed to different 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 updates administrator user name and password details for an existing pagelet producer connection 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 application.

Syntax

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

Name of the application in which to perform this operation.

For WebCenter Portal, the application name is always webcenter.

For Portal Framework applications, specify the appropriate name.

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 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 application is deployed. For example, WC_Spaces.

Required when applications with the same name are deployed to different 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 lists connection names and details for all pagelet producers currently registered for a Portal Framework application named 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 application.

Syntax

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

Name of the application in which to perform this operation.

For WebCenter Portal, the application name is always webcenter.

For Portal Framework applications, specify the appropriate name.

name

Name of an existing pagelet producer connection.

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 deregisters a pagelet producer connection named MyPageletProducer currently configured for a Portal Framework application named 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 application in which to perform this operation.

For WebCenter Portal, the application name is always webcenter.

For Portal Framework applications, specify the appropriate name.

producerName

Name of an existing producer.

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 refreshes the WSRPSamples producer inWebCenter Portal (webcenter):

wls:/weblogic/serverConfig> refreshProducer(appName='webcenter', producerName='WSRPSamples')

Producer WSRPSamples has been refreshed.

listPortletClientConfig

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

Lists portlet client's configuration for a named application.

Syntax

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

Name of the application in which to perform this operation.

For WebCenter Portal, the application name is always webcenter.

For Portal Framework applications, specify the appropriate name.

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.


Examples

The following example lists portlet client configuration for a Portal Framework application named myPortalApp.

wls:/weblogic/serverConfig> listPortletClientConfig(appName='myPortalApp')

-------------------------------------
Portlet Client Configuration Settings
-------------------------------------
Application Striping: 0
Content Cache Enabled: 0
Maximum Content Cache Objects: 2000
Maximum Content Cache Size: 10000000
Default Timeout: 30
Maximum IFrame Querystring Length: 0
Maximum Resource URL Length: 1500
Maximum Timeout: 60
Minimum Timeout: 2
Parallel Pool Size: 20
Parallel Queue Size: 40
Maximum Rendition Cache Objects: 1000
Resource Proxy Path: /resource-proxy
Supported Locales: en, de, fr

setPortletClientConfig

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

Edits the portlet client's configuration, for a named application. If you omit a parameter, the corresponding configuration setting remains unchanged.

Note:

Configuration changes made using this WLST command are only effective after your restart the Managed Server on which the application is deployed. For details, see Oracle Fusion Middleware Administering Oracle WebCenter Portal.

Syntax

setPortletClientConfig(appName, [applicationStriping, contentCacheEnabled,
contentCacheMaxObjects, contentCacheMaxSize, defaultTimeout,
maximumIframeQueryStringLength, maximumResourceUrlLength, maximumTimeout,
minimumTimeout, parallelPoolSize, parallelQueueSize,
renditionCacheMaxObjects, resourceProxyPath, supportedLocales, server, applicationVersion])
Argument Definition
appName

Name of the application in which to perform this operation.

For WebCenter Portal, the application name is always webcenter.

For Portal Framework applications, specify the appropriate name.

applicationStriping

Optional. Specifies whether to enable application striping. Valid values are 1 (true) and 0 (false).

The default value is 0 (false).

contentCacheEnabled

Optional. Specifies whether to enable the portlet client's content cache. Valid values are 1 (true) and 0 (false).

The default value is 1 (true).

contentCacheMaxObjects

Optional. Maximum number of objects to be stored in the portlet client's content cache.

The default value is 0 (unlimited).

contentCacheMaxSize

Optional. Maximum size of the portlet client's content cache in bytes.

The default value is 0 (unlimited).

defaultTimeout

Optional. Default timeout period in seconds for requests made to producers.

The default value is 10 seconds.

maximumIframeQueryStringLength

Optional. Maximum length of portlet inline frame URLs before URL shortening is applied.

The default value is 0 (always shorten URLs).

maximumResourceUrlLength

Optional. Maximum length of portlet resource URLs.

The default value is 1500.

maximumTimeout

Optional. Maximum timeout period in seconds for requests made to producers.

The default value is 300 seconds.

minimumTimeout

Optional. Minimum timeout period in seconds for requests made to producers.

The default value is 1.

parallelPoolSize

Optional. Number of threads used for parallel execution of tasks.

The default value is 10.

parallelQueueSize

Optional. Number of tasks to allow in queue for parallel execution.

The default value is 20.

renditionCacheMaxObjects

Optional. Maximum number of objects in the cache used by the portlet client to store portlet renditions for use when rendering portlets in inline frames.

The default value is 25.

resourceProxyPath

Optional. The base path of the portlet resource proxy servlet, relative to the context root of the application.

The default value is '/resourceproxy'.

supportedLocales

Optional. Specifies one or more locales supported by the portlet client. The default value is en (English). Separate multiple locales with a comma.

For example: supportedLocales='en,fr,de'

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.


Examples

The following example sets new values for the ContentCacheEnabled, MinimumTimeout, MaximumTimeout, and ParallelQueueSize configuration settings. All other settings remain unchanged:

wls:/weblogic/serverConfig> setPortletClientConfig(appName='myPortalApp',
contentCacheEnabled=0, minimumTimeout=10, maximumTimeout=120,
parallelQueueSize=25)

The following example sets the value of the SupportedLocales configuration setting to English, French, and Spanish. All other settings remain unchanged:

wls:/weblogic/serverConfig> setPortletClientConfig(appName='myPortalApp',
supportedLocales='en, fr, es')

getPortletClientConfig

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

Returns the value of a specific portlet client configuration setting or values of all settings for a named application.

Syntax

getPortletClientConfig(appName, [configSetting, server, applicationVersion])
Argument Definition
appName

Name of the application in which to perform this operation.

For WebCenter Portal, the application name is always webcenter.

For Portal Framework applications, specify the appropriate name.

configSetting

Optional. Name of the portlet client configuration setting to return. One of the following values:

ApplicationStriping

ContentCacheEnabled

ContentCacheMaxObjects

ContentCacheMaxSize

DefaultTimeout

MaximumIframeQueryStringLength

MaximumResourceUrlLength

MaximumTimeout

MinimumTimeout

ParallelPoolSize

ParallelQueueSize

RenditionCacheMaxObjects

ResourceProxyPath

SupportedLocales

Note: The values are case-sensitive.

Omit this parameter to return the names and values of all settings.

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.


Examples

The following example returns the value of the DefaultTimeout configuration setting for a Portal Framework application named myPortalApp:

wls:/weblogic/serverConfig> defaultTimeout =
getPortletClientConfig(appName='myPortalApp', configSetting='DefaultTimeout')

The following example returns of the names and values of all portlet client configuration settings for a Portal Framework application named myPortalApp in a dict:

wls:/weblogic/serverConfig> settingsDict = 
getPortletClientConfig(appName='myPortalApp')

registerOOTBProducers

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

Registers several out-of-the-box producers with WebCenter Portal or a Portal Framework application: 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 application in which the out-of-the-box producers are to be registered.

For WebCenter Portal, the application name is always webcenter.

For Portal Framework applications, specify the appropriate name.

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 registers out-of-the-box producers in a Portal Framework 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 with WebCenter Portal or a Portal Framework application: OmniPortlet, Web Clipping, and WSRP Tools

Syntax

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

Name of the application in which the out-of-the-box producers are currently registered.

For WebCenter Portal, the application name is always webcenter.

For Portal Framework applications, specify the appropriate name.

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 deregisters out-of-the-box producers, and deletes their associated connections, in a Portal Framework applicationan 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 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 application in which the sample producers are to be registered.

For WebCenter Portal, the application name is always webcenter.

For Portal Framework applications, specify the appropriate name.

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 registers Oracle WebCenter Portal's sample producers in a Portal Framework 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 Oracle WebCenter Portal's sample producers (WSRP Samples and JPDK Samples) from a named application.

Syntax

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

Name of the application in which the sample producers are currently registered.

For WebCenter Portal, the application name is always webcenter.

For Portal Framework applications, specify the appropriate name.

If a value is not specified, this argument defaults to webcenter.

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 deregisters sample producers from a Portal Framework application named myApp.

wls:/weblogic/serverConfig> deregisterSampleProducers(appName='myApp') 

Proxy Server

Use the commands listed in Table 10-24 to manage proxy server settings used by tools and services, in a named application.

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

Table 10-24 RSS WLST Commands

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

getWebCenterProxyConfig

Return the proxy host and proxy port used by the tools and services.

Online

setWebCenterProxyConfig

Specify the proxy host and proxy port used by tools and services.

Online

unsetWebCenterProxyConfig

Delete proxy host and proxy port settings.

Online

getRssProxyConfig

Deprecated.

Online

setRssProxyConfig

Deprecated.

Online

unsetRssProxyConfig

Deprecated.

Online


getWebCenterProxyConfig

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

Returns the proxy host and proxy port used by RSS news feeds and activity streams in a named application. Depending on your network configuration, proxy details may be required to display external RSS news feeds and external links in activity streams in your application.

Syntax

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

Name of the application in which to perform this operation.

For WebCenter Portal, the application name is always webcenter.

For Portal Framework applications, specify the appropriate name.

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 returns the proxy host and proxy port used by tools and services in WebCenter Portal (webcenter):

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

setWebCenterProxyConfig

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

Specifies the proxy host and proxy port used by RSS news feeds and activity streams, in a named application. Depending on your network configuration, proxy details may be required to display external RSS news feeds and external links in activity streams in your application.

Syntax

setWebCenterProxyConfig(appName, proxyHost, proxyPort, [server, applicationVersion])
Argument Definition
appName

Name of the application in which to perform this operation.

For WebCenter Portal, the application name is always webcenter.

For Portal Framework applications, specify the appropriate name.

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 application is deployed. For example, WC_Spaces.

Required when applications with the same name are deployed to different 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 the proxy host and proxy port used by tools and services in WebCenter Portal (webcenter):

wls:/weblogic/serverConfig> setWebCenterProxyConfig(appName='webcenter', 
proxyHost='www-proxy.example.com', proxyPort='80')

unsetWebCenterProxyConfig

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

Deletes the current proxy host and proxy port settings configured for a named application.

Syntax

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

Name of the application in which to perform this operation.

For WebCenter Portal, the application name is always webcenter.

For Portal Framework applications, specify the appropriate name.

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 proxy host and proxy port settings configured for WebCenter Portal (webcenter):

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

getRssProxyConfig

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

(Deprecated from 11.1.1.8.0. Use getWebCenterProxyConfig instead.)

Returns the proxy host and proxy port used by tools and services. Depending on your network configuration, proxy details may be required to display external RSS news feeds and external links in activity streams in your application.

Syntax

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

Name of the application in which to perform this operation.

For WebCenter Portal, the application name is always webcenter.

For Portal Framework applications, specify the appropriate name.

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 returns the proxy host and proxy port used by tools and services in WebCenter Portal (webcenter):

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

setRssProxyConfig

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

(Deprecated from 11.1.1.8.0. Use setWebCenterProxyConfig instead.)

Specifies the proxy host and proxy port used by tools and services, such as RSS news feeds and activity streams. Depending on your network configuration, proxy details may be required to display external RSS news feeds and external links in activity streams in your application.

Syntax

setRssProxyConfig(appName, proxyHost, proxyPort, [server, applicationVersion])
Argument Definition
appName

Name of the application in which to perform this operation.

For WebCenter Portal, the application name is always webcenter.

For Portal Framework applications, specify the appropriate name.

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 application is deployed. For example, WC_Spaces.

Required when applications with the same name are deployed to different 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 the proxy host and proxy port used by tools and services in WebCenter Portal (webcenter):

wls:/weblogic/serverConfig> setRssProxyConfig(appName='webcenter', 
proxyHost='www-proxy.example.com', proxyPort='80')

unsetRssProxyConfig

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

(Deprecated from 11.1.1.8.0. Use unsetWebCenterProxyConfig instead.)

Deletes the current proxy host and proxy port settings used by tools and services.

Syntax

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

Name of the application in which to perform this operation.

For WebCenter Portal, the application name is always webcenter.

For Portal Framework applications, specify the appropriate name.

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 proxy host and proxy port settings used by tools and services in WebCenter Portal (webcenter):

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

Search - Oracle SES Search

Use the commands listed in Table 10-25 to manage Oracle Secure Enterprise Search (SES) connections and other Oracle SES search related properties for WebCenter Portal and Portal Framework applications.

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

Table 10-25 Search - Oracle SES WLST Commands

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

createSESConnection

Create a connection to an Oracle SES instance for a named 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 named application.

Online

setSearchSESConfig

Configure search settings for an existing Oracle SES search connection.

Online

listSearchSESConfig

List Oracle SES properties for a named application.

Online

createFederationTrustedEntity

Create a federation trusted entity on an Oracle (SES) instance.

Online

setSESVersion

Obtains and stores version information for the Oracle SES instance that is currently configured for a named application.

Online

listSESVersion

Returns version information for the Oracle SES instance configured for a named application.

Online

createDefaultSourceGroup

Creates a source group in Oracle SES instance with default document, discussion, and announcement sources.

Online


createSESConnection

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

Creates a connection to an Oracle Secure Enterprise Search (SES) instance for a named application.

Syntax

createSESConnection(appName, name, url, appUser, appPassword,[default, server, applicationVersion])
Argument Definition
appName

Name of the application in which to perform this operation.

For WebCenter Portal, the application name is always webcenter.

For Portal Framework applications, specify the appropriate name.

name

Connection name. The name must be unique (across all connection types) within the 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 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 application and the Oracle Identity Management server configured for Oracle SES.

appPassword

Password for the user name specified.

default

Optional. Configures search 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 configuration.

This argument defaults to 0.

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 creates a new search connection that points to the Oracle SES instance http://myhost.com:7777/search/query/OracleSearch and makes this connection the active SES search connection for a Portal Framework application named myApp.

wls:/weblogic/serverConfig>createSESConnection(appName='myApp', 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 for a named application.

Syntax

setSESConnection(appName, name, [url, appUser, appPassword, default, server, applicationVersion])
Argument Definition
appName

Name of the application in which to perform this operation.

For WebCenter Portal, the application name is always webcenter.

For Portal Framework applications, specify the appropriate name.

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 application uses to log in to Oracle Secure Enterprise Search so that it may perform searches on behalf of portal users.

appPassword

Optional. Password that the application uses to log in to Oracle Secure Enterprise Search so that it may perform searches on behalf of portal users.

default

Optional. Configures search 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 configuration.

This argument defaults to 0.

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 modifies the URL of a search connection named SESConn1 and makes the connection the active Oracle SES search connection for a Portal Framework application named myApp.

wls:/weblogic/serverConfig> etSESConnection(appName='myApp', 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 named application.

Syntax

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

Name of the application in which to perform this operation.

For WebCenter Portal, the application name is always webcenter.

For Portal Framework applications, specify the appropriate name.

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 an 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 application is deployed. For example, WC_Spaces.

Required when applications with the same name are deployed to different 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 example displays connection details for all Oracle SES search connections configured for a Portal Framework application named myApp.

wls:/weblogic/serverConfig>listSESConnections(appName='myApp', verbose=1)

The following example displays connection details for an Oracle SES search connection named SESConn1.

wls:/weblogic/serverConfig>listSESConnections(appName='myApp', 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 application in which to perform this operation.

For WebCenter Portal, the application name is always webcenter.

For Portal Framework applications, specify the appropriate name.

connectionName

Optional. Names the connection used for search.

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 application is deployed. For example, WC_Spaces.

Required when applications with the same name are deployed to different 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 specifies that search 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 results that search 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 Oracle SES search settings for a named application.

Syntax

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

Name of the application in which to perform this operation.

For WebCenter Portal, the application name is always webcenter.

For Portal Framework applications, specify the appropriate name.

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 displays Oracle SES search configuration information for WebCenter Portal (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,  [sesSchema, server, applicationVersion])
Argument Definition
appName

Name of the application in which to perform this operation.

For WebCenter Portal, the application name is always webcenter.

For Portal Framework applications, specify the appropriate name.

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

sesSchema

Username for the Oracle SES administrative user. The default value is eqsys.

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 creates a federation trusted entity named myEntity on the Oracle SES instance http://myseshost.com:7777/search/query/OracleSearch:

wls:/weblogic/serverConfig>
createFederationTrustedEntity(appName='webcenter', 
sesUrl='http://myseshost.com:7777/search/api/admin/AdminService', 
sesSchema='eqsys', sesPassword='password', entityName='myEntity', 
entityPassword='password', desc='This is a my sample entity')

setSESVersion

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

Obtains version information for the Oracle Secure Enterprise Search (SES) instance that is configured for a named application, and stores the version for use by search queries later on.

Version information is used when the Oracle SES connection is set as the default connection for search queries.

Syntax

setSESVersion(appName, sesUrl, sesSchema, sesPassword, [server, applicationVersion])
Argument Definition
appName

Name of the application in which to perform this operation.

For WebCenter Portal, the application name is always webcenter.

For Portal Framework applications, specify the appropriate name.

sesUrl

Web service URL for the Oracle SES Administration API.

Use the format:

http://host:port/search/api/admin/AdminService
sesSchema

Username for the Oracle SES administrative user. For example, searchsys.

sesPassword

Password for the Oracle SES administrative user.

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 obtains version information for the Oracle SES instance http://myhost.com:7777/search/query/OracleSearch and makes this information available to a Portal Framework application named MyApp:

wls:/weblogic/serverConfig>setSESVersion(appName='myApp', sesUrl='http://myseshost.com:7777/search/api/admin/AdminService', sesSchema='searchsys', sesPassword='password')

listSESVersion

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

Returns the version number of the Oracle Secure Enterprise Search (SES) instance that is being used by a named application.

Syntax

listSESVersion(appName, sesUrl, [server, applicationVersion])
Argument Definition
appName

Name of the application in which to perform this operation.

For WebCenter Portal, the application name is always webcenter.

For Portal Framework applications, specify the appropriate name.

sesUrl

Web service URL for the Oracle SES Administration API.

Use the format:

http://host:port/search/api/admin/AdminService
sesUrl

Web service URL for the Oracle SES Administration API.

Use the format:

http://host:port/search/api/admin/AdminService
sesSchema

Username for the Oracle SES administrative user. For example, searchsys.

sesPassword

Password for the Oracle SES administrative user.

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 returns version information for the Oracle SES instance http://myhost.com:7777/search/query/OracleSearch and confirms that the version information is saved in the Portal Framework application named MyApp:

wls:/weblogic/serverConfig>listSESVersion(appName='myApp', sesUrl='http://myseshost.com:7777/search/api/admin/AdminService')

----------------- 
SES Version Config
-----------------
url:  http://myhost.com:7777/search/api/admin/AdminService
version:  11.1.2.2.0 

createDefaultSourceGroup

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

Creates a source group in an Oracle Secure Enterprise Search (SES) instance with a default name, for a given host, port and application name, as well as the shared documents and discussions/announcement sources.

Syntax

createDefaultSourceGroup(appName, sesUrl, sesPassword, host, port, defaultHost, defaultPort, [sesSchema, server, applicationVersion])
Argument Definition
appName

Name of the application in which to perform this operation.

For WebCenter Portal, the application name is always webcenter.

For Portal Framework applications, specify the appropriate name.

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.

host

Host name of the machine where the application is running.

port

Port number used to access the application.

defaulthost

Host name of the machine where the default sources are configured.

defaultport

Port number used where the default sources are configured.

sesSchema

Optional. Username for the Oracle SES administrative user. Default value is eqsys.

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 creates a default source group in the Oracle SES instance http://myhost.com:7777/search/query/OracleSearch for the Portal Framework application named myApp at: http://webhost:8888/webcenter

The default source group also includes documents and discussions sources at: http://mydefaultHost:8989

wls:/weblogic/serverConfig>createDefaultSourceGroup(appName='myApp', sesUrl='http://myseshost.com:7777/search/api/admin/AdminService',
sesSchema='eqsys', sesPassword='password', host='webhost', port='8888', defaultHost='mydefaultHost', defaultPort='8989')

Search - Oracle SES Search Crawlers

Use the commands listed in Table 10-26 to manage Oracle Secure Enterprise Search (SES) crawlers for WebCenter Portal and Portal Framework applications.

There is no need to restart your application after running Oracle SES crawler WLST commands.

Table 10-26 Search - Oracle SES Crawler WLST Commands

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

createSpacesCrawler

Create a crawler forWebCenter Portal objects on an Oracle SES instance.

Online

createDocumentsCrawler

Create a documents crawler for a named application, on an Oracle SES instance.

Online

createDiscussionsCrawler

Create a discussions crawlers and an announcement crawler for a named application, on an Oracle SES instance.

Online

listSpacesCrawler

Return the Spaces crawler configured for WebCenter Portal, on an Oracle SES instance.

Online

listDocumentsCrawler

Return the documents crawler configured for a named application, on an Oracle SES instance.

Online

listDiscussionsCrawler

Return the discussion and announcement crawlers configured for a named application, on an Oracle SES instance.

Online

startSpacesCrawler

Start the Spaces crawler configured for WebCenter Portal, on an Oracle SES instance.

Online

startDocumentsCrawler

Start the documents crawler configured for a named application, on an Oracle SES instance.

Online

startDiscussionsCrawler

Start the discussion and announcement crawlers configured for a named application, on an Oracle SES instance.

Online

stopSpacesCrawler

Stop the Spaces crawler configured for WebCenter Portal, on an Oracle SES instance.

Online

stopDocumentsCrawler

Stop the documents crawler configured for a named application, on an Oracle SES instance.

Online

stopDiscussionsCrawler

Stop discussion and announcement crawlers configured for a named application, on an Oracle SES instance.

Online

deleteSpacesCrawler

Delete the Spaces crawler configured for WebCenter Portal, on an Oracle SES instance.

Online

deleteDocumentsCrawler

Delete the documents crawler configured for a named application, on an Oracle SES instance.

Online

deleteDiscussionsCrawler

Delete discussion and announcement crawlers configured for a named application, on an Oracle SES instance.

Online


createSpacesCrawler

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

Creates a crawler for WebCenter Portal objects on an Oracle SES instance. The command creates a WebCenter Portal datasource and specifies a schedule for crawling WebCenter Portal objects (such as portals, 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 application in which to perform this operation.

For WebCenter Portal, the application name is always webcenter.

host

Host name of the machine where WebCenter Portal is running.

port

Port number used to access WebCenter Portal.

sesUrl

Web service URL for the Oracle SES Administration API. Use the format:

http://host:port/search/api/admin/AdminService

sesPassword

Password for the Oracle SES administrative user (eqsys).

crawlUser

Crawl administration user in WebCenter Portal.

This user must exist in WebCenter Portal and in your back-end identity management server with appropriate permissions and roles. For example: mycrawladmin)

crawlPassword

Password for the WebCenter Portal 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 application is deployed. For example, WC_Spaces.

Required when applications with the same name are deployed to different 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 creates a Spaces crawler on the Oracle SES instance http://myseshost.com:7777 for WebCenter Portal (webcenter) located at http://myhost.com:8888/webcenter/portal:

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

For WebCenter Portal, the application name is always webcenter.

For Portal Framework applications, specify the appropriate name.

host

Host name of the machine where the application is running.

port

Port number used to access the 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 e