deleteConnection

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

Deletes a named WebCenter Portal connection.

If you use deleteConnection to delete a WSRP or PDK-Java producer connection (instead of using deregisterWSRPProducer or deregisterPDKJavaProducer), unused secondary connections will remain, which you might want to remove. For example, when you delete a WSRP producer connection, its associated Web Service connection remains; when you delete a PDK-Java producer connection, its associated URL connection remains.

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

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

applicationVersion

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

Example

The following example sets the WebCenter Portal Service Framework Resource Action Handler class to my.company.ResourceActionHandler:

wls:/wc_domain/domainRuntime> setWebCenterServiceFrameworkConfig(appName='webcenter',resourceActionHandlerClassName='my.company.ResourceActionHandler')
Successfully set the WebCenter Portal service framework configuration.
Resource Action Handler class: my.company.ResourceActionHandler
To effect connection changes, you must restart the managed server on which the
WebCenter Portal application is deployed.

The following example sets only the WebCenter Portal Service Framework Resource Action Handler display as popup value to 1 (true):

wls:/wc_domain/domainRuntime>
setWebCenterServiceFrameworkConfig(appName='webcenter', resourceActionHandlerDisplayInPopup=1)
Successfully set the WebCenter Portal service framework configuration.
Resource Action Handler Display In Popup: true
To effect connection changes, you must restart the managed server on which the WebCenter Portal application is deployed.

Analytics

Analytics Collector Connections

Use the commands listed in Table 10-3 to manage Analytics Collector connections for a WebCenter Portal application. Events raised in WebCenter Portal applications using OpenUsage APIs can be sent to an Analytics Collector for use by Analytics and Activity Graph services.

createAnalyticsCollectorConnection

Description

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

Events raised in WebCenter Portal applications using OpenUsage APIs can be sent to an Analytics Collector for use by the Analytics and Activity Graph services.

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

Syntax

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

connectionName

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

isUnicast

Optional. Specifies whether events are sent to a clustered Analytics Collector in multicast mode or whether a single Analytics Collector using unicast communication is required. Valid values are 1 (true) and 0 (false). The default value is 1 (unicast).

collectorHost

Optional. Host name where the Analytics Collector is running. The default value is localhost.

Only required for unicast communication, that is, where isUnicast='1'.

clusterName

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

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

collectorPort

Optional. Port on which the Analytics Collector listens for events. The default value is 31314.

Analytics events are sent to the Analytics Collector when isEnabled=1 and default=1.

timeout

Optional. Length of time (in seconds) to wait for a response from the Analytics Collector. Default value is 30.

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

default

Optional. Indicates whether this connection is the default (or active) Analytics Collector connection for the WebCenter Portal application. Valid values are 1 (true) and 0 (false). When set to 1, the WebCenter Portal application sends events on this connection. When set to 0, the connection is not used. The default for this argument is 0.

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

server

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

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

applicationVersion

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

Example

The following example creates a connection named MyAnalyticsCollector for a WebCenter Portal application named webcenter. Events are sent to a single Analytics Collector using unicast communication:

Analytics events are sent to the Analytics Collector when isEnabled=1 and default=1.

timeout

Optional. Length of time (in seconds) to wait for a response from the Analytics Collector. Default value is 30.

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

default

Optional. Indicates whether this connection is the default (or active) Analytics Collector connection for the WebCenter Portal application. Valid values 1 (true) and 0 (false). When set to 1, the WebCenter Portal application sends events on this connection. When set to 0, the connection is not used. The default for this argument is 0.

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

server

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

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

applicationVersion

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

Example

The following example updates host and port details for an existing Analytics Collector connection named MyAnalyticsCollector. On this connection, events are sent to a single Analytics Collector in unicast mode:

The following example updates cluster, port, and timeout details for an existing Analytics Collector connection named MyAnalyticsCollector. On this connection, events are sent to a clustered Analytics Collector in multicast mode:

setDefaultAnalyticsCollectorConnection

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

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

The default Analytics Collector connection is used to send events raised in WebCenter Portal applications using OpenUsage APIs to an Analytics Collector for use by Analytics and Activity Graph services.

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

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

The Analytics Collector periodically broadcasts a 'heartbeat' to advertise its location (hostName). In a clustered environment, WebCenter Portal applications use the heartbeat to determine which Analytics Collectors are available.

server

Optional. Name of the managed server where the Analytics Collector is deployed. For example, WC_Utilities.

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

applicationVersion

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

Activity Graph

Use the commands listed in Table 10-5 to manage Activity Graph system properties and metadata.

Configuration changes made using the setAGProperty WLST command are only effective after your restart the managed server on which the Activity Graph application is deployed (WC_Utilities). For all other commands, configuration changes are effective immediately.

Syntax

Name of the Activity Graph application in which to perform this operation—always activitygraph-engines.

directoryPath

Destination directory for the XML file that will be generated. If you specify a directory that does not exist, then it will be created.

definitionFilePath

Name for the XML file that will be generated. If a file with the same name exists in the destination directory then it will be overwritten. Example

urn

URN for the Activity Graph provider to export.

server

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

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

applicationVersion

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

Example

The following example exports configuration information for the Activity Graph provider oracle.webcenter.activitygraph.analytics to an XML file named 'ag-provider-config.xml, at the specified location:

Example

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.

setAGPasswordCredential

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

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

See also, "Managing the Activity Graph Service" in the Oracle Fusion Middleware Administrator's Guide for Oracle WebCenter for a list of properties with the PasswordCredential datatype, for example, oracle.webcenter.activitygraph.providers.datasources.ses.soap.admin.credential.

Example

archiveASByDeletedObjects

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

Archives activity stream data associated with deleted objects.This command moves data from production tables to archive tables, except for WC_ACTOR_DETAIL—data in this table is copied to the archive table rather than moved.

Rows in WC_OBJECT_DETAIL that satisfy the criteria (in this case, deleted objects) are deleted.

Syntax

archiveASByDeletedObjects(appName, [server, applicationVersion])

Argument

Definition

appName

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

server

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

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

applicationVersion

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

Example

archiveASByClosedSpaces

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

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

This command moves data from production tables to archive tables, except for WC_ACTOR_DETAIL—data in this table is copied to the archive table rather than moved. Rows in WC_OBJECT_DETAIL that satisfy the criteria (in this case, objects involved in activities of Spaces that are closed) are deleted.

Syntax

archiveASByClosedSpaces(appName, [server, applicationVersion])

Argument

Definition

appName

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

server

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

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

applicationVersion

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

Example

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

archiveASByInactiveSpaces

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

Archives activity stream data associated with spaces that have been inactive since a specified date. An inactive space is an open or closed space in which there has been no activity since the specified date.

This command moves data from production tables to archive tables, except for WC_ACTOR_DETAIL—data in this table is copied to the archive table rather than moved.Rows in WC_OBJECT_DETAIL that satisfy the criteria (in this case, objects involved in activities of spaces that have been inactive since the specified date) are deleted.

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

name

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

socketType

Specifies whether Oracle WebCenter Content's Content Server connects on the content server listener port or the Web server filter, and whether the listener port is SSL enabled. Valid values are socket, web, and socketssl. This option has no default.

Choose from:

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

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

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

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

url

Optional. Content Server URL. Required only if socketType is set to web or jaxws. URL should be in the format: http://<hostname>:<port>/<web root>/<plugin root>

For example, http://mycontentserver/cms/idcplg.

serverHost

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

serverPort

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

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

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

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

keystoreLocation

Optional. Location of key store that contains the private key used to sign the security assertions. Required only if socketType is set to socketssl.

The key store location must be an absolute path.

keystorePassword

Optional. Password required to access the key store. Required only if socketType is set to socketssl.

privateKeyAlias

Optional. Client private key alias in the key store. The key is used to sign messages to the server. The public key corresponding to this private key must be imported in the server keystore.

Required only if socketType is set to socketssl. The value for this argument must be a string that contains neither special characters nor white space.

privateKeyPassword

Optional. Password to be used with the private key alias in the key store. Required only if socketType is set to socketssl.

webContextRoot

Optional. Web server context root for the Content Server. Use the format /<context_root>. For example, /cs.

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

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

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

Using the document review functionality available in Oracle AutoVue.

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

Editing advanced document properties.

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

Viewing folder and file workflow details.

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

Previewing files in a slide viewer.

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

Site Studio integration

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

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

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

If your WebCenter Portal application is connected to multiple Content Servers, Oracle recommends that each Content Server has a unique Web Server Context Root so that OHS re-direction works correctly.

clientSecurityPolicy

Optional. Client security policy to be used when the socketType is jaxws. For example: oracle/wss11_saml_token_with_message_protection_service_policy

cacheInvalidationInterval

Optional. Frequency between checks for external Content Server content changes (in minutes). WebCenter Portal automatically clears items that have changed from the cache. Defaults to 0 which means that cache invalidation is disabled. The minimum interval is 2 minutes.

Tune this value based on your machine's memory configuration and the types of binary documents that you expect to cache.

adminUsername

Optional. User name with administrative rights for this Content Server instance. This user will be used to fetch content type information based on profiles and track document changes for cache invalidation purpose. Defaults to sysadmin.

adminPassword

Optional. Password for the Content Server administrator specified in adminUsername. Required when socketType is set to web.

extAppId

Optional. External application used to authenticate users against the Content Server. This value should match the name of an existing external application connection. See also listExtAppConnections. If extAppId is not set, no change is made to the authentication method or external application ID.

If extAppId is set to an empty string, the authentication method used is IDENTITY_PROPAGATION. With this method, the WebCenter Portal application and Content Server use the same identity store to authenticate users. Note that extAppID is mandatory when socketType is set to web.

timeout

Optional. Length of time allowed to log in to Content Server (in ms) before issuing a connection timeout message. If no timeout is set, there is no time limit for the login operation.

isPrimary

Optional. Valid string values are 1 (true) and 0 (false). 1 specifies that this connection is the primary connection used by the Documents service. This argument defaults to 0.

In the Spaces application, the primary connection is used to store space-specific content and Home space content.

server

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

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

applicationVersion

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

Examples

The following example creates a socket-based connection to an Oracle WebCenter Content repository running on myhost.com at port 4444. For authentication purposes, an existing external application named myExtApp is used. See also, createExtAppConnection.

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

name

Name of an existing Oracle WebCenter Content repository connection.

socketType

Optional. Specifies whether the Oracle WebCenter Content's Content Server connects on the content server listener port or the Web server filter, and whether the listener port is SSL enabled. Valid values are socket, web, and socketssl. This option has no default.

Choose from:

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

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

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

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

url

Optional. Content Server URL. Required only if socketType is set to web or jaxws. URL should be in the format: http://<hostname>:<port>/<web root>/<plugin root>

For example, http://mycontentserver/cms/idcplg.

serverHost

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

serverPort

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

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

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

For example, 4444

keystoreLocation

Optional. Location of key store that contains the private key used to sign the security assertions. Required only if socketType is set to socketssl.

The key store location must be an absolute path.

keystorePassword

Optional. Password required to access the key store. Required only if socketType is set to socketssl.

privateKeyAlias

Optional. Client private key alias in the key store. Required only if socketType is set to socketssl. The value for this argument must be a string that contains neither special characters nor white space.

privateKeyPassword

Optional. Password to be used with the private key alias in the key store. Required only if socketType is set to socketssl.

webContextRoot

Optional. Web server context root for the Content Server. Use the format /<context_root>. For example, /cs.

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

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

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

clientSecurityPolicy

Optional. Client security policy to be used when the socketType is jaxws. For example: oracle/wss11_saml_token_with_message_protection_service_policy

cacheInvalidationInterval

Optional. Frequency between checks for external Content Server content changes (in minutes). WebCenter Portal automatically clears items that have changed from the cache. Defaults to 0 which means that cache invalidation is disabled. The minimum interval is 2 minutes.

Tune this value based on your machine's memory configuration and the types of binary documents that you expect to cache.

adminUsername

Optional. User name with administrative rights for this Content Server instance. This user will be used to fetch content type information based on profiles and track document changes for cache invalidation purpose. Defaults to sysadmin.

adminPassword

Optional. Password for the Content Server administrator specified in adminUsername. Required when socketType is set to web.

extAppId

Optional. External application used to authenticate users against the Content Server. This value should match the name of an existing external application connection. See also listExtAppConnections. If extAppId is not set, no change is made to the authentication method or external application ID.

If extAppId is set to an empty string, the authentication method used is IDENTITY_PROPAGATION. With this method, the WebCenter Portal application and Content Server use the same identity store to authenticate users.

timeout

Optional. Length of time allowed to log in to Content Server (in ms) before issuing a connection timeout message. If no timeout is set, there is no time limit for the login operation.

isPrimary

Optional. Valid string values are 1 (true) and 0 (false). 1 specifies that this connection is the primary connection used by the Documents service. This argument defaults to 0.

In the Spaces application, the primary connection is used to store space-specific content and Home space content.

server

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

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

applicationVersion

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

Examples

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

Syntax

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

verbose

Optional. Displays content repository connection details in verbose mode. Valid options are 1 (true) and 0(false). When set to 1, listJCRContentServerConnections lists all Oracle WebCenter Content repository connections that are configured for a WebCenter Portal application, along with their details. When set to 0, only connection names are listed. This argument defaults to 0.

name

Optional. Name of an existing Oracle WebCenter Content repository connection. When specified you can view connection details for a specific Oracle WebCenter Content repository connection. If you supply a value for name, you must supply a value for verbose.

server

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

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

applicationVersion

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

Examples

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

The following example lists all properties of the Oracle WebCenter Content repository connection named myContentServerConnection1. The connection named myContentServerConnection1 must exist and be an Oracle WebCenter Content repository connection. If, for example, you specify an Oracle Portal connection, the properties are not listed and an error is displayed.

Description

Syntax

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

name

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

dataSource

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

The datasource must be on the server where the WebCenter Portal application is deployed.

extAppId

Optional. External application used to authenticate users against Oracle Portal. This value should match the name of an existing external application connection. See also listExtAppConnections. If extAppId is not set, no change is made to the authentication method or external application ID.

If extAppId is set to an empty string, the authentication method used is IDENTITY_PROPAGATION. With this method, the WebCenter Portal application and Oracle Portal use the same identity store to authenticate users.

timeout

Optional. Length of time allowed to log in to Oracle Portal (in ms) before issuing a connection timeout message. If no timeout is set, there is no time limit for the login operation.

isPrimary

Optional. Valid string values are 1 (true) and 0 (false). 1 specifies that this connection is the primary connection used by the Documents service. This argument defaults to 0.

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

server

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

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

applicationVersion

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

Example

The following example creates a Oracle Portal connection named myPortalConnection using the data source jdbc/portalDS and specifies that an external application, named myExtApp, is used for authentication.

Syntax

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

name

Name of an existing Oracle Portal connection.

dataSource

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

The datasource must be on the server where the WebCenter Portal application is deployed.

extAppId

Optional. External application used to authenticate users against Oracle Portal. This value should match the name of an existing external application connection. See also listExtAppConnections. If extAppId is not set, no change is made to the authentication method or external application ID.

If extAppId is set to an empty string, the authentication method used is IDENTITY_PROPAGATION. With this method, the WebCenter Portal application and Oracle Portal use the same identity store to authenticate users.

timeout

Optional. Length of time allowed to log in to Oracle Portal (in ms) before issuing a connection timeout message. If no timeout is set, there is no time limit for the login operation.

isPrimary

Optional. Valid string values are 1 (true) and 0 (false). 1 specifies that this connection is the primary connection used by the Documents service. When set to 0, and the specified connection is the primary connection used by the Documents service, the primary connection is reset. If this parameter is not set, the primary connection used by the Documents service does not change. This argument has no default.

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

server

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

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

applicationVersion

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

Syntax

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

verbose

Optional. Displays content repository connection details in verbose mode. Valid options are 1 (true) and 0 (false). When set to 1, listJCRPortalConnections lists all Oracle Portal connections that are configured for a WebCenter Portal application, along with their details. When set to 0, only connection names are listed. This argument defaults to 0.

name

Optional. Name of an existing Oracle Portal connection. When specified you can view connection details for a specific Oracle Portal connection. If you supply a value for name, you must supply a value for verbose.

server

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

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

applicationVersion

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

Example

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

Syntax

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

name

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

path

Full path to a folder whose contents you want to expose through this file system connection. For example, if you have a folder called C:\ProjectDocuments and you want to use that folder with the Documents service, you need to specify this folder as the path argument to this command.

isPrimary

Optional. Valid values are 1 (true) and 0 (false). 1 specifies that this connection is the primary connection used by the Documents service. When set to 0, and when the specified connection is the primary connection used by the Documents service, the primary connection is reset. If this parameter is not set, the primary connection used by the Documents service does not change. This argument has no default.

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

server

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

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

applicationVersion

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

Example

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

Optional. Full path to a folder whose contents you want to expose through this file system connection. For example, if you have a folder called C:\ProjectDocuments and you want to use that folder with the Documents service, you need to specify this folder as the path argument to this command.

isPrimary

Optional. Valid values are 1 (true) and 0 (false). When set to 1, specifies that this connection is the primary connection used by the Documents service. When set to 0, and when the specified connection is the primary connection used by the Documents service, the primary connection is reset. If this parameter is not set, the primary connection used by the Documents service does not change. This argument has no default.

Note that in the Spaces application, the primary connection must be an Oracle WebCenter Content repository connection.

server

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

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

applicationVersion

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

Example

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

Syntax

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

verbose

Optional. Displays content repository connection details in verbose mode. Valid options are 1 (true) and 0 (false). When set to 1, listJCRFileSystemConnections lists all file system connections that are configured for a WebCenter Portal application, along with their details. When set to 0, only connection names are listed. This argument defaults to 0.

name

Optional. Name of an existing file system connection. When specified you can view connection details for a specific file system connection. If you supply a value for name, you must supply a value for verbose.

server

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

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

applicationVersion

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

Examples

The following example lists all of the file system connections that are configured for an application named webcenter.

Syntax

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

name

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

url

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

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

likeLimit

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

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

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

Note: Only specify a value above 64 if your SharePoint instance supports LIKE queries on URLs greater than 64 characters.

extAppId

Optional. External application used to authenticate users against the SharePoint repository. This value should match the name of an existing external application connection. See also listExtAppConnections.

If extAppId is not set, the SharePoint repository connection will not work.

Optional. Length of time allowed to log in to the SharePoint repository (in ms) before issuing a connection timeout message. If no timeout is set, there is no time limit for the login operation.

isPrimary

Optional. Valid values are 1 (true) and 0 (false). 1 specifies that this connection is the primary connection used by the Documents service. The argument defaults to 0. If this parameter is omitted, the primary connection used by the Documents service does not change.

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

server

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

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

applicationVersion

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

Example

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

Syntax

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

name

Name of an existing SharePoint connection.

url

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

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

likeLimit

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

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

Oracle recommends the default value (64). The default is suitable in most instances so, typically, there is no need to set a new value. To reset the default, specify likeLimit='' or likeLimit=64.

Note: Only specify a value above 64 if your SharePoint instance supports LIKE queries on URLs greater than 64 characters.

extAppId

Optional. External application used to authenticate users against the SharePoint repository. This value should match the name of an existing external application connection. See also listExtAppConnections. If extAppId is not set, no change is made to the current external application ID.

If no external application is set, the SharePoint connection will not work.

timeout

Optional. Length of time allowed to log in to the SharePoint repository (in ms) before issuing a connection timeout message. If no timeout is set, there is no time limit for the login operation.

isPrimary

Optional. Valid values are 1 (true) and 0 (false). 1 specifies that this connection is the primary connection used by the Documents service. When set to 0, and the specified connection is the primary connection used by the Documents service, the primary connection is reset. If this parameter is not set, the primary connection used by the Documents service does not change. This argument has no default.

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

server

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

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

applicationVersion

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

Syntax

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

verbose

Optional. Displays SharePoint connection details in verbose mode. Valid options are 1 (true) and 0 (false). When set to 1, listJCRSharePointConnections lists all SharePoint connections that are configured for a WebCenter Portal application, along with their details. When set to 0, only connection names are listed. This argument defaults to 0.

name

Optional. Name of an existing SharePoint connection. When specified you can view connection details for a specific SharePoint connection. If you supply a value for name, you must supply a value for verbose.

server

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

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

applicationVersion

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

Example

The following example lists the names of all the SharePoint connections that are configured for an application named webcenter.

listDocumentsSpacesProperties

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

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

Syntax

listDocumentsSpacesProperties(appName, [server, applicationVersion])

Argument

Definition

appName

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

server

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

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

applicationVersion

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

Example

The following example lists properties for the back-end Oracle WebCenter Content repository that is being used by a Spaces application (named webcenter) to store space-specific documents and Home space documents.

setDocumentsSpacesProperties

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

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

Syntax

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

spacesRoot

Optional. Root folder under which the Spaces application content is stored. The value for this argument must use the format: /<foldername>. For example, /WebCenter or /WebCenterSpaces. The spacesRoot cannot be /, the root itself, and it must be unique across applications. If the folder specified does not exist it will be created for you.

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

adminUserName

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

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

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

applicationName

Optional. Unique Spaces application identifier. This name is used to separate data when multiple Spaces applications share the same content repository, and must be unique across applications.

The value for this argument must begin with an alphabetical character, followed by any combination of alphanumeric characters or the underscore character. The string must be less than or equal to 30 characters. Note that if you provide a value for this argument, you must also provide values for the spacesRoot and adminUserName arguments.

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

<applicationName><WorkflowName>

<applicationName><WorkflowStepName>

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

server

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

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

applicationVersion

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

Examples

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

The following example modifies the administrator's user name for the back-end Oracle WebCenter Content repository that is being used by the Spaces application to store space-specific documents and Home space documents.

deleteDocumentsSpacesProperties

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

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

createDiscussionForumConnection

Description

Creates a new discussions server connection for a named WebCenter Portal application.

The Discussions service and the Announcements service both require a discussions server connection. Both services use the same discussions server connection.

While you can register multiple discussions server connections for a WebCenter Portal application, only one connection is used for discussion and announcement services - the default (or active) connection.

Syntax

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

name

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

url

URL of the discussions server hosting discussion forums and announcements. For example: http://myhost:8888/owc_discussions.

adminUser

Name of the discussions server administrator. This account is used by the Discussions and Announcements services to perform administrative operations on behalf of WebCenter Portal users.

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

policyURIForAuthAccess

Optional. URI to the SAML token based policy required for authenticated access to the discussions server Web service.

The client policy specified must be compatible with the service policy that is configured for the OWCDiscussionsServiceAuthenticated endpoint in the discussions server. Out-of-the-box, the default service policy is WSS 1.0 SAML Token Service Policy (oracle/wss10_saml_token_service_policy).

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.

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

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.

Optional. Length of time (in seconds) the Discussions service waits for a response from the discussions server before issuing a connection timeout message. This argument defaults to -1. When set to -1, the service default (10 seconds) applies.

default

Optional. Indicates that this connection is the default connection for the Discussions and Announcements services.

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

server

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

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

applicationVersion

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

Example

The following example creates a discussions server connection for a WebCenter Portal application.

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

name

Name of an existing discussions server connection.

url

Optional. URL to the discussions server.

adminUser

Optional. Name of the discussions server administrator. This account is used by the Discussions service to perform administrative operations on behalf of WebCenter Portal users.

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

policyURIForAuthAccess

Optional. URI to the SAML token based policy required for authenticated access to the discussions server Web service.

The client policy specified must be compatible with the service policy that is configured for the OWCDiscussionsServiceAuthenticated endpoint in the discussions server. Out-of-the-box, the default service policy is WSS 1.0 SAML Token Service Policy (oracle/wss10_saml_token_service_policy).

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.

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

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

recipientKeyAlias

Optional. Recipient key alias to be used for message protected policy authentication. Only required when the discussion server connection is using a message protection-based security policy for authentication. The default is null.

See also "Configuring WS-Security for WebCenter Portal Applications and Components" in the Oracle Fusion Middleware Administrator's Guide for Oracle WebCenter.

timeout

Optional. Length of time (in seconds) the Discussion and Announcement services wait for a response from the discussions server before issuing a connection timeout message. This argument defaults to -1. When set to -1, the service default (10 seconds) applies.

default

Optional. Indicates that this connection is the default connection for the Discussions and Announcements services. Required only if more than one connection is defined.

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

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

Note: While you can register multiple discussions server connections for a WebCenter Portal application, only one connection is used for discussion and announcement services— the default (or active) connection.

server

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

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

applicationVersion

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

Example

The following example updates attributes for a secure discussions server connection named MyDiscussionsServer.

(Spaces application only) Application root category ID on the discussions server under which all discussion forums are stored. For example, if set to 3, then all forums are stored inside the category 3.

Syntax

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

verbose

Optional. Valid options are 1 (true) and 0 (false). When set to 1, listDiscussionForumConnections lists all of the discussions server connections that are configured for a WebCenter Portal application, along with their details. When set to 0, only connection names are listed. This argument defaults to 0.

name

Optional. Name of an existing discussions server connection. Use this argument to view connection details for a specific discussions server connection.

server

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

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

applicationVersion

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

Examples

The following example lists the names of all of the discussions server connections that are currently configured for an application named webcenter.

listDefaultDiscussionForumConnection

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

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

Syntax

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

verbose

Optional. Valid options are 1 (true) and 0 (false). When set to 1, the name and details of the discussions server connections are listed. When set to 0, only the connection name displays. This argument defaults to 0.

server

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

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

applicationVersion

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

Examples

The following example names the discussions server connection that the Discussions/Announcements service are using, in an application named webcenter.

setDefaultDiscussionForumConnection

Description

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

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

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

forums.fetch.size

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

recentTopics.fetch.size

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

watchedTopics.fetch.size

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

watchedForums.fetch.size

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

application.root.category.id

Application root category ID on the discussions server under which all discussion forums are stored. For example, if set to 3, all forums are stored inside category 3.

ForumGatewayManager.AUTO_START

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

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

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

Example

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.

syncDiscussionServerPermissions

Description

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

Note:

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

Syntax

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:

Syntax

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

name

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

displayName

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

url

Optional. External application login URL.

To determine an application's URL, navigate to the application's login page and note down the URL for that page. For example: http://login.yahoo.com/config/login

authMethod

Optional. Authentication mechanism used by the external application. Valid options are GET, POST, and BASIC. This argument defaults to POST.

userFieldName

Optional. Name that identifies the user name or user ID field on the external application's login form. To find this name, look at the HTML source for the login page. This argument does not specify user credentials.

Mandatory if authMethod is GET or POST and a login url is specified. Not required if BASIC authentication method is selected.

pwdFieldName

Optional. Name that identifies the password field on the external application's login form. To find this name, look at the HTML source for the login page. This argument does not specify user credentials.

Mandatory if authMethod is GET or POST and a login url is specified. Not required if BASIC authentication method is selected.

server

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

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

applicationVersion

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

Example

The following example creates a connection for an external application named My Yahoo!, in a WebCenter Portal application.

Syntax

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

name

Name of an existing external application connection.

displayName

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

url

Optional. External application login URL. To determine an application's URL, navigate to the application's login page and note down the URL for that page.

authMethod

Optional. Authentication mechanism used by the external application. Valid options are GET, POST, and BASIC. This argument defaults to POST.

userFieldName

Optional. Name that identifies the user name or user ID field on the external application's login form. To find this name, look at the HTML source for the login page. This argument does not specify user credentials.

Mandatory if authMethod is GET or POST and a login URL is specified but can be left blank if BASIC authentication method is selected.

pwdFieldName

Optional. Name that identifies the password field on the external application's login form. To find this name, look at the HTML source for the login page. This argument does not specify user credentials.

Mandatory if authMethod is GET or POST, but can be left blank if BASIC authentication method is selected.

server

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

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

applicationVersion

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

Example

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

Syntax

Name of the WebCenter application for which to perform this operation.

verbose

Optional. Displays external application details in verbose mode. Valid options are 1 (true) and 0 (false). When set to 1, listExtAppConnections lists all of the external applications that are configured for a WebCenter application, along with their details. When set to 0, listExtAppConnections lists only the names of the external applications. This argument defaults to 0.

If you set this argument to 0, do not specify the name argument.

name

Optional. Name of an existing external application connection. You can use this argument to view details about a specific connection.

server

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

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

applicationVersion

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

Examples

The following example lists the names of all the external applications currently used by a WebCenter Portal application named webcenter.

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.

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.

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

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

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

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

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

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

Syntax

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

name

Name of an existing external application connection.

type

Credential type. Valid values are SHARED and PUBLIC.

username

Name of the shared or public user.

password

Password for the shared or public user.

field

Optional. Additional login field value. Use the format FieldName:FieldValue, where FieldName names an additional login field configured with displayToUser=1.

server

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

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

applicationVersion

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

Example

The following example specifies public credentials for an external application named ABC. The public user name is mypublic.username, the password is mypublic.password, and there is one additional field named Account.

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.

createIMPConnection

Description

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

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

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

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.

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.

Optional. Length of time (in seconds) that the Instant Messaging and Presence service waits for a response from the presence server before issuing a connection timeout message. This argument defaults to -1. When set to -1, the service default (10 seconds) applies.

default

Optional. Indicates whether this connection is the default connection for the Instant Messaging and Presence service. Valid values are 1 (true) and 0 (false). The default for this argument is 0.

server

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

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

applicationVersion

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

Examples

The following example creates an external application suitable for an instant messaging and presence server connection and then creates a connection named myLCSPresenceServer to a Microsoft Live Communications Server:

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.

Optional. Length of time (in seconds) that the Instant Messaging and Presence service waits for a response from the presence server before issuing a connection timeout message. This argument defaults to -1. When set to -1, the service default (10 seconds) applies.

default

Optional. Indicates whether this connection is the default connection for the Instant Messaging and Presence service. Valid values are 1 (true) and 0 (false). The default for this argument is 0.

To specify that the Instant Messaging and Presence service uses this connection, change the value from 0 to 1.

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

server

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

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

applicationVersion

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

Examples

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

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

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

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

verbose

Optional. Displays presence server connection details in verbose mode. Valid values are 1 (true) and 0 (false). When set to 1, listIMPConnections lists all of the presence server connections that are configured for a WebCenter Portal application, along with their details.When set to 0, only connection names are listed. This argument defaults to 0.

name

Optional. Name of an existing presence server connection. Use this argument to view connection details for a specific presence server connection. Note that if you use the name argument when verbose argument set to 1, the verbose argument is ignored.

server

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

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

applicationVersion

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

Examples

The following example lists all of the instant messaging and presence server connections that are configured for an application named webcenter.

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

The following example lists all of the instant messaging and presence server connections that are configured for the application in verbose mode.

listDefaultIMPConnection

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

Lists the connection that the Instant Messaging and Presence service is using, in a named WebCenter Portal application. While you can register multiple presence server connections for a WebCenter Portal application, the Instant Messaging and Presence service only uses one connection—the default (or active) connection.

If only one presence server connection is available, that connection is assumed to be the default connection.

Syntax

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

verbose

Optional. Displays the default presence server connection in verbose mode, if available. Valid options are 1 (true) and 0 (false). When set to 1, the name and details of the presence server connection are listed. When set to 0, only the connection name displays. This argument defaults to 0.

server

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

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

applicationVersion

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

Example

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

setDefaultIMPConnection

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

Specifies the default connection for the Instant Messaging and Presence service, in a named WebCenter Portal application. While you can register multiple presence server connections with a WebCenter Portal application, the Instant Messaging and Presence service only uses one connection—the default (or active) connection.

If only one presence server connection is available, that connection is assumed to be the default connection.

Syntax

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

Argument

Definition

appName

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

name

Name of an existing instant messaging and presence connection.

server

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

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

applicationVersion

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

Example

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

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

resolve.display.name.from.user.profile

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

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

im.address.resolver.class

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

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

User Preferences

User Credentials

User Profiles

im.address.profile.attribute

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

Syntax

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

name

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

displayName

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

server

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

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

applicationVersion

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

Example

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

Mail

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

You can register multiple mail server connections:

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

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

createMailConnection

Description

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

You can register multiple mail server connections:

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

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

Syntax

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

name

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

imapHost

Optional. Host name of the machine on which the IMAP service is running.

imapPort

Optional. Port on which the IMAP service listens.

smtpHost

Optional. Host name of the machine where the SMTP service is running.

smtpPort

Optional. Port on which the SMTP service listens.

imapSecured

Optional. Specifies whether the mail server connection to the IMAP server is SSL-enabled. Valid values are 1 (true) and 0 (false). The default for this argument is 0.

smtpSecured

Optional. Specifies whether the SMTP server is secured. Valid values are 1 (true) and 0 (false). The default for this argument is 0.

appId

External application associated with the mail server connection.

External application credential information is used to authenticate users against the IMAP and SMTP servers. The same credentials are supplied to authenticate the user on both the IMAP and SMTP servers.

The external application you configure for the Mail service must use authMethod=POST, and specify several additional login fields:

fieldName='Email Address' and displaytoUser=1

fieldName='Your Name' and displaytoUser=1

fieldName='Reply-To Address' and displaytoUser=1

If an external application does not exist yet, use the WLST command createMailExtApp to create an external application that automatically has all the required additional fields.

Optional. Length of time (in seconds) that the service waits to acquire a connection before terminating. This argument defaults to -1. When set to -1, the service default (10 seconds) applies.

default

Optional. Indicates whether this connection is the default connection for the Mail service. Valid values are 1 (true) and 0 (false). This argument defaults to 0.

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

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

server

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

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

applicationVersion

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

Examples

The following example creates an external application suitable for a mail server connection, and then creates a mail server connection named myMailConnection:

Description

(Spaces application only.) This command enables you to set additional, optional, LDAP server attributes that cannot be set using createMailConnection. When LDAP details are defined, the Mail service creates, edits, and deletes spacedistribution lists for the Spaces application. Distribution lists are named after their space (excluding non-java identifiers) and assigned a domain (derived from the domain attribute, for example, @mycompany.com). If LDAP details are not provided, spacedistribution lists are not created or maintained. The mail server must be a Microsoft Exchange Server.

External application credential information is used to authenticate users against the IMAP and SMTP servers. The same credentials are supplied to authenticate the user on both the IMAP and SMTP servers.

The external application you configure for the Mail service must use authMethod=POST, and specify several additional login fields:

fieldName='Email Address' and displaytoUser=1

fieldName='Your Name' and displaytoUser=1

fieldName='Reply-To Address' and displaytoUser=1

If an external application does not exist yet, use the WLST command createMailExtApp to create an external application that automatically has all the required additional fields.

Optional. Host name of the machine where the LDAP directory server is running.

ldapPort

Optional. Port on which the LDAP directory server listens.

ldapBaseDN

Optional. Base distinguished name for the LDAP schema. For example, CN=Users,DC=oracle,DC=com.

ldapAdminUser

Optional. User name of the LDAP directory server administrator. A valid administrator with privileges to make entries into the LDAP schema.

ldapAdminPassword

Optional. Password for the LDAP directory server administrator. This password will be stored in a secured store.

ldapSecured

Optional. Specifies whether the connection to the LDAP server is secured (SSL enabled). Valid values are 1 (true) and 0 (false). The default for this argument is 0. Set this to 1 for all LDAP communications over SSL.

domain

Optional. Domain name appended to spacedistribution lists. For example, if the domain attribute is set to mycompany.com, the Finance Project space will maintain a distribution list named FinanceProject@oracle.com.

defaultUser

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

timeout

Optional. Length of time (in seconds) that the service waits to acquire a connection before terminating. This argument defaults to -1. When set to -1, the service default (10 seconds) applies.

default

Optional. Indicates whether this connection is the default (or active) connection for the Mail service. Valid values are 1 (true) and 0 (false). This argument defaults to 0. 1 specifies that this connection is the default connection for the Mail service.

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

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

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

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

Syntax

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

verbose

Optional. Displays mail server connection details in verbose mode. Valid options are 1 (true) and 0 (false). When set to 1, listMailConnections lists all of the mail server connections that are configured for a WebCenter Portal application, along with their details. When set to 0, only connection names are listed. This argument defaults to 0.

name

Optional. Name of an existing mail server connection. Use this argument to view connection details for a specific mail server connection.

server

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

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

applicationVersion

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

Example

The following example lists the names of mail server connections that are currently configured for an application named webcenter.

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

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

listDefaultMailConnection

Description

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

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

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

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

Syntax

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

verbose

Optional. Displays the default mail server connection in verbose mode, if available. Valid options are 1 (true) and 0 (false). When set to 1, the name and details of the mail server connection are listed. When set to 0, only the connection name displays. This argument defaults to 0.

server

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

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

applicationVersion

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

Example

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

setDefaultMailConnection

Description

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

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

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

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

Defines the delimiter that is used to separate multiple mail addresses. A comma is used by default.

Some mail servers require mail addresses in the form lastname, firstname and, in such cases, a semi-colon is required.

mail.emailgateway.polling.frequency

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

Email communication through spacedistribution lists can be published as discussion forum posts on a discussions server. For details, see "Publishing Space Mail in a Discussion Forum" in Oracle Fusion Middleware User's Guide for Oracle WebCenter.

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

Syntax

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

name

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

displayName

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

server

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

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

applicationVersion

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

Example

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

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

Online

setNotificationsConfig

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

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

Use an existing mail server or BPEL server connection. If the WebCenter Portal application is connected to a BPEL server, the Oracle User Messaging Service (UMS) is available for routing notifications through multiple messaging channels, including mail, worklists, and SMS. If you configure the Notifications service to use a BPEL server connection, you may specify a sender 'From' address for each available messaging channel. That is, you can specify a sender mail address and an SMS address.

Alternatively, you can route notification messages through a mail server. If you configure the Notifications service to use a mail server connection, the external application associated with the mail server connection must contain shared credentials. Shared credentials are required for routing application-wide notifications.

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

senderMailAddress

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

Use the format:

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

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

This argument applies to notifications routed through BPEL servers. When a BPEL server is used and UMS is configured with multiple email drivers, this address is also used to identify the appropriate email driver.

When a mail server is used, the "From Address" is the same user that is specified for the associated external application's shared credentials.

senderSMSAddress

Optional. SMS number from which all SMS notifications are sent.

Typically, the SMS address format is a 4-6 digit number (without -, spaces, or any other characters). For example, 28734.

This argument applies to notifications routed through BPEL servers. When a BPEL server is used and UMS is configured with multiple SMS drivers, this address is also used to identify the appropriate SMS driver.

server

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

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

applicationVersion

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

Example

The following example specifies that the Notifications service use a BPEL server connection named 'WebCenter-Worklist' and also defines the mail address and SMS address from which all notifications are sent:

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

Online

createPersonalEventConnection

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

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

The Personal Events service supports connections to Microsoft Exchange Server 2003 and Microsoft Exchange Server 2007.While you can register multiple personal events connections for a WebCenter Portal application, only one connection is used for personal events services - the default (or active) connection.

Optional. Indicates whether this connection is the default connection for the Personal Events service. Valid values are 1 (true) and 0 (false). The default for this argument is 0.

To specify that the Personal Events service uses this connection, set the value to 1.

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

server

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

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

applicationVersion

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

Example

The following example creates a connection named MyPEConnection for the Spaces application (appName='webcenter'). The connection points to a Microsoft Exchange Server 2007 and is designated as the default connection for the Personal Events service.

Syntax

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

verbose

Optional. Displays connection details for the Personal Events service in verbose mode. Valid options are 1 (true) and 0 (false). When set to 1, listPersonalEventConnections lists all of the personal events server connections that are configured for a WebCenter Portal application, along with their details. When set to 0, only connection names are listed. This argument defaults to 0.

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

name

Optional. Name of an existing personal events connection. Use this argument to view connection details for a specific personal events server.

server

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

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

applicationVersion

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

Example

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

Syntax

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

verbose

Optional. Controls verbose or concise output. Valid options are 1 and 0. When set to 1, this command lists the CMIS connections and their properties. When set to 0, this command lists connection names only. Defaults to 1.

name

Optional. Name of an existing connection. If not specified or set to None, then all connections are listed.

namespace

Optional. WebCenter Portal's Personalization connection namespace for the connection you want to list. If not specified or set to none, this command lists connections configured to be available in all namespaces.

Syntax

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

verbose

Optional. Controls verbose or concise output. Valid options are 1 and 0. When set to 1, this command lists the Activity Graph connections and their properties. When set to 0, this command lists connection names only. Defaults to 1.

name

Optional. Name of an existing connection. If not specified or set to None, then all connections are listed.

namespace

Optional. WebCenter Portal's Personalization connection namespace for the connection you want to list. If not specified or set to none, this command lists connections configured to be available in all namespaces.

Example

The following example lists the names of all the Activity Graph connections:

Syntax

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

verbose

Optional. Controls verbose or concise output. Valid options are 1 and 0. When set to 1, this command lists the People connections and their properties. When set to 0, this command lists connection names only. Defaults to 1.

name

Optional. Name of an existing connection. If not specified or set to None, then all connections are listed.

namespace

Optional. WebCenter Portal's Personalization connection namespace for the connection you want to list. If not specified or set to none, this command lists connections configured to be available in all namespaces.

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

verbose

Optional. Controls verbose or concise output. Valid options are 1 and 0. When set to 1, this command lists the connections and their properties. When set to 0, this command lists connection names only. Defaults to 1.

name

Optional. Name of an existing connection. If not specified or set to None, then all connections are listed.

namespace

Optional. WebCenter Portal's Personalization connection namespace for the connection you want to list. If not specified or set to none, this command lists connections configured to be available in all namespaces.

Example

The following example lists the names of all connections with the type my.connection.type:

deleteWCPSCMISConnection

Description

Syntax

deleteWCPSCMISConnection(name, [namespace, server])

Argument

Definition

name

Connection name.

namespace

Optional. WebCenter Portal's Personalization connection namespace for the connection you want to delete. If not specified or set to none, this command deletes connections configured to be available in all namespaces.

deleteWCPSActivityGraphConnection

Description

Deletes an Activity Graph connection configured for the Personalization service.

Syntax

deleteWCPSActivityGraphConnection(name, [namespace, server])

Argument

Definition

name

Connection name.

namespace

Optional. WebCenter Portal's Personalization connection namespace for the connection you want to delete. If not specified or set to none, this command deletes connections configured to be available in all namespaces.

deleteWCPSPeopleConnection

Description

Deletes a People connection configured for the Personalization service.

Syntax

deleteWCPSPeopleConnection(name, [namespace, server])

Argument

Definition

name

Connection name.

namespace

Optional. WebCenter Portal's Personalization connection namespace for the connection you want to delete. If not specified or set to none, this command deletes connections configured to be available in all namespaces.

deleteWCPSCustomConnection

Description

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

Syntax

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

Argument

Definition

name

Connection name.

type

Custom connection type.

namespace

Optional. WebCenter Portal's Personalization connection namespace for the connection you want to delete. If not specified or set to none, this command deletes connections configured to be available in all namespaces.

Property value as a string. Use None to remove a property value from the connection.

namespace

Optional. WebCenter Portal's Personalization connection namespace for the connection you want to change. If not specified or set to none, this command modifies properties of connections configured to be available in all namespaces.

registerWSRPProducer

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

Creates a connection to a WSRP portlet producer and registers the WRSP producer with a named WebCenter Portal application. When you create a WSRP producer connection, a Web Service connection is also created named <name>-wsconn where <name> is the value specified for the name argument.

portlets[/wsrp(1|2)]?WSDL is static text. The text entered here depends on how the producer is deployed.

For example:

http://myhost.com:7778/MyPortletApp/portlets/wsrp2?WSDL

proxyHost

Optional. Host name or IP address of the proxy server.

A proxy is required when the WebCenter Portal application and the remote portlet producer are separated by a firewall and an HTTP proxy is needed to communicate with the producer.

proxyPort

Optional. Port number on which the proxy server listens.

timeout

Optional. Timeout setting for communications with the producer, in seconds. For example, the maximum time the producer may take to register, deregister, or display portlets on WebCenter Portal pages. This argument defaults to 30.

Individual portlets may define their own timeout period, which takes precedence over the value expressed here.

registrationProperties

Optional. A list of registration properties and their values. The format of this argument must be a comma-separated list of valid registration properties, each followed by an equals symbol and the value. For example: name=Producer,key=123. The registration properties for a producer can be found using listWSRPProducerRegistrationProperties. See listWSRPProducerRegistrationProperties.

tokenType

Optional. Type of token profile to use for authentication with this WSRP producer.

When the argument enforcePolicyURI=1, valid values are:

USERNAME_WITHOUT_PASSWORD
(oracle/wss10_username_id_propagation_with_msg_protection_client_policy)—This policy provides message protection (integrity and confidentiality) and identity propagation for outbound SOAP requests in accordance with the WS-Security 1.0 standard. Credentials (user name only) are included in outbound SOAP request messages through a WS-Security UsernameToken header. No password is included.

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.

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.

WSS11_SAML_TOKEN_WITH_MSG_PROTECTION
(oracle/wss11_saml_token_with_message_protection_client_policy)—This policy provides message-level protection (integrity and confidentiality) and SAML token population for outbound SOAP requests in accordance with the WS-Security 1.1 standard. A SAML token, included in the SOAP message, is used in SAML-based authentication with sender vouches confirmation. This policy uses the symmetric key technology for signing and encryption, and WS-Security's Basic 128 suite of asymmetric key technologies for endorsing signatures.

WSS10_SAML_TOKEN_ONLY (oracle/wss10_saml_token_client_policy)—This policy provides SAML-based authentication for outbound SOAP request messages in accordance with the WS-Security 1.0 standard. The policy propagates user identity and is typically used in intra departmental deployments where message protection and integrity checks are not required.

This policy does not require any keystore configuration.

If the argument enforcePolicyURI=0, you can specify any valid Oracle Web Services Manager (OWSM) policy URI for the tokenType argument.

issuer

Optional. Name of the issuer of the token. The issuer name is the entity that vouches for the verification of the subject. For example: www.oracle.com.

This argument only applies when the tokenType is: SAML_TOKEN_WITH_MSG_PROTECTION, SAML_TOKEN_WITH_MSG_INTEGRITY, WSS10_SAML_TOKEN_ONLY, WSS11_SAML_TOKEN_WITH_MSG_PROTECTION.

defUser

Optional. User name to assert to the remote producer when the user is not authenticated with the WebCenter Portal application.

When unauthenticated, the identity anonymous is associated with the application user. The value anonymous may be inappropriate for the remote producer, so you may need to specify an alternative identity here. Keep in mind though, that in this case, the WebCenter Portal application has not authenticated the user so the default user you specify should be a low privileged user in the remote producer. If the user has authenticated to the application, the user's identity is asserted rather than the default user.

This argument only applies when the tokenType is: USERNAME_WITHOUT_PASSWORD, SAML_TOKEN_WITH_MSG_PROTECTION, SAML_TOKEN_WITH_MSG_INTEGRITY, WSS10_SAML_TOKEN_ONLY, WSS11_SAML_TOKEN_WITH_MSG_PROTECTION.

extApp

Optional. This argument applies when the tokenType is USERNAME_WITH_PASSWORD. If this producer uses an external application to store and supply user credentials for authentication, use this argument to name the associated external application.

keyStorePath

Optional. Full path to the key store that contains the certificate and the private key that is used for signing some parts of the SOAP message, such as the security token and SOAP message body. The selected file should be a key store created with the Java keytool.

keyStorePswd

Optional. Password to the key store that was set when the key store was created.

sigKeyAlias

Optional. Identifier for the certificate associated with the private key that is used for signing.

sigKeyPswd

Optional. Password for accessing the key identified by the alias that is specified using the sigKeyAlias argument.

encKeyAlias

Optional. Key alias to be used for encryption. A valid value is one of the key aliases that is located in the specified key store.

encKeyPswd

Optional. Password for accessing the encryption key.

recptAlias

Optional. Key store alias that is associated with the producer's certificate. This certificate is used to encrypt the message to the producer.

Do not specify a recipient key alias when the tokenType is SAML_TOKEN_WITH_MSG_INTEGRITY.

enforcePolicyURI

Optional. Valid values are 1 (true) and 0 (false).When set to 1, users must specify one of the following token profiles for the tokenType argument: USERNAME_WITHOUT_PASSWORD, USERNAME_WITH_PASSWORD, SAML_TOKEN_WITH_MSG_PROTECTION, SAML_TOKEN_WITH_MSG_INTEGRITY, WSS11_SAML_TOKEN_WITH_MSG_PROTECTION,WSS10_SAML_TOKEN_ONLY

When set to 0, users can specify any Oracle Web Services Manager (OWSM) policy URI. The user must ensure that the OWSM policy specified is valid.

The default value is 1.

server

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

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

applicationVersion

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

Examples

The following example registers a WSRP producer named WSRPSamples and registers the WSRP producer with an application named webcenter.

portlets[/wsrp(1|2)]?WSDL is static text. The text entered here depends on how the producer is deployed.

For example:

http://myhost:7778/MyPortletApp/portlets/wsrp2?WSDL

proxyHost

Optional. Host name or IP address of the proxy server.

A proxy is required when the WebCenter Portal application and the remote portlet producer are separated by a firewall and an HTTP proxy is needed to communicate with the producer.

proxyPort

Optional. Port number on which the proxy server listens.

timeout

Optional. Timeout setting for communications with the producer, in seconds. For example, the maximum time the producer may take to register, deregister, or display portlets on WebCenter Portal pages.

This argument defaults to 30.

Individual portlets may define their own timeout period, which takes precedence over the value expressed here.

extApp

Optional. This argument applies when the tokenType is USERNAME_WITH_PASSWORD. If this producer uses an external application to store and supply user credentials for authentication, use this argument to name the associated external application.

tokenType

Optional. Type of token profile to use for authentication with this WSRP producer.

When the argument enforcePolicyURI=1, valid values are:

USERNAME_WITHOUT_PASSWORD

(oracle/wss10_username_id_propagation_with_msg_protection_client_policy)—This policy provides message protection (integrity and confidentiality) and identity propagation for outbound SOAP requests in accordance with the WS-Security 1.0 standard. Credentials (user name only) are included in outbound SOAP request messages through a WS-Security UsernameToken header. No password is included.

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.

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.

(oracle/wss11_saml_token_with_message_protection_client_policy)—This policy enables message-level protection (integrity and confidentiality) and SAML token population for outbound SOAP requests in accordance with the WS-Security 1.1 standard. A SAML token, included in the SOAP message, is used in SAML-based authentication with sender vouches confirmation. This policy uses the symmetric key technology for signing and encryption, and WS-Security's Basic 128 suite of asymmetric key technologies for endorsing signatures.

WSS10_SAML_TOKEN_ONLY

(oracle/wss10_saml_token_client_policy)—This policy includes SAML-tokens in outbound SOAP request messages in accordance with the WS-Security 1.0 standard. The policy propagates user identity and is typically used in intra departmental deployments where message protection and integrity checks are not required.

This policy does not require any keystore configuration.

If the argument enforcePolicyURI=0, you can specify any valid Oracle Web Services Manager (OWSM) policy URI for the tokenType argument.

issuer

Optional. Name of the issuer of the token. The issuer name is the entity that vouches for the verification of the subject. For example: www.oracle.com.

This argument only applies when the tokenType is: SAML_TOKEN_WITH_MSG_PROTECTION, SAML_TOKEN_WITH_MSG_INTEGRITY, WSS10_SAML_TOKEN_ONLY, WSS11_SAML_TOKEN_WITH_MSG_PROTECTION.

defUser

Optional. User name to assert to the remote producer when the user is not authenticated with the WebCenter Portal application.

When unauthenticated, the identity anonymous is associated with the application user. The value anonymous may be inappropriate for the remote producer, so you may need to specify an alternative identity here. Keep in mind though, that in this case, the WebCenter Portal application has not authenticated the user so the default user you specify should be a low privileged user in the remote producer. If the user has authenticated to the application, the user's identity is asserted rather than the default user.

This argument only applies when the tokenType is: USERNAME_WITHOUT_PASSWORD, SAML_TOKEN_WITH_MSG_PROTECTION, SAML_TOKEN_WITH_MSG_INTEGRITY, WSS10_SAML_TOKEN_ONLY, WSS11_SAML_TOKEN_WITH_MSG_PROTECTION.

keyStorePath

Optional. Full path to the key store that contains the certificate and the private key that is used for signing some parts of the SOAP message, such as the security token and SOAP message body. The selected file should be a key store created with the Java keytool.

keyStorePswd

Optional. Password to the key store that was set when the key store was created.

sigKeyAlias

Optional. Identifier for the certificate associated with the private key that is used for signing.

sigKeyPswd

Optional. Password for accessing the key identified by the alias that is specified using the sigKeyAlias argument.

encKeyAlias

Optional. Key alias used by the producer to encrypt the return message. A valid value is one of the key aliases that is located in the specified key store. If not specified, the producer uses the signing key for encrypting the return message.

encKeyPswd

Optional. Password for accessing the encryption key.

recptAlias

Optional. Key store alias that is associated with the producer's certificate. This certificate is used to encrypt the outbound message to the producer.

Do not specify a recipient key alias when the tokenType is SAML_TOKEN_WITH_MSG_INTEGRITY.

enforcePolicyURI

Optional. Valid values are 1 (true) and 0 (false).When set to 1, users must specify one of the following token profiles for the tokenType argument: USERNAME_WITHOUT_PASSWORD, USERNAME_WITH_PASSWORD, SAML_TOKEN_WITH_MSG_PROTECTION, SAML_TOKEN_WITH_MSG_INTEGRITY, WSS11_SAML_TOKEN_WITH_MSG_PROTECTION, WSS10_SAML_TOKEN_ONLY

When set to 0, users can specify any Oracle Web Services Manager (OWSM) policy URI. The user must ensure that the OWSM policy specified is valid.

The default value is 1.

server

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

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

applicationVersion

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

Example

This example increases the timeout, for the WSRPSamples producer, to 60 seconds.

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

name

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

url

URL for the Oracle PDK-Java producer. Use the following syntax:

http://host_name:port_number/context_root/providers

Where:

host_name is the server where the producer is deployed

port_number is the HTTP Listener port number

context_root is the Web application's context root.

providers is static text. The text entered here depends on how the producer is deployed.

For example:

http://myHost:7778/myEnterprisePortlets/providers

serviceId

Optional. Service ID of the producer.

PDK-Java enables you to deploy multiple producers under a single adapter servlet. Producers are identified by their unique service ID. A service ID is required only if the service ID is not appended to the URL end point.

For example, the following URL endpoint requires sample as the service ID:

http://domain.us.oracle.com:7778/axyz/providers

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

http://domain.us.oracle.com:7778/axyz/providers/sample

The service ID is used to look up a file called <service_id>.properties, which defines the characteristics of the producer, such as whether to display its test page. Use any value to create the service ID.

proxyHost

Optional. Host name or IP address of the proxy server.

A proxy is required if the WebCenter Portal application and the remote portlet producer are separated by a firewall and an HTTP proxy is needed for communication with the producer.

proxyPort

Optional. Port number on which the proxy server listens. This argument defaults to 80.

sharedKey

Optional. Shared key used for message authentication with the remote producer. Message authentication ensures that the incoming messages are sent from a host with a shared key. This argument defaults to null.

The shared key can contain between 10 and 20 alphanumeric characters.

subscriberId

Optional. Consumer's identifier, if required.

When a producer is registered with an application, a call is made to the producer. During the call, the consumer (WebCenter Portal application in this instance) passes the value for subscriberId to the producer. The producer may be coded to use the subscriber ID.

timeout

Optional. Timeout setting for communications with the producer, in seconds. For example, the maximum time the producer may take to register, deregister, or display portlets on WebCenter Portal pages.

This argument defaults to 30.

Individual portlets may define their own timeout period, which takes precedence over the value expressed here.

establishSession

Optional. Enable a user session when executing portlets from this producer. Valid values are 1 (true) and 0 (false). The default for this argument is 0.

When sessions are enabled (1), the server maintains session-specific information, such as the user name. Message authentication uses sessions, so if a shared key is specified, this option should also be enabled. For sessionless communication between the producer and the server, specify 0.

externalApp

Optional. Name of the external application with which to associate the producer. Required if one of this producer's portlets requires authentication.

mapUser

Optional. Flag indicating whether the mapped user name from the external application should be passed to the producer. Valid values are 1 (true) and 0 (false). This argument defaults to 1.

server

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

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

applicationVersion

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

Example

The following example creates and registers an Oracle PDK-Java producer named JPDKSamples, for an application named webcenter.

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

name

Name of an existing PDK-Java producer.

url

URL for the Oracle PDK-Java producer. Use the following syntax:

http://host_name:port_number/context_root/providers

Where:

host_name is the server where the producer is deployed

port_number is the HTTP Listener port number

context_root is the Web application's context root.

providers is static text. The text entered here depends on how the producer is deployed.

For example:

http://myHost:7778/myEnterprisePortlets/providers

serviceId

Optional. Service ID of the producer.

PDK-Java enables you to deploy multiple producers under a single adapter servlet. Producers are identified by their unique service ID. A service ID is required only if the service ID is not appended to the URL end point.

For example the following URL endpoint requires sample as the service ID:

http://domain.us.oracle.com:7778/axyz/providers

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

http://domain.us.oracle.com:7778/axyz/providers/sample

The service ID is used to look up a file called <service_id>.properties, which defines the characteristics of the producer, such as whether to display its test page. Use any value to create the service ID.

proxyHost

Optional. Host name or IP address of the proxy server.

A proxy is required if the WebCenter Portal application and the remote portlet producer are separated by a firewall and an HTTP proxy is needed for communication with the producer.

proxyPort

Optional. Port number on which the proxy server listens.

subscriberId

Optional. Consumer's identifier, if required.

When a producer is registered with an application, a call is made to the producer. During the call, the consumer (WebCenter Portal application in this instance) passes the value for Subscriber ID to the producer. If the producer does not see the expected value for Subscriber ID, it might reject the registration call.

sharedKey

Optional. The shared key is used for message authentication with the remote producer. Message authentication ensures that the incoming messages are sent from a host with a shared key. You should enable sessions using the sharedKey argument, as well as the establishSession argument.

timeout

Optional. Timeout setting for communications with the producer, in seconds. For example, the maximum time the producer may take to register, deregister, or display portlets on WebCenter Portal pages.

Individual portlets may define their own timeout period, which takes precedence over the value expressed here.

establishSession

Optional. Enable a user session when executing portlets from this producer. Valid values are 1 (true) and 0 (false). You should enable sessions using the establishSession argument, as well as the sharedKey argument.

When sessions are enabled (1), the server maintains session-specific information, such as the user name. Message authentication uses sessions, so if a shared key is specified, this option should also be enabled. For sessionless communication between the producer and the server, set to 0.

externalApp

Optional. Name of the external application associated with this producer.

mapUser

Optional. Flag indicating whether the mapped user name from the external application should be passed to the producer. Valid values are 1 (true) and 0 (false).

server

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

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

applicationVersion

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

Example

The following example changes a PDK-Java producer registered with MyApp to use a proxy server.

If pagelets carry secure data, the URL registered must use the https protocol. For example:

https://myhost.com:7779/pagelets

Note: In the Spaces application, if the Pagelet Producer URL is protected by Oracle Access Manager (OAM), the URL to the pagelet catalog must be excluded (mapped directly without access control), or the catalog will appear to be empty when using REST. The pagelet catalog URL is: http://<proxy_host>:<proxy_port>/api/v2/ensemble/pagelets

server

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

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

applicationVersion

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

Example

The following example registers a pagelet producer with an application named webcenter.

Note: In the Spaces application, if the Pagelet Producer URL is protected by Oracle Access Manager (OAM), the URL to the pagelet catalog must be excluded (mapped directly without access control), or the catalog will appear to be empty when using REST. The pagelet catalog URL is: http://<proxy_host>:<proxy_port>/api/v2/ensemble/pagelets

server

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

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

applicationVersion

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

Example

The following example updates administrator user name and password details for an existing pagelet producer named MyPageletProducer:

User name that the WebCenter Portal application uses to authenticate itself as a trusted application to Oracle Secure Enterprise Search so that it may perform searches on behalf of WebCenter Portal users.

The specified user must be present in both the Oracle Identity Management server configured for the WebCenter Portal application and the Oracle Identity Management server configured for Oracle SES.

appPassword

Password for the user name specified.

default

Optional. Configures WebCenter Portal's Search service to actively use the search connection. Valid options are 1 (true) and 0 (false).

Setting to 1 replaces any other search connection that is being used. Setting to 0 does not change the current Search service configuration. This argument defaults to 0.

server

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

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

applicationVersion

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

Example

The following example creates a new search connection that points to the SES instance http://myhost.com:7777/search/query/OracleSearch and makes this connection the active SES search connection for a WebCenter Portal application named app1.

Syntax

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

verbose

Optional. Displays search connection details in verbose mode. Valid options are 1 (true) and 0 (false). When set to 1, listSESConnections lists all of the SES search connections that are configured for a WebCenter Portal application, along with their details. When set to 0, listSESConnections lists connection names only. This argument defaults to 0.

If you set this argument to 0, do not specify the name argument.

name

Optional. Name of an existing search connection. You can use this argument to view details about a specific connection.

server

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

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

applicationVersion

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

Examples

The following example displays connection details for all SES search connections configured for a WebCenter Portal application named WebCenterApp.

The following example changes the maximum number of search results that the Search service returns. No connection name is specified, in this example, so this configuration change is applied to the current default (or active) search connection.

wls:/weblogic/serverConfig> setSearchSESConfig(appName='webcenter', topNRows=500);
Already in Domain Runtime Tree
Restart is needed for the service connection changes to take effect.

listSearchSESConfig

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

Lists SES search settings for a WebCenter Portal application.

Syntax

listSearchSESConfig(appName, [server, applicationVersion])

Argument

Definition

appName

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

server

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

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

applicationVersion

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

Example

The following example displays SES search configuration information for a WebCenter Portal application named webcenter.

Delete discussion and announcement crawlers configured for a WebCenter Portal application, on an Oracle SES instance.

Online

createSpacesCrawler

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

Creates a crawler for Spaces objects on an Oracle SES instance. The command creates a WebCenter Portal datasource and specifies a schedule for crawling Spaces objects (such as spaces, lists, pages, and people).

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.

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

host

Host name of the machine where the WebCenter Portal application is running.

port

Port number used to access the WebCenter Portal application.

sesUrl

Web Service URL for the Oracle SES Administration API. Use the format: http://<host>:<port>/search/api/admin/AdminService

sesPassword

Password for the Oracle SES administrative user (eqsys).

configUrl

URL of the XML configuration file providing details of the source, such as the data feed type, location, security attributes, and so on.Use the URL format: http://<host>:<port>/cs
/idcplg? IdcService=SES_CRAWLER_DOWNLOAD_CONFIG
&source=<sourcename>

If the authentication type is Oracle SSO, then enter a user ID (and password) of a user in the identity management server fronted by Oracle SSO. This user must be granted the same permissions as sysadmin. If it is not possible to grant those permissions, then delete the "remote" user corresponding to this user in Content Server, and create a "local" version of the user (same name) in Content Server.

password

Password for the administrative user specified.

scratchDir

Local directory where Oracle SES can write temporary status logs. The directory must be on the system where Oracle SES is installed.

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.

createDiscussionsCrawler

Description

Creates a discussion forum crawler and an announcements crawler for a WebCenter Portal application, on an Oracle Secure Enterprise Search (SES) instance.

The command creates two Oracle SES database sources (one for discussion forums and one for announcements) and specifies a crawl schedule. The discussion forums source is named <appname_host_port>_forums with a view of FORUMCRAWLER_VW, and the announcements source is named <appname_host_port>_announcements with a view of ANNOUNCEMENTS_VW.

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.

If regular crawls are not required, choose MANUAL and then use the startDiscussionsCrawler command to initiate a crawl manually.

startHour

Time to start the crawl. Any number between 1 and 24.

For example, enter 2 for 2:00am, 14 for 2:00pm, and so on.

hoursBetweenLaunches

Number of hours between crawls.

Only valid when freqType='HOURLY'.

startDayOfWeek

Day on which to start a weekly crawl. For example, MONDAY, TUESDAY, and so on.

Only valid when freqType='WEEKLY'.

startDayOfMonth

Day of the month on which to start a monthly crawl. For example, enter 1 for 1st day of the month, 2 for 2nd day of the month, and so on.

Only valid when freqType='MONTHLY'.

daysBetweenLaunches

Number of days between crawls.

Only valid when freqType='DAILY'.

weeksBetweenLaunches

Number of weeks between crawls.

Only valid when freqType='WEEKLY'.

monthsBetweenLaunches

Number of months between crawls.

Only valid when freqType='MONTHLY'.

server

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

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

applicationVersion

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

Example

The following example creates a discussion forum crawler and an announcements crawler on the Oracle SES instance http://myseshost.com:7777 for a Spaces application (webcenter) located at http://myhost.com:8888/webcenter/spaces:

Syntax

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

sesUrl

Web Service URL for the Oracle SES Administration API. Use the format: http://<host>:<port>/search/api/admin/AdminService

sesPassword

Password for the Oracle SES administrative user (eqsys).

host

Host name of the machine where the Spaces application is running.

port

Port number used to access the Spaces application.

verbose

Optional. Valid options are 1 (true) and 0 (false). When set to 1, listSpacesCrawlers returns the Spaces crawler configured for a Spaces application in Oracle SES, along with details. When set to 0, only source names are listed. This argument defaults to 0.

server

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

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

applicationVersion

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

Example

The following example returns the Spaces crawler configured in the Oracle SES instance http://myseshost.com:7777 for a Spaces application named webcenter located at http://myhost.com:8888/webcenter/spaces:

Syntax

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

sesUrl

Web Service URL for the Oracle SES Administration API. Use the format: http://<host>:<port>/search/api/admin/AdminService

sesPassword

Password for the Oracle SES administrative user (eqsys).

host

Host name of the machine where the WebCenter Portal application is running.

port

Port number used to access the WebCenter Portal application.

verbose

Optional. Valid options are 1 (true) and 0 (false). When set to 1, listDocumentsCrawlers returns the documents crawler that is configured for a WebCenter Portal application in Oracle SES, along with details. When set to 0, only source names are listed. This argument defaults to 0.

server

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

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

applicationVersion

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

Example

The following example returns the documents crawler configured in the Oracle SES instance http://myseshost.com:7777 for a Spaces application named webcenter located at http://myhost.com:8888/webcenter/spaces:

Syntax

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

sesUrl

Web Service URL for the Oracle SES Administration API. Use the format: http://<host>:<port>/search/api/admin/AdminService

sesPassword

Password for the Oracle SES administrative user (eqsys).

host

Host name of the machine where the WebCenter Portal application is running.

port

Port number used to access the WebCenter Portal application.

verbose

Optional. Valid options are 1 (true) and 0 (false). When set to 1, listDocumentsCrawlers returns discussion and announcement crawlers that are configured for a WebCenter Portal application in Oracle SES, along with details. When set to 0, only source names are listed. This argument defaults to 0.

server

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

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

applicationVersion

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

Example

The following example returns discussion and announcement crawlers configured in the Oracle SES instance http://myseshost.com:7777 for a Spaces application named webcenter located at http://myhost.com:8888/webcenter/spaces:

Syntax

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

sesUrl

Web Service URL for the Oracle SES Administration API. Use the format: http://<host>:<port>/search/api/admin/AdminService

sesPassword

Password for the Oracle SES administrative user (eqsys).

host

Host name of the machine where the Spaces application is running.

port

Port number used to access the Spaces application.

server

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

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

applicationVersion

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

Example

The following example starts the Spaces crawler configured on the Oracle SES instance http://myseshost.com:7777 for a Spaces application named webcenter located at http://myhost.com:8888/webcenter/spaces:

Syntax

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

sesUrl

Web Service URL for the Oracle SES Administration API. Use the format: http://<host>:<port>/search/api/admin/AdminService

sesPassword

Password for the Oracle SES administrative user (eqsys).

host

Host name of the machine where the WebCenter Portal application is running.

port

Port number used to access the WebCenter Portal application.

server

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

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

applicationVersion

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

Example

The following example starts the document crawler configured on the Oracle SES instance http://myseshost.com:7777 for a Spaces application named webcenter located at http://myhost.com:8888/webcenter/spaces:

Syntax

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

sesUrl

Web Service URL for the Oracle SES Administration API. Use the format: http://<host>:<port>/search/api/admin/AdminService

sesPassword

Password for the Oracle SES administrative user (eqsys).

host

Host name of the machine where the WebCenter Portal application is running.

port

Port number used to access the WebCenter Portal application.

server

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

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

applicationVersion

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

Example

The following example starts the discussion and announcement crawlers configured on the Oracle SES instance http://myseshost.com:7777 for a Spaces application named webcenter located at http://myhost.com:8888/webcenter/spaces:

Syntax

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

sesUrl

Web Service URL for the Oracle SES Administration API. Use the format: http://<host>:<port>/search/api/admin/AdminService

sesPassword

Password for the Oracle SES administrative user (eqsys).

host

Host name of the machine where the Spaces application is running.

port

Port number used to access the Spaces application.

server

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

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

applicationVersion

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

Example

The following example stops the Spaces crawler configured on the Oracle SES instance http://myseshost.com:7777 for a Spaces application named webcenter located at http://myhost.com:8888/webcenter/spaces:

Syntax

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

sesUrl

Web Service URL for the Oracle SES Administration API. Use the format: http://<host>:<port>/search/api/admin/AdminService

sesPassword

Password for the Oracle SES administrative user (eqsys).

host

Host name of the machine where the WebCenter Portal application is running.

port

Port number used to access the WebCenter Portal application.

server

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

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

applicationVersion

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

Example

The following example stops the document crawler configured on the Oracle SES instance http://myseshost.com:7777 for a Spaces application named webcenter located at http://myhost.com:8888/webcenter/spaces:

Syntax

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

sesUrl

Web Service URL for the Oracle SES Administration API. Use the format: http://<host>:<port>/search/api/admin/AdminService

sesPassword

Password for the Oracle SES administrative user (eqsys).

host

Host name of the machine where the WebCenter Portal application is running.

port

Port number used to access the WebCenter Portal application.

server

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

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

applicationVersion

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

Example

The following example stops the discussion and announcement crawlers configured on the Oracle SES instance http://myseshost.com:7777 for a Spaces application named webcenter located at http://myhost.com:8888/webcenter/spaces:

Syntax

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

sesUrl

Web Service URL for the Oracle SES Administration API. Use the format: http://<host>:<port>/search/api/admin/AdminService

sesPassword

Password for the Oracle SES administrative user (eqsys).

host

Host name of the machine where the Spaces application is running.

port

Port number used to access the Spaces application.

server

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

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

applicationVersion

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

Example

The following example deletes the Spaces crawler configured on the Oracle SES instance http://myseshost.com:7777 for a Spaces application named webcenter located at http://myhost.com:8888/webcenter/spaces:

Syntax

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

sesUrl

Web Service URL for the Oracle SES Administration API. Use the format: http://<host>:<port>/search/api/admin/AdminService

sesPassword

Password for the Oracle SES administrative user (eqsys).

host

Host name of the machine where the WebCenter Portal application is running.

port

Port number used to access the WebCenter Portal application.

server

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

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

applicationVersion

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

Example

The following example deletes the document crawler configured on the Oracle SES instance http://myseshost.com:7777 for a Spaces application named webcenter located at http://myhost.com:8888/webcenter/spaces:

Syntax

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

sesUrl

Web Service URL for the Oracle SES Administration API. Use the format: http://<host>:<port>/search/api/admin/AdminService

sesPassword

Password for the Oracle SES administrative user (eqsys).

host

Host name of the machine where the WebCenter Portal application is running.

port

Port number used to access the WebCenter Portal application.

server

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

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

applicationVersion

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

Example

The following example deletes the discussion and announcement crawlers configured on the Oracle SES instance http://myseshost.com:7777 for a Spaces application named webcenter located at http://myhost.com:8888/webcenter/spaces:

Description

Syntax

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

server

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

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

applicationVersion

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

Example

The following example displays search configuration information for a WebCenter Portal application named webcenter.

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

setSpacesCrawlProperties

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

Specifies crawl properties for WebCenter Portal applications.

WebCenter Portal applications can be crawled by Oracle SES to provide a faster, more unified search experience across WebCenter Portal objects, specifically: spaces, lists, pages, people (profiles), wikis, blogs, documents, discussions, and announcements. Three distinct crawlers make this possible:

Spaces Crawler (for spaces, lists, pages, and people)

Documents Crawler (for documents, wikis, blogs)

Discussions Crawler (for discussions and announcements).

Use this command to enable or disable Oracle SES crawlers in WebCenter Portal applications:

Spaces application—To use Oracle SES crawlers in the Spaces application, you must enable all three crawlers.

Framework applications—To use Oracle SES crawlers in WebCenter Portal applications, you must enable both the documents and discussions crawlers. The Spaces crawler is not applicable.

(Spaces application only) You can also use this command to specify an interval between full crawls for the Spaces crawler. During a full crawl, all of the Spaces crawler content is re-read. Out-of-the-box, full crawls for the Spaces crawler occur every seven days but you can specify a different frequency to suit your installation.

Note that incremental crawls, for all three crawlers, are initiated by a scheduler running from Oracle SES. During these incremental crawls, only content added or updated since the previous crawl is processed.

oracle/wss10_saml_token_client_policy—use to access the BPEL server with the default, non message protected policy.

oracle/wss10_saml_token_with_message_protection_client_policy—use to access the BPEL server with a message protected policy. If selected, you must configure keys stores both in your WebCenter Portal application and in the BPEL application.

GPA—use if your environment supports Global Policy Attachments (GPA).

If you omit this argument, the connection defaults to oracle/wss10_saml_token_client_policy.

recipientKeyAlias

Optional. Recipient key alias to be used for message protected SAML policy authentication. Only required when the BPEL server connection is using a SAML token policy for authentication and the application's Worklist service is using multiple BPEL server connections.

oracle/wss10_saml_token_client_policy—use to access the BPEL server with the default, non message protected policy.

oracle/wss10_saml_token_with_message_protection_client_policy—use to access the BPEL server with a message protected policy. If selected, you must configure keys stores both in your WebCenter Portal application and in the BPEL application.

GPA—use if your environment supports Global Policy Attachments (GPA).

If you omit this argument, the connection defaults to oracle/wss10_saml_token_client_policy.

recipientKeyAlias

Optional. Recipient key alias to be used for message protected SAML policy authentication. Only required when the BPEL server connection is using a SAML token policy for authentication and the application's Worklist service is using multiple BPEL server connections.

listBPELConnections

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

Without any arguments, this command lists all the BPEL connections that are configured for a specific WebCenter Portal application. All BPEL connections are listed, even connections not currently used.

Syntax

Name of the WebCenter Portal application for which to list BPEL server connections.

verbose

Optional. Displays BPEL server connection details in verbose mode. Valid options are 1 (true) and 0 (false). When set to 1, listBPELConnections lists all of the BPEL server connections that are configured, along with their details. When set to 0, listBPELConnections lists connection names only. This argument defaults to 0.

If you set this argument to 0, do not specify the name argument.

name

Optional. Name of an existing BPEL server connection. You can use this argument to view details about a specific connection.

To list all the connections, omit the name argument.

server

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

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

applicationVersion

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

Examples

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

addWorklistConnection

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

Enable an existing BPEL server connection for Worklist services. The Worklist service supports multiple connections so that WebCenter Portal users can monitor and manage assignments and notifications from a range of BPEL servers.

Syntax

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

verbose

Optional. Displays BPEL server connection details in verbose mode. Valid options are 1 (true) and 0 (false). When set to 1, listWorklistConnections lists all of the BPEL server connections that are configured for the Worklist service, along with their details. When set to 0, listWorklistConnections lists connection names only. This argument defaults to 0.

If you set this argument to 0, do not specify the name argument.

name

Optional. Name of an existing BPEL server connection. You can use this argument to view details about a specific connection.

To list all connections, omit the name argument.

server

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

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

applicationVersion

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

Examples

The following example lists the names of all of the BPEL server connections that are configured for the Worklist service.

setSpacesWorkflowConnectionName

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

Specifies the BPEL server connection that the Spaces application uses for internal workflows. The Spaces application uses a BPEL server included with the Oracle SOA Suite to host internal workflows, such as spacemembership notifications, spacesubscription requests, and so on. The connection name specified here must be a valid BPEL server connection.

refreshGroupSpaceCache

Description

WebCenter Spaces 11.1.1.2.0 (and later) uses tables (referred to as the Spaces Cache) to store space metadata and security-related data. When you migrate from WebCenter Spaces 11.1.1.1.0 to 11.1.1.2.0, you must run the refreshGroupSpaceCache command so that all your existing space data is migrated to the new 'Spaces Cache'.

security - Refreshes the cache with security data stored in the policy store. The security data that is stored includes member data for the space, whether or not a space is public, and whether or not a space is accessible to users assigned the Authenticated-User role (in earlier releases this role was named Spaces-User).

metadata - Refreshes the cache with space-related metadata stored in MDS. The data that is stored includes metadata information such as the display name, keywords, icon, logo, and so on.

all - Refreshes the cache with data stored in MDS and the policy store.

syncMode

Optional. Indicates whether to refresh the Spaces application in synchronous or asynchronous mode.

Valid values are 1 and 0. The default value is 1.

When set to 1, the refresh process runs in synchronous mode.

When set to 0, the refresh is asynchronous, that is, a new thread is spawned for the refresh process.

Synchronous mode is recommended.

cleanCache

Optional. Indicates whether to clear the Spaces Cache. Valid values are 1 and 0. The default value is 0.

When set to 0, the content of the Spaces application is not cleared during the refresh operation.

Always set this value to 0 for migration.

Use the 1 value only when importing an entire application, in which case the entire data available in the Spaces Cache is overwritten.

Example

The following examples update the cache to include all space-related metadata (in MDS) and security data (in the policy store) in synchronous mode:

The following example updates the Spaces Cache to include space-related metadata (in MDS) and security data (in the policy store) for two spaces named MyGroupSpace1 and MyGroupSpace2. The cache refreshes in synchronous mode.

refreshSpaceTemplateCache

Description

WebCenter Spaces 11.1.1.2.0 (and later) uses tables (referred to as the Space Templates Cache) to store space template metadata and security-related data. When you migrate from WebCenter Spaces 11.1.1.1.0 to 11.1.1.2.0, you must run the refreshSpaceTemplateCache command so that all your existing template data is migrated to the new 'Space Templates Cache'.

security - Refreshes the cache with security data stored in the policy store. The security data that is stored includes member data for the space template, whether or not a space template is public, and whether or not a space template is accessible to users assigned the Authenticated-User role (in earlier releases this role was named Spaces-User).

metadata - Refreshes the cache with space template-related metadata stored in MDS. The data that is stored includes metadata information such as the display name, keywords, icon, logo, and so on.

all - Refreshes the Space Template Cache with data stored in MDS and the policy store.

syncMode

Optional. Indicates whether to refresh the Spaces application in synchronous or asynchronous mode.

Valid values are 1 and 0. The default value is 1.

When set to 1, the refresh process runs in synchronous mode.

When set to 0, the refresh is asynchronous, that is, a new thread is spawned for the refresh process.

Synchronous mode is recommended.

cleanCache

Optional. Indicates whether to clear the Space Templates Cache. Valid values are 1 and 0. The default value is 0.

When set to 0, the content of the Spaces application is not cleared during the refresh operation.

Always set this value to 0 for migration.

Use the 1 value only when importing an entire application, in which case the entire data available in the Space Templates Cache is overwritten.

Example

The following examples update the cache to include all space template-related metadata (in MDS) and security data (in the policy store) in synchronous mode:

The following example updates the Space Templates Cache to include space template related metadata (in MDS) and security data (in the policy store) for two space templates named MySpaceTemplate1 and MySpaceTemplate2. The cache refreshes in synchronous mode.

Syntax

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

narrowSearchTimeout

Optional. Maximum time allowed (in ms) for small, simple searches, such as fetching a single user from the identity store. The out-of-the-box default is 30000ms.

broadSearchTimeout

Optional. Maximum time allowed (in ms) to return large result sets, such as returning users and roles that match a name pattern. The out-of-the-box default is 60000.

maxSearchFilters

Optional. Number of search filters allowed for the WebCenter Portal application's identity store. The maximum allowed, out-of-the-box, is 100.

Some identity store searches are executed using search filters which are converted into LDAP search calls. If your associated LDAP server limits the search condition, you can set the maxSearchFilters property to match your LDAP server setting.

maxFetchRecords

Optional. Maximum number of records to be returned from each search query. The out-of-the-box default is 100.

The value of this setting will impact the performance of your LDAP server so take this into consideration when increasing the search result limit.

Note that the LDAP server imposes its own search result limit, so the actual limit that is used will be the lesser of these two values.

server

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

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

applicationVersion

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

Name of the export archive EAR file to which you want the export to be written.

exportCustomizations

Optional. Valid values are 1 (true) and 0 (false). When set to 1, all application customizations are exported. When set to 0, application customizations are not exported, that is, default task flows are exported without any customizations. This argument defaults to 1.

exportData

Optional. Valid values are 1 (true) and 0 (false). When set to 1, data stored in the Spaces database for activity streams, events, feedback, lists, links, message boards, people connections, profiles, and tags is exported. Notes data stored in the MDS repository is exported too. When set to 0, this data is not exported. This argument defaults to 0.

server

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

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

applicationVersion

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

Examples

The following example exports a Spaces application and all possible data to a file named myExport.ear.