This chapter describes WebLogic Scripting Tool (WLST) commands for Oracle WebCenter. These commands enable you to configure WebCenter applications from the command-line. For additional details about WebCenter application configuration, see Oracle Fusion Middleware Administrator's Guide for Oracle WebCenter.
Notes:
To use these commands, you must invoke WLST from the Oracle home in which the component has been installed. See "Using Custom WLST Commands" in the Oracle Fusion Middleware Administrator's Guide.Most configuration changes made using WebCenter WLST commands are only effective after you restart the Managed Server on which the WebCenter application is deployed. The only exceptions are the External Applications, Portlet Producers, and WebCenter Import and Export WLST commands.
WebCenter WLST commands are described in the following sections:
Oracle WebCenter WLST commands are grouped into the following categories (Table 5-1).
Most configuration changes made using WebCenter WLST commands are only effective after you restart the Managed Server on which the WebCenter application is deployed. The only exceptions are the External Applications, Portlet Producers, and WebCenter Import and Export WLST commands.
Table 5-1 WLST Command Categories
| Command Category | Description |
|---|---|
|
Manage WebCenter connections. |
|
|
Manage content repository connections and configure the Documents service. |
|
|
Manage discussions server connections. |
|
|
Manage external application connections. |
|
|
Manage instant messaging and presence server connections. |
|
|
Manage mail server connections. |
|
|
Manage personal event server connections. |
|
|
Manage portlet producers. |
|
|
Manage proxy settings for the RSS service. |
|
|
Manage Oracle Secure Enterprise Search (SES) connections and other search-related properties. |
|
|
Manage search crawlers for WebCenter Spaces. |
|
|
Manage BPEL server connections. |
|
|
Manage the BPEL connection for WebCenter Spaces workflows. |
|
|
Manage wiki and blog server connections. |
|
|
Configure options for searching a WebCenter application's identity store. |
|
|
Export and import WebCenter Spaces applications, group spaces, group space templates, and producer metadata. |
Use the General commands, listed in Table 5-2, to manage WebCenter connections.
Configuration changes made using these WebCenter WLST commands are only effective after restarting the Managed Server on which the WebCenter application is deployed. For details, see Oracle Fusion Middleware Administrator's Guide for Oracle WebCenter.
Table 5-2 General WLST Commands
| Use This Command... | To... | Use with WLST... |
|---|---|---|
|
Delete any WebCenter connection. |
Online |
Module: Oracle WebCenter
Use with WLST: Online
Deletes a named WebCenter connection.
If you use deleteConnection to delete a WSRP or PDK-Java producer connection (instead of using deregisterWSRPProducer or deregisterPDKJavaProducer), unused secondary connections will remain, which you might want to remove. For example, when you delete a WSRP producer connection, its associated Web Service connection remains; when you delete a PDK-Java producer connection, its associated URL connection remains.
deleteConnection(appName, name, [server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the WebCenter application in which you want to perform this operation. |
name
|
Connection name. |
server
|
Optional. Name of the managed server where the WebCenter application is deployed. For example, WLS_Spaces.
Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the WebCenter application is deployed. |
Use the commands listed in Table 5-3 to manage content repository connections and configure the Documents service for a WebCenter application.
Configuration changes made using these WebCenter WLST commands are only effective after your restart the Managed Server on which the WebCenter application is deployed. For details, see Oracle Fusion Middleware Administrator's Guide for Oracle WebCenter.
Table 5-3 Content Repository WLST Commands
| Use this command... | To... | Use with WLST... |
|---|---|---|
|
Create an Oracle Content Server repository connection. |
Online |
|
|
Edit an existing Oracle Content Server connection. |
Online |
|
|
List individual or all Oracle Content Server connections that are configured for a WebCenter application. |
Online |
|
|
Create an Oracle Portal repository connection. |
Online |
|
|
Edit an existing Oracle Portal repository connection. |
Online |
|
|
List all Oracle Portal connections that are configured for a WebCenter application. |
Online |
|
|
Create a connection to a file system. |
Online |
|
|
Edit an existing file system repository connection. |
Online |
|
|
List individual or all file system connections configured for a WebCenter application. |
Online |
|
|
List properties for the back-end Oracle Content Server repository that is being used by WebCenter Spaces. |
Online |
|
|
Modify properties for the back-end Oracle Content Server repository used by WebCenter Spaces. |
Online |
|
|
Delete properties for the back-end Oracle Content Server repository used by WebCenter Spaces. |
Online |
Module: Oracle WebCenter
Use with WLST: Online
Creates an Oracle Content Server repository connection, for a named WebCenter application.
createJCRContentServerConnection(appName, name, socketType, [url, serverHost, serverPort, keystoreLocation, keystorePassword, privateKeyAlias, privateKeyPassword, cacheInvalidationInterval, binaryCacheMaxEntrySize, adminUsername, adminPassword, extAppId, timeout, isPrimary, server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the WebCenter application in which you want to perform this operation. |
name
|
Connection name. The name must be unique (across all connection types) within the WebCenter application. |
socketType
|
Specifies whether the Oracle Content Server connects on the content server listener port or the Web server filter, and whether the listener port is SSL enabled. Valid values are socket, web, and socketssl. This option has no default.
Choose from:
|
url
|
Optional. Oracle Content Server URL. Required only if socketType is set to web. URL should be in the format: http://<hostname>:<port>/<web root>/<plugin root>
For example, |
serverHost
|
Optional. Host name of the machine where the Oracle Content Server is running. Required if socketType is set to socket or socketssl. |
serverPort
|
Optional. Port on which the Oracle Content Server listens. Required if socketType is set to socket or socketssl:
For example, |
keystoreLocation
|
Optional. Location of key store that contains the private key used to sign the security assertions. Required only if socketType is set to socketssl.
The key store location must be an absolute path. |
keystorePassword
|
Optional. Password required to access the key store. Required only if socketType is set to socketssl. |
privateKeyAlias
|
Optional. Client private key alias in the key store. The key is used to sign messages to the server. The public key corresponding to this private key must be imported in the server keystore.
Required only if |
privateKeyPassword
|
Optional. Password to be used with the private key alias in the key store. Required only if socketType is set to socketssl. |
cacheInvalidationInterval
|
Optional. Polling interval (in minutes) used by the Oracle Content Server service provider interface (SPI) to check for cache invalidations. Defaults to 0 which means that cache invalidation is disabled. The minimum interval is 2 minutes. |
binaryCacheMaxEntrySize
|
Optional. Maximum size (in bytes) for documents that are cached in the virtual content repository (VCR) binary cache. Defaults is 1024 bytes (1K). |
adminUsername
|
Optional. User name with administrative rights for this Oracle Content Server instance. Defaults to sysadmin. |
adminPassword
|
Optional. Password for the Oracle Content Server administrator. Required when socketType is set to web. |
extAppId
|
Optional. External application used to authenticate WebCenter users against the Oracle Content Server. This value should match the name of an existing external application connection. See also listExtAppConnections. If extAppId is not set, no change is made to the authentication method or external application ID.
If |
timeout
|
Optional. Length of time allowed to log in to Oracle Content Server (in ms) before issuing a connection timeout message. If no timeout is set, there is no time limit for the login operation. |
isPrimary
|
Optional. Valid string values are true and false (note that single quotes should surround true and false). true specifies that this connection is the primary connection used by the Documents service. This argument defaults to false.
In WebCenter Spaces, the primary connection is used to store group space folders and personal space folders. |
server
|
Optional. Name of the managed server where the WebCenter application is deployed. For example, WLS_Spaces.
Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the WebCenter application is deployed. |
The following example creates a socket-based connection to an Oracle Content Server running on myhost.com at port 4444. For authentication purposes, an existing external application named myExtApp is used. See also, createExtAppConnection.
wls:/weblogic/serverConfig> createJCRContentServerConnection(appName='webcenter', name='myContentServerConnection', socketType='socket', serverHost='myhost.com', serverPort='4444', extAppId='myExtApp', isPrimary='true')
The following example creates an SSL socket-based connection to an Oracle Content Server repository.
wls:/weblogic/serverConfig> createJCRContentServerConnection(appName='webcenter', name='myContentServerConnection', socketType='socketssl', serverHost='myhost.com', serverPort='4444', keystoreLocation='d:/keys/here', keystorePassword='AlphaSquad7', privateKeyAlias='enigma', privateKeyPassword='S0larPl3x1s', extAppId='myExtApp')
Module: Oracle WebCenter
Use with WLST: Online
Edits an existing Oracle Content Server connection. This command requires that you specify values for appName and name, plus one additional argument.
setJCRContentServerConnection(appName, name, [socketType, url, serverHost, serverPort, keystoreLocation, keystorePassword, privateKeyAlias, privateKeyPassword, cacheInvalidationInterval, binaryCacheMaxEntrySize, adminUsername, adminPassword, extAppId, timeout, isPrimary, server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the WebCenter application in which you want to perform this operation. |
name
|
Name of an existing Oracle Content Server connection. |
socketType
|
Optional. Specifies whether the Oracle Content Server connects on the content server listener port or the Web server filter, and whether the listener port is SSL enabled. Valid values are socket, web, and socketssl. This option has no default.
Choose from:
|
url
|
Optional. Oracle Content Server URL. Required only if socketType is set to web. URL should be in the format: http://<hostname>:<port>/<web root>/<plugin root>
For example, |
serverHost
|
Optional. Host name of the machine where the Oracle Content Server is running. Required if socketType is set to socket or socketssl. |
serverPort
|
Optional. Port on which the Oracle Content Server listens. Required if socketType is set to socket or socketssl:
For example, |
keystoreLocation
|
Optional. Location of key store that contains the private key used to sign the security assertions. Required only if socketType is set to socketssl.
The key store location must be an absolute path. |
keystorePassword
|
Optional. Password required to access the key store. Required only if socketType is set to socketssl. |
privateKeyAlias
|
Optional. Client private key alias in the key store. Required only if socketType is set to socketssl. The value for this argument must be a string that contains neither special characters nor white space. |
privateKeyPassword
|
Optional. Password to be used with the private key alias in the key store. Required only if socketType is set to socketssl. |
cacheInvalidationInterval
|
Optional. Polling interval (in minutes) used by the Oracle Content Server service provider interface (SPI) to check for cache invalidations. Defaults to 0 which means that cache invalidation is disabled. The minimum interval is 2 minutes. |
binaryCacheMaxEntrySize
|
Optional. Maximum size (in bytes) for documents that are cached in the virtual content repository (VCR) binary cache. Defaults is 1024 bytes (1K). |
adminUsername
|
Optional. User name with administrative rights for this Oracle Content Server instance. Defaults to sysadmin. |
adminPassword
|
Optional. Password for the Oracle Content Server administrator. Required when socketType is set to web. |
extAppId
|
Optional. External application used to authenticate WebCenter users against the Oracle Content Server. This value should match the name of an existing external application connection. See also listExtAppConnections. If extAppId is not set, no change is made to the authentication method or external application ID.
If |
timeout
|
Optional. Length of time allowed to log in to Oracle Content Server (in ms) before issuing a connection timeout message. If no timeout is set, there is no time limit for the login operation. |
isPrimary
|
Optional. Valid string values are true and false (note that single quotes should surround true and false). true specifies that this connection is the primary connection used by the Documents service. This argument defaults to false.
In WebCenter Spaces, the primary connection is used to store group space folders and personal space folders. |
server
|
Optional. Name of the managed server where the WebCenter application is deployed. For example, WLS_Spaces.
Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the WebCenter application is deployed. |
The following example edits a socket-based connection to an Oracle Content Server.
wls:/weblogic/serverConfig>setJCRContentServerConnection(appName='webcenter', name='myContentServerConnection', socketType='socket', serverHost='myhost.com', serverPort='4444', extAppId='myExtApp', isPrimary='true')
The following example edits an SSL socket-based connection to an Oracle Content Server.
wls:/weblogic/serverConfig>setJCRContentServerConnection(appName='webcenter', name='myContentServerConnection', socketType='socketssl', serverHost='myhost.com', serverPort='8443', keystoreLocation='d:/keys/here', keystorePassword='T0PS3CR3T', privateKeyAlias='TekJansen', privateKeyPassword='LadyNocturne', extAppId='myExtApp', isPrimary='true')
Module: Oracle WebCenter
Use with WLST: Online
Without any arguments, this command lists all of the Oracle Content Server connections that are configured for a named WebCenter application.
listJCRContentServerConnections(appName, [verbose], [name, server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the WebCenter application in which you want to perform this operation. |
verbose
|
Optional. Displays content repository connection details in verbose mode. Valid options are true and false. When set to true, listJCRContentServerConnections lists all Oracle Content Server connections that are configured for a WebCenter application, along with their details. When set to false, only connection names are listed. This argument defaults to false. |
name
|
Optional. Name of an existing Oracle Content Server connection. When specified you can view connection details for a specific Oracle Content Server connection. If you supply a value for name, you must supply a value for verbose. |
server
|
Optional. Name of the managed server where the WebCenter application is deployed. For example, WLS_Spaces.
Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the WebCenter application is deployed. |
The following example lists Oracle Content Server connections configured for an application named webcenter.
wls:/weblogic/serverConfig> listJCRContentServerConnections(appName='webcenter')
The following example lists all properties of the Oracle Content Server connection named myContentServerConnection1. The connection named myContentServerConnection1 must exist and be an Oracle Content Server connection. If, for example, you specify an Oracle Portal connection, the properties are not listed and an error is displayed.
wls:/weblogic/serverConfig>listJCRContentServerConnections(appName='webcenter', verbose=true, name='myContentServerConnection1')
Module: Oracle WebCenter
Use with WLST: Online
createJCRPortalConnection(appName, name, dataSource, [extAppId, isPrimary, timeout, server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the WebCenter application in which you want to perform this operation. |
name
|
Connection name. The name must be unique (across all connection types) within the WebCenter application. |
dataSource
|
JNDI DataSource location used to connect to the portal. For example: jdbc/MyPortalDS
The datasource must be on the server where the WebCenter application is deployed. |
extAppId
|
Optional. External application used to authenticate WebCenter users against Oracle Portal. This value should match the name of an existing external application connection. See also listExtAppConnections. If extAppId is not set, no change is made to the authentication method or external application ID.
If |
timeout
|
Optional. Length of time allowed to log in to Oracle Portal (in ms) before issuing a connection timeout message. If no timeout is set, there is no time limit for the login operation. |
isPrimary
|
Optional. Valid string values are true and false. true specifies that this connection is the primary connection used by the Documents service. This argument defaults to false.
In WebCenter Spaces, the primary connection must be an Oracle Content Server connection. |
server
|
Optional. Name of the managed server where the WebCenter application is deployed. For example, WLS_Spaces.
Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the WebCenter application is deployed. |
The following example creates a Oracle Portal connection named myPortalConnection using the data source jdbc/portalDS and specifies that an external application, named myExtApp, is used for authentication.
wls:/weblogic/serverConfig> createJCRPortalConnection(appName='myApp', name='myPortalConnection', dataSource='jdbc/portalDS', extAppId='myExtApp', isPrimary='true')
Module: Oracle WebCenter
Use with WLST: Online
Edits an existing Oracle Portal connection. This command requires that you specify values for either the dataSource or isPrimary argument.
setJCRPortalConnection(appName, name, [dataSource, extAppId, timeout, isPrimary, server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the WebCenter application in which you want to perform this operation. |
name
|
Name of an existing Oracle Portal connection. |
dataSource
|
Optional. JNDI DataSource location used to connect to the portal. For example: jdbc/MyPortalDS
The datasource must be on the server where the WebCenter application is deployed. |
extAppId
|
Optional. External application used to authenticate WebCenter users against Oracle Portal. This value should match the name of an existing external application connection. See also listExtAppConnections. If extAppId is not set, no change is made to the authentication method or external application ID.
If |
timeout
|
Optional. Length of time allowed to log in to Oracle Portal (in ms) before issuing a connection timeout message. If no timeout is set, there is no time limit for the login operation. |
isPrimary
|
Optional. Valid string values are true and false. true specifies that this connection is the primary connection used by the Documents service. When set to false, and the specified connection is the primary connection used by the Documents service, the primary connection is reset. If this parameter is not set, the primary connection used by the Documents service does not change. This argument has no default.
In WebCenter Spaces, the primary connection must be an Oracle Content Server connection. |
server
|
Optional. Name of the managed server where the WebCenter application is deployed. For example, WLS_Spaces.
Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the WebCenter application is deployed. |
Module: Oracle WebCenter
Use with WLST: Online
Without any arguments, this command lists all of the Oracle Portal connections that are configured for a named WebCenter application.
listJCRPortalConnections(appName, [verbose, name, server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the WebCenter application in which you want to perform this operation. |
verbose
|
Optional. Displays content repository connection details in verbose mode. Valid options are true and false. When set to true, listJCRPortalConnections lists all Oracle Portal connections that are configured for a WebCenter application, along with their details. When set to false, only connection names are listed. This argument defaults to false. |
name
|
Optional. Name of an existing Oracle Portal connection. When specified you can view connection details for a specific Oracle Portal connection. If you supply a value for name, you must supply a value for verbose. |
server
|
Optional. Name of the managed server where the WebCenter application is deployed. For example, WLS_Spaces.
Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the WebCenter application is deployed. |
Module: Oracle WebCenter
Use with WLST: Online
Creates a connection to a file system repository.
Note:
File system connections must not be used in production or enterprise application deployments. This feature is provided for development purposes only.createJCRFileSystemConnection(appName, name, path, [isPrimary, server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the WebCenter application in which you want to perform this operation. |
name
|
Connection name. The name must be unique (across all connection types) within the WebCenter application. |
path
|
Full path to a folder whose contents you want to expose through this file system connection. For example, if you have a folder called C:\ProjectDocuments and you want to use that folder with the Documents service, you need to specify this folder as the path argument to this command. |
isPrimary
|
Optional. Valid values are true and false. true specifies that this connection is the primary connection used by the Documents service. When set to false, and when the specified connection is the primary connection used by the Documents service, the primary connection is reset. If this parameter is not set, the primary connection used by the Documents service does not change. This argument has no default.
In WebCenter Spaces, the primary connection must be an Oracle Content Server connection. |
server
|
Optional. Name of the managed server where the WebCenter application is deployed. For example, WLS_Spaces.
Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the WebCenter application is deployed. |
Module: Oracle WebCenter
Use with WLST: Online
Edits an existing file system repository connection. This command requires that you specify values for either the path or isPrimary arguments.
Note:
File system connections must not be used in production or enterprise application deployments. This feature is provided for development purposes only.setJCRFileSystemConnection(appName, name, [path, [isPrimary, server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Application name in which you want to set Document service properties. |
name
|
Name for the connection to be used by the Documents service. |
path
|
Optional. Full path to a folder whose contents you want to expose through this file system connection. For example, if you have a folder called C:\ProjectDocuments and you want to use that folder with the Documents service, you need to specify this folder as the path argument to this command. |
isPrimary
|
Optional. Valid values are true and false. When set to true, specifies that this connection is the primary connection used by the Documents service. When set to false, and when the specified connection is the primary connection used by the Documents service, the primary connection is reset. If this parameter is not set, the primary connection used by the Documents service does not change. This argument has no default.
Note that in WebCenter Spaces, the primary connection must be an Oracle Content Server connection. |
server
|
Optional. Name of the managed server where the WebCenter application is deployed. For example, WLS_Spaces.
Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the WebCenter application is deployed. |
Module: Oracle WebCenter
Use with WLST: Online
Without any arguments, this command lists all of the file system connections that are configured for a named WebCenter application.
Note:
File system connections must not be used in production or enterprise application deployments. This feature is provided for development purposes only.listJCRFileSystemConnections(appName, [verbose], [name, server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the WebCenter application in which you want to perform this operation. |
verbose
|
Optional. Displays content repository connection details in verbose mode. Valid options are true and false. When set to true, listJCRFileSystemConnections lists all file system connections that are configured for a WebCenter application, along with their details. When set to false, only connection names are listed. This argument defaults to false. |
name
|
Optional. Name of an existing file system connection. When specified you can view connection details for a specific file system connection. If you supply a value for name, you must supply a value for verbose. |
server
|
Optional. Name of the managed server where the WebCenter application is deployed. For example, WLS_Spaces.
Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the WebCenter application is deployed. |
The following example lists all of the file system connections that are configured for an application named webcenter.
wls:/weblogic/serverConfig> listJCRFileSystemConnections(appName='webcenter')
The following example lists all of the file system connections that are configured, in verbose mode.
wls:/weblogic/serverConfig> listJCRFileSystemConnections(appName='webcenter', verbose=true)
Module: Oracle WebCenter
Use with WLST: Online
Lists properties for the back-end Oracle Content Server repository that is being used by WebCenter Spaces to store group space and personal space documents. This command is only valid for the WebCenter Spaces application.
listDocumentsSpacesProperties(appName, [server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the WebCenter Spaces application in which you want to perform this operation—always webcenter. |
server
|
Optional. Name of the managed server where the WebCenter application is deployed. For example, WLS_Spaces.
Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the WebCenter application is deployed. |
Module: Oracle WebCenter
Use with WLST: Online
Modifies properties for the back-end Oracle Content Server repository that is being used by WebCenter Spaces to store group space data. This command is only valid for the WebCenter Spaces application.
setDocumentsSpacesProperties(appName, [spacesRoot, adminUserName, applicationName, server, applicationVersion])
| Argument | Definition |
|---|---|
| appName | Name of the WebCenter Spaces application in which you want to perform this operation—always webcenter. |
spacesRoot
|
Optional. Root folder under which group space content is stored. The value for this argument must use the format: /foldername. For example, /WebCenter or /WebCenterSpaces. The spacesRoot cannot be /, the root itself, and it must be unique across applications. If the folder specified does not exist it will be created for you.
Note that if you provide a value for this argument, you must also provide values for the |
adminUserName
|
Optional. User name of the content repository administrator. For example: sysadmin. Note that if you provide a value for this argument, you must also provide values for the spacesRoot and applicationName arguments.
Administrative privileges are required for this connection so that operations can be performed on behalf of WebCenter users. |
applicationName
|
Optional. Unique WebCenter Spaces application identifier. This name is used to separate data when multiple WebCenter Spaces applications share the same content repository, and must be unique across applications. The value for this argument must begin with an alphabetical character, followed by any combination of alphanumeric characters or the underscore character. The string must be less than or equal to 30 characters. Note that if you provide a value for this argument, you must also provide values for the spacesRoot and adminUserName arguments. |
server
|
Optional. Name of the managed server where the WebCenter application is deployed. For example, WLS_Spaces.
Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the WebCenter application is deployed. |
The following example modifies connection properties for the back-end Oracle Content Server repository that is being used by WebCenter Spaces to store group space and personal space documents.
wls:/weblogic/serverConfig> setDocumentsSpacesProperties(appName='webcenter', spacesRoot='/AccountingSpaces', adminUserName='admin', applicationName='WCAccounting')
The following example modifies the administrator's user name for the back-end Oracle Content Server repository that is being used by WebCenter Spaces to store group space and personal space documents.
wls:/weblogic/serverConfig> setDocumentsSpacesProperties(appName='webcenter', adminUserName='sysadmin')
Module: Oracle WebCenter
Use with WLST: Online
Deletes properties for the back-end Oracle Content Server repository used by WebCenter Spaces, that is the adminUserName, applicationName, and spacesRoot. This command is only valid for the WebCenter Spaces application.
deleteDocumentsSpacesProperties(appName, [server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the WebCenter Spaces application in which you want to perform this operation—always webcenter. |
server
|
Optional. Name of the managed server where the WebCenter application is deployed. For example, WLS_Spaces.
Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the WebCenter application is deployed. |
Use the commands listed in Table 5-4 to manage discussions server connections for WebCenter applications.
Configuration changes made using these WebCenter WLST commands are only effective after your restart the Managed Server on which the WebCenter application is deployed. For details, see Oracle Fusion Middleware Administrator's Guide for Oracle WebCenter.
Table 5-4 Discussion and Announcement WLST Commands
| Use this command... | To... | Use with WLST... |
|---|---|---|
|
Create a new discussions server connection for a WebCenter application. |
Online |
|
|
Edit an existing discussions server connection. |
Online |
|
|
Set an additional discussions server connection property. |
Online |
|
|
Delete a discussions server connection property. |
Online |
|
|
List all of the discussions server connections that are configured for an application. |
Online |
|
|
List the default discussions server connection for an application. |
Online |
|
|
Specify the default connection for the Discussions and Announcements services. |
Online |
|
|
Specify defaults for the Discussions service. |
Online |
|
|
Remove defaults for the Discussions service. |
Online |
|
|
List Discussions service properties. |
Online |
|
|
Specify defaults for the Announcements service. |
Online |
|
|
Remove defaults for the Announcements service. |
Online |
|
|
List Announcements service properties. |
Online |
Module: Oracle WebCenter
Use with WLST: Online
Creates a new discussions server connection for a named WebCenter application.
The Discussions service and the Announcements service both require a discussions server connection. Both services use the same discussions server connection.
While you can register multiple discussions server connections for a WebCenter application, only one connection is used for discussion and announcement services— the default (or active) connection.
createDiscussionForumConnection(appName, name, url, adminUser, [secured, timeout, default, server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the WebCenter application in which you want to perform this operation. |
name
|
Connection name. The name must be unique (across all connection types) within the WebCenter application. |
url
|
URL of the discussions server hosting discussion forums and announcements. For example: http://myhost:8888/owc_discussions. |
adminUser
|
Name of the discussions server administrator. This account is used by the Discussions and Announcements services to perform administrative operations on behalf of WebCenter users.
This account is mostly used for managing group space discussions and announcements in WebCenter Spaces. It is not necessary for this user to be a |
secured
|
Optional. Indicates that a secure communication (WS-Security) is required between the WebCenter application and the discussions server.
This argument must be set to When set to |
timeout
|
Optional. Length of time (in seconds) the Discussions service waits for a response from the discussions server before issuing a connection timeout message. This argument defaults to -1. When set to -1, the service default (10 seconds) applies. |
default
|
Optional. Indicates that this connection is the default connection for the Discussions and Announcements services.
Valid options are |
server
|
Optional. Name of the managed server where the WebCenter application is deployed. For example, WLS_Spaces.
Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the WebCenter application is deployed. |
The following example creates a secure discussions server connection for a WebCenter application.
wls:/weblogic/serverConfig> createDiscussionForumConnection(appName='webcenter', name='MyDiscussionServer', url='http://myhost.com:8888/owc_discussions', adminUser='admin', secured=true, default=false)
Module: Oracle WebCenter
Use with WLST: Online
Edits an existing discussions server connection. Use this command to update connection attributes.
The connection is created using the createDiscussionForumConnection command.
setDiscussionForumConnection(appName, name, [url, adminUser, secured, timeout, default, server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the WebCenter application in which you want to perform this operation. |
name
|
Name of an existing discussions server connection. |
url
|
Optional. URL to the discussions server. |
adminUser
|
Optional. Name of the discussions server administrator. This account is used by the Discussions service to perform administrative operations on behalf of WebCenter users.
This account is mostly used for managing group space discussions and announcements in WebCenter Spaces. It is not necessary for this user to be a |
secured
|
Optional. Indicates that a secure communication (WS-Security) is required between the WebCenter application and the discussions server.
This argument must be set to When set to |
timeout
|
Optional. Length of time (in seconds) the Discussion and Announcement services wait for a response from the discussions server before issuing a connection timeout message. This argument defaults to -1. When set to -1, the service default (10 seconds) applies. |
default
|
Optional. Indicates that this connection is the default connection for the Discussions and Announcements services. Required only if more than one connection is defined.
Valid options are To specify that the Discussion and Announcements service use this connection, change the value from To disable this connection, use the removeDiscussionForumServiceProperty command:
Note: While you can register multiple discussions server connections for a WebCenter application, only one connection is used for discussion and announcement services— the default (or active) connection. |
server
|
Optional. Name of the managed server where the WebCenter application is deployed. For example, WLS_Spaces.
Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the WebCenter application is deployed. |
The following example updates attributes for a secure discussions server connection named MyDiscussionsServer.
wls:/weblogic/serverConfig> setDiscussionForumConnection(appName='webcenter', name='MyDiscussionServer', url='http://myhost.com:7786/owc_discussions', adminUser='admin', secured=true, default=true)
Module: Oracle WebCenter
Use with WLST: Online
Sets a discussions server connection property. Use this command when additional parameters are required to connect to your discussions server, for example, to set WS-Security keystore and encryption properties for the connection.
This commands provides an extensible way to add any connection property using a key and a value. (You are not limited to connection properties specified by createDiscussionForumConnection and setDiscussionForumConnection.)
Note:
Do not use the setDiscussionForumConnectionProperty to set connection properties available through createDiscussionForumConnection or setDiscussionForumConnection. Attempting to do so, has no effect.All known, additional connection properties are listed in Table 5-5, "Additional Discussion Connection Properties".
Table 5-5 Additional Discussion Connection Properties
| Additional Connection Property | Description |
|---|---|
|
|
Certificate file path in your local directory. Specify Windows paths as
|
|
|
Keystore password. To encrypt this password, set |
|
|
Keystore type associated with the certificate. Valid values are: |
|
|
Key alias to be used for encryption. |
|
|
Password for accessing the encryption key. To encrypt this password, set |
|
|
(WebCenter Spaces only) Determines whether a subcategory or a single forum is created on the discussions server for new group spaces. When set to If a group space template does not define the mapping (the Blank template, for example) then the If there is no value in the template or the connection, the default setting is used ( |
setDiscussionForumConnectionProperty(appName, name, key, value, [secure, server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the WebCenter application in which you want to perform this operation. |
name
|
Name of an existing discussions server connection. |
key
|
Name of the connection property. |
value
|
Value for the property. Allows any property to be modified on the connection with a key and value. |
secure
|
Optional. Indicates whether the property value must be stored securely using encryption. Valid options are true and false. When true, the value is encrypted. The default option is false.
Set to |
server
|
Optional. Name of the managed server where the WebCenter application is deployed. For example, WLS_Spaces.
Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the WebCenter application is deployed. |
The following example configures the location of the keystore certificate for a discussions server connection named MyDiscussionServer.
wls:/weblogic/serverConfig> setDiscussionForumConnectionProperty (appName='webcenter', name='MyDiscussionServer', key='keystore.location', value='c:\\keys\\mykeystore.jks')
The following example adds a custom discussions server connection property called myProperty1 with a value propertyValue1.
wls:/weblogic/serverConfig> setDiscussionForumConnectionProperty (appName='webcenter', name='MyDiscussionServer', key='myProperty1', value='propertyValue1')
The following example adds a secured discussions server connection property called securedProperty with the value secureValue.
wls:/weblogic/serverConfig> setDiscussionForumConnectionProperty (appName='webcenter', name='MyDiscussionServer', key='securedProperty', value='secureValue', secure=true)
Module: Oracle WebCenter
Use with WLST: Online
Deletes a discussions server connection property. Take care when deleting connection properties because the connection may not work as expected if the configuration becomes invalid as a result.
This command can only delete additional connection properties added using the setDiscussionForumConnectionProperty command.
deleteDiscussionForumConnectionProperty(appName, name, key, [server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the WebCenter application in which you want to perform this operation. |
name
|
Name of an existing discussions server connection. |
key
|
Name of the connection property you want to delete. |
server
|
Optional. Name of the managed server where the WebCenter application is deployed. For example, WLS_Spaces.
Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the WebCenter application is deployed. |
Module: Oracle WebCenter
Use with WLST: Online
Lists all of the discussions server connections that are configured for a named WebCenter application.
listDiscussionForumConnections(appName, [verbose, name, server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the WebCenter application in which you want to perform this operation. |
verbose
|
Optional. Valid options are true and false. When set to true, listDiscussionForumConnections lists all of the discussions server connections that are configured for a WebCenter application, along with their details. When set to false, only connection names are listed. This argument defaults to false. |
name
|
Optional. Name of an existing discussions server connection. Use this argument to view connection details for a specific discussions server connection. |
server
|
Optional. Name of the managed server where the WebCenter application is deployed. For example, WLS_Spaces.
Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the WebCenter application is deployed. |
The following example lists the names of all of the discussions server connections that are currently configured for an application named webcenter.
wls:/weblogic/serverConfig>listDiscussionForumConnections(appName='webcenter')
The following example lists connection names and details for all of the discussions server connections currently configured for an application named webcenter.
wls:/weblogic/serverConfig>listDiscussionForumConnections(appName='webcenter', verbose=true)
The following example lists connection details for a discussions server connection named myDiscussionsServer.
wls:/weblogic/serverConfig> listDiscussionForumConnections(appName='webcenter', name='myDiscussionsServer')
Module: Oracle WebCenter
Use with WLST: Online
Names the discussions server connection that the Discussions service and the Announcements service are using, in a named WebCenter application. While you can register multiple discussions server connections for a WebCenter application, the Discussions/Announcements service only uses one connection—known as the default (or active) connection.
listDefaultDiscussionForumConnection(appName, [verbose, server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the WebCenter application in which you want to perform this operation. |
verbose
|
Optional. Valid options are true and false. When set to true, the name and details of the discussions server connections are listed. When set to false, only the connection name displays. This argument defaults to false. |
server
|
Optional. Name of the managed server where the WebCenter application is deployed. For example, WLS_Spaces.
Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the WebCenter application is deployed. |
The following example names the discussions server connection that the Discussions/Announcements service are using, in an application named webcenter.
wls:/weblogic/serverConfig> listDefaultDiscussionForumConnection(appName='webcenter')
The following example lists the name and details of the discussions server connection that the Discussions/Announcements service are using.
wls:/weblogic/serverConfig> listDefaultDiscussionForumConnection(appName='webcenter', verbose=true)
Module: Oracle WebCenter
Use with WLST: Online
Specifies the default discussions server connection for the Discussions service and the Announcements service, in a named WebCenter application.
While you can register multiple discussions server connections with a WebCenter application, the Discussions/Announcements services only uses one connection—this is known as the default (or active) connection.
setDefaultDiscussionForumConnection(appName, name, [server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the WebCenter application in which you want to perform this operation. |
name
|
Name of an existing discussions server connection. |
server
|
Optional. Name of the managed server where the WebCenter application is deployed. For example, WLS_Spaces.
Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the WebCenter application is deployed. |
Module: Oracle WebCenter
Use with WLST: Online
Specifies default values for the Discussions service.
Configurable properties for the Discussions service are listed in Table 5-6, "Discussion Service Configuration Properties".
Table 5-6 Discussion Service Configuration Properties
| Configuration Property | Description |
|---|---|
|
|
Maximum number of topics fetched by the Discussions service and displayed in the topics view. |
|
|
Maximum number of forums fetched by the Discussions service and displayed in the forums view. |
|
|
Maximum number of topics fetched by the Discussions service and displayed in the recent topics view. |
|
|
Maximum number of topics fetched by the Discussions service and displayed in the watched topics view. |
|
|
Maximum number of forums fetched by the Discussions service and displayed in the watched forums view. |
|
|
Application root category ID on the discussions server under which all discussion forums are stored. For example, if set to 3, all forums are stored inside category 3. |
setDiscussionForumServiceProperty(appName, property, value, [server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the WebCenter application in which you want to perform this operation. |
property
|
Name of the configuration property. |
value
|
Value for the property. |
server
|
Optional. Name of the managed server where the WebCenter application is deployed. For example, WLS_Spaces.
Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the WebCenter application is deployed. |
Module: Oracle WebCenter
Use with WLST: Online
Removes the current value that is set for a Discussions service property. Use this command to remove any of the properties listed in Table 5-6, "Discussion Service Configuration Properties".
Take care when using this command as removing values for these properties might cause unexpected behavior.
Note:
Use this command syntax to disable the connection currently used for discussion and announcement services:removeDiscussionForumServiceProperty('appName='webcenter', property='selected.connection')
This command forces the default connection argument to false. See also, setDiscussionForumConnection.
removeDiscussionForumServiceProperty(appName, property, [server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the WebCenter application in which you want to perform this operation. |
property
|
Name of the configuration property. |
server
|
Optional. Name of the managed server where the WebCenter application is deployed. For example, WLS_Spaces.
Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the WebCenter application is deployed. |
Module: Oracle WebCenter
Use with WLST: Online
listDiscussionForumServiceProperties(appName, [server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the WebCenter application in which you want to perform this operation. |
server
|
Optional. Name of the managed server where the WebCenter application is deployed. For example, WLS_Spaces.
Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the WebCenter application is deployed. |
Module: Oracle WebCenter
Use with WLST: Online
Specifies default values for the Announcements service.
Configurable properties for the Announcements service are listed in Table 5-7, "Announcements Service Configuration Properties".
Table 5-7 Announcements Service Configuration Properties
| Configuration Property | Description |
|---|---|
|
|
Maximum number of announcements displayed in the Announcements mini view. |
|
|
Maximum number of announcements displayed in the Announcements main view. |
|
|
Maximum number of announcements displayed in the Announcements links view. |
|
|
Number of days that announcements display and remain editable. |
setAnnouncementServiceProperty(appName, property, value, [server, applicationVersion})
| Argument | Definition |
|---|---|
appName
|
Name of the WebCenter application in which you want to perform this operation. |
property
|
Name of the configuration property. |
value
|
Property value. |
server
|
Optional. Name of the managed server where the WebCenter application is deployed. For example, WLS_Spaces.
Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the WebCenter application is deployed. |
Module: Oracle WebCenter
Use with WLST: Online
Removes the current value that is set for a Announcements service property. Use this command to remove any of the properties listed in Table 5-7, "Announcements Service Configuration Properties".
Take care when using this command as removing values for these properties might cause unexpected behavior.
removeAnnouncementServiceProperty(appName, property, [server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the WebCenter application in which you want to perform this operation. |
property
|
Name of the configuration property. |
server
|
Optional. Name of the managed server where the WebCenter application is deployed. For example, WLS_Spaces.
Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the WebCenter application is deployed. |
Module: Oracle WebCenter
Use with WLST: Online
listAnnouncementServiceProperties(appName, [server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the WebCenter application in which you want to perform this operation. |
server
|
Optional. Name of the managed server where the WebCenter application is deployed. For example, WLS_Spaces.
Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the WebCenter application is deployed. |
Use the commands listed in Table 5-8 to manage external application connections for WebCenter applications.
Configuration changes made using these WebCenter WLST commands are immediately available in the WebCenter application.
Table 5-8 External Application WLST Commands
| Use this command... | To... | Use with WLST... |
|---|---|---|
|
Create an external application connection, for a named WebCenter application. |
Online |
|
|
Edit an existing external application connection. |
Online |
|
|
List individual or all external applications that are configured for a specific WebCenter application. |
Online |
|
|
Add another login field for a specific external application connection. |
Online |
|
|
Edit the value and display-to-user setting for a specific external application login field. |
Online |
|
|
Remove an external application login field. |
Online |
|
|
Specify shared or public credentials for an external application. |
Online |
|
|
Edit shared or public credentials for an external application. |
Online |
|
|
Remove shared or public credentials currently configured for an external application. |
Online |
Module: Oracle WebCenter
Use with WLST: Online
createExtAppConnection(appName, name, [displayName, url, authMethod, userFieldName, pwdFieldName, server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the WebCenter application in which you want to perform this operation. |
name
|
Connection name. The name must be unique (across all connection types) within the WebCenter application. |
displayName
|
Optional. External application display name. A user friendly name for the application that WebCenter users will recognize. The display name must be unique across all external applications within the WebCenter application. |
url
|
Optional. External application login URL.
To determine an application's URL, navigate to the application's login page and note down the URL for that page. For example: |
authMethod
|
Optional. Authentication mechanism used by the external application. Valid options are GET, POST, and BASIC. This argument defaults to POST. |
userFieldName
|
Optional. Name that identifies the user name or user ID field on the external application's login form. To find this name, look at the HTML source for the login page. This argument does not specify user credentials.
Mandatory if |
pwdFieldName
|
Optional. Name that identifies the password field on the external application's login form. To find this name, look at the HTML source for the login page. This argument does not specify user credentials.
Mandatory if |
server
|
Optional. Name of the managed server where the WebCenter application is deployed. For example, WLS_Spaces.
Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the WebCenter application is deployed. |
The following example creates a connection for an external application named My Yahoo!, in a WebCenter application.
wls:/weblogic/serverConfig> createExtAppConnection(appName='webcenter', name='yahoo', displayName='My Yahoo!', url='http://login.yahoo.com/config/login', authMethod='POST', userFieldName='login', pwdFieldName='passwd')
Module: Oracle WebCenter
Use with WLST: Online
setExtAppConnection(appName, name, [displayName], [url], [authMethod], [userFieldName], [pwdFieldName], [server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the WebCenter application in which you want to perform this operation. |
name
|
Name of an existing external application connection. |
displayName
|
Optional. External application display name. A user-friendly name for the application that WebCenter users will recognize. |
url
|
Optional. External application login URL. To determine an application's URL, navigate to the application's login page and note down the URL for that page. |
authMethod
|
Optional. Authentication mechanism used by the external application. Valid options are GET, POST, and BASIC. This argument defaults to POST. |
userFieldName
|
Optional. Name that identifies the user name or user ID field on the external application's login form. To find this name, look at the HTML source for the login page. This argument does not specify user credentials.
Mandatory if |
pwdFieldName
|
Optional. Name that identifies the password field on the external application's login form. To find this name, look at the HTML source for the login page. This argument does not specify user credentials.
Mandatory if |
server
|
Optional. Name of the managed server where the WebCenter application is deployed. For example, WLS_Spaces.
Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the WebCenter application is deployed. |
Module: Oracle WebCenter
Use with WLST: Online
When used with only the appName argument, this command lists the names of all the external applications currently configured for a specific WebCenter application.
listExtAppConnections(appName, [verbose, name, server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the WebCenter application for which you want to perform this operation. |
verbose
|
Optional. Displays external application details in verbose mode. Valid options are true and false. When set to true, listExtAppConnections lists all of the external applications that are configured for a WebCenter application, along with their details. When set to false, listExtAppConnections lists only the names of the external applications. This argument defaults to false.
If you set this argument to |
name
|
Optional. Name of an existing external application connection. You can use this argument to view details about a specific connection. |
server
|
Optional. Name of the managed server where the WebCenter application is deployed. For example, WLS_Spaces.
Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the WebCenter application is deployed. |
The following example lists the names of all the external applications currently used by a WebCenter application named webcenter.
wls:/weblogic/serverConfig> listExtAppConnections(appName='webcenter')
app1
app2
app3
The following example lists details for the external applications app1, app2, and app3.
wls:/weblogic/serverConfig> listExtAppConnections(appName='webcenter', verbose=true)
----
app1
----
Name: app1
Display Name: Application1
Login URL: http://app1
Authentication Method: POST
User Field Name: login
Password Field Name: passwd
Shared Credential: Disabled
Public Credential: Disabled
----
app2
----
Name: app2
Display Name: Application2
Login URL: http://app2
Authentication Method: POST
User Field Name: login
Password Field Name: passwd
Additional Fields: {Account1:true, Accout2:DefVal:false}
Shared Credential: Disabled
Public Credential: Enabled
----
app3
----
Name: app3
Display Name: Application3
Authentication Method: POST
Shared Credential: Enabled
Public Credential: Enabled
The following example lists details for external application app1 only.
wls:/weblogic/serverConfig> listExtAppConnections(appName='webcenter', verbose=true, name='app1')
----
app1
----
Name: app1
Display Name: Application1
Login URL: http://app1
Authentication Method: POST
User Field Name: login
Password Field Name: passwd
Shared Credential: Disabled
Public Credential: Disabled
Module: Oracle WebCenter
Use with WLST: Online
Adds another login field for a specific external application connection. For example, in addition to user name and password, an external application may require other login criteria such as Host and MailAddress.
Optionally, additional login fields can appear on the external application's login for a user to specify.
If you add another login field and the external application uses shared or public credentials, you can use the WLST commands and setExtAppCredential to update the shared/public credentials. See addExtAppCredential and setExtAppCredential.
addExtAppField(appName, name, fieldName, [fieldValue], [displayToUser], [server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the WebCenter application in which you want to perform this operation. |
name
|
Name of an existing external application connection. |
fieldName
|
Login field name. The name that identifies the field on the HTML login form. This field is not applicable if the application uses BASIC authentication. |
fieldValue
|
Optional. Login field value. Enter a default value for the login field or leave blank for a user to specify. This argument is blank by default. |
displayToUser
|
Optional. Specifies whether the login field displays on the external application's login screen. Valid options are true and false. This argument defaults to false.
Note that if you set this argument to |
server
|
Optional. Name of the managed server where the WebCenter application is deployed. For example, WLS_Spaces.
Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the WebCenter application is deployed. |
This example creates an additional field named Account with the default value username.default.example in an external application called ABC. This field will be displayed in ABC's login screen.
wls:/weblogic/serverConfig> addExtAppField(appName='webcenter', name='ABC', fieldName='Account', fieldValue='username.default.example', displayToUser=true)
Module: Oracle WebCenter
Use with WLST: Online
Modifies the field value and display-to-user setting for one or more login fields currently configured for an external application. Either fieldValue or displayToUser must be specified along with the external application name and login field name. The fieldValue and displayToUser arguments are optional.
Using this command has implications on any shared or public credentials that you might have created for this external application. If you modify displayToUser to true, you may also need to update existing shared user or public user credentials. See also setExtAppCredential.
setExtAppField(appName, name, fieldName, [fieldValue], [displayToUser], [server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the WebCenter application in which you want to perform this operation. |
name
|
Name of an existing external application connection. |
fieldName
|
Name of an existing login field. |
fieldValue
|
Optional. New or changed login field value.
Enter a default value for the login field or leave blank for a user to specify. This argument is blank by default. |
displayToUser
|
Optional. Specifies whether the login field displays on the external application's login screen. Valid options are true and false.
If set to |
server
|
Optional. Name of the managed server where the WebCenter application is deployed. For example, WLS_Spaces.
Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the WebCenter application is deployed. |
The following example specifies a default value for a login field named Account and displays the field on the external application's credential provisioning screen.
wls:/weblogic/serverConfig> setExtAppField(appName='webcenter', name='ABC', fieldName='Account', fieldValue='admin', displayToUser=true)
Module: Oracle WebCenter
Use with WLST: Online
Removes a login field from an external application connection.
This command has implications on any shared or public credentials that you may have created for this external application, that is, you may need to remove the login field from shared user or public user credentials.
You can use the setExtAppCredential command to remove a login field, if required. For example, external application myApp has an additional field called Account and public credentials were previously specified using:
addExtAppCredential(appName='webcenter', name='myApp', type='PUBLIC', username='admin', password='mypublic.password', field='Account:admin@myhost.com')
If you remove the Account field, you can modify the credentials by running:
setExtAppCredential(appName='webcenter', name='myApp', type='PUBLIC', username='admin', password='mypublic.password')
For details on using setExtAppCredential, see setExtAppCredential
removeExtAppField(appName, name, fieldName, [server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the WebCenter application in which you want to perform this operation. |
name
|
Connection name. |
fieldName
|
Login field that you want to remove. |
server
|
Optional. Name of the managed server where the WebCenter application is deployed. For example, WLS_Spaces.
Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the WebCenter application is deployed. |
Module: Oracle WebCenter
Use with WLST: Online
Configures shared user or public user credentials for a specific external application.
When shared credentials are specified, every user accessing the WebCenter application is authenticated using the user name and password defined here. WebCenter users are not presented with a login form.
Public users accessing this application through WebCenter are logged in using the user name and password defined here.
If credentials already exists, a warning indicates that the setExtAppCredential command should be used instead.
addExtAppCredential(appName, name, type, username, password, [field, server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the WebCenter application in which you want 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=true. |
server
|
Optional. Name of the managed server where the WebCenter application is deployed. For example, WLS_Spaces.
Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the WebCenter application is deployed. |
The following example specifies public credentials for an external application named ABC. The public user name is mypublic.username, the password is mypublic.password, and there is one additional field named Account.
wls:/weblogic/serverConfig> addExtAppCredential(appName='webcenter', name='ABC', type='PUBLIC', username='mypublic.username', password='mypublic.password', field='Account:username.example')
Module: Oracle WebCenter
Use with WLST: Online
Modifies shared user or public user credentials currently configured for an external application. If the credential has already not been specified, then a warning indicates that addExtAppCredential needs to be used instead. See addExtAppCredential.
The arguments username and password are optional because setExtAppCredential only manipulates existing credentials.
You can use setExtAppCredential command to update passwords in systems that require changing passwords every few days.
setExtAppCredential(appName, name, type, [username], [password], [field], [server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the WebCenter application in which you want to perform this operation. |
name
|
Name of an existing external application connection. |
type
|
Credential type. Valid values are SHARED and PUBLIC. |
username
|
Optional. User name of the shared or public user. |
password
|
Optional. Password for the shared or public user. |
field
|
Optional. Additional login field value. Use the format FieldName:FieldValue, where FieldName names an additional login field configured with displayToUser=true. |
server
|
Optional. Name of the managed server where the WebCenter application is deployed. For example, WLS_Spaces.
Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the WebCenter application is deployed. |
Module: Oracle WebCenter
Use with WLST: Online
Removes shared user or public user credentials currently configured for an external application.
If credentials do not exist, an error displays.
removeExtAppCredential(appName, name, type, [server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the WebCenter application in which you want to perform this operation. |
name
|
Name of an existing external application connection. |
type
|
Credential type. Valid values are SHARED and PUBLIC. |
server
|
Optional. Name of the managed server where the WebCenter application is deployed. For example, WLS_Spaces.
Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the WebCenter application is deployed. |
Use the commands listed in Table 5-9, to manage instant messaging and presence server connections.
Configuration changes made using these WebCenter WLST commands are only effective after your restart the Managed Server on which the WebCenter application is deployed. For details, see Oracle Fusion Middleware Administrator's Guide for Oracle WebCenter.
Table 5-9 Instant Messaging and Presence WLST Commands
| Use this command... | To... | Use with WLST... |
|---|---|---|
|
Create a new instant messaging and presence server connection for a WebCenter application. |
Online |
|
|
Edit an existing instant messaging and presence server connection. |
Online |
|
|
Modify instant messaging and presence server connection properties. |
Online |
|
|
Delete an instant messaging and presence server connection property. |
Online |
|
|
List which presence servers the WebCenter application supports. |
Online |
|
|
List all of the instant messaging and presence server connections that are configured for an application. |
Online |
|
|
List the default instant messaging and presence server connection that is configured for an application. |
Online |
|
|
Set a specified connection as the default instant messaging and presence server connection. |
Online |
|
|
Specify defaults for the Instant Messaging and Presence service. |
Online |
|
|
Remove defaults for the Instant Messaging and Presence service. |
Online |
|
|
List Instant Messaging and Presence service properties. |
Online |
Module: Oracle WebCenter
Use with WLST: Online
Creates an instant messaging and presence server connection for a named WebCenter application.
Use the listIMPAdapters command to find out which types of instant messaging and presence servers are supported. Out-of-the-box, WebCenter applications support Oracle WebLogic Communication Server (OWLCS) and Microsoft Live Communication Server (LCS).
While you can register multiple presence server connections for a WebCenter application, only one connection is used for instant messaging and presence services— the default (or active) connection.
createIMPConnection(appName, name, adapter, url, domain, [appId, poolName, policyURI, timeout, default, server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the WebCenter application in which you want to perform this operation. |
name
|
Connection name. The name must be unique (across all connection types) within the WebCenter application. |
url
|
URL of the sever hosting instant messaging and presence services.
For example: |
adapter
|
Adapter name. Specify the adapter that matches your instant messaging and presence server. Valid values are LCS and OWLCS.
Choose |
domain
|
User domain associated with this connection.
The domain specified is used to construct each user's SIP ID. For example, if the domain is If the user SIP address needs to be resolved from the OID/LDAP server, then specify the user profile attribute that will provide the SIP address here as SIP is short for Session Initiation Protocol - an Internet protocol for live communication between people. |
appId
|
Optional. External application associated with the presence server connection.
If specified, external application credential information is used to authenticate users against the LCS or OWLCS server. This argument is mandatory for LCS server connections. The external application you configure for the IMP service must use |
poolName
|
Optional. (LCS connections only.) Pool name that is required to create an LCS connection. Refer to Microsoft Live Communication Server documentation for details on the pool name. This argument is mandatory for LCS server connections. |
policyURI
|
Optional. (OWLCS connections only.) URI to the security policy that is required for authentication on the Oracle WebLogic Communication Server (OWLCS) server. |
timeout
|
Optional. Length of time (in seconds) that the Instant Messaging and Presence service waits for a response from the presence server before issuing a connection timeout message. This argument defaults to -1. When set to -1, the service default (10 seconds) applies. |
default
|
Optional. Indicates whether this connection is the default connection for the Instant Messaging and Presence service. Valid values are true and false. The default for this argument is false. |
server
|
Optional. Name of the managed server where the WebCenter application is deployed. For example, WLS_Spaces.
Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the WebCenter application is deployed. |
The following example creates an instant messaging and presence server connection to a Oracle WebLogic Communication Server named myOWLCSPresenceServer.
wls:/weblogic/serverConfig>createIMPConnection(appName='webcenter', name='myOWLCSPresenceServer', adapter='OWLCS', url='http://myowlcshost.com:8888', domain='oracle.com')
The following example also creates an instant messaging and presence server connection to a Oracle WebLogic Communication Server named myOWLCSPresenceServer.
wls:/weblogic/serverConfig>createIMPConnection(appName='webcenter', name='myOWLCSPresenceServer', adapter='OWCLS', url='http://myowlcshost.com:8888', domain='oracle.com', policyURI='oracle/wss11_saml_token_with_message_ protection_client_policy', timeout=60, default=false)
The following example creates an instant messaging and presence server connection to a Microsoft Live Communication Server named myLCSPresenceServer.
wls:/weblogic/serverConfig> createIMPConnection(appName='webcenter', name='myLCSPresenceServer', adapter='LCS', url='http://mylcshost.com/owc/lcs', domain='oracle.com', appId='LCSExtApp', poolName='pool1.myhost.com', timeout=60, default=true)
Module: Oracle WebCenter
Use with WLST: Online
Edits an existing instant messaging and presence server connection. Use this command to update connection attributes.
The connection is created using the createIMPConnection command.
setIMPConnection(appName, name, [adapter, url, domain, appId, poolName, policyURI, timeout, default, server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the WebCenter application in which you want to perform this operation. |
name
|
Name of an existing presence server connection. |
adapter
|
Optional. Adapter name. Specify the adapter that matches your instant messaging and presence server. Valid values are LCS and OWLCS.
Choose |
url
|
Optional. URL of the server hosting instant messaging and presence services. |
domain
|
Optional. User domain associated with this connection.
The domain specified is used to construct each user's SIP ID. For example, if the domain is If the user SIP address needs to be resolved from the OID/LDAP server, then specify the user profile attribute that will provide the SIP address here as Alternatively, dynamically resolve the user SIP address on your own using a custom class. Provide a custom class that implements SIP is short for Session Initiation Protocol - an Internet protocol for live communication between people. |
appId
|
Optional. External application associated with the presence server connection.
If specified, external application credential information is used to authenticate users against the LCS or OWLCS server. This argument is mandatory for LCS server connections. The external application you configure for the IMP service must use |
poolName
|
Optional. (LCS connections only.) Pool name that is required to create an LCS connection. Mandatory for LCS connections. Refer to Microsoft Live Communication Server documentation for details on the pool name. |
policyURI
|
Optional. (OWLCS connections only.) URI to the security policy that is required for authentication on the Oracle WebLogic Communication Server (OWLCS) server. |
timeout
|
Optional. Length of time (in seconds) that the Instant Messaging and Presence service waits for a response from the presence server before issuing a connection timeout message. This argument defaults to -1. When set to -1, the service default (10 seconds) applies. |
default
|
Optional. Indicates whether this connection is the default connection for the Instant Messaging and Presence service. Valid values are true and false. The default for this argument is false.
To specify that the Instant Messaging and Presence service uses this connection, change the value from To disable this connection, use the removeIMPServiceProperty command:
While you can register multiple presence server connections for a WebCenter application, only one connection is used for instant messaging and presence services— the default (or active) connection. |
server
|
Optional. Name of the managed server where the WebCenter application is deployed. For example, WLS_Spaces.
Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the WebCenter application is deployed. |
The following example updates attributes for an existing instant messaging and presence server connection.
wls:/weblogic/serverConfig>setIMPConnection(appName='webcenter', name='myOWLCSPresenceServer', adapter='OWCLS', url='http://myowlcshost.com:8888', domain='oracle.com')
The following example sets attributes on an existing instant messaging and presence server connection.
wls:/weblogic/serverConfig>setIMPConnection(appName='webcenter', name='myOWLCSPresenceServer', adapter='OWCLS', url='http://myowlcshost.com:8888', domain='oracle.com', policyURI='oracle/wss11_saml_token_with_message_protection_ client_policy', timeout=60, default=false)
The following example sets attributes on an existing instant messaging and presence server connection.
wls:/weblogic/serverConfig>setIMPConnection(appName='webcenter', name='myLCSPresenceServer', adapter='LCS', url='http://mylcshost.com/owc/lcs', domain='oracle.com', appId='LCSExtApp', poolName='pool1.myhost.com', timeout=60, default=false)
Module: Oracle WebCenter
Use with WLST: Online
Sets an instant messaging and presence server connection property. Use this command if additional parameters are required to connect to your presence server. This is an extensible way to add any connection property using a key and a value. (You are not limited to connection properties specified by createIMPConnection and setIMPConnection.)
All known, additional connection properties are listed in Table 5-10, "Additional IMP Connection Properties".
Table 5-10 Additional IMP Connection Properties
| Additional Connection Property | Description |
|---|---|
|
|
(OWLCS only) URL to the OWLCS Presence service. Required if the OWLCS Presence service is deployed on a separate node. When no value is specified, the connection |
|
|
(OWLCS only) URL to the OWLCS Contact Management service. Required if the OWLCS Contact Management service is deployed on a separate node. When no value is specified, the connection |
|
|
(OWLCS only) URL to the OWLCS Third Party Call service. Required if the OWLCS Third Party Call service is deployed on a separate node. When no value is specified, the connection's |
|
|
(OWLCS only) Third party call method. Valid values are: |
|
|
(OWLCS only) Domain name of the PSTN gateway. Required when the |
|
|
(OWLCS only) User profile attribute used to store users' phone numbers. The default attribute is Required when the call.method is |
|
|
(OWLCS and LCS) User domain. If WebCenter user names are qualified with a domain, specify that domain here. For example, when user names are |
Do not use the setIMPConnectionProperty to set connection properties available through createIMPConnection or setIMPConnection. Attempting to do so, has no effect.
setIMPConnectionProperty(appName, name, key, value, [secure, server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the WebCenter application in which you want to perform this operation. |
name
|
Name of an existing presence server connection. |
key
|
Name of the connection property. |
value
|
Value for the property. Allows any property to be modified on the connection with a key and value. |
secure
|
Optional. Indicates whether the property value must be stored securely using encryption. Valid options are true and false. When true, the value is encrypted. The default option is false. |
server
|
Optional. Name of the managed server where the WebCenter application is deployed. For example, WLS_Spaces.
Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the WebCenter application is deployed. |
Module: Oracle WebCenter
Use with WLST: Online
Deletes an instant messaging and presence server connection property. Use caution when deleting connection properties because the connection might not work as expected if the configuration becomes invalid as a result.
This command can only delete additional connection properties added using the setIMPConnectionProperty command.
deleteIMPConnectionProperty(appName, name, key, [server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the WebCenter application in which you want to perform this operation. |
name
|
Name of an existing presence server connection. |
key
|
Name of the connection property you want to delete. |
server
|
Optional. Name of the managed server where the WebCenter application is deployed. For example, WLS_Spaces.
Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the WebCenter application is deployed. |
Module: Oracle WebCenter
Use with WLST: Online
Lists which types of instant messaging and presence servers Oracle WebCenter supports. Out-of-the-box, WebCenter applications support Oracle WebLogic Communication Server (OWLCS) and Microsoft Live Communication Server (LCS).
Module: Oracle WebCenter
Use with WLST: Online
Lists all of the instant messaging and presence server connections that are configured for a named WebCenter application.
listIMPConnections(appName,[verbose], [name], [server, applicationVersion)
| Argument | Definition |
|---|---|
appName
|
Name of the WebCenter application in which you want to perform this operation. |
verbose
|
Optional. Displays presence server connection details in verbose mode. Valid values are true and false. When set to true, listIMPConnections lists all of the presence server connections that are configured for a WebCenter application, along with their details.When set to false, only connection names are listed. This argument defaults to false. |
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 true, the verbose argument is ignored. |
server
|
Optional. Name of the managed server where the WebCenter application is deployed. For example, WLS_Spaces.
Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the WebCenter application is deployed. |
The following example lists all of the instant messaging and presence server connections that are configured for an application named webcenter.
wls:/weblogic/serverConfig> listIMPConnections(appName='webcenter')
The following example lists all of the instant messaging and presence server connections that are configured for the application in verbose mode.
wls:/weblogic/serverConfig> listIMPConnections(appName='webcenter', verbose=true)
The following example lists connection details for an instant messaging and presence server connections named impConnection1.
wls:/weblogic/serverConfig> listIMPConnections(appName='webcenter', name='impConnection1')
Module: Oracle WebCenter
Use with WLST: Online
Lists the connection that the Instant Messaging and Presence service is using, in a named WebCenter application. While you can register multiple presence server connections for a WebCenter application, the Instant Messaging and Presence service only uses one connection —the default (or active) connection.
If only one presence server connection is available, that connection is assumed to be the default connection.
listDefaultIMPConnection(appName, verbose, [server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the WebCenter application in which you want to perform this operation. |
verbose
|
Optional. Displays the default presence server connection in verbose mode, if available. Valid options are true and false. When set to true, the name and details of the presence server connection are listed. When set to false, only the connection name displays. This argument defaults to false. |
server
|
Optional. Name of the managed server where the WebCenter application is deployed. For example, WLS_Spaces.
Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the WebCenter application is deployed. |
Module: Oracle WebCenter
Use with WLST: Online
Specifies the default connection for the Instant Messaging and Presence service, in a named WebCenter application. While you can register multiple presence server connections with a WebCenter application, the Instant Messaging and Presence service only uses one connection — the default (or active) connection.
If only one presence server connection is available, that connection is assumed to be the default connection.
setDefaultIMPConnection(appName, name, [server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the WebCenter application in which you want to perform this operation. |
name
|
Name of an existing instant messaging and presence connection. |
server
|
Optional. Name of the managed server where the WebCenter application is deployed. For example, WLS_Spaces.
Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the WebCenter application is deployed. |
Module: Oracle WebCenter
Use with WLST: Online
Specifies default values for the Instant Messaging and Presence service.
Configurable properties for the Instant Messaging and Presence service are listed in Table 5-11, "Instant Messaging and Presence Service Configuration Properties".
Table 5-11 Instant Messaging and Presence Service Configuration Properties
| Configuration Property | Description |
|---|---|
|
|
Connection used by the Instant Messaging and Presence service. |
|
|
Cache timeout for instant messaging and presence data. The default is 60 seconds. |
|
|
Determines what to display if user display names are missing. When set to Display names are not mandatory in presence data. If the WebCenter application does not always provide display names by default and you consider this information important, set |
setIMPServiceProperty(appName, property, value, [server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the WebCenter application in which you want to perform this operation. |
property
|
Name of the configuration property. |
value
|
Value for the property. |
server
|
Optional. Name of the managed server where the WebCenter application is deployed. For example, WLS_Spaces.
Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the WebCenter application is deployed. |
Module: Oracle WebCenter
Use with WLST: Online
Removes the current value that is set for an Instant Messaging and Presence service property. Use this command to remove any of the properties listed in Table 5-11, "Instant Messaging and Presence Service Configuration Properties".
Take care when using this command as removing values for these properties might cause unexpected behavior.
Note:
Use this command syntax to disable the connection currently used by the Instant Messaging and Presence service:removeIMPServiceProperty('appName='webcenter', property='selected.connection')
This command forces the default connection argument to false. See also, setIMPConnection.
removeIMPServiceProperty(appName, property, [server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the WebCenter application in which you want to perform this operation. |
property
|
Name of the configuration property. |
server
|
Optional. Name of the managed server where the WebCenter application is deployed. For example, WLS_Spaces.
Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the WebCenter application is deployed. |
Module: Oracle WebCenter
Use with WLST: Online
listIMPServiceProperties(appName, [server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the WebCenter application in which you want to perform this operation. |
server
|
Optional. Name of the managed server where the WebCenter application is deployed. For example, WLS_Spaces.
Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the WebCenter application is deployed. |
Use the commands listed in Table 5-12 to manage mail server connections for a WebCenter application.
You can register multiple mail server connections:
WebCenter Spaces supports multiple mail connections. The mail connection configured with default=true is the default connection for mail services in WebCenter Spaces. All additional connections are offered as alternatives; WebCenter Spaces users can choose which one they want to use through user preferences.
Custom WebCenter applications only use one mail connection—the connection configured with default=true. Any additional connections are ignored.
Configuration changes made using these WebCenter WLST commands are only effective after your restart the Managed Server on which the WebCenter application is deployed. For details, see Oracle Fusion Middleware Administrator's Guide for Oracle WebCenter.
| Use this command... | To... | Use with WLST... |
|---|---|---|
|
Create a mail server connection for a WebCenter application. |
Online |
|
|
Edit an existing mail server connection. |
Online |
|
|
Set mail server connection properties. |
Online |
|
|
Delete a mail server connection property. |
Online |
|
|
List all of the mail server connections that are configured for an application. |
Online |
|
|
List the default mail server connection that is configured for an application. |
Online |
|
|
Set a specified connection as the default mail server connection. |
Online |
|
|
Specify defaults for the Mail service. |
Online |
|
|
Remove defaults for the Mail service. |
Online |
|
|
List Mail service properties. |
Online |
Module: Oracle WebCenter
Use with WLST: Online
Creates a mail server connection for a WebCenter application.
WebCenter applications support the Microsoft Exchange Server or any mail server that supports IMAP4 and SMTP. The most important mail server connection attributes are: imapHost, imapPort, imapSecured, smtpHost, smtpPort, and smtpSecured
You can register multiple mail server connections:
WebCenter Spaces supports multiple mail connections. The mail connection configured with default=true is the default connection for mail services in WebCenter Spaces. All additional connections are offered as alternatives; WebCenter Spaces users can choose which one they want to use through user preferences.
Custom WebCenter applications only use one mail connection—the connection configured with default=true. Any additional connections are ignored.
createMailConnection(appName, name, imapHost, imapPort, smtpHost, smtpPort, imapSecured, smtpSecured, appId, [timeout, default, server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the WebCenter application in which you want to perform this operation. |
name
|
Connection name. The name must be unique (across all connection types) within the WebCenter application. |
imapHost
|
Host name of the machine on which the IMAP service is running. |
imapPort
|
Port on which the IMAP service listens. |
smtpHost
|
Host name of the machine where the SMTP service is running. |
smtpPort
|
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 true and false. The default for this argument is false. |
smtpSecured
|
Optional. Specifies whether the SMTP server is secured. Valid values are true and false. The default for this argument is false. |
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. See also createExtAppConnection. The external application you configure for the Mail service must use |
timeout
|
Optional. Length of time (in seconds) that the service waits to acquire a connection before terminating. This argument defaults to -1. When set to -1, the service default (10 seconds) applies. |
default
|
Optional. Indicates whether this connection is the default connection for the Mail service. Valid values are true and false. This argument defaults to false.
|
server
|
Optional. Name of the managed server where the WebCenter application is deployed. For example, WLS_Spaces.
Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the WebCenter application is deployed. |
The following example creates a mail server connection named myMailConnection and enables the mail server connection in the WebCenter application.
wls:/weblogic/serverConfig> createMailConnection(appName='webcenter' , name='myMailConnection' , imapHost='myimaphost.com', imapPort=143 , smtpHost='mysmtphost.com' , smtpPort=25 , imapSecured=false, smtpSecured=false, appId='extApp_Mail', timeout=60, default=true)
Module: Oracle WebCenter
Use with WLST: Online
Edits an existing mail connection. Use this command to update connection attributes.
The connection is created using the createMailConnection command.
(WebCenter Spaces application only.) This command enables you to set additional, optional, LDAP server attributes that cannot be set using createMailConnection. When LDAP details are defined, the Mail service creates, edits, and deletes group space distribution lists for WebCenter Spaces. group space distribution lists are named after their group space (excluding non-java identifiers) and assigned a domain (derived from the domain attribute, for example, @mycompany.com). If LDAP details are not provided, group space distribution lists are not created or maintained. The mail server must be a Microsoft Exchange Server.
setMailConnection(appName, name, [imapHost, imapPort, smtpHost, smtpPort, imapSecured, smtpSecured, appId, default, ldapHost, ldapPort, ldapBaseDN, ldapAdminUser, ldapAdminPassword, ldapSecured, domain, defaultUser, timeout, server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the WebCenter application in which you want to perform this operation. |
name
|
Name of an existing mail server connection. |
imapHost
|
Optional. Host name of the machine on which the IMAP service is running. |
imapPort
|
Optional. Port on which the IMAP service listens. |
smtpHost
|
Optional. Host name of the machine where the SMTP service is running. |
smtpPort
|
Optional. Port on which the SMTP service listens. |
imapSecured
|
Optional. Specifies whether the connection to the IMAP server is secured (SSL-enabled). Valid values are true and false. The default for this argument is false. |
smtpSecured
|
Optional. Specifies whether the connection to the SMTP server is secured (SSL-enabled). Valid values are true and false. The default for this argument is false. |
appId
|
Optional. External application associated with the mail server connection.
External application credential information is used to authenticate users against the IMAP and SMTP servers. The same credentials are supplied to authenticate the user on both the IMAP and SMTP servers. See also createExtAppConnection. The external application you configure for the Mail service must use |
ldapHost
|
Optional. Host name of the machine where the LDAP directory server is running. |
ldapPort
|
Optional. Port on which the LDAP directory server listens. |
ldapBaseDN
|
Optional. Base distinguished name for the LDAP schema. For example, CN=Users,DC=oracle,DC=com. |
ldapAdminUser
|
Optional. User name of the LDAP directory server administrator. A valid administrator with privileges to make entries into the LDAP schema. |
ldapAdminPassword
|
Optional. Password for the LDAP directory server administrator. This password will be stored in a secured store. |
ldapSecured
|
Optional. Specifies whether the connection to the LDAP server is secured (SSL enabled). Valid values are true and false. The default for this argument is false. Set this to true for all LDAP communications over SSL. |
domain
|
Optional. Domain name appended to group space distribution lists. For example, if the domain attribute is set to mycompany.com, the Finance Project group 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 group space distribution list that is created. The users specified must exist in the Base LDAP schema (specified in the ldapBaseDN argument). |
timeout
|
Optional. Length of time (in seconds) that the service waits to acquire a connection before terminating. This argument defaults to -1. When set to -1, the service default (10 seconds) applies. |
default
|
Optional. Indicates whether this connection is the default (or active) connection for the Mail service. Valid values are true and false. This argument defaults to false. true specifies that this connection is the default connection for the Mail service.
A connection does not cease to be the default connection for the Mail service if you change the To stop using a default connection, use the removeMailServiceProperty command as follows:
|
server
|
Optional. Name of the managed server where the WebCenter application is deployed. For example, WLS_Spaces.
Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the WebCenter application is deployed. |
The following example sets individual attributes of a mail server connection.
wls:/weblogic/serverConfig>setMailConnection(appName='webcenter', name='myMailConnection', imapHost='myimaphost.com', imapPort=143, smtpHost='mysmtphost.com' , smtpPort=25 , imapSecured=false, smtpSecured=false, appId='extApp_Mail', timeout=60, default=true)
The following example sets individual attributes of a mail server connection.
wls:/weblogic/serverConfig>setMailConnection(appName='webcenter', name='myMailConnection', imapPort=993, imapSecured=true, smtpPort=465 , smtpSecured=true)
The following example sets LDAP attributes for a mail server connection.
wls:/weblogic/serverConfig>setMailConnection(appName='webcenter', name='myMailConnection', domain='ORACLE.COM', defaultUser='admin', imapHost='myimaphost.com', imapPort=143, smtpHost='mysmtphost.com', imapSecured=false, smtpSecured=false, smtpPort=25, appId='extApp_Mail', default=true, ldapHost='myldaphost.com', ldapPort=389, ldapBaseDN='CN=Users,DC=exchange,DC=uk,DC=com', ldapAdminUser='administrator', ldapAdminPassword='adminpswd', ldapSecured=false, timeout=60)
Module: Oracle WebCenter
Use with WLST: Online
Sets a mail server connection property. Use this command if additional parameters are required to connect to your mail server. This is an extensible way to add any connection property using a key and a value. (You are not limited to connection properties specified by createMailConnection and setMailConnection.)
All known, additional connection properties are listed in Table 5-13, "Additional Mail Connection Properties".
Table 5-13 Additional Mail Connection Properties
| Additional Connection Property | Description |
|---|---|
|
|
Characterset used on the connection. The default charset is |
|
Various IMAP properties |
Any valid IMAP connection property. For example, A list of valid IMAP properties are available at: |
|
Various SMTP properties |
Any valid SMTP connection property. For example, A list of valid SMTP properties are available at: |
Note:
Do not use the setMailConnectionProperty to set connection properties available through createMailConnection or setMailConnection. Attempting to do so, has no effect.setMailConnectionProperty(appName, name, key, value, [secure], [server], [applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the WebCenter application in which you want to perform this operation. |
name
|
Name of an existing mail server connection. |
key
|
Name of the connection property. |
value
|
Value for the property. Allows any property to be modified on the connection with a key and value. |
secure
|
Optional. Indicates whether the property value must be stored securely using encryption. Valid options are true and false. When true, the value is encrypted. The default option is false. |
server
|
Optional. Name of the managed server where the WebCenter application is deployed. For example, WLS_Spaces.
Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the WebCenter application is deployed. |
Module: Oracle WebCenter
Use with WLST: Online
Deletes a mail server connection property. Take care when deleting connection properties because the connection may not work as expected if the configuration becomes invalid as a result.
This command can only delete additional connection properties added using the setMailConnectionProperty command.
deleteMailConnectionProperty(appName, name, key, [server], [applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the WebCenter application in which you want to perform this operation. |
name
|
Name of an existing mail server connection. |
key
|
Name of the connection property you want to delete. |
server
|
Optional. Name of the managed server where the WebCenter application is deployed. For example, WLS_Spaces.
Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the WebCenter application is deployed. |
Module: Oracle WebCenter
Use with WLST: Online
Lists all of the mail server connections that are configured for a named WebCenter application.
listMailConnection(appName, [verbose, name, server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the WebCenter application in which you want to perform this operation. |
verbose
|
Optional. Displays mail server connection details in verbose mode. Valid options are true and false. When set to true, listMailConnections lists all of the mail server connections that are configured for a WebCenter application, along with their details. When set to false, only connection names are listed. This argument defaults to false. |
name
|
Optional. Name of an existing mail server connection. Use this argument to view connection details for a specific mail server connection. |
server
|
Optional. Name of the managed server where the WebCenter application is deployed. For example, WLS_Spaces.
Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the WebCenter application is deployed. |
The following example lists the names of mail server connections that are currently configured for an application named webcenter.
wls:/weblogic/serverConfig> listMailConnections(appName='webcenter')
The following example lists connection names and details for all of the mail server connections that are currently configured for an application named webcenter.
wls:/weblogic/serverConfig> listMailConnections(appName='webcenter', verbose=true)
The following example lists connection details for a mail server connection named mailConnection1.
wls:/weblogic/serverConfig> listMailConnections(appName='webcenter', name='mailConnection1')
Module: Oracle WebCenter
Use with WLST: Online
Lists the default mail server connection that the Mail service is using, in a named WebCenter application.
You can register multiple mail server connections but there can only be one default connection:
WebCenter Spaces supports multiple mail connections. The mail connection configured with default=true is the default connection for mail services in WebCenter Spaces. All additional connections are offered as alternatives; WebCenter Spaces users can choose which one they want to use through user preferences.
Custom WebCenter applications only use one mail connection—the connection configured with default=true. Any additional connections are ignored.
listDefaultMailConnection(appName,[verbose], [server], [applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the WebCenter application in which you want to perform this operation. |
verbose
|
Optional. Displays the default mail server connection in verbose mode, if available. Valid options are true and false. When set to true, the name and details of the mail server connection are listed. When set to false, only the connection name displays. This argument defaults to false. |
server
|
Optional. Name of the managed server where the WebCenter application is deployed. For example, WLS_Spaces.
Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the WebCenter application is deployed. |
Module: Oracle WebCenter
Use with WLST: Online
Specifies the default mail server connection for the Mail service, in a named WebCenter application.
You can register multiple mail server connections but there can only be one default connection:
WebCenter Spaces supports multiple mail connections. The mail connection configured with default=true is the default connection for mail services in WebCenter Spaces. All additional connections are offered as alternatives; WebCenter Spaces users can choose which one they want to use through user preferences.
Custom WebCenter applications only use one mail connection—the connection configured with default=true. Any additional connections are ignored.
setDefaultMailConnection(appName, name, [server], [applicationVersion])
| Argument | Description |
|---|---|
appName
|
Name of the WebCenter application in which you want to perform this operation. |
name
|
Name of an existing mail connection. |
server
|
Optional. Name of the managed server where the WebCenter application is deployed. For example, WLS_Spaces.
Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the WebCenter application is deployed. |
Module: Oracle WebCenter
Use with WLST: Online
Specifies default values for the Mail service.
Configurable properties for the Mail service are listed in Table 5-14, "Mail Service Configuration Properties".
Table 5-14 Mail Service Configuration Properties
| Configuration Property | Description |
|---|---|
|
|
Maximum number of messages displayed in mail inboxes. |
|
|
Determines whether user email addresses are resolved to WebCenter user names when LDAP is configured. Valid values are When set to Set this property to |
setMailServiceProperty(appName, property, value, [server], [applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the WebCenter application in which you want to perform this operation. |
property
|
Name of the configuration property |
value
|
Value for the property. |
server
|
Optional. Name of the managed server where the WebCenter application is deployed. For example, WLS_Spaces.
Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the WebCenter application is deployed. |
Module: Oracle WebCenter
Use with WLST: Online
Removes the current value that is set for a Mail service property. Use this command to remove any of the properties listed in Table 5-14, "Mail Service Configuration Properties".
Take care when using this command as removing values for these properties might cause unexpected behavior.
Note:
Use this command syntax to stop the Mail service from using the current default connection:removeMailServiceProperty('appName='webcenter', property='selected.connection')
This command forces the default connection argument to false. See also, setMailConnection.
removeMailServiceProperty(appName, property, [server], [applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the WebCenter application in which you want to perform this operation. |
property
|
Name of the configuration property. |
server
|
Optional. Name of the managed server where the WebCenter application is deployed. For example, WLS_Spaces.
Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the WebCenter application is deployed. |
Module: Oracle WebCenter
Use with WLST: Online
listMailServiceProperties(appName, [server], [applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the WebCenter application in which you want to perform this operation. |
server
|
Optional. Name of the managed server where the WebCenter application is deployed. For example, WLS_Spaces.
Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the WebCenter application is deployed. |
Use the commands listed in Table 5-15 to manage personal events server connections for a WebCenter application.
Configuration changes made using these WebCenter WLST commands are only effective after your restart the Managed Server on which the WebCenter application is deployed. For details, see Oracle Fusion Middleware Administrator's Guide for Oracle WebCenter.
Table 5-15 Personal Events WLST Commands
| Use this command... | To... | Use with WLST... |
|---|---|---|
|
Create a personal events server connection for a named WebCenter application. |
Online |
|
|
Edit an existing personal events server connection. |
Online |
|
|
List all of the personal events server connections that are configured for a named WebCenter application |
Online |
Module: Oracle WebCenter
Use with WLST: Online
Creates a personal events server connection for a named WebCenter application.
The Personal Events service supports connections to Microsoft Exchange Server 2003 and Microsoft Exchange Server 2007.While you can register multiple personal events connections for a WebCenter application, only one connection is used for personal events services - the default (or active) connection.
createPersonalEventConnection(appName, name, webServiceUrl, adapterName, appId, [default, server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the WebCenter application in which you want to perform this operation. For WebCenter Spaces, the name is always webcenter. |
name
|
Connection name. The name must be unique (across all connection types within the WebCenter application. |
webServiceUrl
|
URL of the Web service exposing the event application.
Use the format |
adapterName
|
Specify the adapter that matches the personal events server. Valid values are MSEx2003 and MSEx2007. Choose MSEx2003 for Microsoft Exchange Server 2003 and MSEx2007 for Microsoft Exchange Server 2007.
Each adapter has its own mechanism of authenticating and exchanging data |
appId
|
External application associated with the Microsoft Exchange Server providing personal events services. If specified, external application credential information is used to authenticate users against the Microsoft Exchange Server. |
default
|
Optional. Indicates whether this connection is the default connection for the Personal Events service. Valid values are true and false. The default for this argument is false.
To specify that the Personal Events service uses this connection, set the value to While you can register multiple connections for a WebCenter application, only one connection is used for personal event services— the default (or active) connection. |
server
|
Optional. Name of the managed server where the WebCenter application is deployed. For example, WLS_Spaces.
Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the WebCenter application is deployed. |
The following example creates a connection named MyPEConnection for WebCenter Spaces (appName='webcenter'). The connection points to a Microsoft Exchange Server 2007 and is designated as the default connection for the Personal Events service.
wls:/weblogic/serverConfig>createPersonalEventConnection(appName='webcenter',
name='MyPEConnection', webServiceUrl='http://myexchange.com/EWS/Services.wsdl',
adapterName='MSEx2007', appId='ExtPEApp', default=true)
The following example creates a connection named MyPEConnection for a WebCenter Spaces. The connection points to a Microsoft Exchange Server 2003.
wls:/weblogic/serverConfig>createPersonalEventConnection(appName='webcenter',
name='MyPEConnection',webServiceUrl='http://myexchange.com/ExchangeWS/PersonalEventsWebService.asmx', adapterName='MSEx2003', appId='ExtPEApp')
Module: Oracle WebCenter
Use with WLST: Online
setPersonalEventConnection(appName, name, [webServiceUrl, adapterName, appId, default, server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the WebCenter application in which you want to perform this operation. For WebCenter Spaces, the name is always webcenter. |
name
|
Name of an existing personal events server connection. |
webServiceUrl
|
Optional. URL of the Web service exposing the event application.
Use the format |
adapterName
|
Optional. Specify the adapter that matches the personal events server. Valid values are MSEx2003 and MSEx2007. Choose MSEx2003 for Microsoft Exchange Server 2003 and MSEx2007 for Microsoft Exchange Server 2007.
Each adapter has its own mechanism of authenticating and exchanging data |
appId
|
Optional. External application associated with the Microsoft Exchange Server providing personal events services. If specified, external application credential information is used to authenticate users against the Microsoft Exchange Server. |
default
|
Optional. Indicates whether this connection is the default connection for the Personal Events service. Valid values are true and false. The default for this argument is false.
To specify that the Personal Events service uses this connection, set the value to While you can register multiple connections for a WebCenter application, only one connection is used for personal event services— the default (or active) connection. |
server
|
Optional. Name of the managed server where the WebCenter application is deployed. For example, WLS_Spaces.
Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the WebCenter application is deployed. |
The following example updates the Web service URL for a connection named MyPEConnection.
wls:/weblogic/serverConfig>setPersonalEventConnection(appName='webcenter', name='MyPEConnection', webServiceUrl='http://myexchange.com/EWS/Services.wsdl')
The following example makes a connection named MyPEConnection the default connection for personal events services in WebCenter Spaces.
wls:/weblogic/serverConfig>setPersonalEventConnection(appName='webcenter', name='MyPEConnection', default=true)
Module: Oracle WebCenter
Use with WLST: Online
Lists all of the personal events server connections that are configured for a named WebCenter application.
listPersonalEventConnections(appName, [verbose, name, server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the WebCenter application in which you want to perform this operation. |
verbose
|
Optional. Displays connection details for the Personal Events service in verbose mode. Valid options are true and false. When set to true, listPersonalEventConnections lists all of the personal events server connections that are configured for a WebCenter application, along with their details. When set to false, only connection names are listed. This argument defaults to false.
When set to |
name
|
Optional. Name of an existing personal events connection. Use this argument to view connection details for a specific personal events server. |
server
|
Optional. Name of the managed server where the WebCenter application is deployed. For example, WLS_Spaces.
Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the WebCenter application is deployed. |
The following example lists connection names and details for all of the personal events server connections currently configured for WebCenter Spaces.
wls:/weblogic/serverConfig>listPersonalEventConnections(appName='webcenter', verbose=true)
The following example displays connection details for a personal events server connection named MyPEConnection.
wls:/weblogic/serverConfig>listPersonalEventConnections(appName='webcenter', verbose=true, name='MyPEConnection')
Use the commands listed in Table 5-16 to manage portlet producers used in WebCenter applications.
All configuration changes made using these WebCenter WLST commands are immediately available in the WebCenter application.
Table 5-16 Producer WLST Commands
| Use this command... | To... | Use with WLST... |
|---|---|---|
|
Create and register a WSRP producer. |
Online |
|
|
Edit WSRP producer registration details. |
Online |
|
|
List WSRP producer registration details. |
Online |
|
|
Deregister a WSRP producer, and delete the associated WSRP and Web Service connections. |
Online |
|
|
List registration properties supported by a WSRP producer. |
Online |
|
|
List any user categories that the WSRP producer might support. |
Online |
|
|
Map a role that is defined in the specified application to a user category supported by a WSRP producer. |
Online |
|
|
Create and register an Oracle PDK-Java producer. |
Online |
|
|
Edit PDK-Java producer registration details. |
Online |
|
|
Deregister an Oracle PDK-Java producer, deleting the associated connection. |
Online |
|
|
List registered Oracle PDK-Java producers. |
Online |
|
|
Refresh the metadata stored for the named producer to reflect the portlets currently offered by that producer. |
Online |
|
|
Register out-of-the-box producers provided with Oracle WebCenter. |
Online |
|
|
Deregister out-of-the-box producers provided with Oracle WebCenter. |
Online |
|
|
Register the sample producers provided with Oracle WebCenter. |
Online |
|
|
Deregister sample producers. |
Online |
Module: Oracle WebCenter
Use with WLST: Online
Creates a connection to a WSRP portlet producer and registers the WRSP producer with a named WebCenter application. When you create a WSRP producer connection, a Web Service connection is also created named <name>-wsconn where <name> is the value specified for the name argument.
registerWSRPProducer(appName, name, url, [proxyHost], [proxyPort], [timeout],[externalApp],[registrationProperties],[tokenType],[issuer],[defUser], [keyStorePath],[keyStorePswd],[sigKeyAlias],[sigKeyPswd],[encKeyAlias], [encKeyPswd],[recptAlias],[server],[applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the WebCenter application in which you want to perform this operation. |
name
|
Connection name. The name must be unique (across all connection types) within the WebCenter application.
The name you specify here will appear in the Oracle Composer (under the Portlets folder). |
url
|
Producer WSDL URL. The syntax will vary according to your WSRP implementation, for example:
Where:
For example:
|
proxyHost
|
Optional. Host name or IP address of the proxy server.
A proxy is required when the WebCenter application and the remote portlet producer are separated by a firewall and an HTTP proxy is needed to communicate with the producer. |
proxyPort
|
Optional. Port number on which the proxy server listens. |
timeout
|
Optional. Timeout setting for communications with the producer, in seconds. For example, the maximum time the producer may take to register, deregister, or display portlets on WebCenter pages. This argument defaults to 30.
Individual portlets may define their own timeout period, which takes precedence over the value expressed here. |
registrationProperties
|
Optional. A list of registration properties and their values. The format of this argument must be a comma-separated list of valid registration properties, each followed by an equals symbol and the value. For example: name=Producer,key=123. The registration properties for a producer can be found using listWSRPProducerRegistrationProperties. See listWSRPProducerRegistrationProperties. |
tokenType
|
Optional. Type of token profile to use for authentication with this WSRP producer. Valid values are:
|
tokenType
continued...
|
|
issuer
|
Optional. Name of the issuer of the token. The issuer name is the entity that vouches for the verification of the subject. For example: www.oracle.com.
This argument only applies when the tokenType is: |
defUser
|
Optional. User name to assert to the remote producer when the user is not authenticated with the WebCenter application.
When unauthenticated, the identity anonymous is associated with the application user. The value anonymous may be inappropriate for the remote producer, so you may need to specify an alternative identity here. Keep in mind though, that in this case, the WebCenter application has not authenticated the user so the default user you specify should be a low privileged user in the remote producer. If the user has authenticated to the application, the user's identity is asserted rather than the default user. This argument only applies when the tokenType is: |
extApp |
Optional. This argument applies when the tokenType is USERNAME_WITH_PASSWORD. If this producer uses an external application to store and supply user credentials for authentication, use this argument to name the associated external application. |
keyStorePath
|
Optional. Full path to the key store that contains the certificate and the private key that is used for signing some parts of the SOAP message, such as the security token and SOAP message body. The selected file should be a key store created with the Java keytool. |
keyStorePswd
|
Optional. Password to the key store that was set when the key store was created. |
sigKeyAlias
|
Optional. Identifier for the certificate associated with the private key that is used for signing. |
sigKeyPswd
|
Optional. Password for accessing the key identified by the alias that is specified using the sigKeyAlias argument. |
encKeyAlias
|
Optional. Key alias to be used for encryption. A valid value is one of the key aliases that is located in the specified key store. |
encKeyPswd
|
Optional. Password for accessing the encryption key. |
recptAlias
|
Optional. Key store alias that is associated with the producer's certificate. This certificate is used to encrypt the message to the producer.
Do not specify a recipient key alias when the |
server
|
Optional. Name of the managed server where the WebCenter application is deployed. For example, WLS_Spaces.
Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the WebCenter application is deployed. |
The following example registers a WSRP producer named WSRPSamples and registers the WSRP producer with an application named webcenter.
wls:/weblogic/serverConfig> registerWSRPProducer(appName='webcenter', name='WSRPSamples', url='http://myhost.com:9999/ portletapp/portlets/wsrp2?WSDL')
The following example registers a secure WSRP producer.
wls:/weblogic/serverConfig> registerWSRPProducer(appName='webcenter', name='WSRPSamples2', url='http://myhost.com:8899/portletapp/portlets/wsrp2?WSDL', tokenType='WSS11_SAML_TOKEN_WITH_MSG_PROTECTION', issuer='www.oracle.com', defUser='anonymous', keyStorePath='/keys/mykeystore.jks', keyStorePswd='Test1', sigKeyAlias='mysigalias',sigKeyPswd='mysigpswd', encKeyAlias='myencalias', encKeyPswd='myencpswd', recptAlias='myrcptalias')
Module: Oracle WebCenter
Use with WLST: Online
setWSRPProducer(appName, name, [url], [proxyHost], [proxyPort], [timeout], [externalApp], [tokenType],[issuer], [defUser], [keyStorePath], [keyStorePswd] [sigKeyAlias], [sigKeyPswd], [encKeyAlias], [encKeyPswd], [recptAlias], [server], [applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the WebCenter application in which you want to perform this operation. |
name
|
Name of an existing WSRP producer. |
url
|
Optional. WSRP producer URL. The syntax will vary according to your WSRP implementation, for example:
Where:
For example:
|
proxyHost
|
Optional. Host name or IP address of the proxy server.
A proxy is required when the WebCenter application and the remote portlet producer are separated by a firewall and an HTTP proxy is needed to communicate with the producer. |
proxyPort
|
Optional. Port number on which the proxy server listens. |
timeout
|
Optional. Timeout setting for communications with the producer, in seconds. For example, the maximum time the producer may take to register, deregister, or display portlets on WebCenter pages.
This argument defaults to Individual portlets may define their own timeout period, which takes precedence over the value expressed here. |
extApp |
Optional. This argument applies when the tokenType is USERNAME_WITH_PASSWORD. If this producer uses an external application to store and supply user credentials for authentication, use this argument to name the associated external application. |
tokenType
|
Optional. Type of token profile to use for authentication with this WSRP producer. Valid values are:
|
tokenType
continued...
|
|
issuer
|
Optional. Name of the issuer of the token. The issuer name is the entity that vouches for the verification of the subject. For example: www.oracle.com.
This argument only applies when the tokenType is: |
defUser
|
Optional. User name to assert to the remote producer when the user is not authenticated with the WebCenter application.
When unauthenticated, the identity anonymous is associated with the application user. The value anonymous may be inappropriate for the remote producer, so you may need to specify an alternative identity here. Keep in mind though, that in this case, the WebCenter application has not authenticated the user so the default user you specify should be a low privileged user in the remote producer. If the user has authenticated to the application, the user's identity is asserted rather than the default user. This argument only applies when the tokenType is: |
keyStorePath
|
Optional. Full path to the key store that contains the certificate and the private key that is used for signing some parts of the SOAP message, such as the security token and SOAP message body. The selected file should be a key store created with the Java keytool. |
keyStorePswd
|
Optional. Password to the key store that was set when the key store was created. |
sigKeyAlias
|
Optional. Identifier for the certificate associated with the private key that is used for signing. |
sigKeyPswd
|
Optional. Password for accessing the key identified by the alias that is specified using the sigKeyAlias argument. |
encKeyAlias
|
Optional. Key alias used by the producer to encrypt the return message. A valid value is one of the key aliases that is located in the specified key store. If not specified, the producer uses the signing key for encrypting the return message. |
encKeyPswd
|
Optional. Password for accessing the encryption key. |
recptAlias
|
Optional. Key store alias that is associated with the producer's certificate. This certificate is used to encrypt the outbound message to the producer.
Do not specify a recipient key alias when the |
server
|
Optional. Name of the managed server where the WebCenter application is deployed. For example, WLS_Spaces.
Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the WebCenter application is deployed. |
This example increases the timeout, for the WSRPSamples producer, to 60 seconds.
wls:/weblogic/serverConfig>setWSRPProducer(appName='webcenter', name='WSRPSamples', timeout=60)
This example updates security properties on a secure WSRP producer.
wls:/weblogic/serverConfig>setWSRPProducer(appName='webcenter', name='WSRPSamples2', tokenType='WSS11_SAML_TOKEN_WITH_MSG_PROTECTION', issuer='www.oracle.com', defUser='anonymous', keyStorePath='/keys/mykeystore.jks', keyStorePswd='Test1', sigKeyAlias='mysigalias', sigKeyPswd='mysigpswd',encKeyAlias='myencalias', encKeyPswd='myencpswd', recptAlias='myrcptalias')
This example removes all the security properties set on a secure WSRP producer.
wls:/weblogic/serverConfig>setWSRPProducer(appName='webcenter', name='WSRPSamples2', tokenType='')
Module: Oracle WebCenter
Use with WLST: Online
listWSRPProducers(appName,[name],[verbose], [server], [applicationVersion])
| Argument | Definition |
|---|---|
appName
|
The name of the application in which one or more WSRP producers is registered. |
name
|
Optional. Name of an existing WSRP producer. If omitted, connection details for all WSRP producers configured for this WebCenter application are listed. |
verbose
|
Optional. Displays WSRP producer connection details in verbose mode. Valid options are true and false. When set to true, listWSRPProducers lists all connection properties. When set to false, listWSRPProducers lists connection names only. This argument defaults to true.
If you set this argument to |
server
|
Optional. Name of the managed server where the WebCenter application is deployed. For example, WLS_Spaces.
Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the WebCenter application is deployed. |
Module: Oracle WebCenter
Use with WLST: Online
Deregisters a WSRP producer, and deletes the associated WSRP and Web Service connections.
deregisterWSRPProducer(appName, name, [server], [applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the WebCenter application where the producer is registered. |
name
|
Name of an existing WSRP producer. |
server
|
Optional. Name of the managed server where the WebCenter application is deployed. For example, WLS_Spaces.
Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the WebCenter application is deployed. |
Module: Oracle WebCenter
Use with WLST: Online
listWSRPProducerRegistrationProperties(appName, url,[proxyHost, [proxyPort], [server], [applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the WebCenter application in which you want to perform this operation. |
url
|
WSRP producer URL. The syntax will vary according to your WSRP implementation, for example:
Where:
For example:
|
proxyHost
|
Optional. Host name or IP address of the proxy server.
A proxy is required when the WebCenter application and the remote portlet producer are separated by a firewall and an HTTP proxy is needed to communicate with the producer. |
proxyPort
|
Optional. Port number on which the proxy server listens. |
server
|
Optional. Name of the managed server where the WebCenter application is deployed. For example, WLS_Spaces.
Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the WebCenter application is deployed. |
The following example lists valid registration properties for the WSRP producer with the WSDL URL provided.
wls:/weblogic/serverConfig> listWSRPProducerRegistrationProperties (appName='webcenter', url='http://myhost:9999/portletapp/portlets/wsrp2?WSDL') Registration Property hint : hint text Registration Property label : label text Registration Property language : en Registration Property name : {urn:xyz:wlp:prop:reg:registration}consumerRole Registration Property value : None
Module: Oracle WebCenter
Use with WLST: Online
Lists any user categories that a WSRP producer might support. WebCenter users can use the WLST command mapWSRPProducerUserCategory to map application roles to a producer's user category.
listWSRPProducerUserCategories(appName, name, [server], [applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the WebCenter application in which you want to perform this operation. |
name
|
Name of an existing WSRP producer. |
server
|
Optional. Name of the managed server where the WebCenter application is deployed. For example, WLS_Spaces.
Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the WebCenter application is deployed. |
The following example displays the categories associated with a WSRP producer named WSRPSamples.
wls:/weblogic/serverConfig> listWSRPProducerUserCategories(appName='webcenter', name='WSRPSamples') User Category Name : categoryTwo User Category Description : Custom role two. User Category Mapped Local Roles : None User Category Name : categoryOne User Category Description : Custom role one. User Category Mapped Local Roles : None
Module: Oracle WebCenter
Use with WLST: Online
Maps a role that is defined in the specified WebCenter application to a user category supported by a WSRP producer. The user categories may be found using listWSRPProducerUserCategories.
mapWSRPProducerUserCategory(appName, name, localRole, producerUserCategory, [server], [applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the WebCenter application in which you want to perform this operation. |
name
|
Name of an existing WSRP producer. |
localRole
|
Name of the WebCenter application role to be mapped. |
producerUserCategory
|
WSRP producer user category to which the WebCenter role will be mapped. |
server
|
Optional. Name of the managed server where the WebCenter application is deployed. For example, WLS_Spaces.
Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the WebCenter application is deployed. |
Module: Oracle WebCenter
Use with WLST: Online
Creates a connection to an Oracle PDK-Java portlet producer and registers the Oracle PDK-Java producer with a named WebCenter application.
registerPDKJavaProducer(appName, name, url, [serviceId], [proxyHost, [proxyPort]], [subscriberId], [sharedKey], [timeout], [establishSession],[externalApp], [mapUser], [server], [applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the WebCenter application for which you want to perform this operation. |
name
|
Connection name. The name must be unique (across all connection types) within the WebCenter application. |
url
|
URL for the Oracle PDK-Java producer. Use the following syntax:
Where:
For example:
|
serviceId
|
Optional. Service ID of the producer.
PDK-Java enables you to deploy multiple producers under a single adapter servlet. Producers are identified by their unique service ID. A service ID is required only if the service ID is not appended to the URL end point. For example, the following URL endpoint requires
However, the following URL endpoint, does not require a service ID:
The service ID is used to look up a file called |
proxyHost
|
Optional. Host name or IP address of the proxy server.
A proxy is required if the WebCenter application and the remote portlet producer are separated by a firewall and an HTTP proxy is needed for communication with the producer. |
proxyPort
|
Optional. Port number on which the proxy server listens. This argument defaults to 80. |
sharedKey
|
Optional. Shared key used for message authentication with the remote producer. Message authentication ensures that the incoming messages are sent from a host with a shared key. This argument defaults to null.
The shared key can contain between 10 and 20 alphanumeric characters. |
subscriberId
|
Optional. Consumer's identifier, if required.
When a producer is registered with an application, a call is made to the producer. During the call, the consumer (WebCenter application in this instance) passes the value for subscriberId to the producer. The producer may be coded to use the subscriber ID. |
timeout
|
Optional. Timeout setting for communications with the producer, in seconds. For example, the maximum time the producer may take to register, deregister, or display portlets on WebCenter pages.
This argument defaults to Individual portlets may define their own timeout period, which takes precedence over the value expressed here. |
establishSession
|
Optional. Enable a user session when executing portlets from this producer. Valid values are true and false. The default for this argument is false.
When sessions are enabled ( |
externalApp
|
Optional. Name of the external application with which to associate the producer. Required if one of this producer's portlets requires authentication. |
mapUser
|
Optional. Flag indicating whether the mapped user name from the external application should be passed to the producer. Valid values are true and false. This argument defaults to true. |
server
|
Optional. Name of the managed server where the WebCenter application is deployed. For example, WLS_Spaces.
Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the WebCenter application is deployed. |
Module: Oracle WebCenter
Use with WLST: Online
setPDKJavaProducer(appName, name, url, [serviceId], [proxyHost, [proxyPort]], [subscriberId], [sharedKey], [timeout], [establishSession], [externalApp], [mapUser], [server], [applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the WebCenter application in which you want to perform this operation. |
name
|
Name of an existing PDK-Java producer. |
url
|
URL for the Oracle PDK-Java producer. Use the following syntax:
Where:
For example:
|
serviceId
|
Optional. Service ID of the producer.
PDK-Java enables you to deploy multiple producers under a single adapter servlet. Producers are identified by their unique service ID. A service ID is required only if the service ID is not appended to the URL end point. For example the following URL endpoint requires
However, the following URL endpoint, does not require a service ID:
The service ID is used to look up a file called |
proxyHost
|
Optional. Host name or IP address of the proxy server.
A proxy is required if the WebCenter application and the remote portlet producer are separated by a firewall and an HTTP proxy is needed for communication with the producer. |
proxyPort
|
Optional. Port number on which the proxy server listens. |
subscriberId
|
Optional. Consumer's identifier, if required.
When a producer is registered with an application, a call is made to the producer. During the call, the consumer (WebCenter application in this instance) passes the value for Subscriber ID to the producer. If the producer does not see the expected value for Subscriber ID, it might reject the registration call. |
sharedKey
|
Optional. The shared key is used for message authentication with the remote producer. Message authentication ensures that the incoming messages are sent from a host with a shared key. You should enable sessions using the sharedKey argument, as well as the establishSession argument. |
timeout
|
Optional. Timeout setting for communications with the producer, in seconds. For example, the maximum time the producer may take to register, deregister, or display portlets on WebCenter pages.
Individual portlets may define their own timeout period, which takes precedence over the value expressed here. |
establishSession
|
Optional. Enable a user session when executing portlets from this producer. Valid values are true and false. You should enable sessions using the establishSession argument, as well as the sharedKey argument.
When sessions are enabled ( |
externalApp
|
Optional. Name of the external application associated with this producer. |
mapUser
|
Optional. Flag indicating whether the mapped user name from the external application should be passed to the producer. Valid values are true and false. |
server
|
Optional. Name of the managed server where the WebCenter application is deployed. For example, WLS_Spaces.
Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the WebCenter application is deployed. |
Module: Oracle WebCenter
Use with WLST: Online
Deregisters an Oracle PDK-Java producer and deletes the associated connection, for a named WebCenter application.
deregisterPDKJavaProducer(appName, name, [server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the WebCenter application in which you want to perform this operation. |
name
|
Name of an existing PDK-Java producer. |
server
|
Optional. Name of the managed server where the WebCenter application is deployed. For example, WLS_Spaces.
Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the WebCenter application is deployed. |
The following example deregisters the wc-WebClipping producer, and deletes the associated connection.
wls:/weblogic/serverConfig> deregisterPDKJavaProducer(appName='webcenter', name='wc-WebClipping') Already in Domain Runtime Tree Producer wc-WebClipping has been deregistered. Already in Domain Runtime Tree "wc-WebClipping" successfully deleted Already in Domain Runtime Tree "wc-WebClipping-urlconn" successfully deleted
Module: Oracle WebCenter
Use with WLST: Online
Lists details for one or more Oracle PDK-Java producers registered with a named WebCenter application.
listPDKJavaProducers(appName, [name],[verbose], [server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the WebCenter application in which you want to perform this operation. |
name
|
Optional. Name of an existing PDK-Java portlet producer. If omitted, connection details for all PDK-Java producers configured for this WebCenter application are listed. |
verbose
|
Optional. Displays PDK-Java producer connection details in verbose mode. Valid options are true and false. When set to true, listPDKJavaProducers lists all connection properties. When set to false, listPDKJavaProducers lists connection names only. This argument defaults to true.
If you set this argument to |
server
|
Optional. Name of the managed server where the WebCenter application is deployed. For example, WLS_Spaces.
Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the WebCenter application is deployed. |
The following example lists all the connection properties (verbose mode) for the JPDKSamples producer.
wls:/weblogic/serverConfig> listPDKJavaProducers(appName='webcenter', name='JPDKSamples', verbose=true) ---------------------- wc-WebClipping ---------------------- Service Id: None Shared Key: None External Application Id: None Subscriber Id: None URL: http://myhost.com:9999/portalTools/webClipping/providers/webClipping ---------------------- wc-OmniPortlet ---------------------- Service Id: None Shared Key: None External Application Id: None Subscriber Id: None URL: http://myhost:9999/portalTools/omniPortlet/providers/omniPortlet
Module: Oracle WebCenter
Use with WLST: Online
Refreshes the metadata stored for a named producer to reflect the portlets that are currently offered by that producer.
refreshProducer(appName, producerName, [server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the WebCenter application in which the producer is registered. |
producerName
|
Name of an existing producer. |
server
|
Optional. Name of the managed server where the WebCenter application is deployed. For example, WLS_Spaces.
Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the WebCenter application is deployed. |
Module: Oracle WebCenter
Use with WLST: Online
Registers out-of-the-box producers provided with Oracle WebCenter: OmniPortlet, Web Clipping, Rich Text Portlet, and WSRP Tools.
registerOOTBProducers(producerHost, producerPort, appName, [server, applicationVersion])
| Argument | Definition |
|---|---|
producerHost
|
Host name or IP address of the server hosting out-of-the-box producers. |
producerPort
|
Port number for the server hosting out-of-the-box producers. |
appName
|
Name of the WebCenter application in which the out-of-the-box producers are to be registered. |
server
|
Optional. Name of the managed server where the WebCenter application is deployed. For example, WLS_Spaces.
Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the WebCenter application is deployed. |
The following example registers out-of-the-box producers in a WebCenter application named myApp.
wls:/weblogic/serverConfig> registerOOTBProducers(producerHost='myhost.com', producerPort=9999, appName='myApp') Registering Out-of-the-Box Producers Registering producers at http://myhost.com:9999 Registering Omniportlet Created connection wc-OmniPortlet-urlconn Created connection wc-OmniPortlet Producer connection wc-OmniPortlet has been registered. Registering WebClipping Created connection wc-WebClipping-urlconn Created connection wc-WebClipping Producer connection wc-WebClipping has been registered. Registering RichTextPortlet Created connection wc-RichText-wsconn Created connection wc-RichText Producer connection wc-RichText has been registered. Registering WSRP Tools Created connection wc-WSRPTools-wsconn Created connection wc-WSRPTools Producer connection wc-WSRPTools has been registered.
Module: Oracle WebCenter
Use with WLST: Online
Deregisters out-of-the-box producers provided with Oracle WebCenter: OmniPortlet, Web Clipping, Rich Text Portlet, and WSRP Tools.
deregisterOOTBProducers(appName, [server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the WebCenter application in which the out-of-the-box producers are currently registered. |
server
|
Optional. Name of the managed server where the WebCenter application is deployed. For example, WLS_Spaces.
Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the WebCenter application is deployed. |
The following example deregisters out-of-the-box WebCenter producers, and deletes their associated connections, in an application named myApp.
wls:/weblogic/serverConfig> deregisterOOTBProducers(appName='myApp')
Deregistering Out-of-the-Box Producers
Deregistering Omniportlet
Producer wc-OmniPortlet has been deregistered.
wc-OmniPortlet successfully deleted
wc-OmniPortlet-urlconn successfully deleted
Deregistering WebClipping
Producer wc-WebClipping has been deregistered.
wc-WebClipping successfully deleted
wc-WebClipping-urlconn successfully deleted
Deregistering RichTextPortlet
Producer wc-RichText has been deregistered.
wc-RichText successfully deleted
wc-RichText-wsconn successfully deleted
Deregistering WSRP Tools
Producer wc-WSRPTools has been deregistered.
wc-WSRPTools successfully deleted
wc-WSRPTools-wsconn successfully deleted
Module: Oracle WebCenter
Use with WLST: Online
Registers the sample producers provided with Oracle WebCenter with a named WebCenter application. There are two sample producers — WSRP Samples and JPDK Samples.
registerSampleProducers(producerHost, producerPort, appName, [server, applicationVersion])
| Argument | Definition |
|---|---|
producerHost
|
Host name or IP address of the server hosting the sample producers. |
producerPort
|
Port number for the server hosting the sample producers. |
appName
|
Name of the WebCenter application in which the sample producers are to be registered. |
server
|
Optional. Name of the managed server where the WebCenter application is deployed. For example, WLS_Spaces.
Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the WebCenter application is deployed. |
Module: Oracle WebCenter
Use with WLST: Online
Deregisters the Oracle WebCenter sample producers (WSRP Samples and JPDK Samples) from a named WebCenter application.
deregisterSampleProducers(appName, [server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the WebCenter application in which the sample producers are currently registered. If a value is not specified, this argument defaults to webcenter. |
server
|
Optional. Name of the managed server where the WebCenter application is deployed. For example, WLS_Spaces.
Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the WebCenter application is deployed. |
Use the commands listed in Table 5-17 to manage proxy settings for the RSS service.
Configuration changes made using these WebCenter WLST commands are only effective after your restart the Managed Server on which the WebCenter application is deployed. For details, see Oracle Fusion Middleware Administrator's Guide for Oracle WebCenter.
| Use this command... | To... | Use with WLST... |
|---|---|---|
|
Return the proxy host and proxy port used by the RSS service. |
Online |
|
|
Specify the proxy host and proxy port used by the RSS service. |
Online |
Module: Oracle WebCenter
Use with WLST: Online
Returns the proxy host and proxy port used by the RSS service. Depending on your network configuration, proxy details may be required to display external RSS news feeds in your WebCenter application.
getRssProxyConfig(appName, [server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the WebCenter application in which you want to perform this operation. |
server
|
Optional. Name of the managed server where the WebCenter application is deployed. For example, WLS_Spaces.
Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the WebCenter application is deployed. |
Module: Oracle WebCenter
Use with WLST: Online
Specifies the proxy host and port for the RSS service. Depending on your network configuration, proxy details may be required to display external RSS news feeds in your WebCenter application.
setRssProxyConfig(appName, proxyHost, proxyPort, [server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the WebCenter application in which you want to perform this operation. |
proxyHost
|
Host name of the proxy server. |
proxyPort
|
Port on which the proxy server is running. |
server
|
Optional. Name of the managed server where the WebCenter application is deployed. For example, WLS_Spaces.
Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the WebCenter application is deployed. |
Use the commands listed in Table 5-18 to manage Oracle Secure Enterprise Search (SES) connections and other search related properties for WebCenter applications.
Configuration changes made using these WebCenter WLST commands are only effective after your restart the Managed Server on which the WebCenter application is deployed. For details, see Oracle Fusion Middleware Administrator's Guide for Oracle WebCenter.
Table 5-18 Search WLST Commands
| Use this command... | To... | Use with WLST... |
|---|---|---|
|
Create a connection to an SES instance for a WebCenter application. |
Online |
|
|
Edit an existing SES search connection. |
Online |
|
|
List individual or all SES search connections that are configured for a specific WebCenter application. |
Online |
|
|
Modify search settings for a WebCenter application. |
Online |
|
|
Configure search settings for an existing SES search connection. |
Online |
|
|
List search properties for a WebCenter application. |
Online |
|
|
List SES properties for a WebCenter application. |
Online |
Module: Oracle WebCenter
Use with WLST: Online
Creates a connection to an Oracle Secure Enterprise Search (SES) instance for a WebCenter application.
createSESConnection(appName, name, url, appUser, appPassword,[default], [server], [applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the WebCenter application in which you want to perform this operation. |
name
|
Connection name. The name must be unique (across all connection types) within the WebCenter application. |
url
|
Web Services URL that Oracle Secure Enterprise Search exposes to enable Search requests.
Use the format: |
appUser
|
User name that the WebCenter application uses to authenticate itself as a trusted application to Oracle Secure Enterprise Search so that it may perform searches on behalf of WebCenter users.
The specified user must be present in both the Oracle Identity Management server configured for the WebCenter application and the Oracle Identity Management server configured for Oracle SES. |
appPassword
|
Password for the user name specified. |
default
|
Optional. Configures WebCenter Search service to actively use the search connection. Valid options are true and false.
Setting to |
server
|
Optional. Name of the managed server where the WebCenter application is deployed. For example, WLS_Spaces.
Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the WebCenter application is deployed. |
The following example creates a new search connection that points to the SES instance http://myhost.com:7777/search/query/OracleSearch and makes this connection the active search connection for the WebCenter application named app1.
wls:/weblogic/serverConfig> createSESConnection(appName='app1', name='SESConn1', url='http://myhost.com:7777/search/query/OracleSearch', appUser='wpadmin', appPassword='password', default=true)
Module: Oracle WebCenter
Use with WLST: Online
setSESConnection(appName, name, [url], [appUser],[appPassword],[default], [server], [applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the WebCenter application in which you want to perform this operation. |
name
|
Name of an existing search connection. |
url
|
Optional. Web Services URL that Oracle Secure Enterprise Search exposes to enable Search requests.
Use the format: |
appUser
|
Optional. User name that the WebCenter application uses to log in to Oracle Secure Enterprise Search so that it may perform searches on behalf of WebCenter users. |
appPassword
|
Optional. Password that the WebCenter application uses to log in to Oracle Secure Enterprise Search so that it may perform searches on behalf of WebCenter users. |
default
|
Optional. Configures WebCenter Search service to actively use the search connection. Valid options are true and false.
Setting to |
server
|
Optional. Name of the managed server where the WebCenter application is deployed. For example, WLS_Spaces.
Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the WebCenter application is deployed. |
The following example modifies the URL of a search connection named SESConn1 and makes the connection the active search connection for a WebCenter application named app1.
wls:/weblogic/serverConfig> setSESConnection(appName='app1', name='SESConn1', url='http://myhost.com:7777/search/query/OracleSearch', appUser='wpadmin', appPassword='password', default=true)
Module: Oracle WebCenter
Use with WLST: Online
Lists the names of all Oracle Secure Enterprise Search (SES) search connections configured for a WebCenter application.
listSESConnections(appName, [verbose], [name], [server], [applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the WebCenter application for which you want to perform this operation. |
verbose
|
Optional. Displays search connection details in verbose mode. Valid options are true and false. When set to true, listSESConnections lists all of the search connections that are configured for a WebCenter application, along with their details. When set to false, listSESConnections lists connection names only. This argument defaults to false.
If you set this argument to |
name
|
Optional. Name of an existing search connection. You can use this argument to view details about a specific connection. |
server
|
Optional. Name of the managed server where the WebCenter application is deployed. For example, WLS_Spaces.
Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the WebCenter application is deployed. |
The following example displays connection details for all search connections configured for a WebCenter application, named WebCenterApp.
wls:/weblogic/serverConfig> listSESConnections(appName='WebCenterApp', verbose='true')
The following example displays connection details for a search connection named SESConn1.
wls:/weblogic/serverConfig> listSESConnections(appName='WebCenterApp', verbose='true', name='SESConn1')
Module: Oracle WebCenter
Use with WLST: Online
Modifies search settings for a WebCenter application. If a parameter is not specified it is not modified.
setSearchConfig(appName,[numSavedSearches],[numResultsRegion],[numResultsMain], [numResultsToolbar],[executionTimeout],[prepareTimeout],[showAllExecutionTimeout], [server], [applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the WebCenter application in which you want to perform this operation. |
numSavedSearches
|
Optional. The number of saved searches to display in the Saved Searches drop down (on main search page). |
numResultsRegion
|
Optional. The number of saved searches displayed in a Saved Search task flow. |
numResultsMain
|
Optional. The number of search results displayed, per service, for searches submitted from the main search page. |
numResultsToolbar
|
Optional. The number of search results displayed, per service, for searches submitted from the global search toolbar. The value for this argument must be a valid number. |
executionTimeout
|
Optional. The maximum time that a service is allowed to execute a search (in ms). The value for this argument must be a valid number. |
prepareTimeout
|
Optional. The maximum time that a service is allowed to initialize a search (in ms). The value for this argument must be a valid number. |
showAllExecutionTimeout
|
Optional. The maximum time that a service is allowed to display search all results (in ms). The value for this argument must be a valid number. |
server
|
Optional. Name of the managed server where the WebCenter application is deployed. For example, WLS_Spaces.
Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the WebCenter application is deployed. |
The following example specifies that saved searches display five search results per service. Additionally, that a seven second search execution timeout is required.
wls:/weblogic/serverConfig> setSearchConfig(appName='webcenter', numResultsRegion=5, executionTimeout=7000);
The following example increases the number of saved searches in the Saved Searches drop down list to eight, while changing the number of results from global toolbar searches to ten, per service.
wls:/weblogic/serverConfig> setSearchConfig(appName='webcenter', numSavedSearches=8, numResultsToolbar=10);
The following example sets the search execution timeout to five seconds and allows each service fifteen seconds to display search results before timing out.
wls:/weblogic/serverConfig> setSearchConfig(appName='webcenter', executionTimeout=5000, showAllExecutionTimeout=15000);
Module: Oracle WebCenter
Use with WLST: Online
Configures search settings for an existing Oracle Secure Enterprise Search (SES) search connection. If a parameter is not specified it is not modified.
setSearchSESConfig(appName,[connectionName],[dataGroup],[topNRows], [server], [applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the WebCenter application in which you want to perform this operation. |
connectionName
|
Optional. Names the search connection that the Search service must use. |
dataGroup
|
Optional. Names the Secure Enterprise Search data group in which to search. If a value is not provided, everything in the Oracle Secure Enterprise Search instance will be searched. |
topNRows
|
Optional. Number of top N rows of search results for gathering refinement data. |
server
|
Optional. Name of the managed server where the WebCenter application is deployed. For example, WLS_Spaces.
Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the WebCenter application is deployed. |
The following example specifies that the Search service must use the search connection named SESConn1, and to search the data group named group2.
wls:/weblogic/serverConfig> setSearchSESConfig (appName='webcenter',connectionName='SESConn1', dataGroup='group2', topNRows=200);
The following example changes the maximum number of search results that the Search service returns. No connection name is specified, in this example, so this configuration change is applied to the current default (or active) search connection.
wls:/weblogic/serverConfig> setSearchSESConfig(appName='webcenter', topNRows=500);
Already in Domain Runtime Tree
Restart is needed for the service connection changes to take effect.
Module: Oracle WebCenter
Use with WLST: Online
listSearchConfig(appName, [server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the WebCenter application for which you want to perform this operation. |
server
|
Optional. Name of the managed server where the WebCenter application is deployed. For example, WLS_Spaces.
Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the WebCenter application is deployed. |
Module: Oracle WebCenter
Use with WLST: Online
listSearchSESConfig(appName, [server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the WebCenter application for which you want to perform this operation. |
server
|
Optional. Name of the managed server where the WebCenter application is deployed. For example, WLS_Spaces.
Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the WebCenter application is deployed. |
The following example displays SES search configuration information for a WebCenter application named webcenter.
wls:/weblogic/serverConfig> listSearchSESConfig(appName='webcenter')
Already in Domain Runtime Tree
-----------------
Search SES Config
-----------------
connectionName: SESConn1
dataGroup: group2
topNRows: 200
Use the commands listed in Table 5-19 to manage crawl settings for WebCenter Spaces.
Configuration changes made using these WebCenter WLST commands are effective immediately; no restart is required.
Table 5-19 WebCenter Spaces Crawler WLST Commands
| Use This Command... | To... | Use with WLST... |
|---|---|---|
|
Specify crawl properties for WebCenter Spaces. |
Online |
|
|
Return the current crawl settings for WebCenter Spaces. |
Online |
Module: Oracle WebCenter
Use with WLST: Online
Specifies crawl properties for WebCenter Spaces.
WebCenter Spaces can be crawled by Oracle SES to provide a faster, more unified search experience across WebCenter objects, specifically: group spaces, lists, pages, people (profiles), wikis, blogs, documents, discussions, and announcements. Three distinct crawlers make this possible:
WebCenter Spaces Crawler (for group spaces, lists, pages, people, wikis, and blogs)
Documents Crawler (for documents)
Discussions Crawler (for discussions and announcements).
You can use this command to enable or disable these Oracle SES crawlers in WebCenter Spaces.
You can also use this command to specify an interval between full crawls for the WebCenter Spaces Crawler. During a full crawl, all of the WebCenter Spaces Crawler content is re-read. Out-of-the-box, full crawls for the WebCenter Spaces Crawler occur every seven days but you can specify a different frequency to suit your installation.
Note that incremental crawls, for all three crawlers, are initiated by a scheduler running from Oracle SES. During these incremental crawls, only content added or updated since the previous crawl is processed.
setSpacesCrawlProperties(appName, [fullCrawlIntervalInHours, spacesCrawlEnabled, documentCrawlEnabled, discussionsCrawlEnabled, server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the WebCenter Spaces application—always webcenter. |
fullCrawlIntervalInHours
|
Optional. Number of hours between full crawls. The default is 168 hours or 7 days. |
spacesCrawlEnabled
|
Optional. Specifies whether the WebCenter Spaces Crawler is enabled in Oracle SES. Valid values are true and false. This argument defaults to false.
When set to |
documentCrawlEnabled
|
Optional. Specifies whether the Documents Crawler is enabled in Oracle SES. Valid values are true and false. This argument defaults to false.
When set to |
discussionsCrawlEnabled
|
Optional. Specifies whether the Discussions Crawler is enabled in Oracle SES. Valid values are true and false. This argument defaults to false.
When set to |
server
|
Optional. Name of the managed server where the WebCenter application is deployed. For example, WLS_Spaces.
Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the WebCenter application is deployed. |
Module: Oracle WebCenter
Use with WLST: Online
Returns the current crawl settings for WebCenter Spaces, such as the number of hours between full crawls (WebCenter Spaces crawler), and which Oracle SES crawlers are enabled (WebCenter Spaces crawler, Discussions crawler, and Document crawler).
getSpacesCrawlProperties(appName, [server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the WebCenter Spaces application—always webcenter. |
server
|
Optional. Name of the managed server where the WebCenter application is deployed. For example, WLS_Spaces.
Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the WebCenter application is deployed. |
The following example returns the current crawl settings for WebCenter Spaces.
wls:/weblogic/serverConfig>getSpacesCrawlProperties(appName='webcenter')
WebCenter Spaces Crawl Properties:-----------------fullCrawlIntervalInHours: 124spacesCrawlEnabled: truedocumentCrawlEnabled: truediscussionsCrawlEnabled: false
Use the commands listed in Table 5-20 to manage BPEL server connections for WebCenter applications.
Configuration changes made using these WebCenter WLST commands are only effective after your restart the Managed Server on which the WebCenter application is deployed. For details, see Oracle Fusion Middleware Administrator's Guide for Oracle WebCenter.
| Use this command... | To... | Use with WLST... |
|---|---|---|
|
Create a connection to a BPEL server for a WebCenter application. |
Online |
|
|
Edit an existing BPEL server connection. |
Online |
|
|
List all of the BPEL server connections that are configured for a WebCenter application. |
Online |
|
|
Enable an existing BPEL server connection for the Worklist service. |
Online |
|
|
Disable a BPEL server connection currently used by the Worklist service. |
Online |
|
|
List individual or all BPEL server connections configured for the Worklist service. |
Online |
Module: Oracle WebCenter
Use with WLST: Online
Creates a connection to a BPEL server for a named WebCenter application. BPEL server connections can be used by the application's Worklist service and WebCenter Spaces workflows.
To configure the Worklist service to actively use a new BPEL server connection, use the addWorklistConnection command. See addWorklistConnection.
To specify the BPEL server connection that WebCenter Spaces uses for its internal workflows, use the setSpacesWorkflowConnectionName command. See setSpacesWorkflowConnectionName.
createBPELConnection(appName, name, url, [policy], [server], [applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the WebCenter application in which you want to perform this operation. |
name
|
Connection name. The name must be unique (across all connection types) within the WebCenter application. |
url
|
URL required to access the BPEL server.
Use the format: The BPEL server URL must be unique within the WebCenter application. |
policy
|
Optional. SAML token policy this connection uses for authentication. This argument defaults to oracle/wss10_saml_token_client_policy. |
server
|
Optional. Name of the managed server where the WebCenter application is deployed. For example, WLS_Spaces.
Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the WebCenter application is deployed. |
The following example creates a connection named WebCenter Worklist with the URL value provided:
wls:/weblogic/serverConfig> createBPELConnection(appName='webcenter', name='WebCenter Worklist', url='http://myhost.com:8001', policy='oracle/wss10_saml_token_client_policy)
The following example creates a connection that uses the default security policy:
wls:/weblogic/serverConfig> createBPELConnection(appName='webcenter', name='WebCenter Worklist', url='http://myhost.com:8001')
Module: Oracle WebCenter
Use with WLST: Online
Edits an existing BPEL server connection. The BPEL server URL and the security policy are both editable.
To configure the Worklist service to actively use an existing BPEL server connection, use the addWorklistConnection command. See addWorklistConnection.
To specify the BPEL server connection used for Webcenter Spaces workflows, use the setSpacesWorkflowConnectionName command. See setSpacesWorkflowConnectionName.
setBPELConnection(appName, name,[url],[policy],[server], [applicationVersion])
| Argument | Definition |
|---|---|
appName |
Name of the WebCenter application in which you want to perform this operation. |
name
|
Existing BPEL server connection name. |
url
|
Optional. URL required to access the BPEL server.
Use the format: The BPEL server URL must be unique within the WebCenter application. |
policy
|
Optional. SAML token policy this connection uses for authentication. This argument defaults to oracle/wss10_saml_token_client_policy. |
server
|
Optional. Name of the managed server where the WebCenter application is deployed. For example, WLS_Spaces.
Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the WebCenter application is deployed. |
The following example updates the BPEL server URL and security policy for a connection named WebCenter Worklist.
wls:/weblogic/serverConfig> setBPELConnection(appName='webcenter', name='WebCenter Worklist',url='http://myhost.com:6666', policy='oracle/wss10_ saml_token_with_message_protection_client_policy')
The following example updates the BPEL server URL for a connection named WebCenter Worklist.
wls:/weblogic/serverConfig> setBPELConnection(appName='webcenter', name='WebCenter Worklist',url='http://myhost.com:8001')
Module: Oracle WebCenter
Use with WLST: Online
Without any arguments, this command lists all the BPEL connections that are configured for a specific WebCenter application. All BPEL connections are listed, even connections not currently used.
listBPELConnections(appName, [verbose], [name], [server], [applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the WebCenter application for which you want to list BPEL server connections. |
verbose
|
Optional. Displays BPEL server connection details in verbose mode. Valid options are true and false. When set to true, listBPELConnections lists all of the BPEL server connections that are configured, along with their details. When set to false, listBPELConnections lists connection names only. This argument defaults to false.
If you set this argument to |
name
|
Optional. Name of an existing BPEL server connection. You can use this argument to view details about a specific connection.
To list all the connections, omit the |
server
|
Optional. Name of the managed server where the WebCenter application is deployed. For example, WLS_Spaces.
Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the WebCenter application is deployed. |
The following example lists the names of all the BPEL server connections that are configured for a WebCenter application.
wls:/weblogic/serverConfig> listBPELConnections(appName='webcenter')
------------------
WebCenter Worklist
------------------
------------------
Human Resources Worklist
------------------
The following example lists the names and details of all of the BPEL server connections that are configured for a WebCenter application.
wls:/weblogic/serverConfig> listBPELConnections(appName='webcenter', verbose=true)
------------------
WebCenter Worklist
------------------
Connection Name: WebCenter Worklist
PolicyURI:oracle/wss10_saml_token_client_policy
URL:http://myhost.com:8001
------------------
Human Resources Worklist
------------------
Connection Name: Human Resources Worklist
PolicyURI:oracle/wss10_saml_token_client_policy
URL:http://myhost.com:8888
------------------
Module: Oracle WebCenter
Use with WLST: Online
Enable an existing BPEL server connection for Worklist services. The Worklist service supports multiple connections so that WebCenter users can monitor and manage assignments and notifications from a range of BPEL servers.
The name must specify an existing BPEL server connection.
addWorklistConnection(appName, name,[verbose, server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the WebCenter application in which you want to perform this operation. |
name
|
Name of an existing BPEL server connection. |
verbose
|
Optional. Displays output indicating whether a matching BPEL server connection exists and provides connection details. True turns verbose mode on; false turns verbose mode off. This argument defaults to false. |
server
|
Optional. Name of the managed server where the WebCenter application is deployed. For example, WLS_Spaces.
Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the WebCenter application is deployed. |
The following example enables the Human Resources Worklist connection for the Worklist service.
wls:/weblogic/serverConfig> addWorklistConnection(appName='webcenter', name='Human Resources Worklist', verbose=true) Human Resources Worklist successfully added to WorkList ------------------ Human Resources Worklist ------------------ Connection Name: Human Resources Worklist PolicyURI:oracle/wss10_saml_token_client_policy URL:http://myhost.com:8888
The following example also enables the Human Resources Worklist connection for the Worklist service.
wls:/weblogic/serverConfig> addWorklistConnection(appName='webcenter', name='Human Resources Worklist', verbose=true) Human Resources Worklist successfully added to WorkList ------------------ Human Resources Worklist ------------------ Connection Name: Human Resources Worklist PolicyURI:oracle/oracle/wss10_saml_token_client_policy URL:http://myhost.com:8888
Module: Oracle WebCenter
Use with WLST: Online
Disables a BPEL server connection that is currently used by the Worklist service. Connection details are retained but the Worklist service no longer uses the connection specified.
removeWorklistConnection(appName, name, [server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the WebCenter application in which you want to perform this operation. |
name
|
Name of an existing BPEL server connection. |
server
|
Optional. Name of the managed server where the WebCenter application is deployed. For example, WLS_Spaces.
Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the WebCenter application is deployed. |
Module: Oracle WebCenter
Use with WLST: Online
Without any arguments, this command lists all of the BPEL server connections that are configured for the Worklist service, in a named WebCenter application.
listWorklistConnections(appName, [verbose],[name], [server], [applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the WebCenter application for which you want to perform this operation. |
verbose
|
Optional. Displays BPEL server connection details in verbose mode. Valid options are true and false. When set to true, listWorklistConnections lists all of the BPEL server connections that are configured for the Worklist service, along with their details. When set to false, listWorklistConnections lists connection names only. This argument defaults to false.
If you set this argument to |
name
|
Optional. Name of an existing BPEL server connection. You can use this argument to view details about a specific connection.
To list all connections, omit the |
server
|
Optional. Name of the managed server where the WebCenter application is deployed. For example, WLS_Spaces.
Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the WebCenter application is deployed. |
The following example lists the names of all of the BPEL server connections that are configured for the Worklist service.
wls:/weblogic/serverConfig> listWorklistConnections(appName='webcenter')
------------------
WebCenter Worklist
------------------
The following example lists both the names and connection details of all of the BPEL server connections that are configured for the Worklist service.
wls:/weblogic/serverConfig> listWorklistConnections(appName='webcenter', verbose=true)
------------------
WebCenter Worklist
------------------
Connection Name: WebCenter Worklist
PolicyURI:oracle/wss10_saml_token_client_policy
URL:http://myhost.com:8001
The following example lists connection details of a named BPEL server connection—MyWorklist. As the Worklist service is not currently configured to use MyWorklist, an appropriate message displays.
wls:/weblogic/serverConfig> listWorklistConnections(appName='webcenter', verbose=true, name='MyWorklist') ------------------ The following connection is not in the ADF Worklist:MyWorklist
Use the commands listed in Table 5-21 to manage the BPEL server connection used for WebCenter Spaces workflows (group space membership notifications, group space subscription requests, and so on).
Configuration changes made using these WebCenter WLST commands are only effective after your restart the Managed Server on which the WebCenter Spaces deployed. For details, see Oracle Fusion Middleware Administrator's Guide for Oracle WebCenter.
Table 5-21 WebCenter Spaces Workflow WLST Commands
| Use This Command... | To... | Use with WLST... |
|---|---|---|
|
Return the name of the BPEL server connection that WebCenter Spaces is using for internal workflows. |
Online |
|
|
Specify the BPEL server connection used for Webcenter Spaces workflows. |
Online |
Module: Oracle WebCenter
Use with WLST: Online
Returns the name of the BPEL server connection that WebCenter Spaces is currently using for internal workflows (group space membership notifications, group space subscription requests, and so on).
getSpacesWorkflowConnectionName(appName, [server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the WebCenter Spaces application—always webcenter. |
server
|
Optional. Name of the managed server where the WebCenter application is deployed. For example, WLS_Spaces.
Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the WebCenter application is deployed. |
Module: Oracle WebCenter
Use with WLST: Online
Specifies the BPEL server connection that Webcenter Spaces uses for internal workflows. WebCenter Spaces uses a BPEL server included with the Oracle SOA Suite to host internal workflows, such as group space membership notifications, group space subscription requests, and so on. The connection name specified here must be a valid BPEL server connection.
setSpacesWorkflowConnectionName(appName, name, [server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the WebCenter Spaces application—always webcenter. |
name
|
Name of an existing BPEL connection. |
server
|
Optional. Name of the managed server where the WebCenter application is deployed. For example, WLS_Spaces.
Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the WebCenter application is deployed. |
Use the commands listed in Table 5-22 to manage wiki and blog server connections for a WebCenter application.
Configuration changes made using these WebCenter WLST commands are only effective after your restart the Managed Server on which the WebCenter application is deployed. For details, see Oracle Fusion Middleware Administrator's Guide for Oracle WebCenter.
Table 5-22 Wiki and Blog WLST Commands
| Use this command... | To... | Use with WLST... |
|---|---|---|
|
Create a wiki and blog server connection for a named WebCenter application. |
Online |
|
|
Edit an existing wiki and blog server connection. |
Online |
|
|
List wiki and blog server connections for a named WebCenter application. |
Online |
|
|
List the default connection used by the Wiki and Blog service. |
Online |
Module: Oracle WebCenter
Use with WLST: Online
createWikiserverConnection(appName, name, url, passcode [default, server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the WebCenter application in which you want to perform this operation. |
name
|
Connection name. The name must be unique (across all connection types) within the WebCenter application. |
url
|
Base URL for the wiki and blog server. Enter an Oracle WebCenter Wiki and Blog Server URL. Use the format: <protocol>://<host>:<port> |
passcode
|
Passcode that is required to call methods in Oracle WebCenter Wiki and Blog Web Services. The passcode is an arbitrary string that the administrator sets up in Oracle WebCenter Wiki and Blog Server after installation to prevent unauthorized access. Contact the administrator to obtain the server's passcode. |
default
|
Optional. Indicates whether this connection is the default connection for the Wiki and Blog service. Valid values are true and false. The default for this argument is false.
To specify that the Wiki and Blog service uses this connection, set the value to While you can register multiple connections for a WebCenter application, only one connection is used for wiki and blog services— the default (or active) connection. |
server
|
Optional. Name of the managed server where the WebCenter application is deployed. For example, WLS_Spaces.
Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the WebCenter application is deployed. |
Module: Oracle WebCenter
Use with WLST: Online
setWikiserverConnection(appName, name, [url, passcode, default, server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the WebCenter application in which you want to perform this operation. |
name
|
Connection name. The name must be unique (across all connection types) within the WebCenter application. |
url
|
Optional. Base URL for the wiki and blog server. Enter an Oracle WebCenter Wiki and Blog Server URL. Use the format: <protocol>://<host>:<port> |
passcode
|
Optional. Passcode that is required to call methods in Oracle WebCenter Wiki and Blog Web Services. The passcode is an arbitrary string that the administrator sets up in Oracle WebCenter Wiki and Blog Server after installation to prevent unauthorized access. Contact the administrator to obtain the server's passcode. |
default
|
Optional. Indicates whether this connection is the default connection for the Wiki and Blog service. Valid values are true and false.
To specify that the Wiki and Blog service uses this connection, set the value to While you can register multiple connections for a WebCenter application, only one connection is used for wiki and blog services— the default (or active) connection. |
server
|
Optional. Name of the managed server where the WebCenter application is deployed. For example, WLS_Spaces.
Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the WebCenter application is deployed. |
Module: Oracle WebCenter
Use with WLST: Online
Lists all of the wiki and blog server connections that are configured for a named WebCenter application.
listWikiserverConnections(appName, [verbose, name, server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the WebCenter application in which you want to perform this operation. |
verbose
|
Optional. Displays connection details for the Wiki and Blog service in verbose mode. Valid options are true and false. When set to true, listWikiserverConnections lists all of the wiki and blog server connections that are configured for a WebCenter application, along with their details. When set to false, only connection names are listed. This argument defaults to false.
When set to |
name
|
Optional. Name of an existing wiki and blog connection. Use this argument to view connection details for a specific wiki and blog server. |
server
|
Optional. Name of the managed server where the WebCenter application is deployed. For example, WLS_Spaces.
Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the WebCenter application is deployed. |
The following example lists connection names and details for all of the wiki and blog server connections currently configured for WebCenter Spaces.
wls:/weblogic/serverConfig>listWikiserverConnections(appName='webcenter', verbose=true)
The following example displays connection details for a wiki and blog server connection named MyWikiConnection.
wls:/weblogic/serverConfig>listWikiserverConnections(appName='webcenter', verbose=true, name='MyWikiConnection')
Module: Oracle WebCenter
Use with WLST: Online
Lists the connection that the Wiki and Blog service is using, in a named WebCenter application. While you can register multiple wiki and blog server connections for a WebCenter application, the Wiki and Blog service only uses one connection —the default (or active) connection.
listDefaultWikiserverConnection(appName, verbose, [server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the WebCenter application in which you want to perform this operation. |
verbose
|
Optional. Displays the default wiki and blog server connection in verbose mode, if available. Valid options are true and false. When set to true, the name and details of the wiki and blog server connection are listed. When set to false, only the connection name displays. This argument defaults to false. |
server
|
Optional. Name of the managed server where the WebCenter application is deployed. For example, WLS_Spaces.
Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the WebCenter application is deployed. |
Use the commands listed in Table 5-23 to configure options for searching a WebCenter application's identity store.
Table 5-23 WebCenter Identity Store WLST Commands
| Use this command... | To... | Use with WLST... |
|---|---|---|
|
Modify configuration options for searching a WebCenter applications's identity store. |
Online |
|
|
List current configuration options for searching a WebCenter application's identity store. |
Online |
Module: Oracle WebCenter
Use with WLST: Online
Modifies configuration options for searching a WebCenter application's identity store. Use these settings to optimize identity store searches (for users and roles) in a WebCenter application.
Identity store search parameters are stored in adf-config.xml. If a search parameter is not specified, it is not modified.
setWebCenterIdStoreSearchConfig(appName,[narrowSearchTimeout, broadSearchTimeout, maxSearchFilters, maxFetchRecords, server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the WebCenter application in which you want to perform this operation. |
narrowSearchTimeout
|
Optional. The maximum time allowed (in ms) for small, simple searches, such as fetching a single user from the identity store. The out-of-the-box default is 30000ms. |
broadSearchTimeout
|
Optional. The maximum time allowed (in ms) to return large result sets, such as returning users and roles that match a name pattern. The out-of-the-box default is 60000. |
maxSearchFilters
|
Optional. The number of search filters allowed for the WebCenter application's identity store. The maximum allowed, out-of-the-box, is 100.
Some identity store searches are executed using search filters which are converted into LDAP search calls. If your associated LDAP server limits the search condition, you can set the |
maxFetchRecords
|
Optional. The maximum number of records to be returned from each search query. The out-of-the-box default is 100.
The value of this setting will impact the performance of your LDAP server so take this into consideration when increasing the search result limit. Note that the LDAP server imposes its own search result limit, so the actual limit that is used will be the lesser of these two values. |
server
|
Optional. Name of the managed server where the WebCenter application is deployed. For example, WLS_Spaces.
Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the WebCenter application is deployed. |
The following example increases both identity store search timeouts.
wls:/weblogic/serverConfig>setWebCenterIdStoreSearchConfig(appName='webcenter', narrowSearchTimeout=60000, broadSearchTimeout=100000);
The following example limits the maximum number of records returned to 100.
wls:/weblogic/serverConfig>setWebCenterIdStoreSearchConfig(appName='webcenter', maxFetchRecords=100);
Module: Oracle WebCenter
Use with WLST: Online
Lists current configuration options for searching the WebCenter application's identity store.
Identity store search parameters are stored in adf-config.xml.
listWebCenterIdStoreSearchConfig(appName,[server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the WebCenter application in which you want to perform this operation. |
server
|
Optional. Name of the managed server where the WebCenter application is deployed. For example, WLS_Spaces.
Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the WebCenter application is deployed. |
The following example displays identity store search configuration information for a WebCenter application named webcenter.
wls:/weblogic/serverConfig>listWebCenterIdStoreSearchConfig(appName='webcenter');
----------------- User role search configuration parameters ----------------- Narrow search timeout : 30000 Broad search timeout : 60000 Maximum search filters : 100 Maximum records to fetch : 200
Use the commands listed in Table 5-24 to export and import WebCenter Spaces and producer metadata associated with custom WebCenter applications.
Table 5-24 Import and Export WLST Commands
| Use this command... | To... | Use with WLST... |
|---|---|---|
|
Export WebCenter Spaces to a WebCenter export archive. |
Online |
|
|
Import WebCenter Spaces from a WebCenter export archive. |
Online |
|
|
Export one or more group spaces to a WebCenter export archive. |
Online |
|
|
Export one or more group space templates to a WebCenter export archive. |
Online |
|
|
Import one or more group spaces or group space templates from a WebCenter export archive. |
Online |
|
|
Export portlet client metadata and producer customizations and personalizations to a WebCenter export archive. Custom WebCenter applications only. |
Online |
|
|
Import portlet client metadata and producer customizations and personalizations from a WebCenter export archive. Custom WebCenter applications only. |
Online |
Module: Oracle WebCenter
Use with WLST: Online
(WebCenter Spaces only) Exports a WebCenter Spaces application to a WebCenter export archive (.EAR) using the filename provided.
exportWebCenterApplication(appName, fileName, [exportCustomizations, exportSecurity, exportData, server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the WebCenter Spaces application in which you want to perform this operation. |
fileName
|
Name of the export archive EAR file to which you want the export to be written. |
exportCustomizations
|
Optional. Valid values are true and false. When set to true, all customizations are exported. When set to false, customizations are not exported, that is, default task flows are exported without any customizations. This argument defaults to true. |
exportSecurity
|
Optional. Valid values are true and false. When set to true, policy-store.xml contains application roles and permissions, as well as user details and their role assignments. When set to false, policy-store.xml contains application roles and permissions only. User details are not exported. This argument defaults to false. |
exportData
|
Optional. Valid values are true and false. When set to true, data stored in the WebCenter Spaces database for lists, events, tags, and links is exported. When set to false, this data is not exported. This argument defaults to false. |
server
|
Optional. Name of the managed server where the WebCenter application is deployed. For example, WLS_Spaces.
Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the WebCenter application is deployed. |
The following example exports a WebCenter Spaces application and all possible data to a file named myExport.ear.
wls:/weblogic/serverConfig> exportWebCenterApplication(appName='webcenter', fileName='myExport.ear', exportCustomizations=true, exportSecurity=true, exportData=true)
The following example exports a test application with the intention of importing the resultant EAR to an alternative system with a different user base. In this case, security policies (which might reference users or roles specific to the originating server) are not required. Additionally, data created during testing (such as lists, group space events, links, tags) is not required.
wls:/weblogic/serverConfig> exportWebCenterApplication(appName='webcenter', fileName='export.ear')
Module: Oracle WebCenter
Use with WLST: Online
(WebCenter Spaces only) Imports a WebCenter Spaces application from a WebCenter export archive file to a server.
After importing WebCenter Spaces you will need to restart the managed server where the application is deployed.
importWebCenterApplication(appName, fileName, [server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the WebCenter Spaces application in which you want to perform this operation. |
fileName
|
Name of the WebCenter export archive that you want to import. |
server
|
Optional. Name of the managed server where the WebCenter application is deployed. For example, WLS_Spaces.
Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the WebCenter application is deployed. |
Module: Oracle WebCenter
Use with WLST: Online
(WebCenter Spaces only) Exports one or more group spaces to a WebCenter export archive (.EAR), using the filename specified.
exportGroupSpaces(appName, fileName, names, [exportCustomizations, exportSecurity, exportData, server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the WebCenter Spaces application in which you want to perform this operation—always webcenter. |
fileName
|
Name of the local file to which the export will be written. |
names
|
Names of the group spaces that you want to export. Separate multiple group space names with a comma. |
exportCustomizations
|
Optional. Valid values are true and false. When set to false, customizations are not exported, that is, default task flows are exported without any customizations. This argument defaults to true. |
exportSecurity
|
Optional. Valid values are true and false. When set to true, policy-store.xml contains group space roles and permissions, as well as member details and their role assignments. When set to false, policy-store.xml contains group space roles and permissions only. Member details are not exported. This argument defaults to false. |
exportData
|
Optional. Valid values are true and false. When set to true, group space data stored in the WebCenter Spaces database for lists, events, tags, and links is exported. When set to false, this data is not exported. This argument defaults to false. |
server
|
Optional. Name of the managed server where the WebCenter application is deployed. For example, WLS_Spaces.
Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the WebCenter application is deployed. |
The following example exports two group spaces (myGroup1 and myGroup2) from a WebCenter Spaces application named webcenter.
wls:/weblogic/serverConfig> exportGroupSpaces(appName='webcenter', fileName='myExport.ear', names='myGroup1, myGroup2', exportCustomizations=true, exportSecurity=true, exportData=true)
Module: Oracle WebCenter
Use with WLST: Online
(WebCenter Spaces only) Exports one or more group space templates to a WebCenter export archive (.EAR), using the filename specified.
exportGroupSpaceTemplates(appName, fileName, names, [server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the WebCenter Spaces application in which you want to perform this operation—always webcenter. |
fileName
|
Name of the local file to which the export will be written. |
names
|
Names of the group space templates that you want to export. Separate multiple group space template names with a comma. |
server
|
Optional. Name of the managed server where the WebCenter application is deployed. For example, WLS_Spaces.
Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the WebCenter application is deployed. |
The following example exports two group space templates (myGroupTemplate1 and myGroupTemplate2) from a WebCenter Spaces application named webcenter.
wls:/weblogic/serverConfig> exportGroupSpaceTemplates(appName='webcenter', fileName='myExport.ear', names='myGroupTemplate1, myGroupTemplate2')
Module: Oracle WebCenter
Use with WLST: Online
(WebCenter Spaces only) Imports one or more group spaces or group space templates from a WebCenter export archive.
importGroupSpaces(appName, fileName, [server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the WebCenter Spaces application in which you want to perform this operation—always webcenter. |
fileName
|
Name of the WebCenter archive file that you want to import. |
server
|
Optional. Name of the managed server where the WebCenter application is deployed. For example, WLS_Spaces.
Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the WebCenter application is deployed. |
Module: Oracle WebCenter
Use with WLST: Online
Exports portlet client metadata and producer customizations and personalizations, for a custom WebCenter application. This command exports metadata for all the application's producers to a named export archive (.EAR file). You cannot opt to export metadata for specific producers.
Only use this command to migrate producer data associated with custom WebCenter applications. Do not use this command for WebCenter Spaces.
exportPortletClientMetadata(appName, fileName, [exportPersonalizations, server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the custom WebCenter application in which you want to perform this operation. |
fileName
|
Name of the export archive (.EAR) to which you want the export to be written. |
exportPersonalizations
|
Optional. Valid values are true and false. When set to true, personalizations for all producers are exported. When set to false, personalizations are not exported. This argument defaults to true. |
server
|
Optional. Name of the managed server where the WebCenter application is deployed. For example, WLS_Spaces.
Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the WebCenter application is deployed. |
The following example exports portlet client metadata and producer customizations and personalizations to an export archive named myExport.ear. Personalizations are not exported.
wls:/weblogic/serverConfig> exportPortletClientMetadata(appName='myApp', fileName='myExport.ear', exportPersonalizations=false)
Module: Oracle WebCenter
Use with WLST: Online
Imports portlet client metadata and producer customizations and personalizations from a named WebCenter export archive.
Producer personalizations are optional on export. Producer personalizations are imported if the export archive specified includes personalizations.
Only use this command to migrate producer data for a custom WebCenter application. Do not use this command for WebCenter Spaces.
importPortletClientMetadata(appName, fileName, [server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the custom WebCenter application in which you want to perform this operation. |
fileName
|
Name of the WebCenter export archive that you want to import. |
server
|
Optional. Name of the managed server where the WebCenter application is deployed. For example, WLS_Spaces.
Required when applications with the same name are deployed to different servers 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. |