Note:
To use these commands, you must invoke WLST from the Oracle home (ORACLE_HOME) directory. See Running Oracle WebLogic Scripting Tool (WLST) Commands in Administering Oracle WebCenter Portal.
Most configuration changes made using these WLST commands are only effective after you restart the Managed Server on which WebCenter Portal is deployed. There are some exceptions, including WLST commands for External Applications, Portlet Producers, and Lifecycle.
For additional details about Oracle WebCenter Portal configuration, see Introduction to Administration for Oracle WebCenter Portal in Administering Oracle WebCenter Portal.
Note:
Beginning with 12c (12.2.1.3.0), Oracle WebCenter Portal has deprecated support for Jive features (announcements and discussions). If you are upgrading from a prior release, these features remain available in your existing installations that are being upgraded.
Oracle WebCenter Portal's custom WLST commands are described in the following sections:
Oracle WebCenter Portal's WLST commands are grouped into the several categories (Table 2-1).
Most configuration changes made using these WLST commands are only effective after you restart the Managed Server on which WebCenter Portal is deployed. The only exceptions are the External Applications, Portlet Producers, and Lifecycle WLST commands.
Table 2-1 WLST Command Categories
| Command Category | Description |
|---|---|
|
Manage connections for WebCenter Portal. |
|
|
Manage analytics collector connections and configure the analytics collector. |
|
|
Archive and restore activity stream data. |
|
|
Manage content repository connections and configure document services. |
|
| Manage discussions server connections and configure discussions and announcements. | |
|
Manage external application connections. |
|
|
Manage instant messaging and presence server connections and configure instant messaging and presence. |
|
|
Manage mail server connections and configure mail. |
|
|
Manage settings for notifications. |
|
|
Manage profile information. |
|
|
Manage personal event server connections. |
|
|
Manage portlet producers. |
|
|
Manage proxy settings for RSS and activity stream. |
|
|
Manage Elasticsearch (ES) connections. |
|
|
Manage Oracle Secure Enterprise Search (SES) connections and other search-related properties. |
|
|
Manage Oracle Secure Enterprise Search (SES) crawlers. |
|
|
Manage search crawlers for WebCenter Portal. |
|
|
Manage BPEL server connections. |
|
|
Manage WebCenter Portal workflow settings and portal metadata. |
|
|
Configure options while searching an application's identity store. |
|
|
Export and import application metadata, individual portals, portal templates, portal assets, and portlet producer metadata. |
|
|
Upgrade from a previous Oracle WebCenter Portal release. |
Use the General commands, listed in Table 2-2, to manage connections, and perform other general tasks.
Configuration changes made using these WLST commands are only effective after restarting the Managed Server on which WebCenter Portal is deployed.
Table 2-2 General WLST Commands
| Use This Command... | To... | Use with WLST... |
|---|---|---|
|
Delete any connection. |
Online |
|
|
List all connection types. |
Online |
|
|
Set WebCenter Portal Service Framework configuration properties. |
Online |
|
|
Return WebCenter Portal Framework configuration properties. |
Online |
|
|
Return status information for the last Oracle WebCenter Portal command executed. |
Online |
Module: Oracle WebCenter Portal
Use with WLST: Online
Description
Deletes a named connection currently configured for WebCenter Portal.
If you use deleteConnection to delete a WSRP or PDK-Java producer connection (instead of using deregisterWSRPProducer or deregisterPDKJavaProducer), unused secondary connections will remain, which you might want to remove. For example, when you delete a WSRP producer connection, its associated web service connection remains and when you delete a PDK-Java producer connection, its associated URL connection remains.
Syntax
deleteConnection(appName, name, [server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the application in which to perform this operation. For WebCenter Portal, the application name is always |
name
|
Connection name. |
server
|
Optional. Name of the managed server where the application is deployed. For example, Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the application is deployed. |
Example
The following example deletes a connection configured for WebCenter Portal (webcenter):
wls:/weblogic/serverConfig> deleteConnection(appName='webcenter', name='MyConnection')
Module: Oracle WebCenter Portal
Use with WLST: Online
Description
Sets configuration properties for Oracle WebCenter Portal's services framework, such as the Resource Action Handler class and display as popup properties.
Syntax
setWebCenterServiceFrameworkConfig(appName, [resourceActionHandlerClassName, resourceActionHandlerDisplayInPopup, server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the application in which to perform this operation. For WebCenter Portal, the application name is always |
resourceActionHandlerClassName
|
Optional. Class used by the Service Framework Resource Action Handler. |
|
|
Optional. Indicates whether the Resource Action Handler displays resources in a popup or inline. Valid options are |
server
|
Optional. Name of the managed server where the application is deployed. For example, Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the application is deployed. |
Example
The following example sets the WebCenter Portal Service Framework Resource Action Handler class to my.company.ResourceActionHandler:
wls:/wc_domain/domainRuntime> setWebCenterServiceFrameworkConfig(appName='webcenter', resourceActionHandlerClassName='my.company.ResourceActionHandler') Successfully set the WebCenter Portal service framework configuration. Resource Action Handler class: my.company.ResourceActionHandler To effect connection changes, you must restart the managed server on which the application is deployed.
The following example sets only the WebCenter Portal Service Framework Resource Action Handler display as popup value to 1 (true):
wls:/wc_domain/domainRuntime>
setWebCenterServiceFrameworkConfig(appName='webcenter', resourceActionHandlerDisplayInPopup=1)
Successfully set the WebCenter Portal service framework configuration.
Resource Action Handler Display In Popup: true
To effect connection changes, you must restart the managed server on which the application is deployed.
Module: Oracle WebCenter Portal
Use with WLST: Online
Description
Returns WebCenter Portal Service Framework configuration property settings, such as:
resourceActionHandlerClassName: Class currently used by the WebCenter Portal Service Framework Resource Action Handler
resourceActionHandlerDisplayInPopup: Indicates whether the Resource Action Handler displays resources in a popup or inline. Valid options are 1 (true) and 0 (false).
Syntax
getWebCenterServiceFrameworkConfig(appName, [server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the application in which to perform this operation. For WebCenter Portal, the application name is always |
server
|
Optional. Name of the managed server where the application is deployed. For example, Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the application is deployed. |
Example
The following example returns the service framework resource action handler class and display as popup properties, for WebCenter Portal (webcenter):
wls:/weblogic/serverConfig>getWebCenterServiceFrameworkConfig(appName='webcenter')
Resource Action Handler Class: my.company.ResourceActionHandler
Resource Action Handler Display In Popup: true
Module: Oracle WebCenter Portal
Use with WLST: Online
Description
Returns the status of last WebCenter Portal command executed.
Use the webcenterErrorOccurred command to determine the status of the last WebCenter Portal command executed. The command returns 1 if an error occurred or 0 otherwise.
Syntax
webcenterErrorOccurred ()
Example
The following example returns 1 if an error occurred:
wls:/mydomain/serverConfig> webcenterErrorOccurred()
Module: Oracle WebCenter Portal
Use with WLST: Online
Description
Lists all the Oracle WebCenter Portal connection types.
Syntax
getWebCenterConnectionTypes(appName, [server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the application in which to perform this operation. For WebCenter Portal, the application name is always |
server
|
Optional. Name of the managed server where the application is deployed. For example, Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the application is deployed. |
Example
The following example returns connection types for WebCenter Portal (webcenter):
wls:/mydomain/serverConfig>getWebCenterConnectionTypes(appName='webcenter')
This section includes the commands to manage analytics collector connections and configure analytics collector for WebCenter Portal.
Analytics Collector Connections
Use the commands listed in Table 2-3 to manage analytics collector connections for WebCenter Portal. Events raised in these portal applications using OpenUsage APIs can be sent to an analytics collector for use by analytics.
Connection configuration changes made using these Oracle WebCenter Portal WLST commands are only effective after your restart the Managed Server on which the application is deployed.
Table 2-3 Analytics Collector Connection WLST Commands
| Use this command... | To... | Use with WLST... |
|---|---|---|
|
Create a connection to an analytics collector for WebCenter Portal. |
Online |
|
|
Edit an existing analytics collector connection. |
Online |
|
|
List all of the analytics collector connections that are configured for WebCenter Portal. |
Online |
|
|
Specify the default (or active) analytics collector connection for WebCenter Portal. |
Online |
|
|
Return connection details for the analytics collector being used by WebCenter Portal. |
Online |
Analytics Collector and Cluster Configuration
Use the commands listed in Table 2-4 to configure event collection properties for the analytics collector that is deployed on the WC_Utilities managed server.
If you reconfigure the analytics collector or set up clustering, you must restart the managed server on which the analytic collector is deployed (WC_Utilities).
Table 2-4 Analytics Collector Configuration WLST Commands
| Use this command... | To... | Use with WLST... |
|---|---|---|
|
Set analytics collector options, and cluster options if operating a clustered environment. |
Online |
|
|
Return analytics collector settings. |
Online |
|
|
List events currently registered with the analytics collector. |
Online |
Module: Oracle WebCenter Portal
Use with WLST: Online
Description
Creates a connection to an analytics collector for a named application.
Events raised in WebCenter Portal using OpenUsage APIs can be sent to an analytics collector for use by analytics.
While you can register multiple analytics collector connections for an application, only one analytics collector connection is used - the default (or active) connection where default=1.
Syntax
createAnalyticsCollectorConnection(appName, connectionName, [isUnicast, collectorhost, clusterName, collectorPort, isEnabled, timeout, default, server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the application in which to perform this operation. For WebCenter Portal, the name is always |
connectionName
|
Connection name. The name must be unique across all connection types within application. |
isUnicast
|
Optional. Specifies whether events are sent to a clustered analytics collector in multicast mode or whether a single analytics collector using unicast communication is required. Valid values are |
collectorHost
|
Optional. Host name where the analytics collector is running. The default value is Only required for unicast communication, that is, where |
clusterName
|
Optional. Name of the cluster where a clustered analytics collector is running. Only required for multicast communication, that is, where |
collectorPort
|
Optional. Port on which the analytics collector listens for events. The default value is |
isEnabled
|
Optional. Specifies whether to send analytics events raised using OpenUsage APIs to the analytics collector. Valid values Analytics events are sent to the analytics collector when |
timeout
|
Optional. Length of time (in seconds) to wait for a response from the analytics collector. Default value is Only required for multicast communication, that is, where |
default
|
Optional. Indicates whether this connection is the default (or active) analytics collector connection for the application. Valid values are While you can register multiple analytics collector connections for an application, only one connection is used by analytics—the default (or active) connection. |
server
|
Optional. Name of the managed server where the application is deployed. For example, Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the application is deployed. |
Example
The following example creates a connection named MyAnalyticsCollector for WebCenter Portal (webcenter). Events are sent to a single analytics collector using unicast communication:
wls:/weblogic/serverConfig>createAnalyticsCollectorConnection(appName='webcenter', connectionName='MyAnalyticsCollector', isUnicast=1, collectorHost='myhost.com', collectorPort=31314, isEnabled=1, timeout=30, default=1)
The following example creates a connection named MyAnalyticsCollector for WebCenter Portal. Events are sent to a clustered analytics collector in multicast mode
wls:/weblogic/serverConfig>createAnalyticsCollectorConnection(appName='webcenter', connectionName='MyAnalyticsCollector', isUnicast=0, clusterName='collector-cluster', ccollectorPort=31314, isEnabled=1, timeout=30, default=1)
Module: Oracle WebCenter Portal
Use with WLST: Online
Description
Edits an existing analytics collector connection for a named application.
Events raised in WebCenter Portal using OpenUsage APIs can be sent to an analytics collector for use by analytics.
While you can register multiple analytics collector connections for an application, only one analytics collector connection is used - the default (or active) connection.
Syntax
setAnalyticsCollectorConnection(appName, connectionName, [isUnicast, collectorHost, clusterName, collectorPort, isEnabled, timeout, default, server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the application in which to perform this operation. For WebCenter Portal, the name is always |
connectionName
|
Connection name. The name must be unique across all connection types within application. |
isUnicast
|
Optional. Specifies whether events are sent to a clustered analytics collector in multicast mode or whether a single analytics collector using unicast communication is required. Valid values are |
collectorHost
|
Optional. Host name where the analytics collector is running. The default value is Only required for unicast communication, that is, where |
clusterName
|
Optional. Name of the cluster where a clustered analytics collector is running. Only required for multicast communication, that is, where |
collectorPort
|
Optional. Port on which the analytics collector listens for events. The default value is |
isEnabled
|
Optional. Specifies whether to send analytics events raised using OpenUsage APIs to the analytics collector. Valid values are Analytics events are sent to the analytics collector when |
timeout
|
Optional. Length of time (in seconds) to wait for a response from the analytics collector. Default value is Only required for multicast communication, that is, where |
default
|
Optional. Indicates whether this connection is the default (or active) analytics collector connection for the application. Valid values are While you can register multiple analytics collector connections for an application, only one connection is used by analytics—the default (or active) connection. |
server
|
Optional. Name of the managed server where the application is deployed. For example, Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the application is deployed. |
Example
The following example edits host and port details for an existing analytics collector connection named MyAnalyticsCollector. On this connection, events are sent to a single analytics collector in unicast mode:
wls:/weblogic/serverConfig>setAnalyticsCollectorConnection(appName='webcenter', connectionName='MyAnalyticsCollector', collectorHost='myhost.com', collectorPort=31314)
The following example edits cluster, port, and timeout details for an existing analytics collector connection named MyAnalyticsCollector. On this connection, events are sent to a clustered analytics collector in multicast mode:
wls:/weblogic/serverConfig>setAnalyticsCollectorConnection(appName='webcenter', connectionName='MyAnalyticsCollector', clusterName='collector-cluster', collectorPort=31314, timeout=60)
Module: Oracle WebCenter Portal
Use with WLST: Online
Description
Lists connection names and details for all analytics collector connections that are configured for a named application.
Syntax
listAnalyticsCollectorConnections(appName, [server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the application in which to perform this operation. For WebCenter Portal, the application name is always |
server
|
Optional. Name of the managed server where the application is deployed. For example, Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the application is deployed. |
Example
The following example lists connection names and details for all the analytics collector connections that are currently configured for WebCenter Portal (webcenter):
wls:/weblogic/serverConfig>listAnalyticsCollectorConnections(appName='webcenter')
------------------
MyAnalyticsCollector
------------------
ClusterName/HostName: localhost
Port: 31314
Timeout: 30
Unicast: 1 (true)
Enabled: 1 (true)
------------------
TestAnalyticsCollector
------------------
ClusterName/HostName: localhost
Port: 32456
Timeout: 456
Unicast: 1 (true)
Enabled: 1 (true)
------------------
Module: Oracle WebCenter Portal
Use with WLST: Online
Description
Specifies the default analytics collector connection for a named application.
The default analytics collector connection is used to send events raised in WebCenter Portal using OpenUsage APIs to an analytics collector for use by analytics.
While you can register multiple analytics collector connections for an application, only one analytics collector connection is used-- the default (or active) connection.
Syntax
setDefaultAnalyticsCollectorConnection(appName, name, [server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the application in which to perform this operation. For WebCenter Portal, the application name is always |
name
|
Name of an existing analytics collector connection. |
server
|
Optional. Name of the managed server where the application is deployed. For example, Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the application is deployed. |
Example
The following example configures the connection MyAnalyticsCollector for events raised in WebCenter Portal (webcenter):
wls:/weblogic/serverConfig> setDefaultAnalyticsCollectorConnection (appName='webcenter', name='MyAnalyticsCollector')
The following example resets the default connection name:
wls:/weblogic/serverConfig> setDefaultAnalyticsCollectorConnection (appName='webcenter', name='')
Module: Oracle WebCenter Portal
Use with WLST: Online
Description
Return details about the analytics collector connection that is currently configured for a named application.
While you can register multiple analytics collector connections for an application, only one analytics collector connection is used—the default (or active) connection.
Syntax
listDefaultAnalyticsCollectorConnection(appName, [server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the application in which to perform this operation. For WebCenter Portal, the application name is always |
server
|
Optional. Name of the managed server where the application is deployed. For example, Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the application is deployed. |
Example
The following example returns details about the analytics collector connection that is currently configured for a WebCenter Portal (webcenter):
wls:/weblogic/serverConfig>listDefaultAnalyticsCollectorConnection(appName='webcenter')
------------------
MyAnalyticsCollector
------------------
ClusterName/HostName: localhost
Port: 31314
Timeout: 30
Unicast: 1 (true)
Enabled: 1 (true)
------------------
Module: Oracle WebCenter Portal
Use with WLST: Online
Description
Configure the analytics collector deployed on the WC_Utilities managed server. Additionally, in a clustered environment, use this commands to set cluster settings.
Syntax
setAnalyticsCollectorConfig(appName, [collectorHost, defaultPort, maxPort, broadcastType, clusterEnabled, clusterName, heartbeatFrequency, server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the analytics collector application in which to perform this operation--always |
collectorHost
|
Optional. Name of the host on which the analytics collector is running. The default value is |
defaultPort
|
Optional. Default port number on which the analytics collector listens. The default value is |
maxPort
|
Optional. Highest port number that the analytics collector can use when allocating a listener. This property is mostly used in a clustered environment where more than one collector is running in the same box. Each collector listens for incoming UDP messages on a free port within a given port range. The range is from the default port number to the maxPort number. |
broadcastType
|
Optional. Indicates the network channel on which the analytics collector broadcasts a 'heartbeat' to advertise its location to event producers. Valid values are
|
clusterEnabled
|
Optional. Indicates whether the analytics collector is deployed in a cluster. Valid values are If set to |
clusterName
|
Optional. Name of the analytics collector cluster. Only required when |
heartbeatFrequency
|
Optional. Broadcast analytics collector listening information every 'n' seconds. The default frequency is 10 seconds. The analytics collector periodically broadcasts a 'heartbeat' to advertise its location ( |
server
|
Optional. Name of the managed server where the analytics collector is deployed. For example, Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the application is deployed. |
Example
The following example changes the default port to 31315:
wls:/weblogic/serverConfig>setAnalyticsCollectorConfig(appName='analytics-collector', defaultPort=31315)
Module: Oracle WebCenter Portal
Use with WLST: Online
Description
Returns analytics collector settings.
Syntax
listAnalyticsCollectorConfig(appName, [server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the analytics collector application in which to perform this operation--always |
server
|
Optional. Name of the managed server where the analytics collector is deployed. For example, Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the application is deployed. |
Example
The following command lists current settings for the analytics collector that is configured for an application named webcenter:
wls:/weblogic/serverConfig>listAnalyticsCollectorConfig(appName='analytics-collector')
This is sample output for a standalone analytics collector:
CollectorHost = localhost CollectorDefaultPort = 31314 CollectorMaximumPort = 31314 BroadcastType = Multicast ClusterEnabled = ClusterName = ClusterBroadcastFrequency = 55
This is sample output for an analytics collector in a clustered environment:
CollectorHost = localhost CollectorDefaultPort = 31314 CollectorMaximumPort = 31318 BroadcastType = Multicast ClusterEnabled = 1 ClusterName = myCluster ClusterBroadcastFrequency = 55
Module: Oracle WebCenter Portal
Use with WLST: Online
Description
Lists all the events currently registered with the analytics collector.
Syntax
listAnalyticsEventTypes(appName, [server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the application in which to perform this operation. For WebCenter Portal, the application name is always |
server
|
Optional. Name of the managed server where the application is deployed. For example, Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the application is deployed. |
Example
The following command lists all the events currently registered with the analytics collector for use by WebCenter Portal (webcenter):
wls:/weblogic/serverConfig>listAnalyticsEventTypes(appName='webcenter')
Sample output:
{HTTP://WWW.ORACLE.COM/ANALYTICS/WC}PAGEEDIT
{HTTP://WWW.ORACLE.COM/ANALYTICS/WC}DOCLIB_DOCUMENTCREATE
{HTTP://WWW.ORACLE.COM/ANALYTICS/WC}LOGINS
...
Use the commands listed in Table 2-5 to archive and restore activity stream data generated for WebCenter Portal.
Configuration changes made using these WLST commands are effective only after your restart the Managed Server on which the application is deployed. For details, see Oracle Fusion Middleware Administering Oracle WebCenter Portal.
Table 2-5 Activity Stream WLST Commands
| Use this command... | To... | Use with WLST... |
|---|---|---|
|
Archive activity stream data that is older than a specified date. |
Online |
|
|
Archive activity stream data associated with deleted objects. |
Online |
|
|
Archive activity stream data associated with portals that are currently closed. |
Online |
|
|
Archive activity stream data associated with portals that have been inactive since a specified date. |
Online |
|
|
Restore archived activity stream data from a specified date into production tables. |
Online |
|
|
Truncates activity stream archive data. |
Online |
|
|
Archive activity stream data associated with a portal. |
Online |
|
|
Archive activity stream data associated with all portals. |
Online |
|
|
Archive activity stream data associated with a user. |
Online |
|
|
Archive activity stream data associated with all users. |
Online |
|
|
Archive activity stream data associated with deleted actors. |
Online |
|
|
Report activity stream statistics. |
Online |
Module: Oracle WebCenter Portal
Use with WLST: Online
Description
Archives activity stream data that is older than a specified date.
This command moves data from production tables to archive tables. Exceptions include WC_ACTOR_DETAIL and WC_OBJECT_DETAIL—data in these tables is copied to archive tables rather than moved.
Rows in WC_OBJECT_DETAIL that are not used by any activity element are deleted.
Syntax
archiveASByDate(appName, year, month, day, [server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the application in which to perform this operation. For WebCenter Portal, the application name is always |
year
|
Year before which to archive activity stream data. For example, 2009. |
month
|
Month before which to archive activity stream data. For example, enter 1 for January, 2 for February, and so on. |
day
|
Day of the month before which to archive activity stream data. |
server
|
Optional. Name of the managed server where the application is deployed. For example, Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the application is deployed. |
Example
The following example archives activity stream data that is older than March 1, 2015 for WebCenter Portal (webcenter):
wls:/weblogic/serverConfig> archiveASByDate(appName='webcenter', year=2015, month=3, day=1)
Module: Oracle WebCenter Portal
Description
Archives activity stream data associated with deleted objects. This command moves data from production tables to archive tables, except for WC_ACTOR_DETAIL—data in this table is copied to the archive table rather than moved.
Rows in WC_OBJECT_DETAIL that satisfy the criteria (in this case, deleted objects) are deleted.
Syntax
archiveASByDeletedObjects(appName, [server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the application in which to perform this operation. For WebCenter Portal, the application name is always |
server
|
Optional. Name of the managed server where the application is deployed. For example, Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the application is deployed. |
Example
The following example archives activity stream data associated with deleted objects from WebCenter Portal (webcenter):
wls:/weblogic/serverConfig> archiveASByDeletedObjects(appName='webcenter')
Use with WLST: Online
Module: Oracle WebCenter Portal
Use with WLST: Online
Description
Archives activity stream data associated with portals that are currently closed.
This command moves data from production tables to archive tables, except for WC_ACTOR_DETAIL—data in this table is copied to the archive table rather than moved.
Rows in WC_OBJECT_DETAIL that satisfy the criteria (in this case, objects involved in activities of portals that are closed) are deleted.
Syntax
archiveASByClosedSpaces(appName, [server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the application on which to perform this operation. For WebCenter Portal, the application name is always |
server
|
Optional. Name of the managed server where the application is deployed. For example, Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the application is deployed. |
Example
The following example archives activity stream data associated with portals that are currently marked as closed in WebCenter Portal (webcenter):
wls:/weblogic/serverConfig> archiveASByClosedSpaces(appName='webcenter')
Module: Oracle WebCenter Portal
Use with WLST: Online
Description
Archives activity stream data associated with portals that have been inactive since a specified date. An inactive portal is an open or closed portal in which there has been no activity since the specified date.
This command moves data from production tables to archive tables, except for WC_ACTOR_DETAIL—data in this table is copied to the archive table rather than moved. Rows in WC_OBJECT_DETAIL that satisfy the criteria (in this case, objects involved in activities of portals that have been inactive since the specified date) are deleted.
Syntax
archiveASByInactiveSpaces(appName, year, month, day, [server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the application in which to perform this operation. For WebCenter Portal, the application name is always |
year
|
Year the portal became inactive. For example, 2014. |
month
|
Month the portal became inactive. For example, enter 1 for January, 2 for February, and so on. |
day
|
Day of the month the portal became inactive. |
server
|
Optional. Name of the managed server where WebCenter Portal is deployed. For example, Required when applications with the same name are deployed to different servers and when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the application is deployed. |
Example
The following example archives activity stream data associated with portals that have been inactive (no activities have occurred, regardless of open or closed status) since October 1, 2014:
wls:/weblogic/serverConfig> archiveASByInactiveSpaces(appName='webcenter', year=2014, month=10, day=1)
Module: Oracle WebCenter Portal
Use with WLST: Online
Description
Restores archived activity stream data from a specified date into production tables.
This command moves data from archive tables to production tables, except for WC_ACTOR_DETAIL—data in this table is not restored because data is not deleted from this table during the archive process.
Rows that already exist in the production tables are not changed during the restore process.
Syntax
restoreASByDate(appName, year, month, day, [server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the application in which to perform this operation. For WebCenter Portal, the application name is always |
year
|
Year from which to restore activity stream data. For example, 2014. |
month
|
Month from which to restore activity stream data. For example, enter 1 for January, 2 for February, and so on. |
day
|
Day of the month from which to restore activity stream data. |
server
|
Optional. Name of the managed server where the application is deployed. For example, Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the application is deployed. |
Example
The following example restores activity stream data archived since October 1, 2014:
wls:/weblogic/serverConfig>restoreASByDate(appName='webcenter', year=2014, month=10, day=1)
Module: Oracle WebCenter Portal
Use with WLST: Online
Description
Truncates activity stream archive data.
Syntax
truncateASArchive(appName, [server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the application in which to perform this operation. For WebCenter Portal, the application name is always |
server
|
Optional. Name of the managed server where the application is deployed. For example, Required when applications with the same name are deployed to different servers and when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the application is deployed. |
Example
The following example truncates activity stream archive data:
wls:/weblogic/serverConfig>truncateASArchive(appName='webcenter')
Module: Oracle WebCenter Portal
Use with WLST: Online
Description
Archives activity stream data associated with a named portal, only keeping a fixed number of activities.
This command moves data from production tables to archive tables.
Syntax
archiveASBySpace(appName, space, cnt, [server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the application in which to perform this operation. For WebCenter Portal, the application name is always |
space
|
Name of the portal whose data you want to archive. For example, |
cnt
|
Number of portal activities you want to keep in the production table. For example, |
server
|
Optional. Name of the managed server where the application is deployed. For example, Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the application is deployed. |
Example
The following example keeps the last 2000 activities associated with the portal MySalesPortal and archives the rest:
wls:/weblogic/serverConfig> archiveASBySpace(appName='webcenter', space='MySalesPortal', cnt=2000)
Module: Oracle WebCenter Portal
Use with WLST: Online
Description
Archives activity stream data for all portals, only keeping a fixed number of activities.
This command moves data from production tables to archive tables.
Syntax
archiveASAllSpaces(appName, cnt, [server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the application on which to perform this operation. For WebCenter Portal, the application name is always |
cnt
|
Number of portal activities you want to keep in the production table. For example, |
server
|
Optional. Name of the managed server where the application is deployed. For example, Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the application is deployed. |
Example
The following example keeps the last 2000 activities for each portal in production tables and archives the remaining activity stream data:
wls:/weblogic/serverConfig> archiveASAllSpaces(appName='webcenter', cnt=2000)
Module: Oracle WebCenter Portal
Use with WLST: Online
Description
Archives activity stream data associated with a single user, only keeping a fixed number of activities.
This command moves data from production tables to archive tables.
Syntax
archiveASByUser(appName, actor, cnt, [server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the application in which to perform this operation. For WebCenter Portal, the application name is always |
actor
|
Name of the user whose data you want to archive. For example, |
cnt
|
Number of user activities you want to keep in the production table. For example, |
server
|
Optional. Name of the managed server where the application is deployed. For example, Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the application is deployed. |
Example
The following example keeps the last 2000 activities associated with the user Monty and archives the rest:
wls:/weblogic/serverConfig> archiveASByUser(appName='webcenter', actor='Monty', cnt=2000)
Module: Oracle WebCenter Portal
Use with WLST: Online
Description
Archives activity stream data for all users, only keeping a fixed number of activities.
This command moves data from production tables to archive tables.
Syntax
archiveASAllUsers(appName, cnt, [server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the application in which to perform this operation. For WebCenter Portal, the application name is always |
cnt
|
Number of user activities you want to keep in the production table. For example, |
server
|
Optional. Name of the managed server where the application is deployed. For example, Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the application is deployed. |
Example
The following example keeps the last 2000 activities from all users in production tables and archives the remaining activity stream data:
wls:/weblogic/serverConfig> archiveASAllUsers(appName='webcenter', cnt=2000)
Module: Oracle WebCenter Portal
Use with WLST: Online
Description
Archives activity stream data associated with deleted users (actors).
This command moves data from production tables to archive tables. Rows in WC_AS_ACTOR_DETAIL that satisfy the criteria (in this case, deleted actors) are deleted.
Syntax
archiveASByDeletedActors(appName, [server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the application in which to perform this operation. For WebCenter Portal, the application name is always |
server
|
Optional. Name of the managed server where the application is deployed. For example, Required when applications with the same name are deployed to different servers and when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the application is deployed. |
Example
The following example archives activity stream data associated with users deleted from WebCenter Portal (webcenter):
wls:/weblogic/serverConfig> archiveASByDeletedActors(appName='webcenter')
Module: Oracle WebCenter Portal
Use with WLST: Online
Description
Reports various activity stream statistics:
Number of activities for top "N" portals, ordered by activity count
Number of activities for top "N" users, ordered by activity count
Number of activities after a specific date
Number of activities after a specific date for top "N" portals, ordered by activity count
number of activities after a specified date for top "N" users, ordered by activity count
Syntax
showASStatistics(appName, year, month, day, cnt, [server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the application in which to perform this operation. For WebCenter Portal, the application name is always |
year
|
Year from which to report activity stream statistics. For example, 2014. |
month
|
Month from which to report activity stream statistics. For example, enter 1 for January, 2 for February, and so on. |
day
|
Day of the month from which to report activity stream statistics. |
cnt
|
Number of portals or users included in the report. For example, |
server
|
Optional. Name of the managed server where the application is deployed. For example, Required when applications with the same name are deployed to different servers and when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the application is deployed. |
Example
The following example reports activity stream statistics for the top 50 portals and top 50 users in WebCenter Portal (webcenter) since 6/12/2014:
wls:/weblogic/serverConfig> showASStatistics(appName='webcenter', year=2014, month=7, day=18, cnt=3)
============================================================
Cutoff Date = 7/18/12 12:23 PM
Top Count = 3
1. Portals with most activity count are:
Portal Finance Count =10
Portal Photography Count =9
Portal Sport Count =7
2. Users with most activity count are:
User Monty Count =30
User Karen Count =20
User Dave Count =10
3. Total Activities after 7/18/14 12:23 PM =80
4. Portals with most activity count after specific date, are:
Portal Photography Count =9
Portal Finance Count =6
Portal Sport Count =6
5. Users with most activity count after specific date, are:
User Monty Count =10
User Dave Count =8
User Josie Count =7
Use the commands listed in Table 2-6 to manage BPEL server connections to manage membership and other notifications in WebCenter Portal.
Configuration changes made using these WLST commands are only effective after your restart the Managed Server on which the application is deployed. For details, see Oracle Fusion Middleware Administering Oracle WebCenter Portal.
Table 2-6 Worklist Commands
| Use this command... | To... | Use with WLST... |
|---|---|---|
|
Create a connection to a BPEL server for a named application. |
Online |
|
|
Edit an existing BPEL server connection. |
Online |
|
|
List all of the BPEL server connections that are configured for a named application. |
Online |
Module: Oracle WebCenter Portal
Use with WLST: Online
Description
Creates a connection to a BPEL server for a named application. A BPEL server connection can be used to manage memberships and notifications in WebCenter Portal. WebCenter Portal supports only a single connection to the BPEL server. Multiple BPEL server connections are not supported.
To specify the BPEL server connection that WebCenter Portal uses for its internal workflows, use the setSpacesWorkflowConnectionName command. See setSpacesWorkflowConnectionName.
Syntax
createBPELConnection(appName, name, url, [policy, recipientKeyAlias, linkUrl, server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the application in which to perform this operation. For WebCenter Portal, the application name is always |
name
|
Connection name. The name must be unique (across all connection types) within the application. |
url
|
URL required to access the BPEL server. Use the format: The BPEL server URL must be unique within the application. |
policy
|
Optional. SAML token policy this connection uses for authentication. Enter any valid policy. Valid values include:
If you omit this argument, the connection defaults to |
recipientKeyAlias |
Optional. Recipient key alias to be used for message protected SAML policy authentication. Only required when the BPEL server connection is using a SAML token policy for authentication and the application's worklist is using multiple BPEL server connections. The default is null. See also "Configuring WS-Security" in Oracle Fusion Middleware Administering Oracle WebCenter Portal. |
linkUrl |
Optional. URL used to link to the BPEL server. Only required if it is different to the Use the format: The default is null. For performance reasons, in an HTTPS or SSO environment, |
server
|
Optional. Name of the managed server where the application is deployed. For example, Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the application is deployed. |
Examples
The following example creates a connection named WebCenter Worklist with the default security policy:
wls:/weblogic/serverConfig> createBPELConnection(appName='webcenter', name='WebCenter Worklist', url='http://myhost.com:8001', policy='oracle/wss10_saml_token_client_policy)
The following example creates a connection that uses a message protected security policy, and defines a specific link URL:
wls:/weblogic/serverConfig> createBPELConnection(appName='webcenter', name='WebCenter Worklist',url='http://myhost.com:8001', policy='oracle/wss10_ saml_token_with_message_protection_client_policy', recipientKeyAlias='myalias', linkUrl='http://mySSO.com:7777')
The following example creates a connection to be used in an environment that supports Global Policy Attachments (GPA):
wls:/weblogic/serverConfig> createBPELConnection(appName='webcenter', name='WebCenter Worklist', url='http://myhost.com:8001', policy='GPA')
Module: Oracle WebCenter Portal
Use with WLST: Online
Description
Edits an existing BPEL server connection.
To specify the BPEL server connection used for WebCenter Portal's internal workflows, use the setSpacesWorkflowConnectionName command. See setSpacesWorkflowConnectionName.
Syntax
setBPELConnection(appName, name, [url, policy, recipientKeyAlias, linkUrl, server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the application in which to perform this operation. For WebCenter Portal, the application name is always |
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 application. |
policy
|
Optional. SAML token policy this connection uses for authentication. Enter any valid policy. Valid values include:
If you omit this argument, the connection defaults to |
recipientKeyAlias |
Optional. Recipient key alias to be used for message protected SAML policy authentication. Only required when the BPEL server connection is using a SAML token policy for authentication and the application's worklist is using multiple BPEL server connections. The default is null. See also "Configuring WS-Security" in Administering Oracle WebCenter Portal. |
linkUrl |
Optional. URL used to link to the BPEL server. Only required if it is different to the For example, The default is null. For performance reasons, in an HTTPS or SSO environment, the Link URL specifies user access to BPEL worklist items, through HTTPS or SSO web servers, whereas the BPEL SOAP URL specifies direct access to BPEL web services, without redirection through HTTPS or SSO web servers. |
server
|
Optional. Name of the managed server where the application is deployed. For example, Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the application is deployed. |
Examples
The following example updates the BPEL server URL, security policy, recipient key alias, and link url for a connection named WebCenter Worklist.
wls:/weblogic/serverConfig> setBPELConnection(appName='webcenter', name='WebCenter Worklist',url='http://myhost.com:6666', policy='oracle/wss10_ saml_token_with_message_protection_client_policy', recipientKeyAlias='myalias', linkUrl='http://mySSO.com:7777')
The following example changes the security policy to use Global Policy Attachments (GPA):
wls:/weblogic/serverConfig> setBPELConnection(appName='webcenter', name='WebCenter Worklist', policy='GPA')
Module: Oracle WebCenter Portal
Use with WLST: Online
Description
Without any arguments, this command lists all the BPEL connections that are configured for a named application. All BPEL connections are listed, even connections not currently used.
Syntax
listBPELConnections(appName, [verbose, name, server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the application in which to perform this operation. For WebCenter Portal, the application name is always |
verbose
|
Optional. Displays BPEL server connection details in verbose mode. Valid options are When set to When set to 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 application is deployed. For example, Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the application is deployed. |
Examples
The following example lists the names of all the BPEL server connections that are configured for WebCenter Portal:
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 WebCenter Portal:
wls:/weblogic/serverConfig> listBPELConnections(appName='webcenter', verbose=1)
------------------
WebCenter Worklist
------------------
Connection Name: WebCenter Worklist
PolicyURI:oracle/wss10_saml_token_client_policy
URL:http://myhost.com:8001
------------------
Human Resources Worklist
------------------
Connection Name: Human Resources Worklist
PolicyURI:oracle/wss10_saml_token_client_policy
URL:http://myhost.com:8888
------------------
Use the commands listed in Table 2-7 to manage content repository connections and configure document services for WebCenter Portal.
Configuration changes made using these WLST commands are only effective after your restart the Managed Server on which the application is deployed. For details, see Administering Oracle WebCenter Portal.
Table 2-7 Content Repository WLST Commands
| Use this command... | To... | Use with WLST... |
|---|---|---|
|
Create a connection to an Oracle WebCenter Content repository. |
Online |
|
|
Edit an existing Oracle WebCenter Content repository connection. |
Online |
|
|
List individual or all Oracle WebCenter Content repository connections that are configured for a named application. |
Online |
|
|
List properties for the back-end Content Server that is being used by WebCenter Portal. |
Online |
|
|
Modify properties for the back-end Content Server used by WebCenter Portal. |
Online |
|
|
Delete properties for the back-end Content Server used by WebCenter Portal. |
Online |
|
|
Delete a connection to an Oracle WebCenter Content repository. |
Online |
|
|
Export Folders_g data to a specified location. |
Online |
|
|
Migrate Folders_g data to FrameworkFolders. |
Online |
Module: Oracle WebCenter Portal
Use with WLST: Online
Description
Creates a connection to an Oracle WebCenter Content repository for a named application.
Syntax
createContentServerConnection(appName, name, socketType, [url, serverHost, serverPort, keystoreLocation, keystorePassword, privateKeyAlias, privateKeyPassword, webContextRoot, clientSecurityPolicy, cacheInvalidationInterval, binaryCacheMaxEntrySize, adminUsername, adminPassword, extAppId, timeout, isPrimary, server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the application in which to perform this operation. For WebCenter Portal, the application name is always |
name
|
Connection name. The name must be unique (across all connection types) within the application. |
socketType
|
Specifies whether Oracle WebCenter Content's Content Server connects on the content server listener port or the web server filter, and whether the listener port is SSL enabled. Valid values are Choose from:
|
url
|
Optional. Content Server URL. Required only if URL should be in the format: http://hostname:port/web_root/plugin_root For example: |
serverHost
|
Optional. Host name of the machine where the Content Server is running. Required if |
serverPort
|
Optional. Port on which the Content Server listens. Required if
This property corresponds to the |
keystoreLocation
|
Optional. Location of key store that contains the private key used to sign the security assertions. Required only if The key store location must be an absolute path. |
keystorePassword
|
Optional. Password required to access the key store. Required only if |
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 |
webContextRoot
|
Optional. Web server context root for the Content Server. Use the format
Note: To fully enable these Oracle WebCenter Content features you must access WebCenter Portal through Oracle HTTPS Server (OHS) to expose Content Server and the application under the same host and port. Both the application and Content Server must also use single sign on. For information about setting up OHS to front-end WebCenter Portal, see "Content Server - Configuration" in Oracle Fusion Middleware Administering Oracle WebCenter Portal. If your application is connected to multiple Content Servers, Oracle recommends that each Content Server has a unique Web Server Context Root so that OHS re-direction works correctly. |
clientSecurityPolicy
|
Optional. Client security policy to be used when the Leave the field blank if your environment supports Global Policy Attachments (GPA). |
cacheInvalidationInterval
|
Optional. Time between checks for external Content Server content changes (in minutes). WebCenter Portal automatically clears items that have changed from the cache. The minimum interval is 2 minutes. By default, cache invalidation is disabled (specified as |
binaryCacheMaxEntrySize
|
Optional. Maximum cacheable size (in bytes) for Content Server binary documents. Documents larger than this size are not cached by WebCenter Portal. Defaults is 102400 bytes (100K). Tune this value based on your machine's memory configuration and the types of binary documents that you expect to cache. Most documents stored in Content Server are considered binary content, that is, images, plain text, Word documents, and so on. The only exception is Site Studio content which is stored in data files (CDF files) and cache separately in a Virtual Content Repository (VCR) cache (or node cache). |
adminUsername
|
Required when Defaults to |
adminPassword
|
Optional. Password for the Content Server administrator specified in |
extAppId
|
Optional. External application used to authenticate users against the Content Server. This value should match the name of an existing external application connection. See also listExtAppConnections. If If |
timeout
|
Length of time allowed to log in to the Content Server (in ms) before issuing a connection timeout message, and the RIDC socket timeout used for all service requests for connection types If the timeout property is not set, the following values are used:
If the |
isPrimary
|
Optional. Valid string values are
This argument defaults to In WebCenter Portal, the primary connection is used to store portal-specific content and Home portal content. Note: If you mark a connection as primary, you must run the |
server
|
Optional. Name of the managed server where the application is deployed. For example, Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the application is deployed. |
Example
The following example creates a socket-based connection to an Oracle WebCenter Content repository running on myhost.com at port 4444. For authentication purposes, an existing external application named myExtApp is used. See also, createExtAppConnection.
wls:/weblogic/serverConfig> createContentServerConnection(appName='webcenter', name='myContentServerConnection', socketType='socket', serverHost='myhost.com', serverPort=4444, extAppId='myExtApp', isPrimary=1)
The following example creates an SSL socket-based connection to an Oracle WebCenter Content repository.
wls:/weblogic/serverConfig> createContentServerConnection(appName='webcenter', name='myContentServerConnection', socketType='socketssl', serverHost='myhost.com', serverPort=4444, keystoreLocation='d:/keys/here', keystorePassword='AlphaSquad7', privateKeyAlias='enigma', privateKeyPassword='S0larPl3x1s', extAppId='myExtApp')
The following example creates a JAX-WS (Java API for XML web services) connection to an Oracle WebCenter Content repository:
wls:/weblogic/serverConfig> createContentServerConnection(appName='webcenter' name='myContentServerConnection', socketType='jaxws', url='http://myhost.com:9044/idcnativews', adminUsername='weblogic', clientSecurityPolicy='oracle/wss10_saml_token_client_policy')
Module: Oracle WebCenter Portal
Use with WLST: Online
Description
Edits an existing Oracle WebCenter Content repository connection. This command requires that you specify values for appName and name, plus one additional argument.
Syntax
setContentServerConnection(appName, name, [socketType, url, serverHost, serverPort, keystoreLocation, keystorePassword, privateKeyAlias, privateKeyPassword, webContextRoot, clientSecurityPolicy, cacheInvalidationInterval, binaryCacheMaxEntrySize, adminUsername, adminPassword, extAppId, timeout, isPrimary, server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the application in which to perform this operation. For WebCenter Portal, the application name is always |
name
|
Name of an existing Oracle WebCenter Content repository connection. |
socketType
|
Optional. Specifies whether the Oracle WebCenter Content's Content Server connects on the content server listener port or the web server filter, and whether the listener port is SSL enabled. Valid values are Choose from:
|
url
|
Optional. Content Server URL. Required only if URL should be in the format: http://hostname:port/web_root/plugin_root For example: |
serverHost
|
Optional. Host name of the machine where the Content Server is running. Required if |
serverPort
|
Optional. Port on which the Content Server listens. Required if
For example, |
keystoreLocation
|
Optional. Location of key store that contains the private key used to sign the security assertions. Required only if The key store location must be an absolute path. |
keystorePassword
|
Optional. Password required to access the key store. Required only if |
privateKeyAlias
|
Optional. Client private key alias in the key store. Required only if 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 |
webContextRoot
|
Optional. Web server context root for the Content Server if Content Server is front-ended with Oracle HTTP Server (OHS). Use the format Oracle recommends that you access WebCenter Portal through Oracle HTTP Server (OHS) if you want to use Content Presenter to create or edit Site Studio content. Without Oracle HTTP Server (and WebContextRoot configuration), it is still possible to create or edit Site Studio content from within Content Presenter, but the create and edit actions launch new browser windows (or tabs) rather than opening within the Content Presenter task flow. Note: To fully enable these features you must access WebCenter Portal through Oracle HTTPS Server (OHS) to expose Content Server and the application under the same host and port. In addition, both the application and the Content Server must use single sign on.
|
clientSecurityPolicy
|
Optional. Client security policy to be used when the Leave the field blank if your environment supports Global Policy Attachments (GPA). |
cacheInvalidationInterval
|
Optional. Time between checks for external Content Server content changes (in minutes). WebCenter Portal automatically clears items that have changed from the cache. The minimum interval is 2 minutes. By default, cache invalidation is disabled (specified as |
binaryCacheMaxEntrySize
|
Optional. Maximum cacheable size (in bytes) for Content Server binary documents. Documents larger than this size are not cached by WebCenter Portal. Defaults is 102400 bytes (100K). Tune this value based on your machine's memory configuration and the types of binary documents that you expect to cache. |
adminUsername
|
Optional. User name with administrative rights for this Content Server instance. This user will be used to fetch content type information based on profiles and track document changes for cache invalidation purpose. Defaults to |
adminPassword
|
Optional. Password for the Content Server administrator specified in |
extAppId
|
Optional. External application used to authenticate users against the Content Server. This value should match the name of an existing external application connection. See also listExtAppConnections. If If |
timeout
|
Length of time allowed to log in to the Content Server (in ms) before issuing a connection timeout message, and the RIDC socket timeout used for all service requests for connection types If the timeout property is not set, the following values are used:
If the |
isPrimary
|
Optional. Valid string values are
This argument defaults to In WebCenter Portal, the primary connection is used to store portal-specific content and Home portal content. |
server
|
Optional. Name of the managed server where the application is deployed. For example, Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the application is deployed. |
Example
The following example edits a socket-based connection to an Oracle WebCenter Content repository.
wls:/weblogic/serverConfig>setContentServerConnection(appName='webcenter', name='myContentServerConnection', socketType='socket', serverHost='myhost.com', serverPort=4444, extAppId='myExtApp', isPrimary=1)
The following example edits an SSL socket-based connection to an Oracle WebCenter Content repository.
wls:/weblogic/serverConfig>setContentServerConnection(appName='webcenter', name='myContentServerConnection', socketType='socketssl', serverHost='myhost.com', serverPort=8443, keystoreLocation='d:/keys/here', keystorePassword='T0PS3CR3T', privateKeyAlias='TekJansen', privateKeyPassword='LadyNocturne', extAppId='myExtApp', isPrimary=1)
The following example edits a JAX-WS (Java API for XML web services) connection to an Oracle WebCenter Content repository:
wls:/weblogic/serverConfig> setContentServerConnection(appName='webcenter', socketType='jaxws', url='http://myhost.com:9044/idcnativews', adminUsername='weblogic', clientSecurityPolicy='oracle/wss10_saml_token_client_policy')
Module: Oracle WebCenter Portal
Use with WLST: Online
Description
Without any arguments, this command lists all of the Oracle WebCenter Content repository connections that are configured for a named application.
Syntax
listContentServerConnections(appName, [verbose, name, server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the application in which to perform this operation. For WebCenter Portal, the application name is always |
verbose
|
Optional. Displays content repository connection details in verbose mode. Valid options are When set to When set to This argument defaults to |
name
|
Optional. Name of an existing Oracle WebCenter Content repository connection. When specified you can view connection details for a specific Oracle WebCenter Content repository connection. If you supply a value for |
server
|
Optional. Name of the managed server where the application is deployed. For example, Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the application is deployed. |
Example
The following example lists Oracle WebCenter Content repository connections configured for WebCenter Portal (webcenter):
wls:/weblogic/serverConfig> listContentServerConnections(appName='webcenter')
The following example lists all properties of the Oracle WebCenter Content repository connection named myContentServerConnection1. The connection named myContentServerConnection1 must exist and be an Oracle WebCenter Content repository connection.
wls:/weblogic/serverConfig>listContentServerConnections(appName='webcenter', verbose=1, name='myContentServerConnection1')
Module: Oracle WebCenter Portal
Use with WLST: Online
Description
Lists properties for the back-end Oracle WebCenter Content repository that is being used by WebCenter Portal to store portal-specific documents and Home portal documents. This command is only valid for WebCenter Portal.
Syntax
listContentServerProperties(appName, [server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the application in which to perform this operation. For WebCenter Portal, the application name is always |
server
|
Optional. Name of the managed server where the application is deployed. For example, Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the application is deployed. |
Example
The following example lists properties for the back-end Oracle WebCenter Content repository that is being used by a WebCenter Portal instance (webcenter) to store portal-specific documents and Home portal documents.
wls:/weblogic/serverConfig> listContentServerProperties(appName='webcenter')
The Documents Portal Server identifier is "/EnterpriseLibraries"
The Documents repository administrator is "sysadmin"
The Documents security group is "/WebCenter1109"
The Documents primary connection is "myContentServerConnection"
Module: Oracle WebCenter Portal
Use with WLST: Online
Description
Modifies properties for the back-end Oracle WebCenter Content repository that is being used by WebCenter Portal to store portal-related data.
Syntax
setContentServerProperties(appName, [portalServerIdentifier, adminUserName, securityGroup, server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the application in which to perform this operation. For WebCenter Portal, the application name is always |
portalServerIdentifier
|
Optional. Root folder under which WebCenter Portal content is stored. The value for this argument must use the format: For example, The Note: If you change the value of this argument, you must also provide the value for the |
adminUserName
|
Optional. User name of a content repository administrator. For example: Administrative privileges are required for this connection so that operations can be performed on behalf of WebCenter Portal users. Administrative privileges are required for this connection so that operations can be performed on behalf of WebCenter Portal users. |
securityGroup
|
Optional. Unique identifier to use as the value for the security group assigned to files in Content Server that are created in WebCenter Portal. This name is used to separate data when multiple WebCenter Portal instances share the same WebCenter Content instance, and must be unique across WebCenter Portal instances. 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: If you change the value of this argument, you must also change the value of the |
server
|
Optional. Name of the managed server where the application is deployed. For example, Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the application is deployed. |
Example
The following example modifies connection properties for the back-end Oracle WebCenter Content repository that is being used by WebCenter Portal to store portal-related documents:
wls:/weblogic/serverConfig> setContentServerProperties(appName='webcenter', portalServerIdentifier='/AccountingSpaces', adminUserName='admin', securityGroup='WCAccounting')
The following example modifies the administrator's user name for the back-end Oracle WebCenter Content repository that is being used by WebCenter Portal to store portal-related documents:
wls:/weblogic/serverConfig> setContentServerProperties(appName='webcenter', adminUserName='sysadmin')
Module: Oracle WebCenter Portal
Use with WLST: Online
Description
Deletes properties for the back-end Oracle WebCenter Content repository used by WebCenter Portal, that is the adminUserName, applicationName, and spacesRoot.
Syntax
deleteContentServerProperties(appName, [server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the application in which to perform this operation. For WebCenter Portal, the application name is always |
server
|
Optional. Name of the managed server where the application is deployed. For example, Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the application is deployed. |
Example
The following example deletes connection properties (adminUserName, applicationName, spacesRoot) of the back-end Oracle WebCenter Content repository that is being used by WebCenter Portal:
wls:/weblogic/serverConfig> deleteContentServerProperties(appName='webcenter')
Module: Oracle WebCenter Portal
Use with WLST: Online
Description
Deletes a named Oracle WebCenter Content repository connection.
Syntax
deleteContentServerConnection(appName, name)
| Argument | Definition |
|---|---|
appName
|
Name of the application in which to perform this operation. For WebCenter Portal, the application name is always |
name
|
Name of the existing Oracle WebCenter Content repository connection that you want to delete. |
Example
The following example deletes the Oracle WebCenter Content repository connection named MyContentServerConnection.
wls:/weblogic/serverConfig> deleteContentServerConnection(appName='webcenter' name='MyContentServerConnection')
Module: Oracle WebCenter Portal
Use with WLST: Online
Description
Exports Folders_g data to a specified location so you can migrate the data to FrameworkFolders using the WLST command migrateFoldersGToFrameworkFolders. After migrating Folders_g data to FrameworkFolders, you can generate comparison reports from the exported Folders_g data to verify that all the files and folders are migrated to FrameworkFolders.
Syntax
exportFoldersGData(appName,server,[connectionName,directoryPath,applicationVersion])
| Argument | Definition |
|---|---|
appName |
Name of the application in which to perform this operation. For WebCenter Portal, the application name is always |
server |
Name of the managed server where the application is deployed. For example, Note: In a clustered environment where applications share the same content server connection (that is, applications connect to the same content server and share the same root folder and security group), run this command only against one managed server. |
connectionName |
Optional. Content Server connection name. Only required if you want to export Folders_g data for a non default content server connection. If this argument is not specified, the default content server connection is used, that is, the content server connection where |
directoryPath |
Optional. Destination directory for the Folders_g data that you want to migrate. If this argument is not specified, Folders_g data is exported to the folder named |
applicationVersion |
Optional. Version number of the deployed application. Required if more than one version of the application is deployed. |
Example
The following example exports the Folders_g data for a WebCenter Portal application deployed to the WC_Portal managed server. WebCenter Portal's default content server connection details are used, and Folders_g data exported to the default location, the WCP_ORACLE_HOME/common/wlst/FRAMEWORK_FOLDER_MIGRATION directory.
exportFoldersGData(appName='webcenter',server='WC_Portal')
The following example exports the Folders_g data for a WebCenter Portal application deployed to the WC_Portal managed server. The content server connection named MyContentServerConnection is used, and Folders_g data exported to the /scratch/myTemp_Dir directory.
exportFoldersGData(appName='webcenter',server='WC_Portal',connectionName='MyContentServerConnection',directoryPath='/scratch/myTemp_Dir/')
Module: Oracle WebCenter Portal
Use with WLST: Online
Description
Migrates the Folders_g data to FrameworkFolders and verifies the integrity of the migrated data.
Syntax
migrateFoldersGDataToFrameworkFolders(appName,server,contentDbConnectionUrl,contentDbUserName,[connectionName,directoryPath,reportMode,applicationVersion])
| Argument | Definition |
|---|---|
appName |
Name of the application in which to perform this operation. For WebCenter Portal, the application name is always |
server |
Name of the managed server where the application is deployed. For example, Note: In a clustered environment where applications share the same content server connection (that is, connect to the same content server and share the same root folder and security group), run this command against only one managed server. |
|
|
Connection URL for the database where WebCenter Content schema (named OCS) is present. Use the connection URL format |
|
|
User name of the WebCenter Content schema (named OCS) that you want to migrate. |
connectionName |
Optional. Content Server connection name. Only required if you want to migrate Folders_g data for a non default content server connection. If not specified, the default content server connection is used, that is, the content server connection where |
directoryPath |
Optional. Directory containing the Folders_g data that you want to migrate. If not specified, Folders_g data is migrated from |
|
|
Optional. Indicates whether to generate a report describing what will happen during migration that you can review prior to migrating the actual data. Valid values are
The default value is |
applicationVersion |
Optional. Version number of the deployed application. Required if more than one version of the application is deployed. |
Example
The following example migrates the Folders_g data from the default directory (WCP_ORACLE_HOME/common/wlst/FRAMEWORK_FOLDER_MIGRATION) to FrameworkFolders and validates the migrated data for the WebCenter Portal application deployed to the WC_Portal managed server. Migration is performed using the default Content Server connection details and the specified WebCenter Content database connection and user name.
migrateFoldersGDataToFrameworkFolders(appName='webcenter',server='WC_Portal',contentDbConnectionUrl='wccdbhost.example.com:wccdbport:wccdbsid', contentDbUserName='SCHEMA_PREFIX_OCS')
The following example migrates Folders_g data from the /scratch/myTemp_Dir directory to FrameworkFolders and validates the migrated data for the WebCenter Portal application deployed to the WC_Portal managed server. Content Server connection named MyContentServerConnection and the specified WebCenter Content database connection and username are used to perform the migration.
migrateFoldersGDataToFrameworkFolders(appName='webcenter',server='WC_Portal',contentDbConnectionUrl='wccdbhost.example.com:wccdbport:wccdbsid', contentDbUserName='SCHEMA_PREFIX_OCS',connectionName='MyContentServerConnection',directoryPath='/scratch/myTemp_Dir/)
The following example reports how Folders_g data will be migrated to FrameworkFolders for the WebCenter Portal application deployed to WC_Portal. MyContentServerConnection connection details and specified WebCenter Content database connection and username are used to generate the migration report which is saved to the same location as the Folders_g data (/scratch/myTemp_Dir):
migrateFoldersGDataToFrameworkFolders(appName='webcenter',server='WC_Portal',contentDbConnectionUrl='wccdbhost.example.com:wccdbport:wccdbsid', contentDbUserName='SCHEMA_PREFIX_OCS',connectionName='MyContentServerConnection',directoryPath='/scratch/myTemp_Dir/', reportMode='true')
Note:
Beginning with 12c (12.2.1.3.0), Oracle WebCenter Portal has deprecated support for Jive features (announcements and discussions). If you are upgrading from a prior release, these features remain available in your existing installations that are being upgraded.
Use the commands listed in Table 2-8 to manage discussions server connections for WebCenter Portal.
Configuration changes made using these WLST commands are only effective after your restart the Managed Server on which the application is deployed. For details, see Oracle Fusion Middleware Administering Oracle WebCenter Portal.
Table 2-8 Discussion and Announcement WLST Commands
| Use this command... | To... | Use with WLST... |
|---|---|---|
|
Create a new discussions server connection for a named application. |
Online |
|
|
Edit an existing discussions server connection. |
Online |
|
|
Specify the default connection for discussions and announcements. |
Online |
|
|
List all of the discussions server connections that are configured for a named application. |
Online |
|
|
List the default discussions server connection for a named application. |
Online |
|
|
Set an additional discussions server connection property. |
Online |
|
|
Delete a discussions server connection property. |
Online |
|
|
Specify defaults for discussions. |
Online |
|
|
Remove defaults for discussions. |
Online |
|
|
List discussions settings. |
Online |
|
|
Specify defaults for announcements. |
Online |
|
|
Remove defaults for announcements. |
Online |
|
|
List announcements settings. |
Online |
|
|
Grant system administrator permissions on the discussions server to a user or a group. |
Online |
|
|
Grant category administrator permissions on the discussions server to a user or a group. |
Online |
|
|
Set discussions server properties. |
Online |
|
|
Return discussions server property values. |
Online |
|
|
Remove current discussions server property values. |
Online |
Module: Oracle WebCenter Portal
Use with WLST: Online
Description
Creates a new discussions server connection for a named application.
Discussions and announcements both require a discussions server connection. Discussions and announcements both use the same discussions server connection.
While you can register multiple discussions server connections for an application, only one connection is used for discussion and announcement services - the default (or active) connection.
Syntax
createDiscussionForumConnection(appName, name, url, adminUser, [timeout, default, policyURIForAuthAccess, policyURIForPublicAccess, recipientKeyAlias, server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the application in which to perform this operation. For WebCenter Portal, the application name is always |
name
|
Connection name. The name must be unique (across all connection types) within the application. |
url
|
URL of the discussions server hosting discussion forums and announcements. For example: |
adminUser
|
Name of the discussions server administrator. This account is used by discussions and announcements to perform administrative operations on behalf of WebCenter Portal users. This account is mostly used for managing discussions and announcements in WebCenter Portal. It is not necessary for this user to be a |
policyURIForAuthAccess
|
Optional. URI to the SAML token based policy required for authenticated access to the discussions server web service. The client policy specified must be compatible with the service policy that is configured for the Valid client policy values include:
See also "Managing Announcements and Discussions" in Administering Oracle WebCenter Portal. |
policyURIForPublicAccess
|
Optional. URI to the policy required to enforce message security and integrity for public access to the discussions server Web service. Default value is The client policy specified must be compatible with the service policy that is configured for the Valid client policy values include:
|
recipientKeyAlias
|
Optional. Recipient key alias to be used for message protected policies (applicable to the See also "Configuring WS-Security" in Administering Oracle WebCenter Portal. |
timeout
|
Optional. Length of time (in seconds) discussions waits for a response from the discussions server before issuing a connection timeout message. This argument defaults to |
default
|
Optional. Indicates that this connection is the default connection for discussions and announcements. Valid options are When set to When set to |
server
|
Optional. Name of the managed server where the application is deployed. For example, Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the application is deployed. |
Example
The following example creates a discussions server connection for WebCenter Portal:
wls:/weblogic/serverConfig>createDiscussionForumConnection(appName='webcenter', name='MyDiscussionServer', url='http://myhost.com:8888/owc_discussions', adminUser='admin', policyURIForAuthAccess='oracle/wss10_saml_token_client_policy', default=0)
Module: Oracle WebCenter Portal
Use with WLST: Online
Description
Edits an existing discussions server connection. Use this command to update connection attributes.
The connection is created using the createDiscussionForumConnection command.
Syntax
setDiscussionForumConnection(appName, name, [url, adminUser, policyURIForAuthAccess, policyURIForPublicAccess, recipientKeyAlias, timeout, default, server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the application in which to perform this operation. For WebCenter Portal, the application name is always |
name
|
Name of an existing discussions server connection. |
url
|
Optional. URL to the discussions server. |
adminUser
|
Optional. Name of the discussions server administrator. This account is used by discussions to perform administrative operations on behalf of WebCenter Portal users. This account is mostly used for managing discussions and announcements in WebCenter Portal. It is not necessary for this user to be a |
policyURIForAuthAccess
|
Optional. URI to the SAML token based policy required for authenticated access to the discussions server web service. The client policy specified must be compatible with the service policy that is configured for the Valid client policy values include:
See also "Managing Announcements and Discussions" in Administering Oracle WebCenter Portal. |
policyURIForPublicAccess
|
Optional. URI to the policy required to enforce message security and integrity for public access to the discussions server web service. Default value is The client policy specified must be compatible with the service policy that is configured for the Valid client values include:
|
recipientKeyAlias
|
Optional. Recipient key alias to be used for message protected policies (applicable to the See also "Configuring WS-Security" in Administering Oracle WebCenter Portal. |
timeout
|
Optional. Length of time (in seconds) discussions and announcements wait for a response from the discussions server before issuing a connection timeout message. This argument defaults to |
default
|
Optional. Indicates that this connection is the default connection for discussions and announcements. Required only if more than one connection is defined. Valid options are To specify that discussion and announcements 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 an application, only one connection is used for discussions and announcements— the default (or active) connection. |
server
|
Optional. Name of the managed server where the application is deployed. For example, Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the application is deployed. |
Example
The following example updates attributes for a secure discussions server connection named MyDiscussionsServer.
wls:/weblogic/serverConfig> setDiscussionForumConnection(appName='webcenter', name='MyDiscussionServer', url='http://myhost.com:7786/owc_discussions', adminUser='admin', policyURIForAuthAccess='oracle/wss10_saml_token_client_policy', default=1)
Module: Oracle WebCenter Portal
Use with WLST: Online
Description
Sets a discussions server connection property. Use this command when additional parameters are required to connect to your discussions server.
This commands provides an extensible way to add any connection property using a key and a value. (You are not limited to connection properties specified by createDiscussionForumConnection and setDiscussionForumConnection .)
Note:
Do not use the setDiscussionForumConnectionProperty to set connection properties available through createDiscussionForumConnection or setDiscussionForumConnection . Attempting to do so, has no effect.
All known, additional connection properties are listed in Table 2-9.
Table 2-9 Additional Discussion Server Connection Properties
| Additional Connection Property | Description |
|---|---|
|
|
Application root category ID on the discussions server under which all discussion forums are stored. For example, if set to 3, then all forums are stored in the category with the ID 3. |
|
|
URL used to link users to the discussions server's Admin Console. Only required if it is different to the Use the following format to specify an alternative public external URL: For example: |
Syntax
setDiscussionForumConnectionProperty(appName, name, key, value, [secure, server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the application in which to perform this operation. For WebCenter Portal, the application name is always |
name
|
Name of an existing discussions server connection. |
key
|
Name of the connection property. See also, Table 2-9. |
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 Set to |
server
|
Optional. Name of the managed server where the application is deployed. For example, Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the application is deployed. |
Example
The following example configures the category used to store discussion forums for a discussions server connection named MyDiscussionServer:
wls:/weblogic/serverConfig>setDiscussionForumConnectionProperty (appName='webcenter', name='MyDiscussionServer', key='application.root.category.id', value='3')
The following example configures an alternative, public external URL so users can access the discussions server's Admin Console:
wls:/weblogic/serverConfig>setDiscussionForumConnectionProperty (appName='webcenter', name='MyDiscussionServer', key='linkURL', value='http://example.com:7777')
The following example adds a custom discussions server connection property called myProperty1 with a value propertyValue1:
wls:/weblogic/serverConfig>setDiscussionForumConnectionProperty (appName='webcenter', name='MyDiscussionServer', key='myProperty1', value='propertyValue1')
The following example adds a secured discussions server connection property called securedProperty with the value secureValue.
wls:/weblogic/serverConfig>setDiscussionForumConnectionProperty (appName='webcenter', name='MyDiscussionServer', key='securedProperty', value='secureValue', secure=1)
Module: Oracle WebCenter Portal
Use with WLST: Online
Description
Deletes a discussions server connection property. Take care when deleting connection properties because the connection may not work as expected if the configuration becomes invalid as a result.
This command can only delete additional connection properties added using the setDiscussionForumConnectionProperty command.
Syntax
deleteDiscussionForumConnectionProperty(appName, name, key, [server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the application in which to perform this operation. For WebCenter Portal, the application name is always |
name
|
Name of an existing discussions server connection. |
key
|
Name of the connection property you want to delete. |
server
|
Optional. Name of the managed server where the application is deployed. For example, Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the application is deployed. |
Example
The following example deletes a discussions server connection property named myProperty1.
wls:/weblogic/serverConfig> deleteDiscussionForumConnectionProperty (appName='webcenter', name='MyDiscussionServer', key='myProperty1')
Module: Oracle WebCenter Portal
Use with WLST: Online
Description
Names the discussions server connection that discussions and announcements service are using, in a named application. While you can register multiple discussions server connections for an application, discussions and announcements only uses one connection—known as the default (or active) connection.
Syntax
listDefaultDiscussionForumConnection(appName, [verbose, server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the application in which to perform this operation. For WebCenter Portal, the application name is always |
verbose
|
Optional. Valid options are When set to When set to |
server
|
Optional. Name of the managed server where the application is deployed. For example, Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the application is deployed. |
Example
The following example names the discussions server connection that discussions and announcements are using in WebCenter Portal:
wls:/weblogic/serverConfig>listDefaultDiscussionForumConnection(appName='webcenter')
The following example lists the name and details of the discussions server connection that discussions and announcements are using in WebCenter Portal:
wls:/weblogic/serverConfig> listDefaultDiscussionForumConnection(appName='webcenter', verbose=1)
Module: Oracle WebCenter Portal
Use with WLST: Online
Description
Lists all the discussions server connections that are configured for a named application.
Syntax
listDiscussionForumConnections(appName, [verbose, name, server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the application in which to perform this operation. For WebCenter Portal, the application name is always |
verbose
|
Optional. Valid options are When set to When set to |
name
|
Optional. Name of an existing discussions server connection. Use this argument to view connection details for a specific discussions server connection. |
server
|
Optional. Name of the managed server where the application is deployed. For example, Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the application is deployed. |
Example
The following example lists the names of all of the discussions server connections that are currently configured for WebCenter Portal:
wls:/weblogic/serverConfig>listDiscussionForumConnections(appName='webcenter')
The following example lists connection names and details for all of the discussions server connections currently configured for WebCenter Portal:
wls:/weblogic/serverConfig>listDiscussionForumConnections(appName='webcenter', verbose=1)
The following example lists connection details for a discussions server connection named myDiscussionsServer.
wls:/weblogic/serverConfig>listDiscussionForumConnections(appName='webcenter', name='myDiscussionsServer')
Module: Oracle WebCenter Portal
Use with WLST: Online
Description
Specifies the default discussions server connection for discussions and announcements in a named application.
While you can register multiple discussions server connections with an application, discussions and announcements only uses one connection—this is known as the default (or active) connection.
Syntax
setDefaultDiscussionForumConnection(appName, name, [server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the application in which to perform this operation. For WebCenter Portal, the application name is always |
name
|
Name of an existing discussions server connection. |
server
|
Optional. Name of the managed server where the application is deployed. For example, Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the application is deployed. |
Example
The following example makes a connection named myDiscussionServer the default (or active) connection for discussions and announcements in WebCenter Portal:
wls:/weblogic/serverConfig> setDefaultDiscussionForumConnection (appName='webcenter', name='myDiscussionServer')
Module: Oracle WebCenter Portal
Use with WLST: Online
Description
Specifies default values for discussions, for a named application.
Configurable properties for discussions are listed in Table 2-10.
Table 2-10 Discussions - Configurable Properties
| Configuration Property | Description |
|---|---|
|
|
Maximum number of topics fetched by discussions and displayed in the topics view. |
|
|
Maximum number of forums fetched by discussions and displayed in the forums view. |
|
|
Maximum number of topics fetched by discussions and displayed in the recent topics view. |
|
|
Maximum number of topics fetched by discussions and displayed in the watched topics view. |
|
|
Maximum number of forums fetched by discussions and displayed in the watched forums view. |
|
|
Application root category ID on the discussions server under which all discussion forums are stored. For example, if set to 3, all forums are stored inside category 3. |
|
|
Communication through mail distribution lists can be published as discussion forum posts. This parameter starts or stops the gateway for this communication. For WebCenter Portal, the default value is |
Syntax
setDiscussionForumServiceProperty(appName, property, value, [server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the application in which to perform this operation. For WebCenter Portal, the application name is always |
property
|
Name of the configuration property. |
value
|
Value for the property. |
server
|
Optional. Name of the managed server where the application is deployed. For example, Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the application is deployed. |
Example
The following example changes the default number of topics displayed in topics view.
wls:/weblogic/serverConfig>setDiscussionForumServiceProperty (appName='webcenter', property='topics.fetch.size', value='30')
Module: Oracle WebCenter Portal
Use with WLST: Online
Description
Removes the current value that is set for a discussions property. Use this command to remove any of the properties listed in Table 2-10.
Take care when using this command as removing values for these properties might cause unexpected behavior.
Note:
Use this command syntax to disable the connection currently used for discussion and announcement services:
removeDiscussionForumServiceProperty('appName='webcenter', property='selected.connection')
This command forces the default connection argument to 0. See also, setDiscussionForumConnection .
Syntax
removeDiscussionForumServiceProperty(appName, property, [server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the application in which to perform this operation. For WebCenter Portal, the application name is always |
property
|
Name of the configuration property. |
server
|
Optional. Name of the managed server where the application is deployed. For example, Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the application is deployed. |
Example
The following example clears the current topics.fetch.size property for discussions in WebCenter Portal:
wls:/weblogic/serverConfig> removeDiscussionForumServiceProperty (appName='webcenter', property='topics.fetch.size')
Module: Oracle WebCenter Portal
Use with WLST: Online
Description
Lists all configurable properties for discussions.
Syntax
listDiscussionForumServiceProperties(appName, [server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the application in which to perform this operation. For WebCenter Portal, the application name is always |
server
|
Optional. Name of the managed server where the application is deployed. For example, Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the application is deployed. |
Example
The following example lists configuration properties for discussions in WebCenter Portal:
wls:/weblogic/serverConfig> listDiscussionForumServiceProperties(appName='webcenter')
Module: Oracle WebCenter Portal
Use with WLST: Online
Description
Specifies default values for announcements in a named application.
Configurable properties for announcements are listed in Table 2-11.
Table 2-11 Announcements - Configurable 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. |
Syntax
setAnnouncementServiceProperty(appName, property, value, [server, applicationVersion})
| Argument | Definition |
|---|---|
appName
|
Name of the application in which to perform this operation. For WebCenter Portal, the application name is always |
property
|
Name of the configuration property. |
value
|
Property value. |
server
|
Optional. Name of the managed server where the application is deployed. For example, Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the application is deployed. |
Example
The following example changes the default number of days that announcements display in WebCenter Portal:
wls:/weblogic/serverConfig>setAnnouncementServiceProperty(appName='webcenter', property='announcements.expiration.days', value='21')
Module: Oracle WebCenter Portal
Use with WLST: Online
Description
Removes the current value that is set for an announcements property. Use this command to remove any of the properties listed in Table 2-11.
Take care when using this command as removing values for these properties might cause unexpected behavior.
Syntax
removeAnnouncementServiceProperty(appName, property, [server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the application in which to perform this operation. For WebCenter Portal, the application name is always |
property
|
Name of the configuration property. |
server
|
Optional. Name of the managed server where the application is deployed. For example, Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the application is deployed. |
Example
The following example clears the announcements.expiration.days property for announcements in WebCenter Portal:
wls:/weblogic/serverConfig>removeAnnouncementServiceProperty (appName='webcenter', property='announcements.expiration.days')
Module: Oracle WebCenter Portal
Use with WLST: Online
Description
Lists all configurable properties for announcements, in a named application.
Syntax
listAnnouncementServiceProperties(appName, [server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the application in which to perform this operation. For WebCenter Portal, the application name is always |
server
|
Optional. Name of the managed server where the application is deployed. For example, Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the application is deployed. |
Example
The following example lists configuration properties for announcements in WebCenter Portal:
wls:/weblogic/serverConfig>listAnnouncementServiceProperties(appName='webcenter')
Module: Oracle WebCenter Portal
Use with WLST: Online
Description
Grants system administrator permissions on the discussions server to a user or a group. This command is useful when you connect the discussions server to a new identity store that does not contain any of the current administrators.
Syntax
addDiscussionsServerAdmin(appName, name, [type, server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the discussions server application in which to perform this operation. For example, |
name
|
Name of the user or group to add as an administrator on the discussions server. |
type
|
Optional. Identifies the type of identity. Valid values are The default value is |
server
|
Optional. Name of the managed server on which the application is deployed. For example, Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the application is deployed. |
Example
The following example grants system administrator permissions on the discussions server to the user weblogic:
addDiscussionsServerAdmin(appName='owc_discussions', name='weblogic', type='USER')
The following example grants system administrator permissions on the discussions server to all users in the Administrators user group:
addDiscussionsServerAdmin(appName='owc_discussions', name='Administrators', type='GROUP')
Module: Oracle WebCenter Portal
Use with WLST: Online
Description
Grants category administrator permissions on the discussions server to a user or a group for a specific category ID.
Syntax
addDiscussionsCategoryAdmin(appName, categoryId, name, [type, server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the discussions server application in which to perform this operation. For example, |
categoryId
|
The ID (number) of a category on the discussions server. |
name
|
Name of the user or group to add as an administrator for the category on the discussions server. |
type
|
Optional. Identifies the type of identity. Valid values are The default value is |
server
|
Optional. Name of the managed server on which the application is deployed. For example, Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the application is deployed. |
Example
The following example grants category administrator permissions on the discussions server to the user weblogic for a category with an ID=2:
addDiscussionsCategoryAdmin(appName='owc_discussions', categoryId=2, name='weblogic', type='USER')
The following example grants category administrator permissions on the discussions server to all users in the Sales user group for a category with an ID=2:
addDiscussionsCategoryAdmin(appName='owc_discussions', categoryId=2, name='Sales', type='GROUP')
Module: Oracle WebCenter Portal
Use with WLST: Online
Description
Sets a discussions server property. Use this command to set a system property on the discussions server.
Note:
To execute discussions server WLST commands, such as setDiscussionsServerProperty, the user used to connect to the Admin Server must also have administrative privileges on the discussions server.
Syntax
setDiscussionsServerProperty(appName, key, value, [server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the discussions server application in which to perform this operation. For example, |
key
|
Name of the discussions server property. For example, |
value
|
Value for the discussions server property. |
server
|
Optional. Name of the managed server where the application is deployed. For example, Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the application is deployed. |
Example
The following example sets properties that configures the discussions server for SSO, where example.com:8890/owc_discussions is the base URL of the webtier on which the discussions server is deployed:
wls:/weblogic/serverConfig>setDiscussionsServerProperty(appName='owc_discussions', key='owc_discussions.sso.mode', value='true') wls:/weblogic/serverConfig>setDiscussionsServerProperty(appName='owc_discussions', key='jiveURL', value='example.com:8890/owc_discussions')
Module: Oracle WebCenter Portal
Use with WLST: Online
Description
Returns the current value of a discussions server property.
Note:
To execute discussions server WLST commands, such as getDiscussionsServerProperty, the user used to connect to the Admin Server must also have administrative privileges on the discussions server.
Syntax
getDiscussionsServerProperty(appName, key, [server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the discussions server application in which to perform this operation. For example, |
key
|
Name of the discussions server property. For example, |
server
|
Optional. Name of the managed server where the application is deployed. For example, Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the application is deployed. |
Example
The following examples return the current value for some key discussions server properties:
wls:/weblogic/serverConfig>getDiscussionsServerProperty(appName='owc_discussions', key='AuthFactory.className') wls:/weblogic/serverConfig>getDiscussionsServerProperty(appName='owc_discussions', key='UserManager.className') wls:/weblogic/serverConfig>getDiscussionsServerProperty(appName='owc_discussions', key='GroupManager.className')
Module: Oracle WebCenter Portal
Use with WLST: Online
Description
Removes the current value that is set for a discussions server property.
Note:
To execute discussions server WLST commands, such as removeDiscussionsServerProperty, the user used to connect to the Admin Server must also have administrative privileges on the discussion server.
Syntax
removeDiscussionsServerProperty(appName, key, [server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the discussions server application in which to perform this operation. For example, |
key
|
Name of the discussions server property. For example, |
server
|
Optional. Name of the managed server where the application is deployed. For example, Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the application is deployed. |
Example
The following example removes the current value for the 'SSO mode' property on the discussions server:
wls:/weblogic/serverConfig>removeDiscussionsServerProperty(appName='owc_discussions', key='owc_discussions.sso.mode')
Use the commands listed in Table 2-12 to manage external application connections for WebCenter Portal.
Configuration changes made using these WLST commands are immediately available in the application, that is, you do not need to restart the managed server.
Table 2-12 External Application WLST Commands
| Use this command... | To... | Use with WLST... |
|---|---|---|
|
Create an external application connection, for a named application. |
Online |
|
|
Edit an existing external application connection. |
Online |
|
|
List individual or all external applications that are configured for a named 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 Portal
Use with WLST: Online
Description
Creates an external application connection for a named application.
Syntax
createExtAppConnection(appName, name, [displayName, url, authMethod, userFieldName, pwdFieldName, server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the application in which to perform this operation. For WebCenter Portal, the application name is always |
name
|
Connection name. The name must be unique (across all connection types) within WebCenter Portal. |
displayName
|
Optional. External application display name. A user friendly name for the external application that WebCenter Portal users will recognize. The display name must be unique across all external applications within WebCenter Portal. |
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 This argument defaults to |
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 creating an automated ADF external application login. |
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 creating an automated ADF external application login. |
server
|
Optional. Name of the managed server where the application is deployed. For example, Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the application is deployed. |
Example
The following example creates a connection for an external application named My Yahoo!, in WebCenter Portal (webcenter).
wls:/weblogic/serverConfig> createExtAppConnection(appName='webcenter', name='yahoo', displayName='My Yahoo!', url='http://login.yahoo.com/config/login', authMethod='POST', userFieldName='login', pwdFieldName='password')
Module: Oracle WebCenter Portal
Use with WLST: Online
Description
Edits an existing external application connection.
Syntax
setExtAppConnection(appName, name, [displayName, url, authMethod, userFieldName, pwdFieldName, server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the application in which to perform this operation. For WebCenter Portal, the application name is always |
name
|
Name of an existing external application connection. |
displayName
|
Optional. External application display name. A user-friendly name for the external application that WebCenter Portal users will recognize. The display name must be unique across all external applications within WebCenter Portal. |
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 |
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 application is deployed. For example, Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the application is deployed. |
Example
The following example updates the display name attribute for an external application named yahoo.
wls:/weblogic/serverConfig> setExtAppConnection(appName='webcenter', name='yahoo', displayName='My Favorite Yahoo!')
Module: Oracle WebCenter Portal
Use with WLST: Online
Description
When used with only the appName argument, this command lists the names of all the external applications currently configured for a named WebCenter Portal application.
Syntax
listExtAppConnections(appName, [verbose, name, server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the application in which to perform this operation. For WebCenter Portal, the application name is always |
verbose
|
Optional. Displays external application details in verbose mode. Valid options are When set to When set to 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 application is deployed. For example, Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the application is deployed. |
Example
The following example lists the names of all the external applications currently used by WebCenter Portal (webcenter):
wls:/weblogic/serverConfig> listExtAppConnections(appName='webcenter')
app1
app2
app3
The following example lists details for the external applications app1, app2, and app3.
wls:/weblogic/serverConfig> listExtAppConnections(appName='webcenter', verbose=1)
----
app1
----
Name: app1
Display Name: Application1
Login URL: http://app1
Authentication Method: POST
User Field Name: login
Password Field Name: passwd
Shared Credential: Disabled
Public Credential: Disabled
----
app2
----
Name: app2
Display Name: Application2
Login URL: http://app2
Authentication Method: POST
User Field Name: login
Password Field Name: passwd
Additional Fields: {Account1:1, Accout2:DefVal:0}
Shared Credential: Disabled
Public Credential: Enabled
----
app3
----
Name: app3
Display Name: Application3
Authentication Method: POST
Shared Credential: Enabled
Public Credential: Enabled
The following example lists details for external application app1 only.
wls:/weblogic/serverConfig> listExtAppConnections(appName='webcenter', verbose=1, name='app1')
----
app1
----
Name: app1
Display Name: Application1
Login URL: http://app1
Authentication Method: POST
User Field Name: login
Password Field Name: passwd
Shared Credential: Disabled
Public Credential: Disabled
Module: Oracle WebCenter Portal
Use with WLST: Online
Description
Adds another login field for a specific external application connection. For example, in addition to user name and password, an external application may require other login criteria such as Host and MailAddress.
Optionally, additional login fields can appear on the external application's login for a user to specify.
If you add another login field and the external application uses shared or public credentials, you can use the WLST commands addExtAppCredential and setExtAppCredential to update the shared/public credentials. See addExtAppCredential and setExtAppCredential.
Syntax
addExtAppField(appName, name, fieldName, [fieldValue, displayToUser, server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the application in which to perform this operation. For WebCenter Portal, the application name is always |
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 Note that if you set this argument to |
server
|
Optional. Name of the managed server where the application is deployed. For example, Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the application is deployed. |
Example
This example creates an additional field named Account with the default value username.default.example in an external application called ABC. This field will be displayed on ABC's login screen.
wls:/weblogic/serverConfig> addExtAppField(appName='webcenter', name='ABC', fieldName='Account', fieldValue='username.default.example', displayToUser=1)
Module: Oracle WebCenter Portal
Use with WLST: Online
Description
Modifies the field value and display-to-user setting for one or more login fields currently configured for an external application. Either fieldValue or displayToUser must be specified along with the external application name and login field name. The fieldValue and displayToUser arguments are optional.
Using this command has implications on any shared or public credentials that you might have created for this external application. If you modify displayToUser to 1, you may also need to update existing shared user or public user credentials. See also setExtAppCredential.
Syntax
setExtAppField(appName, name, fieldName, [fieldValue, displayToUser, server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the application in which to perform this operation. For WebCenter Portal, the application name is always |
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 If set to |
server
|
Optional. Name of the managed server where the application is deployed. For example, Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the application is deployed. |
Example
The following example specifies a default value for a login field named Account and displays the field on the external application's credential provisioning screen:
wls:/weblogic/serverConfig> setExtAppField(appName='webcenter', name='ABC', fieldName='Account', fieldValue='admin', displayToUser=1)
Module: Oracle WebCenter Portal
Use with WLST: Online
Description
Removes a login field from an external application connection.
This command has implications on any shared or public credentials that you may have created for this external application, that is, you may need to remove the login field from shared user or public user credentials.
You can use the setExtAppCredential command to remove a login field, if required. For example, external application myApp has an additional field called Account and public credentials were previously specified using:
addExtAppCredential(appName='webcenter', name='myApp', type='PUBLIC', username='admin', password='mypublic.password', field='Account:admin@myhost.com')
If you remove the Account field, you can modify the credentials by running:
setExtAppCredential(appName='webcenter', name='myApp', type='PUBLIC', username='admin', password='mypublic.password')
For details on using setExtAppCredential, see setExtAppCredential
Syntax
removeExtAppField(appName, name, fieldName, [server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the application in which to perform this operation. For WebCenter Portal, the application name is always |
name
|
Connection name. |
fieldName
|
Login field that you want to remove. |
server
|
Optional. Name of the managed server where the application is deployed. For example, Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the application is deployed. |
Example
The following example removes the additional login field named Account from an external application named ABC.
wls:/weblogic/serverConfig> removeExtAppField(appName='webcenter, name='ABC', fieldName='Account')
Module: Oracle WebCenter Portal
Use with WLST: Online
Description
Configures shared user or public user credentials for a specific external application.
When shared credentials are specified, every user accessing WebCenter Portal, is authenticated using the user name and password defined here. WebCenter Portal users are not presented with a login form.
Public users accessing this external application through WebCenter Portal are logged in using the public credentials defined here.
If credentials already exists, a warning indicates that the setExtAppCredential command should be used instead.
Syntax
addExtAppCredential(appName, name, type, username, password, [field, server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the application in which to perform this operation. For WebCenter Portal, the application name is always |
name
|
Name of an existing external application connection. |
type
|
Credential type. Valid values are |
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 |
server
|
Optional. Name of the managed server where the application is deployed. For example, Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the application is deployed. |
Example
The following example specifies public credentials for an external application named ABC. The public user name is mypublic.username, the password is mypublic.password, and there is one additional field named Account.
wls:/weblogic/serverConfig> addExtAppCredential(appName='webcenter', name='ABC', type='PUBLIC', username='mypublic.username', password='mypublic.password', field='Account:username.example')
Module: Oracle WebCenter Portal
Use with WLST: Online
Description
Modifies shared user or public user credentials currently configured for an external application. If the credential has already not been specified, then a warning indicates that addExtAppCredential needs to be used instead. See addExtAppCredential.
The arguments username and password are optional because setExtAppCredential only manipulates existing credentials. At least one of the parameters, username, password or field, must be specified.
You can use setExtAppCredential command to update passwords in systems that require changing passwords every few days.
Syntax
setExtAppCredential(appName, name, type, [username, password, field, server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the application in which to perform this operation. For WebCenter Portal, the application name is always |
name
|
Name of an existing external application connection. |
type
|
Credential type. Valid values are |
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 |
server
|
Optional. Name of the managed server where the application is deployed. For example, Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the application is deployed. |
Example
The following example changes the public user's login credentials for an external application named ABC.
wls:/weblogic/serverConfig> setExtAppCredential(appName='webcenter',name='ABC', type='PUBLIC', username='username.example', password='password.example', field='Account:username.example')
Module: Oracle WebCenter Portal
Use with WLST: Online
Description
Removes shared user or public user credentials currently configured for an external application.
If credentials do not exist, an error displays.
Syntax
removeExtAppCredential(appName, name, type, [server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the application in which to perform this operation. For WebCenter Portal, the application name is always |
name
|
Name of an existing external application connection. |
type
|
Credential type. Valid values are |
server
|
Optional. Name of the managed server where the application is deployed. For example, Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the application is deployed. |
Example
The following example removes shared credentials specified for an external application named ABC.
wls:/weblogic/serverConfig> removeExtAppCredential(appName='webcenter', name='ABC', type='SHARED')
Use the commands listed in Table 2-13, to manage instant messaging and presence server connections.
Configuration changes made using these WLST commands are only effective after your restart the Managed Server on which WebCenter Portal is deployed. For details, see Oracle Fusion Middleware Administering Oracle WebCenter Portal.
Table 2-13 Instant Messaging and Presence WLST Commands
| Use this command... | To... | Use with WLST... |
|---|---|---|
|
Create a new instant messaging and presence server connection for a named 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 a named application supports. |
Online |
|
|
List all of the instant messaging and presence server connections that are configured for a named application. |
Online |
|
|
List the default instant messaging and presence server connection that is configured for a named application. |
Online |
|
|
Set a specified connection as the default instant messaging and presence server connection. |
Online |
|
|
Specify defaults for instant messaging and presence. |
Online |
|
|
Remove defaults for instant messaging and presence. |
Online |
|
|
List instant messaging and presence properties. |
Online |
|
|
Create an external application suitable for instant messaging and presence server connection. |
Online |
Module: Oracle WebCenter Portal
Use with WLST: Online
Description
Creates an instant messaging and presence server connection for a named application.
Use the listIMPAdapters command to find out which types of instant messaging and presence servers are supported. Out-of-the-box, WebCenter Portal supports Microsoft Office Communications Server 2007 SP1 (OCS) and Microsoft Lync 2010.
While you can register multiple presence server connections for WebCenter Portal, only one connection is used for instant messaging and presence services—the default (or active) connection.
Syntax
createIMPConnection(appName, name, adapter, url, [appId, poolName, userDomain, timeout, default, server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the application in which to perform this operation. For WebCenter Portal, the application name is always |
name
|
Connection name. The name must be unique (across all connection types) within the application. |
adapter
|
Adapter name. Specify the adapter that matches your instant messaging and presence server. The valid value is Choose |
url
|
URL of the sever hosting instant messaging and presence services. For example: |
domain
|
Deprecated. Use the setIMPServiceProperty command to resolve IM addresses. |
appId
|
Optional. External application associated with the presence server connection. If specified, external application credential information is used to authenticate users against the OCS or Lync server. This argument is mandatory for OCS and Lync server connections. The external application you configure for instant messaging and presence services must use See also addExtAppField and setExtAppField. |
poolName
|
Optional. Pool name that is required to create an OCS or Lync connection. Refer to Microsoft Office Communications Server, or Microsoft Lync Server documentation for details on pool names. This argument is mandatory for OCS and Lync server connections. |
userDomain
|
Active Directory domain on the OCS/Lync server. This argument is mandatory for OCS/Lync server connections. |
timeout
|
Optional. Length of time (in seconds) that instant messaging and presence waits for a response from the presence server before issuing a connection timeout message. This argument defaults to When set to |
default
|
Optional. Indicates whether this connection is the default connection for instant messaging and presence services. Valid values are |
server
|
Optional. Name of the managed server where the application is deployed. For example, Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the application is deployed. |
Example
The following example creates an instant messaging and presence server connection to a Microsoft Office Communications Server named myOCSPresenceServer.
wls:/weblogic/serverConfig>createIMPConnection(appName='webcenter', name='myOCSPresenceServer', adapter='OCS2007', url='http://myocshost.com/owc/ocs', appId='OCSExtApp', userDomain='OCS', poolName='pool01.myocshost.com', timeout=60, default=1)
The following example creates an instant messaging and presence server connection to a Microsoft Lync Server named myLyncServer.
wls:/weblogic/serverConfig>createIMPConnection(appName='webcenter', name='myLyncServer', adapter='OCS2007', url='http://mylynchost.com:8888' appId='LyncExtApp', userDomain='LYNC', poolName='pool05.mylynchost.com', timeout=60, default=1))
Module: Oracle WebCenter Portal
Use with WLST: Online
Description
Edits an existing instant messaging and presence server connection. Use this command to update connection attributes.
The connection is created using the createIMPConnection command.
Syntax
setIMPConnection(appName, name, [adapter, url, appId, poolName, userDomain, timeout, default, server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the application in which to perform this operation. For WebCenter Portal, the application name is always |
name
|
Name of an existing presence server connection. |
adapter
|
Optional. Adapter name. Specify the adapter that matches your instant messaging and presence server. Valid value is Choose |
url
|
Optional. URL of the server hosting instant messaging and presence services. |
domain
|
Deprecated. Use the setIMPServiceProperty command to resolve IM addresses. |
appId
|
External application associated with the presence server connection. If specified, external application credential information is used to authenticate users against the OCS or Lync server. This argument is mandatory for OCS and Lync server connections. The external application you configure for instant messaging and presence services must use See also addExtAppField and setExtAppField. |
poolName
|
Pool name that is required to create an OCS or Lync connection. Refer to Microsoft Office Communications Server or Microsoft Lync Server documentation for details on pool names. This argument is mandatory for OCS, and Lync server connections. |
userDomain
|
Active Directory domain on the OCS server. This argument is mandatory for OCS/Lync server connections. |
timeout
|
Optional. Length of time (in seconds) that instant messaging and presence waits for a response from the presence server before issuing a connection timeout message. This argument defaults to |
default
|
Optional. Indicates whether this connection is the default connection for instant messaging and presence services. Valid values are To specify that instant messaging and presence uses this connection, change the value from To disable this connection, use the removeIMPServiceProperty command:
While you can register multiple presence server connections for an application, only one connection is used for instant messaging and presence services—the default (or active) connection. |
server
|
Optional. Name of the managed server where the application is deployed. For example, Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the application is deployed. |
Example
The following example sets attributes on an existing instant messaging and presence server connection.
wls:/weblogic/serverConfig>setIMPConnection(appName='webcenter', name='myOCSPresenceServer', adapter='OCS2007', url='http://myocshost.com/owc/ocs', timeout=120, default=1)
Module: Oracle WebCenter Portal
Use with WLST: Online
Description
Sets an instant messaging and presence server connection property. Use this command if additional parameters are required to connect to your presence server. This is an extensible way to add any connection property using a key and a value. (You are not limited to connection properties specified by createIMPConnection and setIMPConnection .)
All known, additional connection properties are listed in Table 2-14.
Table 2-14 Additional Instant Messaging and Presence Connection Properties
| Additional Connection Property | Description |
|---|---|
|
|
URL to the presence server This must be supplied if presence is deployed on a separate server. |
|
|
URL to the contact management service. This must be supplied if the contact management service is deployed on a separate server. |
|
|
URL for the third-party call server. If no value is supplied, then this uses the same value as |
|
|
Supports values When set to When set to |
|
|
The domain name of the |
|
|
The attribute used to read users' phone numbers from the user profile. The default is BUSINESS_PHONE. Supply this attribute value only when |
|
|
If the WebCenter user identity is qualified with a domain (for example, If the user identity is qualified with a domain and the presence server uses the same |
Note:
Do not use the setIMPConnectionProperty to set connection properties available through createIMPConnection or setIMPConnection . Attempting to do so has no effect.
Syntax
setIMPConnectionProperty(appName, name, key, value, [secure, server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the application in which to perform this operation. For WebCenter Portal, the application name is always |
name
|
Name of an existing presence server connection. |
key
|
Name of the connection property. See Table 2-14. |
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 |
server
|
Optional. Name of the managed server where the application is deployed. For example, Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the application is deployed. |
Example
The following example adds a custom instant messaging and presence server connection property called admin.user with a default value admin:
wls:/weblogic/serverConfig>setIMPConnectionProperty(appName='webcenter', name='MyLCSPresenceServer', key='admin.user', value='admin')
Module: Oracle WebCenter Portal
Use with WLST: Online
Description
Deletes an instant messaging and presence server connection property. Use caution when deleting connection properties because the connection might not work as expected if the configuration becomes invalid as a result.
This command can only delete additional connection properties added using the setIMPConnectionProperty command.
Syntax
deleteIMPConnectionProperty(appName, name, key, [server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the application in which to perform this operation. For WebCenter Portal, the application name is always |
name
|
Name of an existing presence server connection. |
key
|
Name of the connection property you want to delete. |
server
|
Optional. Name of the managed server where the application is deployed. For example, Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the application is deployed. |
Example
The following example deletes an instant messaging and presence server connection property named admin.user.
wls:/weblogic/serverConfig>deleteIMPConnectionProperty(appName='webcenter', name='MyOCSPresenceServer', key='admin.user')
Module: Oracle WebCenter Portal
Use with WLST: Online
Description
Lists which types of instant messaging and presence servers Oracle WebCenter Portal supports. Out-of-the-box, WebCenter Portal supports Microsoft Office Communications Server 2007 SP1 (OCS) and Microsoft Lync 2010.
Syntax
listIMPAdapters()
Example
The following example lists which presence servers are supported:
wls:/weblogic/serverConfig>listIMPAdapters()
Module: Oracle WebCenter Portal
Use with WLST: Online
Description
Lists all of the instant messaging and presence server connections that are configured for a named application.
Syntax
listIMPConnections(appName,[verbose, name, server, applicationVersion)
| Argument | Definition |
|---|---|
appName
|
Name of the application in which to perform this operation. For WebCenter Portal, the application name is always |
verbose
|
Optional. Displays presence server connection details in verbose mode. Valid values are When set to |
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 |
server
|
Optional. Name of the managed server where the application is deployed. For example, Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the application is deployed. |
Example
The following example lists all the instant messaging and presence server connections that are configured for WebCenter Portal (webcenter):
wls:/weblogic/serverConfig>listIMPConnections(appName='webcenter')
The following example lists all the instant messaging and presence server connections that are configured for WebCenter Portal in verbose mode:
wls:/weblogic/serverConfig>listIMPConnections(appName='webcenter', verbose=1)
The following example lists connection details for an instant messaging and presence server connections named impConnection1.
wls:/weblogic/serverConfig> listIMPConnections(appName='webcenter', name='impConnection1')
Module: Oracle WebCenter Portal
Use with WLST: Online
Description
Lists the connection that instant messaging and presence is using, in a named application. While you can register multiple presence server connections for WebCenter Portal, instant messaging and presence only uses one connection—the default (or active) connection.
If only one presence server connection is available, that connection is assumed to be the default connection.
Syntax
listDefaultIMPConnection(appName, verbose, [server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the application in which to perform this operation. For WebCenter Portal, the application name is always |
verbose
|
Optional. Displays the default presence server connection in verbose mode, if available. Valid options are When set to |
server
|
Optional. Name of the managed server where the application is deployed. For example, Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the application is deployed. |
Example
The following example lists the name and details of the connection that instant messaging and presence is using in WebCenter Portal (webcenter):
wls:/weblogic/serverConfig>listDefaultIMPConnection(appName='webcenter', verbose=1)
Module: Oracle WebCenter Portal
Use with WLST: Online
Description
Specifies the default connection for instant messaging and presence in a named application. While you can register multiple presence server connections with an application, instant messaging and presence only uses one connection—the default (or active) connection.
If only one presence server connection is available, that connection is assumed to be the default connection.
Syntax
setDefaultIMPConnection(appName, name, [server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the application in which to perform this operation. For WebCenter Portal, the application name is always |
name
|
Name of an existing instant messaging and presence connection. |
server
|
Optional. Name of the managed server where the application is deployed. For example, Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the application is deployed. |
Example
The following example makes a connection named myPresenceServer the default (or active) connection for instant messaging and presence in WebCenter Portal (webcenter):
wls:/weblogic/serverConfig>setDefaultIMPConnection(appName='webcenter', name='myPresenceServer')
Module: Oracle WebCenter Portal
Use with WLST: Online
Description
Specifies default values for instant messaging and presence.
Configurable properties for instant messaging and presence are listed in Table 2-15.
Table 2-15 Instant Messaging and Presence - Configurable Properties
| Configuration Property | Description |
|---|---|
|
|
Connection used by instant messaging and presence. |
|
|
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 WebCenter Portal does not always provide display names by default and you consider this information important, set |
|
|
Resolver implementation used to map user names to IM addresses and IM addresses to user names. The default setting is
|
|
|
User profile attribute used to determine a user's IM address. The default setting is |
Syntax
setIMPServiceProperty(appName, property, value, [server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the application in which to perform this operation. For WebCenter Portal, the application name is always |
property
|
Name of the configuration property. |
value
|
Value for the property. |
server
|
Optional. Name of the managed server where the application is deployed. For example, Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the application is deployed. |
Example
The following example changes the default cache timeout for instant messaging and presence data in WebCenter Portal (webcenter):
wls:/weblogic/serverConfig>setIMPServiceProperty(appName='webcenter', property='rtc.cache.time', value='30')
Module: Oracle WebCenter Portal
Use with WLST: Online
Description
Removes the current value that is set for an instant messaging and presence property. Use this command to remove any of the properties listed in Table 2-15.
Take care when using this command as removing values for these properties might cause unexpected behavior.
Note:
Use this command syntax to disable the connection currently used by instant messaging and presence:
removeIMPServiceProperty('appName='webcenter', property='selected.connection')
This command forces the default connection argument to 0. See also, setIMPConnection .
Syntax
removeIMPServiceProperty(appName, property, [server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the application in which to perform this operation. For WebCenter Portal, the application name is always |
property
|
Name of the configuration property. |
server
|
Optional. Name of the managed server where the application is deployed. For example, Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the application is deployed. |
Example
The following example clears the cache expiration value for instant messaging and presence in WebCenter Portal:
wls:/weblogic/serverConfig>removeIMPServiceProperty(appName='webcenter', property='rtc.cache.time')
Module: Oracle WebCenter Portal
Use with WLST: Online
Description
Lists all configurable properties for instant messaging and presence.
Syntax
listIMPServiceProperties(appName, [server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the application in which to perform this operation. For WebCenter Portal, the application name is always |
server
|
Optional. Name of the managed server where the application is deployed. For example, Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the application is deployed. |
Example
The following example lists configuration properties for instant messaging and presence in WebCenter Portal (webcenter):
wls:/weblogic/serverConfig>listIMPServiceProperties(appName='webcenter')
Module: Oracle WebCenter Portal
Use with WLST: Online
Description
Creates an external application suitable for instant messaging and presence server connections. The external application is configured with the required additional properties: authMethod=POST, and additional fields fieldName='Account' and displaytoUser=1.
Syntax
createIMPExtAppConnection(appName, name, [displayName, server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the application in which to perform this operation. For WebCenter Portal, the application name is always |
name
|
Connection name. The name must be unique (across all connection types) within the application. |
displayName
|
Optional. External application display name. A user friendly name for the application that users will recognize. The display name must be unique across all external applications within the application. |
server
|
Optional. Name of the managed server where the application is deployed. For example, Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the application is deployed. |
Example
The following example creates an external application named IMPxApp suitable for instant messaging and presence server connections:
wls:/weblogic/serverConfig>createIMPExtAppConnection(appName='webcenter', name='IMPxApp', displayName='IMP Ext App')
Use the commands listed in Table 2-16 to manage mail server connections for a named application.
WebCenter Portal supports multiple mail connections. The mail connection configured with default=1 is the default connection for mail services in WebCenter Portal. All additional connections are offered as alternatives; WebCenter Portal users can choose which one they want to use through user preferences.
Configuration changes made using these WLST commands are only effective after your restart the Managed Server on which the application is deployed. For details, see Oracle Fusion Middleware Administering Oracle WebCenter Portal.
Table 2-16 Mail WLST Commands
| Use this command... | To... | Use with WLST... |
|---|---|---|
|
Create a mail server connection for a named 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 a named application. |
Online |
|
|
List the default mail server connection that is configured for a named application. |
Online |
|
|
Set a specified connection as the default mail server connection. |
Online |
|
|
Specify defaults for mail. |
Online |
|
|
Remove defaults for mail. |
Online |
|
|
List properties for mail. |
Online |
|
|
Create an external application suitable for mail connections. |
Online |
Module: Oracle WebCenter Portal
Use with WLST: Online
Description
Creates a mail server connection for a named application.
WebCenter Portal supports the Microsoft Exchange Server or any mail server that supports IMAP4 and SMTP. The most important mail server connection attributes are: imapHost, imapPort, imapSecured, smtpHost, smtpPort, and smtpSecured
You can register multiple mail server connections. WebCenter Portal supports multiple mail connections. The mail connection configured with default=1 is the default connection for mail services in WebCenter Portal. All additional connections are offered as alternatives; WebCenter Portal users can choose which one they want to use through user preferences.
Syntax
createMailConnection(appName, name, [imapHost, imapPort, smtpHost, smtpPort, imapSecured, smtpSecured, appId, timeout, default, server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the application in which to perform this operation. For WebCenter Portal, the application name is always |
name
|
Connection name. The name must be unique (across all connection types) within the application. |
imapHost
|
Optional. Host name of the machine on which the IMAP service is running. |
imapPort
|
Optional. Port on which the IMAP service listens. |
smtpHost
|
Optional. Host name of the machine where the SMTP service is running. |
smtpPort
|
Optional. Port on which the SMTP service listens. |
imapSecured
|
Optional. Specifies whether the mail server connection to the IMAP server is SSL-enabled. Valid values are |
smtpSecured
|
Optional. Specifies whether the SMTP server is secured. Valid values are |
appId
|
External application associated with the mail server connection. External application credential information is used to authenticate users against the IMAP and SMTP servers. The same credentials are supplied to authenticate the user on both the IMAP and SMTP servers. The external application you configure for mail must use
If an external application does not exist yet, use the WLST command createMailExtApp to create an external application that automatically has all the required additional fields. See also createExtAppConnection. |
timeout
|
Optional. Length of time (in seconds) that the mail waits to acquire a connection before terminating. This argument defaults to |
default
|
Optional. Indicates whether this connection is the default connection for mail. Valid values are WebCenter Portal supports multiple mail connections. The mail connection configured with |
server
|
Optional. Name of the managed server where the application is deployed. For example, Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the application is deployed. |
Example
The following example creates an external application suitable for a mail server connection, and then creates a mail server connection named myMailConnection for WebCenter Portal (webcenter):
wls:/weblogic/serverConfig>createMailExtApp(appName='webcenter', name='extApp_Mail', displayName='Mail Ext App') wls:/weblogic/serverConfig> reateMailConnection(appName='webcenter' , name='myMailConnection' , imapHost='myimaphost.com', imapPort=143 , smtpHost='mysmtphost.com' , smtpPort=25 , imapSecured=0, smtpSecured=0, appId='extApp_Mail', timeout=60, default=1)
Module: Oracle WebCenter Portal
Use with WLST: Online
Description
Edits an existing mail connection. Use this command to update connection attributes.
The connection is created using the createMailConnection command.
This command enables you to set additional, optional, LDAP server attributes that cannot be set using createMailConnection. When LDAP details are defined, mail creates, edits, and deletes portal distribution lists in WebCenter Portal. Portal distribution lists are named after their portal (excluding non-java identifiers) and assigned a domain (derived from the domain attribute, for example, @mycompany.com). If LDAP details are not provided, portal distribution lists are not created or maintained. The mail server must be a Microsoft Exchange Server.
Syntax
setMailConnection(appName, name, [imapHost, imapPort, smtpHost, smtpPort, imapSecured, smtpSecured, appId, default, ldapHost, ldapPort, ldapBaseDN, ldapAdminUser, ldapAdminPassword, ldapSecured, domain, defaultUser, timeout, server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the application in which to perform this operation. For WebCenter Portal, the application name is always |
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 |
smtpSecured
|
Optional. Specifies whether the connection to the SMTP server is secured (SSL-enabled). Valid values are |
appId
|
Optional. External application associated with the mail server connection. External application credential information is used to authenticate users against the IMAP and SMTP servers. The same credentials are supplied to authenticate the user on both the IMAP and SMTP servers. The external application you configure for mail must use
If an external application does not exist yet, use the WLST command createMailExtApp to create an external application that automatically has all the required additional fields. See also createExtAppConnection. |
ldapHost
|
Optional. Host name of the machine where the LDAP directory server is running. |
ldapPort
|
Optional. Port on which the LDAP directory server listens. |
ldapBaseDN
|
Optional. Base distinguished name for the LDAP schema. For example, |
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 |
domain
|
Optional. Domain name appended to portal distribution lists. For example, if the domain attribute is set to |
defaultUser
|
Optional. Comma-delimited list of user names to whom you want to grant moderation capabilities. These users become members of every portal distribution list that is created. The users specified must exist in the Base LDAP schema (specified in the |
timeout
|
Optional. Length of time (in seconds) that mail waits to acquire a connection before terminating. This argument defaults to |
default
|
Optional. Indicates whether this connection is the default (or active) connection for mail. Valid values are WebCenter Portal supports multiple mail connections. The mail connection configured with A connection does not cease to be the default connection for mail 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 application is deployed. For example, Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the application is deployed. |
Example
The following example sets individual attributes for a mail server connection configured for WebCenter Portal (webcenter):
wls:/weblogic/serverConfig>setMailConnection(appName='webcenter', name='myMailConnection', imapHost='myimaphost.com', imapPort=143, smtpHost='mysmtphost.com' , smtpPort=25 , imapSecured=0, smtpSecured=0, appId='extApp_Mail', timeout=60, default=1)
The following example sets individual attributes for a mail server connection:
wls:/weblogic/serverConfig>setMailConnection(appName='webcenter', name='myMailConnection', imapPort=993, imapSecured=1, smtpPort=465 , smtpSecured=1)
The following example sets LDAP attributes for a mail server connection:
wls:/weblogic/serverConfig>setMailConnection(appName='webcenter', name='myMailConnection', domain='mycompany.com', defaultUser='admin', imapHost='myimaphost.com', imapPort=143, smtpHost='mysmtphost.com', imapSecured=0, smtpSecured=0, smtpPort=25, appId='extApp_Mail', default=1, ldapHost='myldaphost.com', ldapPort=389, ldapBaseDN='CN=Users,DC=exchange,DC=uk,DC=com', ldapAdminUser='administrator', ldapAdminPassword='adminpswd', ldapSecured=0, timeout=60)
Module: Oracle WebCenter Portal
Use with WLST: Online
Description
Sets a mail server connection property. Use this command if additional parameters are required to connect to your mail server. This is an extensible way to add any connection property using a key and a value. (You are not limited to connection properties specified by createMailConnection and setMailConnection .)
Syntax
setMailConnectionProperty(appName, name, key, value, [secure, server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the application in which to perform this operation. For WebCenter Portal, the application name is always |
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 |
server
|
Optional. Name of the managed server where the application is deployed. For example, Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the application is deployed. |
Example
The following example adds a custom mail server connection property called myProperty1 with a default value propertyValue1:
wls:/weblogic/serverConfig> setMailConnectionProperty(appName='webcenter', name='myMailServer', key='myProperty1', value='propertyValue1')
Module: Oracle WebCenter Portal
Use with WLST: Online
Description
Deletes a mail server connection property. Take care when deleting connection properties because the connection may not work as expected if the configuration becomes invalid as a result.
This command can only delete additional connection properties added using the setMailConnectionProperty command.
Syntax
deleteMailConnectionProperty(appName, name, key, [server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the application in which to perform this operation. For WebCenter Portal, the application name is always |
name
|
Name of an existing mail server connection. |
key
|
Name of the connection property you want to delete. |
server
|
Optional. Name of the managed server where the application is deployed. For example, Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the application is deployed. |
Example
The following example deletes a mail server connection property named mailProperty1:
wls:/weblogic/serverConfig>deleteMailConnectionProperty(appName='webcenter', name='myMailServer', key='mailProperty1')
Module: Oracle WebCenter Portal
Use with WLST: Online
Description
Lists all of the mail server connections that are configured for a named application.
Syntax
listMailConnection(appName, [verbose, name, server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the application in which to perform this operation. For WebCenter Portal, the application name is always |
verbose
|
Optional. Displays mail server connection details in verbose mode. Valid options are When set to When set to |
name
|
Optional. Name of an existing mail server connection. Use this argument to view connection details for a specific mail server connection. |
server
|
Optional. Name of the managed server where the application is deployed. For example, Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the application is deployed. |
Example
The following example lists the names of mail server connections that are currently configured for WebCenter Portal:
wls:/weblogic/serverConfig>listMailConnections(appName='webcenter')
The following example lists connection names and details for all of the mail server connections that are currently configured for WebCenter Portal:
wls:/weblogic/serverConfig>listMailConnections(appName='webcenter', verbose=1)
The following example lists connection details for a mail server connection named mailConnection1:
wls:/weblogic/serverConfig>listMailConnections(appName='webcenter', name='mailConnection1')
Module: Oracle WebCenter Portal
Use with WLST: Online
Description
Lists the default mail server connection that mail is using in a named application.
You can register multiple mail server connections but there can only be one default connection. The mail connection configured with default=1 is the default connection for mail services in WebCenter Portal. All additional connections are offered as alternatives; WebCenter Portal users can choose which one they want to use through user preferences.
Syntax
listDefaultMailConnection(appName,[verbose, server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the application in which to perform this operation. For WebCenter Portal, the application name is always |
verbose
|
Optional. Displays the default mail server connection in verbose mode, if available. Valid options are When set to When set to |
server
|
Optional. Name of the managed server where the application is deployed. For example, Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the application is deployed. |
Example
The following example lists the name and details of the mail server connection that mail is using in WebCenter Portal:
wls:/weblogic/serverConfig>listDefaultMailConnection(appName='webcenter', verbose=1)
Module: Oracle WebCenter Portal
Use with WLST: Online
Description
Specifies the default mail server connection for mail in a named application.
You can register multiple mail server connections but there can only be one default connection. The mail connection configured with default=1 is the default connection for mail services in WebCenter Portal. All additional connections are offered as alternatives; WebCenter Portal users can choose which one they want to use through user preferences.
Syntax
setDefaultMailConnection(appName, name, [server, applicationVersion])
| Argument | Description |
|---|---|
appName
|
Name of the application in which to perform this operation. For WebCenter Portal, the application name is always |
name
|
Name of an existing mail connection. |
server
|
Optional. Name of the managed server where the application is deployed. For example, Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the application is deployed. |
Example
The following example configures mail to use a connection named myMailServer.for the default connection in WebCenter Portal:
wls:/weblogic/serverConfig>setDefaultMailConnection(appName='webcenter', name='myMailServer')
Module: Oracle WebCenter Portal
Use with WLST: Online
Description
Specifies default values for mail.
Configurable properties for mail are listed in Table 2-17.
Table 2-17 Mail - Configurable Properties
| Configuration Property | Description |
|---|---|
|
|
Defines the delimiter that is used to separate multiple mail addresses. A comma is used by default. Some mail servers require mail addresses in the form |
|
|
The frequency, in seconds, that portal distribution lists are checked for new incoming emails. The default is 1800 seconds (30 minutes). |
|
|
Maximum number of messages displayed in mail inboxes. |
|
|
Determines whether user email addresses are resolved to WebCenter Portal user names when LDAP is configured. Valid values are When set to Set this property to |
|
|
Restricts the number of recipients to a message. For example, setting this value to '500' limits the number of recipients to 500. |
Syntax
setMailServiceProperty(appName, property, value, [server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the application in which to perform this operation. For WebCenter Portal, the application name is always |
property
|
Name of the configuration property |
value
|
Value for the property. |
server
|
Optional. Name of the managed server where the application is deployed. For example, Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the application is deployed. |
Example
The following example increases the default number of messages displayed in mail inboxes to 100, in WebCenter Portal (webcenter):
wls:/weblogic/serverConfig>setMailServiceProperty(appName='webcenter', property='mail.messages.fetch.size', value='100')
Module: Oracle WebCenter Portal
Use with WLST: Online
Description
Removes the current value that is set for a mail property. Use this command to remove any of the properties listed in Table 2-17.
Take care when using this command as removing values for these properties might cause unexpected behavior.
Note:
Use this command syntax to stop mail from using the current default connection:
removeMailServiceProperty('appName='webcenter', property='selected.connection')
This command forces the default connection argument to 0. See also, setMailConnection .
Syntax
removeMailServiceProperty(appName, property, [server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the application in which to perform this operation. For WebCenter Portal, the application name is always |
property
|
Name of the configuration property. |
server
|
Optional. Name of the managed server where the application is deployed. For example, Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the application is deployed. |
Example
The following example clears the current mail.messages.fetch.size setting for mail, in WebCenter Portal:
wls:/weblogic/serverConfig>removeMailServiceProperty(appName='webcenter', property='mail.messages.fetch.size')
Module: Oracle WebCenter Portal
Use with WLST: Online
Description
Lists all configurable properties for mail.
Syntax
listMailServiceProperties(appName, [server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the application in which to perform this operation. For WebCenter Portal, the application name is always |
server
|
Optional. Name of the managed server where the application is deployed. For example, Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the application is deployed. |
Example
The following example lists configurable properties for mail in WebCenter Portal:
wls:/weblogic/serverConfig>listMailServiceProperties(appName='webcenter')
Module: Oracle WebCenter Portal
Use with WLST: Online
Description
Creates an external application suitable for mail server connections. The external application is configured with all the required additional properties: authMethod=POST, and specify several additional login fields:
fieldName='Email Address' and displaytoUser=1
fieldName='Your Name' and displaytoUser=1
fieldName='Reply-To Address' and displaytoUser=1
Syntax
createMailExtAppConnection(appName, name, [displayName, server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the application in which to perform this operation. For WebCenter Portal, the application name is always |
name |
Connection name. The name must be unique (across all connection types) within the application. |
displayName
|
Optional. External application display name. A user friendly name for the external application that portal users will recognize. The display name must be unique across all external applications within the application. |
server
|
Optional. Name of the managed server where the application is deployed. For example, Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the application is deployed. |
Example
The following example creates an external application named MailxApp suitable for mail server connections.
wls:/weblogic/serverConfig>createMailExtAppConnection(appName='webcenter', name='MailxApp', displayName='Mail Ext App')
Use the commands listed in Table 2-18 to manage settings for the notifications in a named application.
Configuration changes made using these WLST commands take effect after your restart the Managed Server where the application is deployed. For details, see Oracle Fusion Middleware Administering Oracle WebCenter Portal.
Table 2-18 Notifications WLST Commands
| Use this command... | To... | Use with WLST... |
|---|---|---|
|
Specify the connection used for routing notifications raised in a named application. |
Online |
|
|
Return details about the connection that is used to send notifications raised in a named application. |
Online |
Module: Oracle WebCenter Portal
Use with WLST: Online
Description
Specifies the connection used for routing notifications raised in a named application.
Use an existing mail server or BPEL server connection. If the application is connected to a BPEL server, the Oracle User Messaging Service (UMS) is available for routing notifications through multiple messaging channels, including mail and SMS. If you configure notifications to use a BPEL server connection, you may specify a sender 'From' address for each available messaging channel. That is, you can specify a sender mail address and an SMS address.
Alternatively, you can route notification messages through a mail server. If you configure notifications to use a mail server connection, the external application associated with the mail server connection must contain shared credentials. Shared credentials are required for routing application-wide notifications.
Syntax
setNotificationsConfig(appName, type, name, [senderMailAddress, senderSMSAddress, server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the application in which to perform this operation. For WebCenter Portal, the application name is always |
type
|
Type of connection used to send notifications. Valid values are |
name
|
Name of an existing connection. Consider the following:
|
senderMailAddress
|
Optional. Mail address from which all mail notifications are sent. Use the format:
For example, This argument applies to notifications routed through BPEL servers. When a BPEL server is used and UMS is configured with multiple email drivers, this address is also used to identify the appropriate email driver. When a mail server is used, the "From Address" is the same user that is specified for the associated external application's shared credentials. |
senderSMSAddress
|
Optional. SMS number from which all SMS notifications are sent. Typically, the SMS address format is a 4-6 digit number (without -, spaces, or any other characters). For example, This argument applies to notifications routed through BPEL servers. When a BPEL server is used and UMS is configured with multiple SMS drivers, this address is also used to identify the appropriate SMS driver. |
server
|
Optional. Name of the managed server where the application is deployed. For example, Required when applications with the same name are deployed to different servers and when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the application is deployed. |
Example
The following example specifies that notifications in WebCenter Portal (webcenter) use a BPEL server connection named WebCenter-SMS and also defines the mail address and SMS address from which all notifications are sent:
wls:/weblogic/serverConfig>setNotificationsConfig(appName='webcenter', type='BPEL', name='WebCenter-SMS', senderMailAddress='WebCenter Notification<notifications@webcenter.com>', senderSMSAddress='28734')
Module: Oracle WebCenter Portal
Use with WLST: Online
Description
Returns details about the connection that is used to send notifications raised in a named application.
Syntax
getNotificationsConfig(appName, [server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the application in which to perform this operation. For WebCenter Portal, the application name is always |
server
|
Optional. Name of the managed server where the application is deployed. For example, Required when applications with the same name are deployed to different servers and when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the application is deployed. |
Example
The following example returns details about the connection used by notifications service in WebCenter Portal:
wls:/weblogic/serverConfig>getNotificationsConfig(appName='webcenter') ConnectionType: BPEL ConnectionName: WebCenter-SMS SenderMailAddress: notifications@webcenter.com SenderSMSAddress: 28776
Use the commands listed in Table 2-19 to manage user profile information in WebCenter Portal.
Configuration changes made using these WLST commands are effective only after your restart the Managed Server on which WebCenter Portal is deployed. For details, see Oracle Fusion Middleware Administering Oracle WebCenter Portal.
Table 2-19 People Connection WLST Commands
| Use this command... | To... | Use with WLST... |
|---|---|---|
|
Synchronize profile information in the LDAP store, with the WebCenter Portal database schema. |
Online |
|
|
Synchronize profile information for a specific user. |
Online |
|
|
Stop the profile synchronization process. |
Online |
|
|
Check whether profile synchronization is in progress. |
Online |
|
|
Set profile properties. |
Online |
|
|
Return current profile properties. |
Online |
|
|
List current profile properties. |
Online |
|
|
Specify whether to synchronize user profile photos in the WebCenter schema from the LDAP server. |
Online |
Module: Oracle WebCenter Portal
Use with WLST: Online
Description
Synchronizes profile information in the LDAP store with the WebCenter Portal database schema.
Syntax
startSyncProfiles(appName, [server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the application in which to perform this operation. For WebCenter Portal, the application name is always |
server
|
Optional. Name of the managed server where the application is deployed. For example, Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the application is deployed. |
Example
The following example synchronizes user profiles for WebCenter Portal:
wls:/weblogic/serverConfig>startSyncProfiles(appName='webcenter')
Module: Oracle WebCenter Portal
Use with WLST: Online
Description
Stops the profile synchronization process, if currently in progress.
Syntax
stopSyncProfiles(appName, [server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the application in which to perform this operation. For WebCenter Portal, the application name is always |
server
|
Optional. Name of the managed server where the application is deployed. For example, Required when applications with the same name are deployed to different servers and when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the application is deployed. |
Example
The following example stops the profile synchronization process for WebCenter Portal:
wls:/weblogic/serverConfig>stopSyncProfiles(appName='webcenter')
Module: Oracle WebCenter Portal
Use with WLST: Online
Description
Checks whether profile synchronization is in progress.
Syntax
isSyncProfilesRunning(appName, [server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the application in which to perform this operation. For WebCenter Portal, the application name is always |
server
|
Optional. Name of the managed server where the application is deployed. For example, Required when applications with the same name are deployed to different servers and when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the application is deployed. |
Example
The following example checks whether profile synchronization is in progress for WebCenter Portal:
wls:/weblogic/serverConfig>isSyncProfilesRunning(appName='webcenter')
Module: Oracle WebCenter Portal
Use with WLST: Online
Description
Synchronizes profile information for a specific user in the LDAP store with the WebCenter Portal schema.
Syntax
syncProfile(appName, userName, [server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the application in which to perform this operation. For WebCenter Portal, the application name is always |
|
|
Name of the user whose profile information you want to synchronize. |
server
|
Optional. Name of the managed server where the application is deployed. For example, Required when applications with the same name are deployed to different servers and when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the application is deployed. |
Example
The following example synchronizes profile information for a user named chad:
wls:/weblogic/serverConfig>syncProfile(appName='webcenter', userName='chad')
Module: Oracle WebCenter Portal
Use with WLST: Online
Description
Sets profile properties for a named application. If you omit a parameter, the corresponding configuration remains unchanged.
Syntax
setProfileConfig(appName, ProfilePageVersion, ProfileSyncHourOfDay, ProfileSyncFrequencyInDays, server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the application in which to perform this operation. For WebCenter Portal, the application name is always |
|
|
Optional. Specifies the profile page version to use. Valid values for ProfilePageVersion are:
The default value is |
|
|
Optional. Specifies when (the hour) to start profile synchronization. Any value between 0 and 23. The default value is |
|
|
Optional. Specifies how often profile synchronization takes place (in days). Any value greater than 0. The default value is |
server
|
Optional. Name of the managed server where the application is deployed. For example, Required when applications with the same name are deployed to different servers and when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the application is deployed. |
Example
The following example sets new values for the ProfilePageVersion and ProfileSyncHourOfDay configuration settings.
All other settings remain unchanged:
wls:/weblogic/serverConfig>setProfileConfig(appName='webcenter',ProfilePageVersion=v2, ProfileSyncHourOfDay=12)
Module: Oracle WebCenter Portal
Use with WLST: Online
Description
Returns current profile settings for a named application.
Syntax
getProfileConfig(appName, key, [server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the application in which to perform this operation. For WebCenter Portal, the application name is always |
|
|
Name of a profile property. Valid values include: - ProfilePageVersion - ProfileSyncHourofDay - ProfileSyncFrequencyInDays |
server
|
Optional. Name of the managed server where the application is deployed. For example, Required when applications with the same name are deployed to different servers and when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the application is deployed. |
Example
The following examples return current settings for various profile properties:
wls:/weblogic/serverConfig> getProfileConfig(appName='webcenter', key='ProfilePageVersion') wls:/weblogic/serverConfig> getProfileConfig(appName='webcenter', key='ProfileSyncHourOfDay') wls:/weblogic/serverConfig> getProfileConfig(appName='webcenter', key='ProfileSyncFrequencyInDays')
Module: Oracle WebCenter Portal
Use with WLST: Online
Description
Lists the current profile settings for a named application.
Syntax
listProfileConfig(appName, [server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the application in which to perform this operation. For WebCenter Portal, the application name is always |
server
|
Optional. Name of the managed server where the application is deployed. For example, Required when applications with the same name are deployed to different servers and when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the application is deployed. |
Example
The following example lists current profile settings for WebCenter Portal (webcenter):
wls:/weblogic/serverConfig>listProfileConfig(appName='webcenter')
Module: Oracle WebCenter Portal
Use with WLST: Online
Description
Specifies whether to synchronize the latest user profile photos in LDAP with WebCenter Portal's profile cache. When synchronization is enabled, profile photos are synchronized when the profile cache expires. When synchronization is disabled, profile photos are not synchronized with the WebCenter Portal's profile cache.
Syntax
setProfilePhotoSync(appName, enablePhotoSync, [server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the application in which to perform this operation. For WebCenter Portal, the application name is always |
|
|
Specifies whether to periodically synchronize user profile photos in LDAP. Valid values are
The default value is |
server
|
Optional. Name of the managed server where the application is deployed. For example, Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the application is deployed. |
Example
The following example enables profile photo synchronization in WebCenter Portal:
wls:/weblogic/serverConfig>setProfilePhotoSync(appName='webcenter', enablePhotoSync=1)
Use the commands listed in Table 2-20 to manage personal events server connections for a named application.
Configuration changes made using these WLST commands are only effective after your restart the Managed Server on which the application is deployed. For details, see Oracle Fusion Middleware Administering Oracle WebCenter Portal.
Table 2-20 Personal Events WLST Commands
| Use this command... | To... | Use with WLST... |
|---|---|---|
|
Create a personal events server connection for a named application. |
Online |
|
|
Edit an existing personal events server connection. |
Online |
|
|
List all of the personal events server connections that are configured for a named application |
Online |
Module: Oracle WebCenter Portal
Use with WLST: Online
Description
Creates a personal events server connection for a named application.
Personal events supports connections to Microsoft Exchange Server 2007, Microsoft Exchange Server 2010, and Microsoft Exchange Server 2013. While you can register multiple personal events connections for WebCenter Portal, only one connection is used for personal events services - the default (or active) connection.
Syntax
createPersonalEventConnection(appName, name, webServiceUrl, adapterName, appId, [default, server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the application in which to perform this operation. For WebCenter Portal, the application name is always |
name
|
Connection name. The name must be unique (across all connection types within the application. |
webServiceUrl
|
URL of the web service exposing the event application. Use the format: protocol://host:port/appWebServiceInterface/WSName |
adapterName
|
Specify the adapter that matches the personal events server. Valid values are Each adapter has its own mechanism of authenticating and exchanging data |
appId
|
External application associated with the Microsoft Exchange Server providing personal events services. If specified, external application credential information is used to authenticate users against the Microsoft Exchange Server. |
default
|
Optional. Indicates whether this connection is the default connection for personal event services. Valid values are To specify that personal events uses this connection, set the value to While you can register multiple connections for WebCenter Portal, only one connection is used for personal event services—the default (or active) connection. |
server
|
Optional. Name of the managed server where the application is deployed. For example, Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the application is deployed. |
Example
The following example creates a connection named MyPEConnection for WebCenter Portal (webcenter). The connection points to a Microsoft Exchange Server 2007 and is designated as the default connection for personal event services:
wls:/weblogic/serverConfig>createPersonalEventConnection(appName='webcenter', name='MyPEConnection', webServiceUrl='http://myexchange.com/EWS/Services.wsdl', adapterName='MSEx2007', appId='ExtPEApp', default=1)
The following example creates a connection named MyPEConnection for a WebCenter Portal. The connection points to Microsoft Exchange Server 2007:
wls:/weblogic/serverConfig>createPersonalEventConnection(appName='webcenter', name='MyPEConnection', webServiceUrl='http://myexchange.com/ExchangeWS/PersonalEventsWebService.asmx', adapterName='MSEx2007', appId='ExtPEApp')
Module: Oracle WebCenter Portal
Use with WLST: Online
Description
Edits an existing personal events server connection configured for a named application.
Syntax
setPersonalEventConnection(appName, name, [webServiceUrl, adapterName, appId, default, server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the application in which to perform this operation. For WebCenter Portal, the application name is always |
name
|
Name of an existing personal events server connection. |
webServiceUrl
|
URL of the web service exposing the event application. Use the format: protocol://host:port/appWebServiceInterface/WSName |
adapterName
|
Optional. Specify the adapter that matches the personal events server. Valid values are Each adapter has its own mechanism of authenticating and exchanging data |
appId
|
Optional. External application associated with the Microsoft Exchange Server providing personal events services. If specified, external application credential information is used to authenticate users against the Microsoft Exchange Server. |
default
|
Optional. Indicates whether this connection is the default connection for personal events. Valid values are To specify that personal events uses this connection, set the value to While you can register multiple connections for WebCenter Portal, only one connection is used for personal event services— the default (or active) connection. |
server
|
Optional. Name of the managed server where the application is deployed. For example, Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the application is deployed. |
Example
The following example updates the web service URL for a connection named MyPEConnection.
wls:/weblogic/serverConfig>setPersonalEventConnection(appName='webcenter', name='MyPEConnection', webServiceUrl='http://myexchange.com/EWS/Services.wsdl')
The following example makes a connection named MyPEConnection the default connection for personal events services in WebCenter Portal.
wls:/weblogic/serverConfig>setPersonalEventConnection(appName='webcenter', name='MyPEConnection', default=1)
Module: Oracle WebCenter Portal
Use with WLST: Online
Description
Lists all of the personal events server connections that are configured for a named application.
Syntax
listPersonalEventConnections(appName, [verbose, name, server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the application in which to perform this operation. For WebCenter Portal, the application name is always |
verbose
|
Optional. Displays connection details for personal events in verbose mode. Valid options are When set to When set to 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 application is deployed. For example, Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the application is deployed. |
Example
The following example lists connection names and details for all of the personal events server connections currently configured for WebCenter Portal (webcenter):
wls:/weblogic/serverConfig>listPersonalEventConnections(appName='webcenter', verbose=1)
The following example displays connection details for a personal events server connection named MyPEConnection:
wls:/weblogic/serverConfig>listPersonalEventConnections(appName='webcenter', verbose=1, name='MyPEConnection')
Use the commands listed in Table 2-21 to manage portlet producers used in WebCenter Portal.
All configuration changes made using these WLST commands are immediately available in the application.
Table 2-21 Portlet Producer WLST Commands
| Use this command... | To... | Use with WLST... |
|---|---|---|
|
Create and register a WSRP producer. |
Online |
|
|
Edit WSRP producer registration details. |
Online |
|
|
List WSRP producer registration details. |
Online |
|
|
Deregister a WSRP producer, and delete the associated WSRP and web service connections. |
Online |
|
|
List registration properties supported by a WSRP producer. |
Online |
|
|
List any user categories that the WSRP producer might support. |
Online |
|
|
Map a role that is defined in the specified application to a user category supported by a WSRP producer. |
Online |
|
|
Create and register an Oracle PDK-Java producer. |
Online |
|
|
Edit PDK-Java producer registration details. |
Online |
|
|
List registered Oracle PDK-Java producers. |
Online |
|
|
Deregister an Oracle PDK-Java producer, deleting the associated connection. |
Online |
|
|
Create and register a pagelet producer. |
Online |
|
|
Edit pagelet producer registration details. |
Online |
|
|
List pagelet producer registration details. |
Online |
|
|
Deregister a pagelet producer, deleting the associated connection. |
Online |
|
|
Refresh the metadata stored for the named producer to reflect the portlets currently offered by that producer. |
Online |
|
|
List portlet client configuration for a named application. |
Online |
|
|
Edit portlet client configuration settings. |
Online |
|
|
Return portlet client configuration settings. |
Online |
|
|
Register out-of-the-box producers provided with Oracle WebCenter Portal. |
Online |
|
|
Deregister out-of-the-box producers provided with Oracle WebCenter Portal. |
Online |
|
|
Register the sample producers provided with Oracle WebCenter Portal. |
Online |
|
|
Deregister sample producers. |
Online |
Module: Oracle WebCenter Portal
Use with WLST: Online
Description
Creates a connection to a WSRP portlet producer and registers the WRSP producer with a named application. When you create a WSRP producer connection, a web service connection is also created named <name>-wsconn where <name> is the value specified for the name argument.
Syntax
registerWSRPProducer(appName, name, url, [proxyHost], [proxyPort], [timeout],[externalApp],[registrationProperties],[tokenType],[issuer],[defUser], [keyStorePath],[keyStorePswd],[sigKeyAlias],[sigKeyPswd],[encKeyAlias], [encKeyPswd],[recptAlias], [enforcePolicyURI], [server],[applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the application in which to perform this operation. For WebCenter Portal, the application name is always |
name
|
Connection name. The name must be unique (across all connection types) within the application. The name you specify here will appear in Composer (under the Portlets folder). |
url
|
Producer WSDL URL. The syntax will vary according to your WSRP implementation, for example:
Where:
For example:
|
proxyHost
|
Optional. Host name or IP address of the proxy server. A proxy is required when the application and the remote portlet producer are separated by a firewall and an HTTP proxy is needed to communicate with the producer. |
proxyPort
|
Optional. Port number on which the proxy server listens. |
timeout
|
Optional. Timeout setting for communications with the producer, in seconds. For example, the maximum time the producer may take to register, deregister, or display portlets on portal pages. This argument defaults to 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: |
tokenType
|
Optional. Type of token profile to use for authentication with this WSRP producer. When the argument
If the argument |
issuer
|
Optional. Name of the issuer of the token. The issuer name is the entity that vouches for the verification of the subject. For example: 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 portal application. When unauthenticated, the identity anonymous is associated with the application user. The value anonymous may be inappropriate for the remote producer, so you may need to specify an alternative identity here. Keep in mind though, that in this case, the application has not authenticated the user so the default user you specify should be a low privileged user in the remote producer. If the user has authenticated to the application, the user's identity is asserted rather than the default user. This argument only applies when the tokenType is: |
|
|
Optional. This argument 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 |
encKeyAlias
|
Optional. Key alias to be used for encryption. A valid value is one of the key aliases that is located in the specified key store. |
encKeyPswd
|
Optional. Password for accessing the encryption key. |
recptAlias
|
Optional. Key store alias that is associated with the producer's certificate. This certificate is used to encrypt the message to the producer. Do not specify a recipient key alias when the |
enforcePolicyURI
|
Optional. Valid values are When set to The default value is |
server
|
Optional. Name of the managed server where the application is deployed. For example, Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the application is deployed. |
Example
The following example registers a WSRP producer named WSRPSamples with WebCenter Portal (webcenter):
wls:/weblogic/serverConfig> registerWSRPProducer(appName='webcenter', name='WSRPSamples', url='http://myhost.com:9999/ portletapp/portlets/wsrp2?WSDL')
The following example registers a secure WSRP producer:
wls:/weblogic/serverConfig> registerWSRPProducer(appName='webcenter', name='WSRPSamples2', url='http://myhost.com:8899/portletapp/portlets/wsrp2?WSDL', tokenType='WSS11_SAML_TOKEN_WITH_MSG_PROTECTION', issuer='www.oracle.com', defUser='anonymous', keyStorePath='/keys/mykeystore.jks', keyStorePswd='Test1', sigKeyAlias='mysigalias',sigKeyPswd='mysigpswd', encKeyAlias='myencalias', encKeyPswd='myencpswd', recptAlias='myrcptalias')
Module: Oracle WebCenter Portal
Use with WLST: Online
Description
Edits registration details for an existing WSRP producer.
Syntax
setWSRPProducer(appName, name, [url], [proxyHost], [proxyPort], [timeout], [externalApp], [tokenType],[issuer], [defUser], [keyStorePath], [keyStorePswd] [sigKeyAlias], [sigKeyPswd], [encKeyAlias], [encKeyPswd], [recptAlias], [enforcePolicyURI], [server], [applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the application in which to perform this operation. For WebCenter Portal, the application name is always |
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 application and the remote portlet producer are separated by a firewall and an HTTP proxy is needed to communicate with the producer. |
proxyPort
|
Optional. Port number on which the proxy server listens. |
timeout
|
Optional. Timeout setting for communications with the producer, in seconds. For example, the maximum time the producer may take to register, deregister, or display portlets on portal pages. This argument defaults to Individual portlets may define their own timeout period, which takes precedence over the value expressed here. |
|
|
Optional. This argument applies when the |
tokenType
|
Optional. Type of token profile to use for authentication with this WSRP producer. When the argument
|
tokenType
continued...
|
If the argument |
issuer
|
Optional. Name of the issuer of the token. The issuer name is the entity that vouches for the verification of the subject. For example: 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 application. When unauthenticated, the identity anonymous is associated with the application user. The value anonymous may be inappropriate for the remote producer, so you may need to specify an alternative identity here. Keep in mind though, that in this case, the application has not authenticated the user so the default user you specify should be a low privileged user in the remote producer. If the user has authenticated to the application, the user's identity is asserted rather than the default user. This argument only applies when the tokenType is: |
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 |
encKeyAlias
|
Optional. Key alias used by the producer to encrypt the return message. A valid value is one of the key aliases that is located in the specified key store. If not specified, the producer uses the signing key for encrypting the return message. |
encKeyPswd
|
Optional. Password for accessing the encryption key. |
recptAlias
|
Optional. Key store alias that is associated with the producer's certificate. This certificate is used to encrypt the outbound message to the producer. Do not specify a recipient key alias when the |
enforcePolicyURI
|
Optional. Valid values are When set to The default value is |
server
|
Optional. Name of the managed server where the application is deployed. For example, Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the application is deployed. |
Example
This example increases the timeout, for the WSRPSamples producer, to 60 seconds:
wls:/weblogic/serverConfig>setWSRPProducer(appName='webcenter', name='WSRPSamples', timeout=60)
This example updates security properties on a secure WSRP producer:
wls:/weblogic/serverConfig>setWSRPProducer(appName='webcenter', name='WSRPSamples2', tokenType='WSS11_SAML_TOKEN_WITH_MSG_PROTECTION', issuer='www.oracle.com', defUser='anonymous', keyStorePath='/keys/mykeystore.jks', keyStorePswd='Test1', sigKeyAlias='mysigalias', sigKeyPswd='mysigpswd',encKeyAlias='myencalias', encKeyPswd='myencpswd', recptAlias='myrcptalias')
This example removes all the security properties set on a secure WSRP producer:
wls:/weblogic/serverConfig>setWSRPProducer(appName='webcenter', name='WSRPSamples2', tokenType='')
Module: Oracle WebCenter Portal
Use with WLST: Online
Description
Lists WSRP producer registration details for a named application.
Syntax
listWSRPProducers(appName, [name, verbose, server, [applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the application in which to perform this operation. For WebCenter Portal, the application name is always |
name
|
Optional. Name of an existing WSRP producer. If omitted, connection details for all WSRP producers configured for this application are listed. |
verbose
|
Optional. Displays WSRP producer connection details in verbose mode. Valid options are When set to When set to If you set this argument to |
server
|
Optional. Name of the managed server where the application is deployed. For example, Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the application is deployed. |
Example
The following example lists all the WSRP producers registered with WebCenter Portal:
wls:/weblogic/serverConfig> listWSRPProducers(appName='webcenter', verbose=0) ---------------------- WSRPSamples-connection ----------------------
The following example lists detailed connection information for a WSRP producer registered as WSRPSamples-connection with WebCenter Portal:
wls:/weblogic/serverConfig> listWSRPProducers(appName='webcenter', name='WSRPSamples-connection', verbose=1) ---------------------- WSRPSamples-connection ---------------------- Connection Name: WSRPSamples-connection Web Service Connection Name: WSRPSamples-connection-wsconn Proxy Host: None Proxy Port: None Timeout: 0 WSDL URL: http://example.com:7777/portletapp/portlets/wsrp2?WSDL
Module: Oracle WebCenter Portal
Use with WLST: Online
Description
Deregisters a WSRP producer, and deletes the associated WSRP and web service connections.
Syntax
deregisterWSRPProducer(appName, name, [server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the application in which to perform this operation. For WebCenter Portal, the application name is always |
name
|
Name of an existing WSRP producer. |
server
|
Optional. Name of the managed server where the application is deployed. For example, Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the application is deployed. |
Example
The following example deregisters the WSRPSamples producer in WebCenter Portal (webcenter):
wls:/weblogic/serverConfig> deregisterWSRPProducer(appName='webcenter', name='WSRPSamples')
Module: Oracle WebCenter Portal
Use with WLST: Online
Description
Lists registration properties supported by a WSRP portlet producer.
Syntax
listWSRPProducerRegistrationProperties(appName, url, [proxyHost, proxyPort, server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the application in which to perform this operation. For WebCenter Portal, the application name is always |
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 application and the remote portlet producer are separated by a firewall and an HTTP proxy is needed to communicate with the producer. |
proxyPort
|
Optional. Port number on which the proxy server listens. |
server
|
Optional. Name of the managed server where the application is deployed. For example, Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the application is deployed. |
Example
The following example lists valid registration properties for the WSRP producer with the WSDL URL provided:
wls:/weblogic/serverConfig> listWSRPProducerRegistrationProperties (appName='webcenter', url='http://myhost:9999/portletapp/portlets/wsrp2?WSDL') Registration Property hint : hint text Registration Property label : label text Registration Property language : en Registration Property name : {urn:xyz:wlp:prop:reg:registration}consumerRole Registration Property value : None
Module: Oracle WebCenter Portal
Use with WLST: Online
Description
Lists any user categories that a WSRP producer might support. WebCenter Portal users can use the WLST command mapWSRPProducerUserCategory to map application roles to a producer's user category.
Syntax
listWSRPProducerUserCategories(appName, name, [server, [pplicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the application in which to perform this operation. For WebCenter Portal, the application name is always |
name
|
Name of an existing WSRP producer. |
server
|
Optional. Name of the managed server where the application is deployed. For example, Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the application is deployed. |
Example
The following example displays the categories associated with a WSRP producer named WSRPSamples:
wls:/weblogic/serverConfig> listWSRPProducerUserCategories(appName='webcenter', name='WSRPSamples') User Category Name : categoryTwo User Category Description : Custom role two. User Category Mapped Local Roles : None User Category Name : categoryOne User Category Description : Custom role one. User Category Mapped Local Roles : None
Module: Oracle WebCenter Portal
Use with WLST: Online
Description
Maps a role that is defined in the named application to a user category supported by a WSRP producer. The user categories may be found using listWSRPProducerUserCategories.
Syntax
mapWSRPProducerUserCategory(appName, name, localRole, producerUserCategory, [server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the application in which to perform this operation. For WebCenter Portal, the application name is always |
name
|
Name of an existing WSRP producer. |
localRole
|
Name of the application role to be mapped. |
producerUserCategory
|
WSRP producer user category to which the WebCenter Portal role will be mapped. |
server
|
Optional. Name of the managed server where the application is deployed. For example, Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the application is deployed. |
Example
The following example maps the application role admin to the WSRP user category wrsp-admin:
wls:/weblogic/serverConfig> mapWSRPProducerUserCategory(appName='webcenter', name='WSRPProducer1', localRole='admin', producerUserCategory='wsrp-admin')
Module: Oracle WebCenter Portal
Use with WLST: Online
Description
Creates a connection to an Oracle PDK-Java portlet producer and registers the Oracle PDK-Java producer with a named application.
Syntax
registerPDKJavaProducer(appName, name, url, [serviceId, proxyHost, proxyPort, subscriberId, sharedKey, timeout, establishSession, externalApp, mapUser, server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the application in which to perform this operation. For WebCenter Portal, the application name is always |
name
|
Connection name. The name must be unique (across all connection types) within the application. |
url
|
URL for the Oracle PDK-Java producer. Use the following syntax:
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 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 |
sharedKey
|
Optional. Shared key used for message authentication with the remote producer. Message authentication ensures that the incoming messages are sent from a host with a shared key. This argument defaults to null. The shared key can contain between 10 and 20 alphanumeric characters. |
subscriberId
|
Optional. Consumer's identifier, if required. When a producer is registered with an application, a call is made to the producer. During the call, the consumer (WebCenter Portal in this instance) passes the value for subscriberId to the producer. The producer may be coded to use the subscriber ID. |
timeout
|
Optional. Timeout setting for communications with the producer, in seconds. For example, the maximum time the producer may take to register, deregister, or display portlets on portal pages. This argument defaults to 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 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 |
server
|
Optional. Name of the managed server where the application is deployed. For example, Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the application is deployed. |
Example
The following example creates and registers an Oracle PDK-Java producer named JPDKSamples in WebCenter Portal (webcenter):
wls:/weblogic/serverConfig> registerPDKJavaProducer(appName='webcenter', name='JPDKSamples', url='http://myhost:9999/jpdk/providers/sample')
Module: Oracle WebCenter Portal
Use with WLST: Online
Description
Edits registration details for an existing PDK-Java producer.
Syntax
setPDKJavaProducer(appName, name, url, [serviceId, proxyHost, proxyPort, subscriberId, sharedKey, timeout, establishSession, externalApp, mapUser, server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the application in which to perform this operation. For WebCenter Portal, the application name is always |
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 application and the remote portlet producer are separated by a firewall and an HTTP proxy is needed for communication with the producer. |
proxyPort
|
Optional. Port number on which the proxy server listens. |
subscriberId
|
Optional. Consumer's identifier, if required. When a producer is registered with an application, a call is made to the producer. During the call, the consumer (WebCenter Portal 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 |
timeout
|
Optional. Timeout setting for communications with the producer, in seconds. For example, the maximum time the producer may take to register, deregister, or display portlets on portal pages. Individual portlets may define their own timeout period, which takes precedence over the value expressed here. |
establishSession
|
Optional. Enable a user session when executing portlets from this producer. Valid values are 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 |
server
|
Optional. Name of the managed server where the application is deployed. For example, Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the application is deployed. |
Example
The following example changes a PDK-Java producer registered with MyApp to use a proxy server:
wls:/weblogic/serverConfig> setPDKJavaProducer(appName='MyApp',name='MyProducer',
url='http://myhost.com/jpdk/providers/sample', proxyHost='myproxy.com', proxyPort=80)
Module: Oracle WebCenter Portal
Use with WLST: Online
Description
Deregisters an Oracle PDK-Java producer and deletes the associated connection, for a named application.
Syntax
deregisterPDKJavaProducer(appName, name, [server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the application in which to perform this operation. For WebCenter Portal, the application name is always |
name
|
Name of an existing PDK-Java producer. |
server
|
Optional. Name of the managed server where the application is deployed. For example, Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the application is deployed. |
Example
The following example deregisters the wc-OmniPortlet producer, and deletes the associated connection:
wls:/weblogic/serverConfig> deregisterPDKJavaProducer(appName='webcenter', name='wc-OmniPortlet') Already in Domain Runtime Tree Producer wc-OmniPortlet has been deregistered. Already in Domain Runtime Tree "wc-OmniPortlet" successfully deleted Already in Domain Runtime Tree "wc-OmniPortlet-urlconn" successfully deleted
Module: Oracle WebCenter Portal
Use with WLST: Online
Description
Lists details for one or more Oracle PDK-Java producers registered with a named application.
Syntax
listPDKJavaProducers(appName, [name, verbose, server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the application in which to perform this operation. For WebCenter Portal, the application name is always |
name
|
Optional. Name of an existing PDK-Java portlet producer. If omitted, connection details for all PDK-Java producers configured for this application are listed. |
verbose
|
Optional. Displays PDK-Java producer connection details in verbose mode. Valid options are When set to When set to If you set this argument to |
server
|
Optional. Name of the managed server where the application is deployed. For example, Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the application is deployed. |
Example
The following example lists all the connection properties (verbose mode) for the JPDKSamples producer:
wls:/weblogic/serverConfig> listPDKJavaProducers(appName='webcenter', name='JPDKSamples', verbose=1) ---------------------- wc-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 Portal
Use with WLST: Online
Description
Registers a pagelet producer with a named application.
Syntax
registerPageletProducer(appName, name, url, [server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the application in which to perform this operation. For WebCenter Portal, the application name is always |
name
|
Connection name. The name must be unique (across all connection types) within the application. The name you specify here appears in Composer under the Mash-ups >Pagelet Producers folder (by default). |
url
|
URL required to access the server where the Pagelet Producer is deployed. Use the syntax:
The URL must include a fully-qualified domain name. For example:
If pagelets carry secure data, the URL registered must use the
Note: In WebCenter Portal, if the Pagelet Producer URL is protected by Oracle Access Manager (OAM), the URL to the pagelet catalog must be excluded (mapped directly without access control), or the catalog will appear to be empty when using REST. The pagelet catalog URL is: http://proxy_host:proxy_port/api/v2/ensemble/pagelets |
server
|
Optional. Name of the managed server where the application is deployed. For example, Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the application is deployed. |
Example
The following example registers a pagelet producer with WebCenter Portal (webcenter):
wls:/weblogic/serverConfig> registerPageletProducer(appName='webcenter', name='MyPageletProducer', url='http://myhost.com:7001/pagelets')
Module: Oracle WebCenter Portal
Use with WLST: Online
Description
Edits connection details for an existing pagelet producer.
Syntax
setPageletProducer(appName, name, [url, server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the application in which to perform this operation. For WebCenter Portal, the application name is always |
name
|
Name of an existing pagelet producer connection. |
url
|
Optional. URL required to access the server where the Pagelet Producer is deployed. Use the syntax:
The URL must include a fully-qualified domain name. For example:
Note: In WebCenter Portal, if the Pagelet Producer URL is protected by Oracle Access Manager (OAM), the URL to the pagelet catalog must be excluded (mapped directly without access control), or the catalog will appear to be empty when using REST. The pagelet catalog URL is: http://proxy_host:proxy_port/api/v2/ensemble/pagelets |
server
|
Optional. Name of the managed server where the application is deployed. For example, Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the application is deployed. |
Example
The following example updates administrator user name and password details for an existing pagelet producer connection named MyPageletProducer:
wls:/weblogic/serverConfig> setPageletProducer(appName='webcenter', name='MyPageletProducer', url='http://mypagelethost.com:7778/pagelets')
Module: Oracle WebCenter Portal
Use with WLST: Online
Description
Lists connection details for one or all pagelet producers registered with a named application.
Syntax
listPageletProducers(appName, [name, verbose, server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the application in which to perform this operation. For WebCenter Portal, the application name is always |
name
|
Optional. Name of an existing pagelet producer connection. Use this argument to view connection details for a specific pagelet producer. If omitted, connection details for all pagelet producers configured for this application are listed. |
verbose
|
Optional. Displays pagelet producer connection details in verbose mode. Valid options are When set to When set to If you set this argument to |
server
|
Optional. Name of the managed server where the application is deployed. For example, Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the application is deployed. |
Example
The following example lists connection names and details for all pagelet producers registered for WebCenter Portal:
wls:/weblogic/serverConfig> listPageletProducers(appName='webcenter', verbose=1) ---------------------- MyPageletProducer ---------------------- URL: http://myhost.com:7001/pagelets ---------------------- TestPageletProducer ---------------------- URL: http://testhost.com:7002/pagelets ----------------------
The following example displays details for a single pagelet producer connection named MyPageletProducer:
wls:/weblogic/serverConfig> listPageletProducers(appName='webcenter', name='MyPageletProducer', verbose=1) ---------------------- MyPageletProducer ---------------------- URL: http://myhost.com:7001/pagelets
Module: Oracle WebCenter Portal
Use with WLST: Online
Description
Deregisters a pagelet producer currently registered with a named application.
Syntax
deregisterPageletProducer(appName, name, [server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the application in which to perform this operation. For WebCenter Portal, the application name is always |
name
|
Name of an existing pagelet producer connection. |
server
|
Optional. Name of the managed server where the application is deployed. For example, Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the application is deployed. |
Example
The following example deregisters a pagelet producer connection named MyPageletProducer currently configured for WebCenter Portal:
wls:/weblogic/serverConfig> deregisterPageletProducer(appName='webcenter', name='MyPageletProducer')
Module: Oracle WebCenter Portal
Use with WLST: Online
Description
Refreshes the metadata stored for a named producer to reflect the portlets that are currently offered by that producer.
Syntax
refreshProducer(appName, producerName, [server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the application in which to perform this operation. For WebCenter Portal, the application name is always |
producerName
|
Name of an existing producer. |
server
|
Optional. Name of the managed server where the application is deployed. For example, Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the application is deployed. |
Example
The following example refreshes the WSRPSamples producer inWebCenter Portal (webcenter):
wls:/weblogic/serverConfig> refreshProducer(appName='webcenter', producerName='WSRPSamples')
Producer WSRPSamples has been refreshed.
Module: Oracle WebCenter Portal
Use with WLST: Online
Description
Lists portlet client's configuration for a named application.
Syntax
listPortletClientConfig(appName, [server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the application in which to perform this operation. For WebCenter Portal, the application name is always |
server
|
Optional. Name of the managed server where the application is deployed. For example, Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the application is deployed. |
Example
The following example lists portlet client configuration for WebCenter Portal:
wls:/weblogic/serverConfig> listPortletClientConfig(appName='webcenter')
-------------------------------------
Portlet Client Configuration Settings
-------------------------------------
Application Striping: 0
Content Cache Enabled: 0
Maximum Content Cache Objects: 2000
Maximum Content Cache Size: 10000000
Default Timeout: 30
Maximum IFrame Querystring Length: 0
Maximum Resource URL Length: 1500
Maximum Timeout: 60
Minimum Timeout: 2
Parallel Pool Size: 20
Parallel Queue Size: 40
Maximum Rendition Cache Objects: 1000
Resource Proxy Path: /resource-proxy
Supported Locales: en, de, fr
Module: Oracle WebCenter Portal
Use with WLST: Online
Description
Edits the portlet client's configuration, for a named application. If you omit a parameter, the corresponding configuration setting remains unchanged.
Note:
Configuration changes made using this WLST command are only effective after your restart the Managed Server on which the application is deployed. For details, see Oracle Fusion Middleware Administering Oracle WebCenter Portal.
Syntax
setPortletClientConfig(appName, [applicationStriping, contentCacheEnabled, contentCacheMaxObjects, contentCacheMaxSize, defaultTimeout, maximumIframeQueryStringLength, maximumResourceUrlLength, maximumTimeout, minimumTimeout, parallelPoolSize, parallelQueueSize, renditionCacheMaxObjects, resourceProxyPath, supportedLocales, server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the application in which to perform this operation. For WebCenter Portal, the application name is always |
applicationStriping
|
Optional. Specifies whether to enable application striping. Valid values are The default value is |
contentCacheEnabled
|
Optional. Specifies whether to enable the portlet client's content cache. Valid values are The default value is |
contentCacheMaxObjects
|
Optional. Maximum number of objects to be stored in the portlet client's content cache. The default value is |
contentCacheMaxSize
|
Optional. Maximum size of the portlet client's content cache in bytes. The default value is |
defaultTimeout
|
Optional. Default timeout period in seconds for requests made to producers. The default value is |
maximumIframeQueryStringLength
|
Optional. Maximum length of portlet inline frame URLs before URL shortening is applied. The default value is |
maximumResourceUrlLength
|
Optional. Maximum length of portlet resource URLs. The default value is |
maximumTimeout
|
Optional. Maximum timeout period in seconds for requests made to producers. The default value is |
minimumTimeout
|
Optional. Minimum timeout period in seconds for requests made to producers. The default value is |
parallelPoolSize
|
Optional. Number of threads used for parallel execution of tasks. The default value is |
parallelQueueSize
|
Optional. Number of tasks to allow in queue for parallel execution. The default value is |
renditionCacheMaxObjects
|
Optional. Maximum number of objects in the cache used by the portlet client to store portlet renditions for use when rendering portlets in inline frames. The default value is |
resourceProxyPath
|
Optional. The base path of the portlet resource proxy servlet, relative to the context root of the application. The default value is |
supportedLocales
|
Optional. Specifies one or more locales supported by the portlet client. The default value is For example: |
server
|
Optional. Name of the managed server where the application is deployed. For example, Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the application is deployed. |
Example
The following example sets new values for the ContentCacheEnabled, MinimumTimeout, MaximumTimeout, and ParallelQueueSize configuration settings. All other settings remain unchanged:
wls:/weblogic/serverConfig> setPortletClientConfig(appName='webcenter', contentCacheEnabled=0, minimumTimeout=10, maximumTimeout=120, parallelQueueSize=25)
The following example sets the value of the SupportedLocales configuration setting to English, French, and Spanish. All other settings remain unchanged:
wls:/weblogic/serverConfig> setPortletClientConfig(appName='webcenter', supportedLocales='en, fr, es')
Module: Oracle WebCenter Portal
Use with WLST: Online
Description
Returns the value of a specific portlet client configuration setting or values of all settings for a named application.
Syntax
getPortletClientConfig(appName, [configSetting, server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the application in which to perform this operation. For WebCenter Portal, the application name is always |
configSetting
|
Optional. Name of the portlet client configuration setting to return. One of the following values:
Note: The values are case-sensitive. Omit this parameter to return the names and values of all settings. |
server
|
Optional. Name of the managed server where the application is deployed. For example, Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the application is deployed. |
Example
The following example returns the value of the DefaultTimeout configuration setting for WebCenter Portal:
wls:/weblogic/serverConfig> defaultTimeout =
getPortletClientConfig(appName='webcenter', configSetting='DefaultTimeout')
The following example returns the names and values of all portlet client configuration settings for WebCenter Portal:
wls:/weblogic/serverConfig> settingsDict =
getPortletClientConfig(appName='webcenter')
Module: Oracle WebCenter Portal
Use with WLST: Online
Description
Registers several out-of-the-box producers with WebCenter Portal: OmniPortlet and WSRP Tools
Syntax
registerOOTBProducers(producerHost, producerPort, appName, [server, applicationVersion])
| Argument | Definition |
|---|---|
producerHost
|
Host name or IP address of the server hosting out-of-the-box producers. In a cluster fronted by a load balancer, enter the host name of the load balancer. |
producerPort
|
Port number for the server hosting out-of-the-box producers. In a cluster, fronted by a load balancer, enter the port number of the load balancer. |
appName
|
Name of the application in which the out-of-the-box producers are to be registered. For WebCenter Portal, the application name is always |
server
|
Optional. Name of the managed server where the application is deployed. For example, Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the application is deployed. |
Example
The following example registers out-of-the-box producers in WebCenter Portal.
wls:/weblogic/serverConfig> registerOOTBProducers(producerHost='myhost.com', producerPort=9999, appName='webcenter') 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 WSRP Tools Created connection wc-WSRPTools-wsconn Created connection wc-WSRPTools Producer connection wc-WSRPTools has been registered.
Module: Oracle WebCenter Portal
Use with WLST: Online
Description
Deregisters out-of-the-box producers with WebCenter Portal: OmniPortlet and WSRP Tools
Syntax
deregisterOOTBProducers(appName, [server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the application in which the out-of-the-box producers are currently registered. For WebCenter Portal, the application name is always |
server
|
Optional. Name of the managed server where the application is deployed. For example, Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the application is deployed. |
Example
The following example deregisters out-of-the-box producers, and deletes their associated connections, in WebCenter Portal:
wls:/weblogic/serverConfig> deregisterOOTBProducers(appName='webcenter')
Deregistering Out-of-the-Box Producers
Deregistering Omniportlet
Producer wc-OmniPortlet has been deregistered.
wc-OmniPortlet successfully deleted
wc-OmniPortlet-urlconn successfully deleted
Deregistering WSRP Tools
Producer wc-WSRPTools has been deregistered.
wc-WSRPTools successfully deleted
wc-WSRPTools-wsconn successfully deleted
Module: Oracle WebCenter Portal
Use with WLST: Online
Description
Registers the sample producers provided with Oracle WebCenter Portal with a named application. There are two sample producers— WSRP Samples and JPDK Samples.
Syntax
registerSampleProducers(producerHost, producerPort, appName, [server, applicationVersion])
| Argument | Definition |
|---|---|
producerHost
|
Host name or IP address of the server hosting the sample producers. |
producerPort
|
Port number for the server hosting the sample producers. |
appName
|
Name of the application in which the sample producers are to be registered. For WebCenter Portal, the application name is always |
server
|
Optional. Name of the managed server where the application is deployed. For example, Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the application is deployed. |
Example
The following example registers the sample producers with WebCenter Portal:
wls:/weblogic/serverConfig> registerSampleProducers(producerHost='myhost.com', producerPort=9999, appName='webcenter')
Module: Oracle WebCenter Portal
Use with WLST: Online
Description
Deregisters Oracle WebCenter Portal's sample producers (WSRP Samples and JPDK Samples) from a named application.
Syntax
deregisterSampleProducers(appName, [server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the application in which the sample producers are currently registered. For WebCenter Portal, the application name is always If a value is not specified, this argument defaults to |
server
|
Optional. Name of the managed server where the application is deployed. For example, Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the application is deployed. |
Example
The following example deregisters sample producers from WebCenter Portal:
wls:/weblogic/serverConfig> deregisterSampleProducers(appName='webcenter')
Use the commands listed in Table 2-22 to manage proxy server settings used by tools and services, in a named application.
Configuration changes made using these WLST commands are only effective after your restart the Managed Server on which the application is deployed. For details, see Oracle Fusion Middleware Administering Oracle WebCenter Portal.
Table 2-22 RSS WLST Commands
| Use this command... | To... | Use with WLST... |
|---|---|---|
|
Return the proxy host and proxy port used by the tools and services. |
Online |
|
|
Specify the proxy host and proxy port used by tools and services. |
Online |
|
|
Delete proxy host and proxy port settings. |
Online |
Module: Oracle WebCenter Portal
Use with WLST: Online
Description
Returns the proxy host and proxy port used by RSS news feeds and activity streams in a named application. Depending on your network configuration, proxy details may be required to display external RSS news feeds and external links in activity streams in your application.
Syntax
getWebCenterProxyConfig(appName, [server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the application in which to perform this operation. For WebCenter Portal, the application name is always |
server
|
Optional. Name of the managed server where the application is deployed. For example, Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the application is deployed. |
Example
The following example returns the proxy host and proxy port used by tools and services in WebCenter Portal (webcenter):
wls:/weblogic/serverConfig> getWebCenterProxyConfig(appName='webcenter')
Module: Oracle WebCenter Portal
Use with WLST: Online
Description
Specifies the proxy host and proxy port used by RSS news feeds and activity streams, in a named application. Depending on your network configuration, proxy details may be required to display external RSS news feeds and external links in activity streams in your application.
Syntax
setWebCenterProxyConfig(appName, proxyHost, proxyPort, [server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the application in which to perform this operation. For WebCenter Portal, the application name is always |
proxyHost
|
Host name of the proxy server. |
proxyPort
|
Port on which the proxy server is running. |
server
|
Optional. Name of the managed server where the application is deployed. For example, Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the application is deployed. |
Example
The following example sets the proxy host and proxy port used by tools and services in WebCenter Portal (webcenter):
wls:/weblogic/serverConfig> setWebCenterProxyConfig(appName='webcenter', proxyHost='www-proxy.example.com', proxyPort='80')
Module: Oracle WebCenter Portal
Use with WLST: Online
Description
Deletes the current proxy host and proxy port settings configured for a named application.
Syntax
unsetWebCenterProxyConfig(appName, [server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the application in which to perform this operation. For WebCenter Portal, the application name is always |
server
|
Optional. Name of the managed server where the application is deployed. For example, Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the application is deployed. |
Example
The following example deletes the proxy host and proxy port settings configured for WebCenter Portal (webcenter):
wls:/weblogic/serverConfig> unsetWebCenterProxyConfig(appName='webcenter')
Use the commands listed in Table 2-23 to manage Elasticsearch (ES) connections for WebCenter Portal.
Configuration changes made using these WLST commands are only effective after your restart the Managed Server on which the application is deployed. For details, see Oracle Fusion Middleware Administering Oracle WebCenter Portal.
Table 2-23 Search - Elasticsearch WLST Commands
| Use this command... | To... | Use with WLST... |
|---|---|---|
|
Create a connection to an Elasticsearch instance for a named application. |
Online |
Module: Oracle WebCenter Portal
Use with WLST: Online
Description
Creates a connection to an Elasticsearch instance for a named application.
Syntax
createSearchConnection(appName, name, url, indexAliasName, appUser, appPassword, [server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the application in which to perform this operation. For WebCenter Portal, the application name is always |
name
|
Connection name. The name must be unique (across all connection types) within the application. |
url
|
URL of the Elasticsearch server. Use the format: http://eshost:esport where
|
indexAliasName
|
Name of the index alias in the Elasticsearch server. For example,
Note: The name must be in lowercase alphanumeric characters and unique across all portal servers. |
appUser
|
User name that the application uses to authenticate itself as a trusted application to Elasticsearch so that it may perform searches on behalf of WebCenter Portal users. |
appPassword
|
Password for the user name specified. |
server
|
Optional. Name of the managed server where the application is deployed. For example, Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the application is deployed. |
Example
The following example creates a new search connection that points to the specified Elasticsearch server and sets this connection as the default search connection for WebCenter Portal, an index named webcenter_portal is created on the Elasticsearch server:
createSearchConnection(appName='webcenter', name='ESConn', url='http://eshost:esport', indexAliasName='webcenter_portal', appUser='wpadmin', appPassword='password')
Use the commands listed in Table 2-24 to manage Oracle Secure Enterprise Search (SES) connections and other Oracle SES search related properties for WebCenter Portal.
Configuration changes made using these WLST commands are only effective after your restart the Managed Server on which the application is deployed. For details, see Oracle Fusion Middleware Administering Oracle WebCenter Portal.
Table 2-24 Search - Oracle SES WLST Commands
| Use this command... | To... | Use with WLST... |
|---|---|---|
|
Create a connection to an Oracle SES instance for a named application. |
Online |
|
|
Edit an existing Oracle SES search connection. |
Online |
|
|
List individual or all Oracle SES search connections that are configured for a named application. |
Online |
|
|
Configure search settings for an existing Oracle SES search connection. |
Online |
|
|
List Oracle SES properties for a named application. |
Online |
|
|
Create a federation trusted entity on an Oracle (SES) instance. |
Online |
|
|
Obtains and stores version information for the Oracle SES instance that is currently configured for a named application. |
Online |
|
|
Returns version information for the Oracle SES instance configured for a named application. |
Online |
|
|
Creates a source group in Oracle SES instance with default document, discussion, and announcement sources. |
Online |
Module: Oracle WebCenter Portal
Use with WLST: Online
Description
Creates a connection to an Oracle Secure Enterprise Search (SES) instance for a named application.
Syntax
createSESConnection(appName, name, url, appUser, appPassword,[default, server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the application in which to perform this operation. For WebCenter Portal, the application name is always |
name
|
Connection name. The name must be unique (across all connection types) within the application. |
url
|
Web services URL that Oracle Secure Enterprise Search exposes to enable Search requests. Use the format: http://host:port/search/query/OracleSearch |
appUser
|
User name that the application uses to authenticate itself as a trusted application to Oracle Secure Enterprise Search so that it may perform searches on behalf of WebCenter Portal users. The specified user must be present in both the Oracle Identity Management server configured for the application and the Oracle Identity Management server configured for Oracle SES. |
appPassword
|
Password for the user name specified. |
default
|
Optional. Configures search to actively use the search connection. Valid options are Setting to Setting to This argument defaults to |
server
|
Optional. Name of the managed server where the application is deployed. For example, Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the application is deployed. |
Example
The following example creates a new search connection that points to the Oracle SES instance http://myhost.com:7777/search/query/OracleSearch and makes this connection the active SES search connection for WebCenter Portal.
wls:/weblogic/serverConfig>createSESConnection(appName='webcenter', name='SESConn1', url='http://myhost.com:7777/search/query/OracleSearch', appUser='wpadmin', appPassword='password', default=1)
Module: Oracle WebCenter Portal
Use with WLST: Online
Description
Edits an existing Oracle Secure Enterprise Search (SES) search connection for a named application.
Syntax
setSESConnection(appName, name, [url, appUser, appPassword, default, server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the application in which to perform this operation. For WebCenter Portal, the application name is always |
name
|
Name of an existing search connection. |
url
|
Optional. Web services URL that Oracle Secure Enterprise Search exposes to enable Search requests. Use the format: http://host:port/search/query/OracleSearch |
appUser
|
Optional. User name that the application uses to log in to Oracle Secure Enterprise Search so that it may perform searches on behalf of portal users. |
appPassword
|
Optional. Password that the application uses to log in to Oracle Secure Enterprise Search so that it may perform searches on behalf of portal users. |
default
|
Optional. Configures search to actively use the search connection. Valid options are Setting to Setting to This argument defaults to |
server
|
Optional. Name of the managed server where the application is deployed. For example, Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the application is deployed. |
Example
The following example modifies the URL of a search connection named SESConn1 and makes the connection the active Oracle SES search connection for WebCenter Portal.
wls:/weblogic/serverConfig> etSESConnection(appName='webcenter', name='SESConn1', url='http://myhost.com:7777/search/query/OracleSearch', appUser='wpadmin', appPassword='password', default=1)
Module: Oracle WebCenter Portal
Use with WLST: Online
Description
Lists the names of all Oracle Secure Enterprise Search (SES) search connections configured for a named application.
Syntax
listSESConnections(appName, [verbose, name, server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the application in which to perform this operation. For WebCenter Portal, the application name is always |
verbose
|
Optional. Displays search connection details in verbose mode. Valid options are When set to When set to This argument defaults to 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 application is deployed. For example, Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the application is deployed. |
Examples
The following example displays connection details for all Oracle SES search connections configured for WebCenter Portal.
wls:/weblogic/serverConfig>listSESConnections(appName='webcenter', verbose=1)
The following example displays connection details for an Oracle SES search connection named SESConn1.
wls:/weblogic/serverConfig>listSESConnections(appName='webcenter', verbose=1, name='SESConn1')
Module: Oracle WebCenter Portal
Use with WLST: Online
Description
Configures search settings for an existing Oracle Secure Enterprise Search (SES) search connection. If a parameter is not specified it is not modified.
Syntax
setSearchSESConfig(appName,[connectionName, dataGroup, topNRows, server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the application in which to perform this operation. For WebCenter Portal, the application name is always |
connectionName
|
Optional. Names the connection used for search. |
dataGroup
|
Optional. Names the Secure Enterprise Search data group in which to search. If a value is not provided, everything in the Oracle Secure Enterprise Search instance will be searched. |
topNRows
|
Optional. Number of top N rows of search results for gathering refinement data. |
server
|
Optional. Name of the managed server where the application is deployed. For example, Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the application is deployed. |
Examples
The following example specifies that search must use the SES search connection named SESConn1, and to search the data group named group2:
wls:/weblogic/serverConfig>setSearchSESConfig(appName='webcenter',connectionName='SESConn1', dataGroup='group2', topNRows=200);
The following example changes the maximum number of results that search returns. No connection name is specified in this example, so this configuration change is applied to the current default (or active) search connection:
wls:/weblogic/serverConfig>setSearchSESConfig(appName='webcenter', topNRows=500);
Already in Domain Runtime Tree
Restart is needed for the service connection changes to take effect.
Module: Oracle WebCenter Portal
Use with WLST: Online
Description
Lists Oracle SES search settings for a named application.
Syntax
listSearchSESConfig(appName, [server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the application in which to perform this operation. For WebCenter Portal, the application name is always |
server
|
Optional. Name of the managed server where the application is deployed. For example, Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the application is deployed. |
Example
The following example displays Oracle SES search configuration information for WebCenter Portal (webcenter):
wls:/weblogic/serverConfig>listSearchSESConfig(appName='webcenter')
Already in Domain Runtime Tree
-----------------
Search SES Config
-----------------
connectionName: SESConn1
dataGroup: group2
topNRows: 200
Module: Oracle WebCenter Portal
Use with WLST: Online
Description
Creates a federation trusted entity on an Oracle Secure Enterprise Search (SES) instance for a given entity name and password.
Syntax
createFederationTrustedEntity(appName, sesUrl, sesPassword, entityName, entityPassword, desc, [sesSchema, server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the application in which to perform this operation. For WebCenter Portal, the application name is always |
sesUrl
|
Web service URL for the Oracle SES Administration API. Use the format: http://host:port/search/api/admin/AdminService |
sesPassword
|
Password for the Oracle SES administrative user ( |
entityName
|
Entity name. |
entityPassword
|
Entity password. |
desc
|
Short description of the entity. Alternatively, specify an empty string |
sesSchema
|
Username for the Oracle SES administrative user. The default value is |
server
|
Optional. Name of the managed server where the application is deployed. For example, Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the application is deployed. |
Example
The following example creates a federation trusted entity named myEntity on the Oracle SES instance http://myseshost.com:7777/search/query/OracleSearch:
wls:/weblogic/serverConfig> createFederationTrustedEntity(appName='webcenter', sesUrl='http://myseshost.com:7777/search/api/admin/AdminService', sesSchema='eqsys', sesPassword='password', entityName='myEntity', entityPassword='password', desc='This is a my sample entity')
Module: Oracle WebCenter Portal
Use with WLST: Online
Description
Obtains version information for the Oracle Secure Enterprise Search (SES) instance that is configured for a named application, and stores the version for use by search queries later on.
Version information is used when the Oracle SES connection is set as the default connection for search queries.
Syntax
setSESVersion(appName, sesUrl, sesSchema, sesPassword, [server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the application in which to perform this operation. For WebCenter Portal, the application name is always |
sesUrl
|
Web service URL for the Oracle SES Administration API. Use the format: http://host:port/search/api/admin/AdminService |
sesSchema
|
Username for the Oracle SES administrative user. For example, |
sesPassword
|
Password for the Oracle SES administrative user. |
server
|
Optional. Name of the managed server where the application is deployed. For example, Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the application is deployed. |
Example
The following example obtains version information for the Oracle SES instance http://myhost.com:7777/search/query/OracleSearch and makes this information available to WebCenter Portal:
wls:/weblogic/serverConfig>setSESVersion(appName='webcenter', sesUrl='http://myseshost.com:7777/search/api/admin/AdminService', sesSchema='searchsys', sesPassword='password')
Module: Oracle WebCenter Portal
Use with WLST: Online
Description
Returns the version number of the Oracle Secure Enterprise Search (SES) instance that is being used by a named application.
Syntax
listSESVersion(appName, sesUrl, [server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the application in which to perform this operation. For WebCenter Portal, the application name is always |
sesUrl
|
Web service URL for the Oracle SES Administration API. Use the format: http://host:port/search/api/admin/AdminService |
sesUrl
|
Web service URL for the Oracle SES Administration API. Use the format: http://host:port/search/api/admin/AdminService |
sesSchema
|
Username for the Oracle SES administrative user. For example, |
sesPassword
|
Password for the Oracle SES administrative user. |
server
|
Optional. Name of the managed server where the application is deployed. For example, Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the application is deployed. |
Example
The following example returns version information for the Oracle SES instance http://myhost.com:7777/search/query/OracleSearch and confirms that the version information is saved in the WebCenter Portal:
wls:/weblogic/serverConfig>listSESVersion(appName='webcenter', sesUrl='http://myseshost.com:7777/search/api/admin/AdminService') ----------------- SES Version Config ----------------- url: http://myhost.com:7777/search/api/admin/AdminService version: 11.1.2.2.0
Module: Oracle WebCenter Portal
Use with WLST: Online
Description
Creates a source group in an Oracle Secure Enterprise Search (SES) instance with a default name, for a given host, port and application name, as well as the shared documents and discussions/announcement sources.
Syntax
createDefaultSourceGroup(appName, sesUrl, sesPassword, host, port, defaultHost, defaultPort, [sesSchema, server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the application in which to perform this operation. For WebCenter Portal, the application name is always |
sesUrl
|
Web service URL for the Oracle SES Administration API. Use the format: http://host:port/search/api/admin/AdminService |
sesPassword
|
Password for the Oracle SES administrative user. |
|
|
Host name of the machine where the application is running. |
|
|
Port number used to access the application. |
|
|
Host name of the machine where the default sources are configured. |
|
|
Port number used where the default sources are configured. |
sesSchema
|
Optional. Username for the Oracle SES administrative user. Default value is |
server
|
Optional. Name of the managed server where the application is deployed. For example, Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the application is deployed. |
Example
The following example creates a default source group in the Oracle SES instance http://myhost.com:7777/search/query/OracleSearch for WebCenter Portal at: http://webhost:8888/webcenter
The default source group also includes documents and discussions sources at: http://mydefaultHost:8989
wls:/weblogic/serverConfig>createDefaultSourceGroup(appName='webcenter', sesUrl='http://myseshost.com:7777/search/api/admin/AdminService', sesSchema='eqsys', sesPassword='password', host='webhost', port='8888', defaultHost='mydefaultHost', defaultPort='8989')
Use the commands listed in Table 2-25 to manage Oracle Secure Enterprise Search (SES) crawlers for WebCenter Portal.
There is no need to restart your application after running Oracle SES crawler WLST commands.
Table 2-25 Search - Oracle SES Crawler WLST Commands
| Use this command... | To... | Use with WLST... |
|---|---|---|
|
Create a crawler forWebCenter Portal objects on an Oracle SES instance. |
Online |
|
|
Create a documents crawler for a named application, on an Oracle SES instance. |
Online |
|
|
Return the Spaces crawler configured for WebCenter Portal, on an Oracle SES instance. |
Online |
|
|
Return the documents crawler configured for a named application, on an Oracle SES instance. |
Online |
|
|
Start the Spaces crawler configured for WebCenter Portal, on an Oracle SES instance. |
Online |
|
|
Start the documents crawler configured for a named application, on an Oracle SES instance. |
Online |
|
|
Stop the Spaces crawler configured for WebCenter Portal, on an Oracle SES instance. |
Online |
|
|
Stop the documents crawler configured for a named application, on an Oracle SES instance. |
Online |
|
|
Delete the Spaces crawler configured for WebCenter Portal, on an Oracle SES instance. |
Online |
|
|
Delete the documents crawler configured for a named application, on an Oracle SES instance. |
Online |
Module: Oracle WebCenter Portal
Use with WLST: Online
Description
Creates a crawler for WebCenter Portal objects on an Oracle SES instance. The command creates a WebCenter Portal datasource and specifies a schedule for crawling WebCenter Portal objects (such as portals, lists, pages, and people).
Syntax
createSpacesCrawler(appName, host, port, sesUrl, sesPassword, crawlUser, crawlPassword, scratchDir, authUserIdFormat, crawlingMode, recrawlPolicy, freqType, startHour, hoursBetweenLaunches, startDayOfWeek, startDayOfMonth, daysBetweenLaunches, weeksBetweenLaunches, monthsBetweenLaunches, [server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the application in which to perform this operation. For WebCenter Portal, the application name is always |
|
|
Host name of the machine where WebCenter Portal is running. |
|
|
Port number used to access WebCenter Portal. |
|
|
Web service URL for the Oracle SES Administration API. Use the format: http://host:port/search/api/admin/AdminService |
|
|
Password for the Oracle SES administrative user ( |
|
|
Crawl administration user in WebCenter Portal. This user must exist in WebCenter Portal and in your back-end identity management server with appropriate permissions and roles. For example: |
|
|
Password for the WebCenter Portal user that is specified in the |
|
|
Local directory where Oracle SES can write temporary status logs. The directory must be on the system where Oracle SES is installed. |
|
|
Format of the user ID in the active identity plug-in. For example, username, email, nickname, user_name. |
|
|
Mode for crawling URLs in the source. The default mode is ACCEPT_ALL—Automatically Accept All URLs for Indexing: Crawls and indexes all URLs in the source. It also extracts and indexes any links found in those URLs. Previously crawled URLs are only reindexed if they have changed. EXAMINE_URL—Examine URLs Before Indexing: Crawls but does not index any URLs in the source. It also crawls any links found in those URLs. INDEX_ONLY—Index Only: Crawls and indexes all URLs in the source. It does not extract any links found in those URLs. Select this option for a source previously crawled using EXAMINE_URL. |
|
|
Specifies whether to crawl all documents or only documents that have changed. Valid values are PROCESS_ALL—All documents are crawled. Use this option to force a full crawl. PROCESS_CHANGED—Only crawl documents that have changed since the previous crawl. This setting can significantly speed up the crawling process. |
|
|
Frequency of scheduled crawls. Valid values are: To schedule crawls MONTHLY, WEEKLY, DAILY, or HOURLY, specify additional arguments as follows: MONTHLY: startHour, startDayOfTheMonth, monthsBetweenLaunches WEEKLY: startHour, startDayOfTheWeek, weeksBetweenLaunches DAILY: startHour, daysBetweenLaunches HOURLY: hoursBetweenLaunches If regular crawls are not required, choose |
|
|
Time to start the crawl. Any number between 1 and 24. For example, enter 2 for 2:00am, 14 for 2:00pm, and so on. |
|
|
Number of hours between crawls. Only valid when |
|
|
Day on which to start a weekly crawl. For example, MONDAY, TUESDAY, and so on. Only valid when |
|
|
Day of the month on which to start a monthly crawl. For example, enter 1 for 1st day of the month, 2 for 2nd day of the month, and so on. Only valid when |
|
|
Number of days between crawls. Only valid when |
|
|
Number of weeks between crawls. Only valid when |
|
|
Number of months between crawls. Only valid when |
server
|
Optional. Name of the managed server where the application is deployed. For example, Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the application is deployed. |
Example
The following example creates a Spaces crawler on the Oracle SES instance http://myseshost.com:7777 for WebCenter Portal (webcenter) located at http://myhost.com:8888/webcenter/portal:
createSpacesCrawler(appName='webcenter', host='myhost.com', port='8888', sesUrl='http://myseshost.com:7777/search/api/admin/AdminService', sesPassword='sespassword', crawlUser='mycrawladmin', crawlPassword='password', scratchDir'/tmp', authUserIdFormat='username', crawlingMode='ACCEPT_ALL', recrawlPolicy= 'PROCESS_ALL', freqType='MANUAL', startHour=1, hoursBetweenLaunches=1, startDayOfWeek='MONDAY', startDayOfMonth=1, daysBetweenLaunches =1, weeksBetweenLaunches=1, monthsBetweenLaunches=1)
Module: Oracle WebCenter Portal
Use with WLST: Online
Description
Creates a documents crawler for a named application, on an Oracle SES instance.
The command creates an Oracle WebCenter Content repository datasource and specifies a schedule for crawling documents in the Oracle WebCenter Content repository.
Syntax
createDocumentsCrawler(appName, host, port, sesUrl, sesPassword, configUrl, user, password, scratchDir, httpEndpoint, displayUrl, realm, authUserIdFormat, pipelineName, crawlingMode, recrawlPolicy, freqType, startHour, hoursBetweenLaunches, startDayOfWeek, startDayOfMonth, daysBetweenLaunches, weeksBetweenLaunches, monthsBetweenLaunches, [server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the application in which to perform this operation. For WebCenter Portal, the application name is always |
|
|
Host name of the machine where the application is running. |
|
|
Port number used to access the application. |
|
|
Web service URL for the Oracle SES Administration API. Use the format: http://host:port/search/api/admin/AdminService |
|
|
Password for the Oracle SES administrative user ( |
|
|
URL of the XML configuration file providing details of the source, such as the data feed type, location, security attributes, and so on.Use the URL format: http://host:port/cs/idcplg?IdcService=SES_CRAWLER_DOWNLOAD_CONFIG&source=sourcename |
|
|
Administrative user for Oracle WebCenter Content's Content Server. For example, If the authentication type is Oracle SSO, then enter a user ID (and password) of a user in the identity management server fronted by Oracle SSO. This user must be granted the same permissions as |
|
|
Password for the administrative user specified. |
|
|
Local directory where Oracle SES can write temporary status logs. The directory must be on the system where Oracle SES is installed. |
|
|
HTTP endpoint for Content Server authorization. For example: http://host:port/idc/idcplg |
|
|
HTTP host information string to prefix the relative access URL to form the complete display URL. For example: http://host:port/idc |
|
|
Realm of the application serving the control and data feed. This parameter is relevant when the feeds are accessed over HTTP and is mandatory when the authentication type is For example, |
|
|
Format of the user ID (in active identity plug-in) that is used by Content Server authorization API. For example, username, email, nickname, user_name. |
|
|
Document service pipeline created for this source in Oracle SES. |
|
|
Mode for crawling URLs in the source. The default mode is ACCEPT_ALL—Automatically Accept All URLs for Indexing: Crawls and indexes all URLs in the source. It also extracts and indexes any links found in those URLs. Previously crawled URLs are only reindexed if they have changed. EXAMINE_URL—Examine URLs Before Indexing: Crawls but does not index any URLs in the source. It also crawls any links found in those URLs. INDEX_ONLY—Index Only: Crawls and indexes all URLs in the source. It does not extract any links found in those URLs. Select this option for a source previously crawled using EXAMINE_URL |
|
|
Specifies whether to crawl all documents or only documents that have changed. Valid values are PROCESS_ALL—All documents are crawled. Use this option to force a full crawl. PROCESS_CHANGED—Only crawl documents that have changed since the previous crawl. This setting can significantly speed up the crawling process. |
|
|
Frequency of scheduled crawls. Valid values are: To schedule crawls MONTHLY, WEEKLY, DAILY, or HOURLY, specify additional arguments as follows: MONTHLY: startHour, startDayOfTheMonth, monthsBetweenLaunches WEEKLY: startHour, startDayOfTheWeek, weeksBetweenLaunches DAILY: startHour, daysBetweenLaunches HOURLY: hoursBetweenLaunches If regular crawls are not required, choose |
|
|
Time to start the crawl. Any number between 1 and 24. For example, enter 2 for 2:00am, 14 for 2:00pm, and so on. |
|
|
Number of hours between crawls. Only valid when |
|
|
Day on which to start a weekly crawl. For example, MONDAY, TUESDAY, and so on. Only valid when |
|
|
Day of the month on which to start a monthly crawl. For example, enter 1 for 1st day of the month, 2 for 2nd day of the month, and so on. Only valid when |
|
|
Number of days between crawls. Only valid when |
|
|
Number of weeks between crawls. Only valid when |
|
|
Number of months between crawls. Only valid when |
server
|
Optional. Name of the managed server where the application is deployed. For example, Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the application is deployed. |
Example
The following example creates a documents crawler on the Oracle SES instance http://myseshost.com:7777 for WebCenter Portal (webcenter) located at http://myhost.com:8888/webcenter/portal:
createDocumentsCrawler(appName='webcenter', host='myhost.com', port='8888', sesUrl='http://myseshost.com:7777/search/api/admin/AdminService', sesPaswword='password', configUrl='http://myucmhost.com:9044/cs/idcplg?IdcService=SES_CRAWLER_DOWNLOAD_ CONFIG&source=mysource', user='adminuser', password='password', scratchDir='/scratch', httpEndpoint='http://myucmhost.com:9044/cs/idcplg', displayUrl='http://myucmhost:9044/cs', realm='jazn.com', authUserIdFormat='username', pipelineName='My UCM Pipeline', crawlingMode='ACCEPT_ALL', recrawlPolicy='PROCESS_ALL', freqType='MANUAL', startHour=1, hoursBetweenLaunches=1, startDayOfWeek='MONDAY', startDayOfMonth=1, daysBetweenLaunches=1, weeksBetweenLaunches=1, monthsBetweenLaunches=1)
Module: Oracle WebCenter Portal
Use with WLST: Online
Description
Creates a discussion forum crawler and an announcements crawler for a named application, on an Oracle Secure Enterprise Search (SES) instance.
The command creates two Oracle SES database sources (one for discussion forums and one for announcements) and specifies a crawl schedule. The discussion forums source is named <appname_host_port>_forums with a view of FORUMCRAWLER_VW, and the announcements source is named <appname_host_port>_announcements with a view of ANNOUNCEMENTS_VW.
Syntax
createDiscussionsCrawler(appName, host, port, sesUrl, sesPassword, dbConnString, user, password, authUserIdFormat, crawlingMode, recrawlPolicy, freqType, startHour, hoursBetweenLaunches, startDayOfWeek, startDayOfMonth, daysBetweenLaunches, weeksBetweenLaunches, monthsBetweenLaunches, [server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the application in which to perform this operation. For WebCenter Portal, the application name is always |
|
|
Host name of the machine where the application is running. |
|
|
Port number used to access the application. |
|
|
Web service URL for the Oracle SES Administration API. Use the format: http://host:port/search/api/admin/AdminService |
|
|
Password for the Oracle SES administrative user ( |
|
|
Connection URL for the database on which the discussions server is installed. Use the format: Oracle: IBM DB2: Microsoft SQL Server: |
|
|
Administrative user for the database on which the discussions server is installed. Oracle: The user IBM DB2: The user Microsoft SQL Server: The user |
|
|
Password for the administrative discussions server user specified. |
|
|
Format of the user ID (in active identity plug-in), that is used by the discussions server authorization API. For example, username, email, nickname, user_name. |
|
|
Mode for crawling URLs in the source. The default mode is ACCEPT_ALL—Automatically Accept All URLs for Indexing: Crawls and indexes all URLs in the source. It also extracts and indexes any links found in those URLs. Previously crawled URLs are only reindexed if they have changed. EXAMINE_URL—Examine URLs Before Indexing: Crawls but does not index any URLs in the source. It also crawls any links found in those URLs. INDEX_ONLY—Index Only: Crawls and indexes all URLs in the source. It does not extract any links found in those URLs. Select this option for a source previously crawled using EXAMINE_URL. |
|
|
Specifies whether to crawl all documents or only documents that have changed. Valid values are PROCESS_ALL—All documents are crawled. Use this option to force a full crawl. PROCESS_CHANGED—Only crawl documents that have changed since the previous crawl. This setting can significantly speed up the crawling process. |
|
|
Frequency of scheduled crawls. Valid values are: To schedule crawls MONTHLY, WEEKLY, DAILY, or HOURLY, specify additional arguments as follows: MONTHLY: startHour, startDayOfTheMonth, monthsBetweenLaunches WEEKLY: startHour, startDayOfTheWeek, weeksBetweenLaunches DAILY: startHour, daysBetweenLaunches HOURLY: hoursBetweenLaunches If regular crawls are not required, choose |
|
|
Time to start the crawl. Any number between 1 and 24. For example, enter 2 for 2:00am, 14 for 2:00pm, and so on. |
|
|
Number of hours between crawls. Only valid when |
|
|
Day on which to start a weekly crawl. For example, MONDAY, TUESDAY, and so on. Only valid when |
|
|
Day of the month on which to start a monthly crawl. For example, enter 1 for 1st day of the month, 2 for 2nd day of the month, and so on. Only valid when |
|
|
Number of days between crawls. Only valid when |
|
|
Number of weeks between crawls. Only valid when |
|
|
Number of months between crawls. Only valid when |
server
|
Optional. Name of the managed server where the application is deployed. For example, Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the application is deployed. |
Example
The following example creates a discussion forum crawler and an announcements crawler on the Oracle SES instance http://myseshost.com:7777 for WebCenter Portal (webcenter) located at http://myhost.com:8888/webcenter/portal:
createDiscussionsCrawler(appName='webcenter', host='myhost.com', port='8888', sesUrl='http://myseshost.com:7777/search/api/admin/AdminService', sesPaswword='password', dbConnString='jdbc:oracle:thin:@myjivedbhost.com:1521/mysid', user='app_discussions_crawler', password='password', authUserIdFormat='nickname', crawlingMode='ACCEPT_ALL', recrawlPolicy='PROCESS_ALL', freqType='MANUAL', startHour=1, hoursBetweenLaunches=1,startDayOfWeek='MONDAY', startDayOfMonth=1, daysBetweenLaunches=1, weeksBetweenLaunches=1, monthsBetweenLaunches=1)
Module: Oracle WebCenter Portal
Use with WLST: Online
Description
Returns the Spaces crawler configured on an Oracle SES instance for WebCenter Portal.
Syntax
listSpacesCrawler(appName, sesUrl, sesPassword, host, port, [sesSchema, verbose, server, applicationVersion]
| Argument | Definition |
|---|---|
appName
|
Name of the application in which to perform this operation. For WebCenter Portal, the application name is always |
|
|
Web service URL for the Oracle SES Administration API. Use the format: http://host:port/search/api/admin/AdminService |
|
|
Password for the Oracle SES administrative user ( |
|
|
Host name of the machine where WebCenter Portal is running. |
|
|
Port number used to access WebCenter Portal. |
|
|
Optional. Username for the Oracle SES administrative user. Default value is |
|
|
Optional. Valid options are When set to When set to |
server
|
Optional. Name of the managed server where WebCenter Portal is deployed. For example, Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the application is deployed. |
Example
The following example returns the Spaces crawler configured in the Oracle SES instance http://myseshost.com:7777 for WebCenter Portal located at http://myhost.com:8888/webcenter/portal:
listSpacesCrawler(appName='webcenter', sesUrl='http://myseshost.com:7777/search/api/admin/AdminService', sesSchema='eqsys', sesPassword'password', host='myhost.com', port='8888') Already in Domain Runtime Tree ----------------- Spaces Crawlers ----------------- webcenter_myhost.com_8888_portal
Module: Oracle WebCenter Portal
Use with WLST: Online
Description
Returns the document crawler configured for a named application, on an Oracle SES instance.
Syntax
listDocumentsCrawler(appName, sesUrl, sesPassword, host, port, [sesSchema, verbose, server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the application in which to perform this operation. For WebCenter Portal, the application name is always |
|
|
Web service URL for the Oracle SES Administration API. Use the format: http://host:port/search/api/admin/AdminService |
|
|
Password for the Oracle SES administrative user ( |
|
|
Host name of the machine where the application is running. |
|
|
Port number used to access the application. |
|
|
Optional. Username for the Oracle SES administrative user. Default value is |
|
|
Optional. Valid options are When set to When set to |
server
|
Optional. Name of the managed server where the application is deployed. For example, Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the application is deployed. |
Example
The following example returns the documents crawler configured in the Oracle SES instance http://myseshost.com:7777 for WebCenter Portal (webcenter) located at http://myhost.com:8888/webcenter/portal:
listDocumentsCrawler(appName='webcenter', sesUrl='http://myseshost.com:7777/search/api/admin/AdminService', sesSchema='eqsys', sesPassword'password', host='myhost.com', port='8888') Already in Domain Runtime Tree ----------------- Documents Crawlers ----------------- webcenter_myhost.com_8888_documents
Module: Oracle WebCenter Portal
Use with WLST: Online
Description
Returns the discussion and announcement crawlers configured for a named application on an Oracle SES instance.
Syntax
listDiscussionsCrawler(appName, sesUrl, sesPassword, host, port, [sesSchema, verbose, server, applicationVersion]
| Argument | Definition |
|---|---|
appName
|
Name of the application in which to perform this operation. For WebCenter Portal, the application name is always |
|
|
Web service URL for the Oracle SES Administration API. Use the format: http://host:port/search/api/admin/AdminService |
|
|
Password for the Oracle SES administrative user ( |
|
|
Host name of the machine where the application is running. |
|
|
Port number used to access the application. |
|
|
Optional. Username for the Oracle SES administrative user. Default value is |
|
|
Optional. Valid options are |
server
|
Optional. Name of the managed server where the application is deployed. For example, Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the application is deployed. |
Example
The following example returns discussion and announcement crawlers configured in the Oracle SES instance http://myseshost.com:7777 for WebCenter Portal located at http://myhost.com:8888/webcenter/portal:
listDiscussionsCrawler(appName='webcenter', sesUrl='http://myseshost.com:7777/search/api/admin/AdminService', sesSchema='eqsys', sesPassword='password', host='myhost.com', port='8888') Already in Domain Runtime Tree ----------------- Discussions Crawler ----------------- webcenter_myhost.com_8888_forums webcenter_myhost.com_8888_announcements
Module: Oracle WebCenter Portal
Use with WLST: Online
Description
Starts the Spaces crawler configured for WebCenter Portal, on an Oracle SES instance.
Syntax
startSpacesCrawler(appName, sesUrl, sesPassword, host, port, [sesSchema, server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the application in which to perform this operation. For WebCenter Portal, the application name is always |
|
|
Web service URL for the Oracle SES Administration API. Use the format: http://host:port/search/api/admin/AdminService |
|
|
Password for the Oracle SES administrative user ( |
|
|
Host name of the machine where WebCenter Portal is running. |
|
|
Port number used to access WebCenter Portal. |
|
|
Optional. Username for the Oracle SES administrative user. Default value is |
server
|
Optional. Name of the managed server where WebCenter Portal is deployed. For example, Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of WebCenter Portal is deployed. |
Example
The following example starts the Spaces crawler configured on the Oracle SES instance http://myseshost.com:7777 for WebCenter Portal (webcenter) located at http://myhost.com:8888/webcenter/portal:
startSpacesCrawler(appName='webcenter', sesUrl'http://myseshost.com:7777/search/api/admin/AdminService', sesSchema='eqsys', sesPassword='password', host='myhost.com', port='8888')
Module: Oracle WebCenter Portal
Use with WLST: Online
Description
Starts the documents crawler configured for a named application, on an Oracle SES instance.
Syntax
startDocumentsCrawler(appName, sesUrl, sesPassword, host, port, [sesSchema, server, applicationVersion]
| Argument | Definition |
|---|---|
appName
|
Name of the application in which to perform this operation. For WebCenter Portal, the application name is always |
|
|
Web service URL for the Oracle SES Administration API. Use the format: http://host:port/search/api/admin/AdminService |
|
|
Password for the Oracle SES administrative user ( |
|
|
Host name of the machine where the application is running. |
|
|
Port number used to access the application. |
|
|
Optional. Username for the Oracle SES administrative user. Default value is |
server
|
Optional. Name of the managed server where the application is deployed. For example, Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the application is deployed. |
Example
The following example starts the document crawler configured on the Oracle SES instance http://myseshost.com:7777 for WebCenter Portal (webcenter) located at http://myhost.com:8888/webcenter/portal:
startDocumentsCrawler(appName='webcenter', sesUrl'http://myseshost.com:7777/search/api/admin/AdminService', sesSchema='eqsys', sesPassword='password', host='myhost.com', port='8888')
Module: Oracle WebCenter Portal
Use with WLST: Online
Description
Starts the discussion and announcement crawlers configured for a named application, on an Oracle Secure Enterprise Search (SES) instance.
Syntax
startDiscussionsCrawler(appName, sesUrl, sesPassword, host, port, [sesSchema, server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the application in which to perform this operation. For WebCenter Portal, the application name is always |
|
|
Web service URL for the Oracle SES Administration API. Use the format: http://host:port/search/api/admin/AdminService |
|
|
Password for the Oracle SES administrative user ( |
|
|
Host name of the machine where the application is running. |
|
|
Port number used to access the application. |
|
|
Optional. Username for the Oracle SES administrative user. Default value is |
server
|
Optional. Name of the managed server where the application is deployed. For example, Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the application is deployed. |
Example
The following example starts the discussion and announcement crawlers configured on the Oracle SES instance http://myseshost.com:7777 for WebCenter Portal (webcenter) located at http://myhost.com:8888/webcenter/portal:
startDiscussionsCrawler(appName='webcenter', sesUrl'http://myseshost.com:7777/search/api/admin/AdminService', sesSchema='eqsys', sesPassword='password', host='myhost.com', port='8888')
Module: Oracle WebCenter Portal
Use with WLST: Online
Description
Stops the Spaces crawler configured for WebCenter Portal, on an Oracle SES instance.
Syntax
stopSpacesCrawler(appName, sesUrl, sesPassword, host, port, [sesSchema, server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the application in which to perform this operation. For WebCenter Portal, the application name is always |
|
|
Web service URL for the Oracle SES Administration API. Use the format: http://host:port/search/api/admin/AdminService |
|
|
Password for the Oracle SES administrative user ( |
|
|
Host name of the machine where WebCenter Portal is running. |
|
|
Port number used to access WebCenter Portal. |
|
|
Optional. Username for the Oracle SES administrative user. Default value is |
server
|
Optional. Name of the managed server where WebCenter Portal is deployed. For example, Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of WebCenter Portal is deployed. |
Example
The following example stops the Spaces crawler configured on the Oracle SES instance http://myseshost.com:7777 for WebCenter Portal located at http://myhost.com:8888/webcenter/portal:
stopSpacesCrawler(appName='webcenter',sesUrl'http://myseshost.com:7777/search/api/admin/AdminService', sesSchema='eqsys', sesPassword='password', host='myhost.com', port='8888')
Module: Oracle WebCenter Portal
Use with WLST: Online
Description
Stops the documents crawler configured for a named application, on an Oracle SES instance.
Syntax
stopDocumentsCrawler(appName, sesUrl, sesPassword, host, port, [sesSchema, server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the application in which to perform this operation. For WebCenter Portal, the application name is always |
|
|
Web service URL for the Oracle SES Administration API. Use the format: http://host:port/search/api/admin/AdminService |
|
|
Password for the Oracle SES administrative user ( |
|
|
Host name of the machine where the application is running. |
|
|
Port number used to access the application. |
|
|
Optional. Username for the Oracle SES administrative user. Default value is |
server
|
Optional. Name of the managed server where the application is deployed. For example, Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the application is deployed. |
Example
The following example stops the document crawler configured on the Oracle SES instance http://myseshost.com:7777 for WebCenter Portal located at http://myhost.com:8888/webcenter/portal:
stopDocumentsCrawler(appName='webcenter',sesUrl'http://myseshost.com:7777/search/api/admin/AdminService', sesSchema='eqsys', sesPassword='password', host='myhost.com', port='8888')
Module: Oracle WebCenter Portal
Use with WLST: Online
Description
Stops the discussion and announcement crawlers configured for a named application, on an Oracle SES instance.
Syntax
stopDiscussionsCrawler(appName, sesUrl, sesPassword, host, port, [sesSchema, server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the application in which to perform this operation. For WebCenter Portal, the application name is always |
|
|
Web service URL for the Oracle SES Administration API. Use the format: http://host:port/search/api/admin/AdminService |
|
|
Password for the Oracle SES administrative user ( |
|
|
Host name of the machine where the application is running. |
|
|
Port number used to access the application. |
|
|
Optional. Username for the Oracle SES administrative user. Default value is |
server
|
Optional. Name of the managed server where the application is deployed. For example, Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the application is deployed. |
Example
The following example stops the discussion and announcement crawlers configured on the Oracle SES instance http://myseshost.com:7777 for WebCenter Portal located at http://myhost.com:8888/webcenter/portal:
stopDiscussionsCrawler(appName='webcenter',sesUrl'http://myseshost.com:7777/search/api/admin/AdminService', sesSchema='eqsys', sesPassword='password', host='myhost.com', port='8888')
Module: Oracle WebCenter Portal
Use with WLST: Online
Description
Deletes the Spaces crawler configured for WebCenter Portal, on an Oracle SES instance.
Syntax
deleteSpacesCrawler(appName, sesUrl, sesPassword, host, port,[sesSchema, server,applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the application in which to perform this operation. For WebCenter Portal, the application name is always |
|
|
Web service URL for the Oracle SES Administration API. Use the format: http://host:port/search/api/admin/AdminService |
|
|
Password for the Oracle SES administrative user ( |
|
|
Host name of the machine where WebCenter Portal is running. |
|
|
Port number used to access WebCenter Portal. |
|
|
Optional. Username for the Oracle SES administrative user. Default value is |
server
|
Optional. Name of the managed server where the application is deployed. For example, Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the application is deployed. |
Example
The following example deletes the Spaces crawler configured on the Oracle SES instance http://myseshost.com:7777 for WebCenter Portal named webcenter located at http://myhost.com:8888/webcenter/portal:
deleteSpacesCrawler(appName='webcenter',sesUrl'http://myseshost.com:7777/search/api/admin/AdminService', sesSchema='eqsys', sesPassword='password', host='myhost.com', port='8888')
Module: Oracle WebCenter Portal
Use with WLST: Online
Description
Deletes the documents crawler configured for a named application, on an Oracle SES instance.
Syntax
deleteDocumentsCrawler(appName, sesUrl, sesPassword, host, port, [sesSchema, server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the application in which to perform this operation. For WebCenter Portal, the application name is always |
|
|
Web service URL for the Oracle SES Administration API. Use the format: http://host:port/search/api/admin/AdminService |
|
|
Password for the Oracle SES administrative user ( |
|
|
Host name of the machine where the application is running. |
|
|
Port number used to access the application. |
|
|
Optional. Username for the Oracle SES administrative user. Default value is |
server
|
Optional. Name of the managed server where the application is deployed. For example, Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the application is deployed. |
Example
The following example deletes the document crawler configured on the Oracle SES instance http://myseshost.com:7777 for WebCenter Portal located at http://myhost.com:8888/webcenter/portal:
deleteDocumentsCrawler(appName='webcenter',sesUrl'http://myseshost.com:7777/search/api/admin/AdminService', sesSchema='eqsys', sesPassword='password', host='myhost.com', port='8888')
Module: Oracle WebCenter Portal
Use with WLST: Online
Description
Deletes the discussion and announcement crawlers configured for a named application, on an Oracle SES instance.
Syntax
deleteDiscussionsCrawler(appName, sesUrl, sesPassword, host, port, [server], [applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the application in which to perform this operation. For WebCenter Portal, the application name is always |
|
|
Web service URL for the Oracle SES Administration API. Use the format: http://host:port/search/api/admin/AdminService |
|
|
Password for the Oracle SES administrative user ( |
|
|
Host name of the machine where the application is running. |
|
|
Port number used to access the application. |
|
|
Optional. Username for the Oracle SES administrative user. Default value is |
server
|
Optional. Name of the managed server where the application is deployed. For example, Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the application is deployed. |
Example
The following example deletes the discussion and announcement crawlers configured on the Oracle SES instance http://myseshost.com:7777 for WebCenter Portal located at http://myhost.com:8888/webcenter/portal:
deleteDiscussionsCrawler(appName='webcenter',sesUrl'http://myseshost.com:7777/search/api/admin/AdminService', sesSchema='eqsys', sesPassword='password', host='myhost.com', port='8888')
Use the commands listed in Table 2-26 to manage search settings and crawl options for WebCenter Portal.
Configuration changes made using these WLST commands are effective immediately; no restart is required.
Table 2-26 WebCenter Portal Search WLST Commands
| Use This Command... | To... | Use with WLST... |
|---|---|---|
|
Modify search settings for a named application. |
Online |
|
|
List search properties for a named application. |
Online |
|
|
Specify crawl properties for a named application. |
Online |
|
|
Return the current crawl settings for a named application. |
Online |
Module: Oracle WebCenter Portal
Use with WLST: Online
Description
Modifies search settings for a named application. If a parameter is not specified, it is not modified.
Syntax
setSearchConfig(appName,[numSavedSearches, numResultsRegion, numResultsMain, executionTimeout, prepareTimeout, showAllExecutionTimeout, server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the application in which to perform this operation. For WebCenter Portal, the application name is always |
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 tool or service, for searches submitted from the main search page. |
executionTimeout
|
Optional. The maximum time that a tool or 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 tool or 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 tool or 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 application is deployed. For example, Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the application is deployed. |
Examples
The following example specifies that saved searches display five search results per tool or service. Additionally, that a seven second search execution timeout is required:
wls:/weblogic/serverConfig>setSearchConfig(appName='webcenter', numResultsRegion=5, executionTimeout=7000);
The following example increases the number of saved searches in the Saved Searches drop down list to eight:
wls:/weblogic/serverConfig>setSearchConfig(appName='webcenter', numSavedSearches=8);
The following example sets the search execution timeout to five seconds and allows each tool or service fifteen seconds to display search results before timing out:
wls:/weblogic/serverConfig>setSearchConfig(appName='webcenter', executionTimeout=5000, showAllExecutionTimeout=15000);
Module: Oracle WebCenter Portal
Use with WLST: Online
Description
Lists search settings for a named application.
Syntax
listSearchConfig(appName, [server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the application in which to perform this operation. For WebCenter Portal, the application name is always |
server
|
Optional. Name of the managed server where the application is deployed. For example, Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the application is deployed. |
Example
The following example displays search configuration information for WebCenter Portal:
wls:/weblogic/serverConfig>listSearchConfig(appName='webcenter')
Module: Oracle WebCenter Portal
Use with WLST: Online
Description
Specifies Oracle SES crawl properties for WebCenter Portal.
WebCenter Portal can be crawled by Oracle SES to provide a faster, more unified search experience across WebCenter Portal objects, specifically: portals, lists, pages, people (profiles), wikis, blogs, documents, discussions, and announcements. Three distinct crawlers make this possible:
Spaces Crawler (for portals, lists, pages, and people)
Documents Crawler (for documents, wikis, blogs)
Discussions Crawler (for discussions and announcements).
Use this command to enable or disable Oracle SES crawlers in WebCenter Portal. To use Oracle SES crawlers, you must enable all three crawlers.
You can also use this command to specify an interval between full crawls for the Spaces crawler. During a full crawl, all of the Spaces crawler content is re-read. Out-of-the-box, full crawls for the Spaces crawler occur every seven days but you can specify a different frequency to suit your installation.
Note that incremental crawls, for all three crawlers, are initiated by a scheduler running from Oracle SES. During these incremental crawls, only content added or updated since the previous crawl is processed.
Syntax
setSpacesCrawlProperties(appName, [fullCrawlIntervalInHours, spacesCrawlEnabled, documentCrawlEnabled, discussionsCrawlEnabled, server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the application in which to perform this operation. For WebCenter Portal, the application name is always |
fullCrawlIntervalInHours
|
Optional. Number of hours between full crawls. The default is 168 hours or 7 days. |
spacesCrawlEnabled
|
Optional. Specifies whether the Spaces crawler is enabled in Oracle SES. Valid values are When set to |
documentCrawlEnabled
|
Optional. Specifies whether the Documents crawler is enabled in Oracle SES. Valid values are When set to |
discussionsCrawlEnabled
|
Optional. Specifies whether the Discussions and Announcement crawlers are enabled in Oracle SES. Valid values are When set to |
server
|
Optional. Name of the managed server where the application is deployed. For example, Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the application is deployed. |
Example
The following example enables Oracle SES crawlers in WebCenter Portal and specifies that WebCenter Portal runs a full crawl through the Spaces crawler every 8 days:
wls:/weblogic/serverConfig>setSpacesCrawlProperties(appName='webcenter', fullCrawlIntervalInHours=192, spacesCrawlEnabled=1, documentCrawlEnabled=1, discussionsCrawlEnabled=1)
Module: Oracle WebCenter Portal
Use with WLST: Online
Description
Returns the current crawl settings for a named application, such as the number of hours between full crawls (Spaces crawler), and whether Oracle SES crawlers are enabled.
Syntax
getSpacesCrawlProperties(appName, [server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the application in which to perform this operation. For WebCenter Portal, the application name is always |
server
|
Optional. Name of the managed server where the application is deployed. For example, Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the application is deployed. |
Example
The following example returns the current crawl settings for WebCenter Portal (webcenter):
wls:/weblogic/serverConfig>getSpacesCrawlProperties(appName='webcenter')
Spaces Crawl Properties:
-----------------
fullCrawlIntervalInHours: 124
spacesCrawlEnabled: 1
documentCrawlEnabled: 1
discussionsCrawlEnabled: 1
Use the commands listed in Table 2-27 to manage workflow settings and metadata for WebCenter Portal.
Table 2-27 WebCenter Portal Application WLST Commands
| Use This Command... | To... | Use with WLST... |
|---|---|---|
|
Return the name of the BPEL server connection that WebCenter Portal is using for internal workflows. |
Online |
|
|
Specify the BPEL server connection used for WebCenter Portal workflows. |
Online |
Module: Oracle WebCenter Portal
Use with WLST: Online
Description
Returns the name of the BPEL server connection that WebCenter Portal is currently using for internal workflows (portal membership notifications, portal subscription requests, and so on).
Syntax
getSpacesWorkflowConnectionName(appName, [server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the application in which to perform this operation. For WebCenter Portal, the application name is always |
server
|
Optional. Name of the managed server where WebCenter Portal is deployed. For example, Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of WebCenter Portal is deployed. |
Example
The following example names the BPEL server connection that WebCenter Portal is currently using for internal workflows:
wls:/weblogic/serverConfig> getSpacesWorkflowConnectionName(appName='webcenter')
WorkflowConfigConnectionName: WebCenter-Worklist
Module: Oracle WebCenter Portal
Use with WLST: Online
Description
Specifies the BPEL server connection that WebCenter Portal uses for internal workflows. WebCenter Portal uses a BPEL server included with the Oracle SOA Suite to host internal workflows, such as portal membership notifications, portal subscription requests, and so on. The connection name specified here must be a valid BPEL server connection.
Note:
Configuration changes made using this WLST command are only effective after your restart the Managed Server on which WebCenter Portal is deployed. For details, see Oracle Fusion Middleware Administering Oracle WebCenter Portal.
Syntax
setSpacesWorkflowConnectionName(appName, name, [server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the application in which to perform this operation. For WebCenter Portal, the application name is always |
name
|
Name of an existing BPEL server connection. |
server
|
Optional. Name of the managed server where WebCenter Portal is deployed. For example, Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of WebCenter Portal is deployed. |
Example
The following example specifies that WebCenter Portal uses the BPEL server connection named WebCenter-Worklist for its internal workflows.
wls:/weblogic/serverConfig>setSpacesWorkflowConnectionName(appName='webcenter', name='WebCenter-Worklist')
Use the commands listed in Table 2-28 to configure options for searching an application's identity store.
Table 2-28 WebCenter Portal Identity Store WLST Commands
| Use this command... | To... | Use with WLST... |
|---|---|---|
|
Modify configuration options for searching a named applications's identity store. |
Online |
|
|
List current configuration options for searching a named application's identity store. |
Online |
Module: Oracle WebCenter Portal
Use with WLST: Online
Description
Modifies configuration options for searching a named application's identity store. Use these settings to optimize identity store searches (for users and roles) in WebCenter Portal.
Identity store search parameters are stored in adf-config.xml. If a search parameter is not specified, it is not modified.
Syntax
setWebCenterIdStoreSearchConfig(appName,[narrowSearchTimeout, broadSearchTimeout, maxSearchFilters, maxFetchRecords, server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the application in which to perform this operation. For WebCenter Portal, the application name is always |
narrowSearchTimeout
|
Optional. Maximum time allowed (in ms) for small, simple searches, such as fetching a single user from the identity store. Out-of-the-box, the default is 30000ms. |
broadSearchTimeout
|
Optional. Maximum time allowed (in ms) to return large result sets, such as returning users and roles that match a name pattern. Out-of-the-box, the default is 60000. |
maxSearchFilters
|
Optional. Number of search filters allowed for the 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. Maximum number of records to be returned from each search query. Out-of-the-box, the default is 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 application is deployed. For example, Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the application is deployed. |
Example
The following example increases 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 Portal
Use with WLST: Online
Description
Lists current configuration options for searching the identity store for a named application (WebCenter Portal.
Identity store search parameters are stored in adf-config.xml.
Syntax
listWebCenterIdStoreSearchConfig(appName, [server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the application in which to perform this operation. For WebCenter Portal, the application name is always |
server
|
Optional. Name of the managed server where the application is deployed. For example, Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the application is deployed. |
Example
The following example displays identity store search configuration information for WebCenter Portal (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 2-29 to perform lifecycle operations for WebCenter Portal.
Table 2-29 Lifecycle WLST Commands
| Use this command... | To... | Use with WLST... |
|---|---|---|
|
Deploy a portal from a stage environment to a production environment. |
Online |
|
|
Propagate metadata for a named portal, from a stage environment to a production environment. |
Online |
|
|
Export one or more named portals to a portal archive ( |
Online |
|
|
Export one or more named portal templates to a portal archive ( |
Online |
|
|
Import one or more portals or portal templates from a portal archive ( |
Online |
|
|
List the content of a portal archive and extract the portal archive to a specified location |
Online or Offline |
|
|
Export connection configuration information from a source WebCenter Portal environment to a named file. |
Online |
|
|
Import new WebCenter Portal connections from a named connection properties file. |
Online |
|
|
Take a portal offline or bring a portal online. |
Online |
|
|
Export a portal asset to an export archive ( |
Online |
|
|
Import a portal asset from an export archive ( |
Online |
|
|
Import translations for WebCenter Portal. |
Online |
|
|
Export the WebCenter Portal application to an export archive ( |
Online |
|
|
Import the WebCenter Portal application from an export archive ( |
Online |
|
|
Export portlet client metadata and producer customizations and personalizations to an export archive. |
Online |
|
|
Import portlet client metadata and producer customizations and personalizations from an export archive. |
Online |
|
|
Display names of producers where metadata imports have failed and reasons for those failures. |
Online |
|
|
Attempt to import outstanding producer metadata. |
Online |
|
|
Clone a Managed Server used by WebCenter Portal. |
Online |
Module: Oracle WebCenter Portal
Use with WLST: Online
Description
Deploys a portal from a stage environment to a production environment.
Note:
The name of the managed server must be the same in both the stage and production environments.
A connection to the production environment must be defined on the stage instance.
You must have at least the WebLogic Monitor role and the WebCenter Portal permission Portals - Manage Security and Configuration.
Syntax
deployWebCenterPortal(appName, portalName, targetConnectionName, [deployCustomizations, deployPortalContent, deploySecurity, deployData, deployActivities, deploySharedAssets, deployConnections, overwrite, savePortal, deployLog, server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the application in which to perform this operation. For WebCenter Portal, the application name is always |
portalName
|
Name of the portal that you want to deploy. For example, Note: Do not enter the portal's display name here. You must enter the portal name that appears in the portal URL. If you are not sure, obtain the portal name from the About Portal dialog. |
targetConnectionName
|
Name of a connection on the source stage instance that specifies how to connect to the target production instance. Note: Use Enterprise Manager or the WLST command |
deployCustomizations
|
Optional. This attribute is deprecated. |
deployPortalContent
|
Optional. Specifies whether to deploy the portal's content folder on the target server. Valid values are 1 and 0.
This argument defaults to |
deploySecurity
|
Optional. This attribute is deprecated. |
deployData
|
Optional. This attribute is deprecated. |
deployActivities
|
Optional. Indicates whether to deploy activity stream messages on the target. This option is only applicable when Valid values are 1 and 0.
This argument defaults to 1. |
deploySharedAssets
|
Optional. Indicates whether to deploy non-seeded shared assets to the target.Valid values are 1 and 0.
This argument defaults to 0. |
deployConnections
|
Optional. Indicates whether to deploy connections associated with portal to the target. Valid values are 1 and 0.
This argument defaults to 1. |
overwrite
|
Optional. Specifies whether to redeploy the portal if the portal already exists in the target. Valid values are 1 and 0.
This argument defaults to 0. |
savePortal
|
Optional. Specifies whether to back up the portal on the target instance before the portal is redeployed. Valid values are 1 and 0.
The default value is 0. |
deployLog
|
Optional. Name and location of a local log file containing detailed information about the deploy operation. If not specified, a deploy log file named |
server
|
Optional. Name of the managed server where WebCenter Portal is deployed. For example, Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the WebCenter Portal application is deployed. |
Example
The following example deploys a portal named myPortal without its content folder:
wls:/weblogic/serverConfig> deployWebCenterPortal(appName='webcenter', portalName='myPortal', targetConnectionName='MyProductionConnection')
Note:
You can use the adf_createHttpUrlConnection WLST command to create MyProductionConnection:. For example:
adf_createHttpURLConnection(appName='webcenter', name='MyProductionConnection', url='http://example.com:7777', user='myuser', password='mypassword', realm='ProductionRealm')
The following example deploys a portal named myPortal with all its associated content, and also specifies a name and location for the deploy log file:
wls:/weblogic/serverConfig> deployWebCenterPortal(appName='webcenter', portalName='myPortal', targetConnectionName='MyProductionConnection', deployPortalContent=1, deployLog='/mydeploylogs/myPortal_deploy.log')
The following example backs up myPortal on the target before redeploying the portal and all its associated content:
wls:/weblogic/serverConfig> deployWebCenterPortal(appName='webcenter', portalName='myPortal', targetConnectionName='MyProductionConnection', deployPortalContent=1, savePortal=1, overwrite=1)
Module: Oracle WebCenter Portal
Use with WLST: Online
Description
Propagates metadata changes for a named portal, from a stage environment to a production environment.
Metadata changes propagated:
Include:
Portal-level customizations (metadata changes) for portal pages, system pages, portlets, assets, task flows
User-level customizations (metadata changes) for portal pages, portlets, task flow instances
Exclude: Security, any changes to content and data, and portal state (online/offline)
Note:
You can only propagate portals that were previously deployed (from stage to production) using the deployWebCenterPortal command.
To migrate other changes, consider using exportWebCenterPortals and importWebCenterPortals, or deployWebCenterPortal.
Note:
The name of the managed server must be the same in both the stage and production environments.
A connection to the production environment must be defined on the stage instance.
You must have at least the WebLogic Monitor role and the WebCenter Portal permission Portals - Manage Security and Configuration.
Syntax
propagateWebCenterPortal(appName, portalName, targetConnectionName, [savePortal, propagateLog, propagateSharedAssets, propagatePortalContent, server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the application in which to perform this operation. For WebCenter Portal, the application name is always |
portalName
|
Name of the portal that you want to propagate. For example, Note: Do not enter the portal's display name here. You must enter the portal name that appears in the portal URL. If you are not sure, obtain the portal name from the About Portal dialog. |
targetConnectionName
|
Name of a connection on the source stage instance that specifies how to connect to the target production instance. Note: Use Enterprise Manager or the WLST command |
savePortal
|
Optional. Specifies whether to back up the portal on the target instance to an archive before propagating the changes for the portal. Valid values are 1 and 0:
The default value is 0. |
propagateLog
|
Optional. Name and location of a local log file containing detailed information about the propagation operation. If not specified, a propagation log file named |
propagateSharedAssets
|
Optional. Specifies whether to propagate non-seeded shared assets metadata changes to the target. Valid values are 1 and 0:
The default value is 0. |
propagatePortalContent
|
Optional. Specifies whether to propagate changes to content associated with the portal to the target instance. Valid values are 1 and 0:
The default value is 0. |
server
|
Optional. Name of the managed server where WebCenter Portal is deployed. For example, Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the WebCenter Portal application is deployed. |
Example
The following example propagates metadata changes for a portal named myPortal:
wls:/weblogic/serverConfig> propagateWebCenterPortal(appName='webcenter', portalName='myPortal', targetConnectionName='MyProductionConnection')
Note:
You can use the adf_createHttpUrlConnection WLST command to create MyProductionConnection. For example:
adf_createHttpURLConnection(appName='webcenter', name='MyProductionConnection', url='http://example.com:7777', user='myuser', password='mypassword', realm='ProductionRealm')
The following example backs up a portal named myPortal with all its associated content before propagating metadata changes for the portal:
wls:/weblogic/serverConfig> propagateWebCenterPortal(appName='webcenter', portalName='myPortal', targetConnectionName='MyProductionConnection', savePortal=1)
The following example propagates metadata changes for a portal named myPortal, and also specifies a name and location for the propagation log file:
wls:/weblogic/serverConfig> propagateWebCenterPortal(appName='webcenter', portalName='myPortal', targetConnectionName='MyProductionConnection', propagateLog='/mypropagationlogs/myPortal_propagation.log')
Module: Oracle WebCenter Portal
Use with WLST: Online
Description
Exports one or more named portals to a portal archive (.par file), using the filename specified.
The portal archive file contains one or more portal data archives (.pdr files) -- one for each portal that you export.
The export operation continues if one of the portals fail to export properly. Status messages are shown in the WLST console indicating the success or failure of the export operation for each specified portal. Portals that could not be exported are excluded from the .par file.
Note:
To run this command you must have at least the WebLogic Monitor role and the WebCenter Portal permission Portals - Manage Security and Configuration.
If your portal is larger than 2 GB, set exportConnections = 0 in the exportWebCenterPortals command. Use the exportWebCenterPortalConnections command to migrate connections.
Syntax
exportWebCenterPortals(appName, fileName, [names, offlineDuringExport, exportPortalContent, exportConnections, exportSharedAssets, server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the application in which to perform this operation. For WebCenter Portal, the application name is always |
fileName
|
Name and location of the export archive ( If you do not specify a location, the archive is created in the same directory that you run the WLST command. |
names
|
Optional. Name of one or more portals that you want to export. Separate multiple portal names with a comma. For example: Note: Do not enter the portal's display names here. You must enter the name that is specified in the portal URL. The portal name is available from the About Portal dialog. If you leave the |
offlineDuringExport
|
Optional. Indicates whether the portals you want to export must be offline before starting the export process. If users are allowed to access the portal, any changes made to the portal once the export starts are not exported. Valid values are 1 and 0.
The default value is 0. |
exportPortalContent
|
Optional. Specifies whether to export each portal's content folder on WebCenter Content Server. A content folder is automatically created on Content Server for any portal using document services to create, manage, and store portal documents (files, folders, wikis, blogs). Only content that is stored in this folder can be exported with the portal.The export does not, for example, include web content or pages displayed through Content Presenter since this information is not stored in the portal's content folder. Valid values are 1 and 0.
The default value is 0. |
exportConnections
|
Optional. Specifies whether to export WebCenter Portal connections into a file named In addition, a copy of Valid values are 1 and 0.
The default value is 0. See also, "Understanding Connection Property Files" in Administering Oracle WebCenter Portal. |
exportSharedAssets
|
Optional. Specifies whether to export non-seeded shared assets and include it in the portal archive (.par). Valid values are 1 and 0.
|
server
|
Optional. Name of the managed server where WebCenter Portal is deployed. For example, Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the WebCenter Portal application is deployed. |
Example
The following example exports myPortal1 and myPortal2 to myPortalExport.par:
wls:/weblogic/serverConfig> exportWebCenterPortals(appName='webcenter', fileName='myPortalExport.par', names='myPortal1, myPortal2')
The following example exports myPortal1 to myPortalExport.par. To ensure that myPortal1 is offline while the export operation takes place, offlineDuringExport is set to 1:
wls:/weblogic/serverConfig> exportWebCenterPortals(appName='webcenter', fileName=myPortalOfflineExport.par', names='myPortal1', offlineDuringExport=1)
The following example exports all the portals, including portal content folders, to exportAllMyPortals.par:
wls:/weblogic/serverConfig> exportWebCenterPortals(appName='webcenter', fileName='exportAllMyPortals.par', exportPortalContent=1)
Module: Oracle WebCenter Portal
Use with WLST: Online
Description
Exports one or more named portal templates to a portal archive (.par file), using the filename specified. The portal archive file contains a portal data archive (.pdr file) for each portal template you export.
Each portal data archive includes template-specific data (pages, discussions, and lists), customizations, security information, and optionally, portal template content.
The export operation continues if one of the portal templates fails to export properly. Status messages are shown in the WLST console indicating the success or failure of the export operation for each specified portal. Portal templates that could not be exported are excluded from the .par file.
Note:
To run this command you must have at least the WebLogic Monitor role and the WebCenter Portal permission Portal Templates - Manage All.
Syntax
exportWebCenterPortalTemplates(appName, fileName, [names, exportPortalTemplateContent, exportConnections, server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the application in which to perform this operation. For WebCenter Portal, the application name is always |
fileName
|
Name and location of the export archive ( If you do not specify a location, the archive is created in the same directory that you run the WLST command. |
names
|
Optional. Name of one or more portals templates that you want to export. Separate multiple template names with a comma. For example: Note: Do not enter portal template display names here. You must enter the name that is specified in the portal template URL. The portal name is available from the About Portal Template dialog. If you leave the |
exportPortalTemplateContent
|
Optional. Specifies whether to export each template's content folder on WebCenter Content Server. A content folder is automatically created on Content Server for any template using document services to create, manage, and store template documents (files, folders, wikis, blogs). Only content that is stored in this folder can be exported with the portal template.The export does not, for example, include web content or pages displayed through Content Presenter since this information is not stored in the portal template's content folder. Valid values are 1 and 0.
The default value is 0. |
exportConnections
|
Optional. Specifies whether to extract WebCenter Portal connections into a file named "connection.properties" and include it in the portal archive (.par). Valid values are 1 and 0. Valid values are 1 and 0.
The default value is 1. |
server
|
Optional. Name of the managed server where WebCenter Portal is deployed. For example, Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the WebCenter Portal application is deployed. |
Example
The following example exports myPortalTemplate1 and myPortalTemplate2 to myPortalTemplateExport.par:
wls:/weblogic/serverConfig> exportWebCenterPortalTemplates(appName='webcenter', fileName='myPortalTemplateExport.par', names='myPortalTemplate1, myPortalTemplate2')
The following example exports all the portal templates, including portal template content, to exportAllMyPortalTemplates.par:
wls:/weblogic/serverConfig> exportWebCenterPortalTemplates(appName='webcenter', fileName='exportAllMyPortalTemplates.par', exportPortalTemplateContent=1)
Module: Oracle WebCenter Portal
Use with WLST: Online
Description
Imports one or more portals or portal templates from a portal archive (.par file).
Note:
To run this command you must have at least the WebLogic Monitor role and either the WebCenter Portal permission Portals - Portals - Manage Security and Configuration, or Portal Templates - Manage All.
Syntax
importWebCenterPortals(appName, fileName, [names, parentPortal, importCustomizations, importPortalContent, importSecurity, importData, importActivities, overwrite, savePortals, forceOffline, importLog, importConnections, connPropertiesFile, importSharedAssets, server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the application in which to perform this operation. For WebCenter Portal, the application name is always |
fileName
|
Name of the portal archive ( |
names
|
Optional. Name of one or more portals or portal templates that you want to import. For example: Separate multiple names with a comma. For example: Note: Do not enter display names here. You must enter the name that is specified in the portal or portal template URL:
Note: If a |
parentPortal
|
Optional. Name of the parent portal under which to place portals in the archive. If specified, imported portals become subportals of the parent portal. This argument defaults to null. When no parent is specified, archived portals are imported as root portals. Note: If the archive contains portal templates, this argument is ignored. |
importCustomizations
|
Optional. This attribute is deprecated. |
importPortalContent
|
Optional. Specifies whether to import content associated with the portal on the instance. Valid values are 1 and 0. Valid values are 1 and 0.
This argument defaults to 0. Note: Portal archives that contain large content folders may exceed the maximum upload size for files (2 GB by default). If necessary, you can increase this setting. For details, see "Changing the Maximum File Upload Size" in Oracle Fusion Middleware Administering Oracle WebCenter Portal. |
importSecurity
|
Optional. This attribute is deprecated. |
importData
|
Optional. This attribute is deprecated. |
importActivities
|
Optional. Indicates whether to import activity messages from the export archive. Valid values are 1 and 0.
This argument defaults to Note: If the archive contains portal templates, this argument is ignored. |
overwrite
|
Optional. Specifies whether to overwrite portals or portal templates that exist in the target. Valid values are
The default is 0. |
savePortals
|
Optional. Specifies whether to save existing portals to an archive before starting the import operation. Valid values are 1 and 0:
The default value is 0. |
forceOffline
|
Optional. Specifies whether to take existing portals offline before starting the import process. Valid values are 1 and 0.
The default value is 0. Note: If the archive contains portal templates, this argument is ignored. |
importLog
|
Optional. Specifies the name of a local log file containing detailed information about the import operation. If not specified, a log file named |
importConnections
|
Optional. Specifies whether to import connections associated with the portal on the instance. Valid values are 1 and 0. Valid values are
The default is 1. |
connPropertiesFile
|
Optional. Specifies the name and location of a connection properties file. For example: Web service and URL connections are imported from the specified connection properties file. Connections that do not exist on the target are imported. Connections that exist on the target are ignored. Note: If |
importSharedAssets
|
Optional. Specifies whether to import non-seeded shared assets along with the portal (.par). sharedassets directory should be present in the archive. Valid values are 1 and 0. Valid values are
The default is 0. |
server
|
Optional. Name of the managed server where WebCenter Portal is deployed. For example, Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the WebCenter Portal application is deployed. |
Example
The following example imports a new version of the sales portal archived in myPortalExport.par and specifies a name and location for the import log file. To ensure that the existing sales portal is offline while the import operation takes place, forceOffline is set to 1:
wls:/weblogic/serverConfig> importWebCenterPortals(appName='webcenter', fileName='myPortalExport.par', names='sales', forceOffline=1, importLog='sales_import.log')
The following example saves a copy of the sales portal before re-importing a new version of the sales portal from myPortalExport.par:
wls:/weblogic/serverConfig> importWebCenterPortals(appName='webcenter', fileName='myPortalExport.par', names='sales', savePortals=1)
The following example imports the newHire portal template archived in myPortalTemplateExport.par and specifies a name and location for the import log file:
wls:/weblogic/serverConfig> importWebCenterPortals(appName='webcenter', fileName='myPortalTemplateExport.par', names='newHire', importLog='newHire.log')
Module: Oracle WebCenter Portal
Use with WLST: Online or Offline
Description
Lists the content of a portal archive and optionally, extracts the portal archive to a specified location.
Syntax
listWebCenterPortalArchive(appName, fileName, [extractDir, server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the application in which to perform this operation. For WebCenter Portal, the application name is always |
fileName
|
Name and location of a portal archive. |
extractDir
|
Optional. Destination directory in which to extract portal archive content. If a directory is specified, the portal archive is extracted to that location. If omitted, archive content is listed but not extracted. |
server
|
Optional. Name of the managed server where WebCenter Portal is deployed. For example, Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the WebCenter Portal application is deployed. |
Example
The following example lists the content of myPortal.par and extracts archive content to the directory /myPortalArchives/myPortalContent:
wls:/weblogic/serverConfig> listWebCenterPortalArchive(appName='webcenter', fileName='/myPortalArchives/myPortal.par', extractDir='/myPortalArchives/myPortalContent')
Module: Oracle WebCenter Portal
Use with WLST: Online
Description
Exports connection configuration information from the source WebCenter Portal environment to a named file.
The following connections are exported:
Analytics collector connections
Content repository connections (Oracle WebCenter Content )
Discussions server connections
Events server connections
External application connections
Mail server connections
Oracle Secure Enterprise Search connections
Portlet producer connections (WSRP and PDK-Java)
Pagelet producer connections
Presence server connections
URL connections
Web service connections (used by data controls)
BPEL server connections
Note:
You must have at least the WebLogic Admin role to run the exportWebCenterPortalConnections command.
Syntax
exportWebCenterPortalConnections(appName, fileName, [connectionType, [connectionName,] logFile, server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the application in which to perform this operation. For WebCenter Portal, the application name is always |
fileName
|
Specifies a name and location for the connection properties file. If you do not specify a location, the file is saved in the current directory. |
connectionType
|
Optional. Specifies the type of connections you want to export. Separate multiple connection types with a comma. For example:
If left blank, all connection types are exported. Valid connection types are:
Note: This argument is mandatory if you specify |
connectionName
|
Optional. Names specific connections you want to export for a single For example, if When you specify a value for Note: If no names are specified, all connections are exported for the specified |
logFile
|
Specifies a name of a local log file containing detailed information about the export connection operation. If not specified, a log file named |
server
|
Optional. Name of the managed server where WebCenter Portal is deployed. For example, Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the WebCenter Portal application is deployed. |
Example
The following example exports connection configuration information for all WSRP producer and web service connections to a file named connection.properties located at /myConnections:
wls:/weblogic/serverConfig> exportWebCenterPortalConnections(appName='webcenter', fileName='/myConnections/connection.properties', connectionType='wsrpProducerConnection,webServiceConnection')
The following example exports connection configuration information for two WSRP producer connections named myWSRP1 and myWSRP2 to a file named connection.properties located at /myConnections:
wls:/weblogic/serverConfig> exportWebCenterPortalConnections(appName='webcenter', fileName='/myConnections/connection.properties', connectionType='wsrpProducerConnection', connectionName='myWSRP1,myWSRP2')
The following example exports all connection configuration information to a file named connection.properties located at /myConnections:
wls:/weblogic/serverConfig> exportWebCenterPortalConnections(appName='webcenter', fileName='/myConnections/connection.properties')
The following example exports connection configuration information to a file named connection.properties located at \myConnections. Detailed information about the export operation is also logged to exportConnections.log located at /myExportLogs:
wls:/weblogic/serverConfig> exportWebCenterPortalConnections(appName='webcenter', fileName='/myConnections/connection.properties', logFile='/myExportLogs/exportConnections.log')
Module: Oracle WebCenter Portal
Use with WLST: Online
Description
Imports new WebCenter Portal connections from a named connection properties file. Connections that do not exist on the target are imported. Connections that exist on the target are ignored.
The following connections can be imported:
Analytics collector connections
Content repository connections (Oracle WebCenter Content)
Discussions server connections
Events server connections
External application connections
Mail server connections
Oracle Secure Enterprise Search connections
Portlet producer connections (WSRP and PDK-Java)
Pagelet producer connections
Presence server connections
URL connections
Web service connections (used by data controls)
BPEL server connections
Note:
You must have at least the WebLogic Admin role to run the importWebCenterPortalConnections command.
You can only import connection information that was previously exported using the exportWebCenterPortalConnections command.
Newly imported portlet producer, external application, URL, and web service connections are immediately available in the target. For the other connection types, you are prompted to restart the managed server on which WebCenter Portal is deployed to make new connections available.
Syntax
importWebCenterPortalConnections(appName, fileName, [promptForPassword, logFile, server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the application in which to perform this operation. For WebCenter Portal, the application name is always |
fileName
|
Specifies the name and location of a connection properties file. |
promptForPassword
|
Optional. Specifies whether to prompt the user for a password if credentials are required to create a new connection during the import operation. For example, you must enter a password to create a new Oracle-Secure Enterprise Search (SES) connection. Valid values are 1 and 0:
The default is 1. |
logFile
|
Optional. Specifies the name of a local log file in which to record detailed information about the import connection operation. If no value is specified, a log file named |
server
|
Optional. Name of the managed server where WebCenter Portal is deployed. For example, Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the WebCenter Portal application is deployed. |
Example
The following example imports connections defined in a file named connection.properties, located at /myConnections:
wls:/weblogic/serverConfig> importWebCenterPortalConnections(appName='webcenter', fileName='/myConnections/connection.properties')
The following example imports connections defined in a file named connection.properties, located at \myConnections. Detailed information about the import operation is also logged to importConnection.log:
wls:/weblogic/serverConfig> importWebCenterPortalConnections(appName='webcenter', fileName='/myConnections/connection.properties', logFile='importConnection.log')
The following example imports connections defined in a file named connection.properties, located at \myConnections. Do not prompt the user to enter credentials (if required):
wls:/weblogic/serverConfig> importWebCenterPortalConnections(appName='webcenter', fileName='/myConnections/connection.properties', promptForPassword=1)
Module: Oracle WebCenter Portal
Use with WLST: Online
Description
Takes a portal offline or brings a portal online.
Syntax
setSpaceState(appName, spaceName, offline, [server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the application in which to perform this operation. For WebCenter Portal, the name is always |
spaceName
|
Name of the portal you want to take offline or bring online. |
offline
|
Specifies whether to take the portal offline or bring it back online. Valid values are
|
server
|
Optional. Name of the managed server where WebCenter Portal is deployed. For example, Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of WebCenter Portal is deployed. |
Example
The following example takes MyPortal offline:
wls:/weblogic/serverConfig> setSpaceState(appName='webcenter', spaceName='MyPortal', offline=1)
Module: Oracle WebCenter Portal
Use with WLST: Online
Description
Exports a single asset, device, or device group to an export archive (.aar file), using the filename specified.
When you export an asset, you can specify either resourceGUID or resourceName.
When you export a device or device group, you can only specify resourceName.
Note:
To run this command you must have at least the WebLogic Monitor role, as well as the appropriate Create/Edit/Delete permission for the type of asset, device or device group you want to export.
For more information, see "Permissions Required to Perform WebCenter Portal Life Cycle Operations" in Administering Oracle WebCenter Portal.
You cannot export out-of-the-box assets, devices, or device groups.
Syntax
exportWebCenterResource(appName, fileName, resourceType, [resourceGUID, resourceName, spaceName, exportContentDirectory, server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the application in which to perform this operation. For WebCenter Portal, the name is always |
fileName
|
Name of the local file to which the export will be written. |
resourceType
|
Type of resource to export (an asset, device, or device group). Valid values include: Where:
You cannot export or import out-of-the-box assets, devices, or device groups. Note: In this release, |
resourceGUID
|
Optional. Unique ID (GUID) of an asset to export. Internal IDs are available from the About dialog for the asset. This argument is not used when |
resourceName
|
Optional. Display name of an asset, device, or device group to export. Asset display names are available from the About dialog for the asset. Device and device group names are available from the Edit dialog for the device or device group. Note: You cannot export out-of-the-box assets, devices, or device groups. |
spaceName
|
Optional. Name of the portal containing the asset to export. Use this argument to export portal assets, that is, assets that are owned by a particular portal. Omit this argument if you want to export shared assets for WebCenter Portal. This argument defaults to null (shared assets are exported). This argument is not used when |
exportContentDirectory
|
Deprecated. You can no longer include MDS content associated with assets in export archives. Use the standard MDS WLST command |
server
|
Optional. Name of the managed server where the application is deployed. Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the application is deployed. |
Example
The following example exports a page template owned by a portal named MyPortal (in WebCenter Portal) to a local file named myPageTemplateExport.aar:
wls:/weblogic/serverConfig> exportWebCenterResource(appName='webcenter', fileName='myPageTemplateExport.aar', resourceType='pageTemplate', resourceGUID='gsr47d9a5ac_7398_439a_97d2_8b54ce905f7e, spaceName='MyPortal')
The following example exports the same page template owned by a portal named MyPortal but specifies the template's display name rather than the GUID:
wls:/weblogic/serverConfig> exportWebCenterResource(appName='webcenter', fileName='myPageTemplateExport.aar', resourceType='pageTemplate', resourceName='MyPageTemplate, spaceName='MyPortal')
The following example exports a device named MyMobileDevice from WebCenter Portal:
wls:/weblogic/serverConfig> exportWebCenterResource(appName='webcenter', fileName='myDeviceExport.aar', resourceType='device', resourceName='MyMobileDevice')
Module: Oracle WebCenter Portal
Use with WLST: Online
Description
Imports a single asset, device, or device group, from an asset export archive (.aar file).
Note:
To run this command you must have at least the WebLogic Monitor role, as well as the appropriate Create/Edit/Delete permission for the type of asset, device or device group you want to import.
For more information, see "Permissions Required to Perform WebCenter Portal Life Cycle Operations" in Administering Oracle WebCenter Portal.
You cannot export or import out-of-the-box assets, devices, or device groups.
Syntax
importWebCenterResource(appName, fileName, [resourceType, spaceName, server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the application in which to perform this operation. For WebCenter Portal, the name is always |
fileName
|
Name of the archive file that you want to import. |
resourceType
|
Optional. Type of resource to import (an asset, device, or device group). Valid values include: Where:
If the archive (
Note: In this release, |
spaceName
|
Optional. Name of the portal into which the asset is to be imported. Omit this argument if you want to import a shared asset into WebCenter Portal. This argument defaults to null (import shared asset). This argument is not used when |
overwriteContentDirectory
|
Deprecated. You can no longer include MDS content associated with assets in export archives. Use the standard MDS WLST command |
server
|
Optional. Name of the managed server where the application is deployed. Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the application is deployed. |
Example
The following example imports a page template from an archive named myPageTemplateExport.aar to MyPortal in WebCenter Portal:
wls:/weblogic/serverConfig> importWebCenterResource(appName='webcenter',fileName='myPageTemplateExport.aar', spaceName='MyPortal', resourceType='pageTemplate')
The following example imports a device from an archive named myDeviceExport.aar to WebCenter Portal:
wls:/weblogic/serverConfig> importWebCenterResource(appName='webcenter',fileName='myDeviceExport.aar', resourceType='device')
Module: Oracle WebCenter
Use with WLST: Online
Description
Imports translated content (XLF files) to MDS and the WebCenter Portal repository for use in WebCenter Portal.
Syntax
importWebCenterTranslations(appName, server, mdsRootDir, [applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the application in which to perform this operation. For WebCenter Portal, the name is always |
server
|
Name of the target managed server on which WebCenter Portal is deployed. For example, |
mdsRootDir
|
MDS root directory on the file system that contains translated XLF files. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of WebCenter Portal is deployed. |
Example
The following example imports translated content in the directory /scratch/shared/newmd to MDS and the WebCenter Portal repository:
wls:/weblogic/serverConfig> importWebCenterTranslations(appName='webcenter', server='WC_Portal, mdsRootDir='/scratch/shared/newmd')
Module: Oracle WebCenter Portal
Use with WLST: Online
Description
Exports an entire WebCenter Portal application to an export archive (.par file) using the filename provided.
Syntax
exportWebCenterApplication(appName, fileName, [connectionFileName, exportCustomizations, exportData, server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the application in which to perform this operation. For WebCenter Portal, the name is always |
fileName
|
Name of the export archive ( |
connectionFileName
|
Optional. Name of the connections file to which export of connections is performed. |
exportCustomizations
|
Optional. This attribute is deprecated. |
exportData
|
Optional. This attribute is deprecated. |
server
|
Optional. Name of the managed server where WebCenter Portal is deployed. For example, Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of WebCenter Portal is deployed. |
Example
The following example exports WebCenter Portal to a file named myAppExport.par, and exports connections to the connection.properties file.
wls:/weblogic/serverConfig>exportWebCenterApplication(appName='webcenter', fileName='myAppExport.par', connectionFileName='connection.properties')
The following example exports a test WebCenter Portal instance to a file named export.par. In this case, data created during testing (such as lists, events, links, tags, and so on) is not exported.
wls:/weblogic/serverConfig>exportWebCenterApplication(appName='webcenter', fileName='export.par')
Module: Oracle WebCenter Portal
Use with WLST: Online
Description
Imports an entire WebCenter Portal application from an export archive file to a managed server.
After importing WebCenter Portal, you must restart the managed server on which you deployed the application.
Syntax
importWebCenterApplication(appName, fileName, [connectionFileName, importConnections, server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the application in which to perform this operation. For WebCenter Portal, the application name is always |
fileName
|
Name of the export archive that you want to import. |
connectionFileName
|
Optional. Name of the connections file from which import of connections is performed. |
importConnections
|
Optional. Specifies whether to import connections from connectionFileName parameter or from the export archive. Valid values are 1 and 0. The default value is 1. 1 - Import connections 0 - Do not import connections |
server
|
Optional. Name of the managed server where WebCenter Portal is deployed. For example, Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of WebCenter Portal is deployed. |
Example
The following example imports WebCenter Portal from the export archive myAppExport.par.
wls:/weblogic/serverConfig> importWebCenterApplication(appName='webcenter', fileName='myAppExport.par')
Module: Oracle WebCenter Portal
Use with WLST: Online
Description
Exports portlet client metadata and producer customizations and personalizations, for WebCenter Portal. 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.
Syntax
exportPortletClientMetadata(appName, fileName, [exportPersonalizations, server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the application in which to perform this operation. For WebCenter Portal, the name is always |
fileName
|
Name of the export archive ( |
exportPersonalizations
|
Optional. Valid values are
This argument defaults to |
server
|
Optional. Name of the managed server where the application is deployed. For example, Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the application is deployed. |
Example
The following example exports portlet client metadata and producer customizations to an export archive named myExport.ear. Personalizations are not exported.
wls:/weblogic/serverConfig> exportPortletClientMetadata(appName='myApp', fileName='myExport.ear', exportPersonalizations=0)
The following example exports portlet client metadata for an application with the version number V2.0 deployed on the server WC_CustomPortal1.
wls:/weblogic/serverConfig> exportPortletClientMetadata(appName='myApp', fileName='myExport.ear', server='WC_CustomPortal1', applicationVersion='V2.0')
Module: Oracle WebCenter Portal
Use with WLST: Online
Description
Imports portlet client metadata and producer customizations and personalizations from a named export archive.
Producer personalizations are optional on export. Producer personalizations are imported if the export archive specified includes personalizations.
Syntax
importPortletClientMetadata(appName, fileName, [server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the application in which to perform this operation. For WebCenter Portal, the name is always |
fileName
|
Name of the export archive that you want to import. |
server
|
Optional. Name of the managed server where the application is deployed. For example, Required when applications with the same name are deployed to different servers and also when you have a cluster. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the application is deployed. |
Example
The following example imports portlet client metadata and producer customizations and personalizations from an export archive named myExport.ear.
wls:/weblogic/serverConfig> importPortletClientMetadata(appName='myApp', fileName='myExport.ear')
Module: Oracle WebCenter Portal
Use with WLST: Online
Description
Lists outstanding producer imports for a named application.
Producer import fails if a producer used by the application is not available when the application first starts after deployment or an import operation.
Syntax
showProducerImportFailures(appName, [server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the application in which to perform this operation. For WebCenter Portal, the name is always |
server
|
Name of the managed server on which the application is deployed. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the application is deployed. |
Example
The following example shows producer import failures for WebCenter Portal (webcenter):
wls:/weblogic/serverConfig> showProducerImportFailures(appName='webcenter')
Module: Oracle WebCenter Portal
Use with WLST: Online
Description
Imports outstanding producer metadata.
Producer import can fail if a producer used by the application is not available when the application first starts after deployment or an import operation. Use this command to import metadata for any producers for which metadata import previously failed.
Syntax
retryAllFailedProducerImports(appName, [server, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the application in which to perform this operation. For WebCenter Portal, the name is always |
server
|
Name of the managed server on which the application is deployed. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the application is deployed. |
Example
The following example imports missing producer metadata for WebCenter Portal (webcenter):
wls:/weblogic/serverConfig> retryAllFailedProducerImports(appName='webcenter') Importing metadata from the following producers failed for application webcenter. Producer Description : Serialised stack trace: [[ oracle.portlet.client.container.PortletHttpException: HTTP <unknown method> request to URL... ... Failure Id : /oracle/adf/portlet/producerImportFailures/producerImportFailure2 Producer Id : /oracle/adf/portlet/JSR286FilePref Producer Name : JSR286FilePref Tried to re-import producer metadata for application webcenter. Attempt to re-import producer metadata succeeded.
Note:
Errors and exceptions that occurred during a previous attempt to import producers display so you can see which failed producers the command is attempting to re-import.
Module: Oracle WebCenter Portal
Use with WLST: Online
Description
Creates a new managed server with the same resources as a specified, base managed server.
Syntax
cloneWebCenterManagedServer(baseManagedServer, newManagedServer, newManagedServerPort, [verbose])
| Argument | Definition |
|---|---|
baseManagedServer
|
Name of the base managed server. |
newManagedServer
|
Name for the new, cloned managed server. |
newManagedServerPort
|
Port number for the new managed server. |
|
|
Optional. Creates the managed server in verbose mode. Valid values are When set to The default is |
Example
The following example creates a clone of the WC_Portal managed server. The new managed server is named WC_Portal2:
wls:/weblogic/serverConfig> cloneWebCenterManagedServer(baseManagedServer='WC_Portal', newManagedServer='WC_Portal2', newManagedServerPort=1234)
Use the commands listed in Table 2-30 when upgrading from a previous Oracle WebCenter Portal release.
Table 2-30 Oracle WebCenter Portal Upgrade WLST Commands
| Use this command... | To... | Use with WLST... |
|---|---|---|
|
Upgrade WebCenter Portal. |
Online |
|
| listDeprecatedFeaturesUsage |
List deprecated connections, taskflows and portlets used in the upgraded WebCenter Portal application. |
Online |
Module: Oracle WebCenter Portal
Use with WLST: Online
Description
Upgrades WebCenter Portal from release 11g to release 12c.
Oracle WebCenter Portal supports the FrameworkFolders folder service on Content Server. If your existing Oracle WebCenter Portal instance is configured to use Folders_g, this command migrates WebCenter Portal and WebCenter Content Server to FrameworkFolders, and upgrades WebCenter Portal to release 12c.
For more information about upgrade, see Upgrading Oracle WebCenter Portal in Upgrading Oracle WebCenter.
Note:
Before running theupgradeWebCenterPortal command, ensure that Node Manager is up and running.Syntax
upgradeWebCenterPortal(appName, server, migrationDirectory, [contentServerName, contentDbConnectionUrl, contentDbUserName, includeFolders, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the application in which to perform this operation. For WebCenter Portal, the application name is always |
server
|
Name of the managed server where the application is deployed. For example, In a clustered environment where applications share the same content server connection (that is, the applications connect to the same content server and share the same root folder and security group) run this command against only one managed server. |
migrationDirectory
|
Absolute directory path (with write permission) where upgrade logs will be written. If WebCenter Portal is configured to use Folders_g-based Content Server, this directory will contain data related to migration of Folders_g to FrameworkFolders. In case of a multi-node setup, this must be a shared directory that can be accessed and written onto from all nodes. Also, the directory must be accessible using the same path from all nodes. |
contentServerName
|
Optional. Name of the managed server where WebCenter Content Server is deployed. For example, Specify this argument if WebCenter Portal is configured to use Content Server. |
contentDbConnectionUrl
|
Optional. Connection URL for the database where WebCenter Content schema (named |
contentDbUserName
|
Optional. Note: Mandatory if contentDbConnectionUrl is specified. User name of the WebCenter Content schema (named |
includeFolders
|
Optional. Comma separated list of folders to be included for migration from Folders_g to FrameworkFolders. The For example, if you want to migrate Contribution Folders and Common Templates, specify |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the application is deployed. |
Example
The following example upgrades WebCenter Portal deployed to the WC_Spaces managed server. The upgrade logs are written to the directory /tmp/upgrade.
wls:/weblogic/serverConfig> upgradeWebCenterPortal(appName='webcenter', server='WC_Spaces', migrationDirectory='/tmp/upgrade');
The following example upgrades WebCenter Portal and WebCenter Content Server to FrameworkFolders and upgrades WebCenter Portal deployed to the WC_Spaces managed server . The upgrade logs are written to the directory /tmp/upgrade. In addition to the default folders, the Contribution Folders is also migrated.
wls:/weblogic/serverConfig> upgradeWebCenterPortal(appName='webcenter', server='WC_Spaces', migrationDirectory='/tmp/upgrade',
contentServerName='UCM_server1', contentDbConnectionUrl='wccdbhost.example.com:wccdbport:wccdbsid', contentDbUserName='SCHEMA_PREFIX_OCS', includeFolders='Contribution Folders');
Note:
Running theupgradeWebCenterPermissions WLST command displays certain error messages that permissions already exist. For example:
Already in Domain Runtime Tree Command FAILED, Reason: JPS-04201: Cannot grant permission(s). Grant already exists for grantee [GranteeEntry: codeSource=null principals=[[AppRole: appID=webcenter name=webcenter#-#defaultadministrator displayName=null description=null category=null uniquename=cn=webcenter\#-\#defaultadministrator,cn=Roles,cn=webcenter,cn=wc_d omain,cn=JPSContext,cn=jpsRoot guid=66FBB210983411E49F671B16134D61DE members=[] classname=oracle.security.jps.service.policystore.ApplicationRole type=JPS_APPLICATION_ROLE]]].
Such error messages do not affect any functionality. You can safely ignore the error messages and proceed with upgrading your WebCenter Portal instance.
Module: Oracle WebCenter Portal
Use with WLST: Online
Description
Lists deprecated connections, taskflows and portlets used in the upgraded WebCenter Portal application. You can run this command to list deprecated usage in a single portal, multiple portals, or the entire application. This command also generates a detailed report. For more information, see Upgrading Oracle WebCenter Portal in Upgrading Oracle WebCenter.
Syntax
listDeprecatedFeaturesUsage(appName, server, reportDirectory, [portal, applicationVersion])
| Argument | Definition |
|---|---|
appName
|
Name of the application in which to perform this operation. For WebCenter Portal, the application name is always |
server
|
Name of the managed server where the application is deployed. For example, In a clustered environment where applications share the same content server connection (that is, the applications connect to the same content server and share the same root folder and security group) run this command against only one managed server. |
reportDirectory
|
Absolute directory path (with write permission) where reports will be written. |
portal
|
Optional. Comma separated portal names for which report needs to be generated. |
applicationVersion
|
Optional. Version number of the deployed application. Required if more than one version of the application is deployed. |
Example
The following example lists the deprecated connections, taskflows and portlets used in WebCenter Portal deployed to the WC_Spaces managed server. The reports are written to the directory /tmp/report.
wls:/weblogic/serverConfig>listDeprecatedFeaturesUsage(appName='webcenter', server='WC_Portal', reportDirectory='/tmp/report')
The following example lists the deprecated connections, taskflows and portlets used in the HRPortal and FinancePortal portals deployed to the WC_Portal managed server. The reports are written to the directory /tmp/report.
wls:/weblogic/serverConfig>listDeprecatedFeaturesUsage(appName='webcenter', server='WC_Portal', reportDirectory='/tmp/report', portal='HRPortal,FinancePortal')