10 WebCenter Portal Custom WLST Commands

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

Connection name.

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

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

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

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

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 1 (true) and 0 (false).

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

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

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

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

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

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

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

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

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

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

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

Name of the base managed server.

Name for the new, clone managed server.

Port number for the new managed server.

Optional. Creates the managed server in verbose mode. Valid values are 1 and 0.

When set to 1, additional progress information displays during the creation process which is useful for diagnostic purposes.

The default is 0.

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

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

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

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

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

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

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

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

Optional. Specifies whether to send analytics events raised using OpenUsage APIs to the Analytics Collector. Valid values 1 (true) and 0 (false). The default value is 0.

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

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

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

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

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

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

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

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

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

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

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.

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

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

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

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

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

Optional. Specifies whether to send analytics events raised using OpenUsage APIs to the Analytics Collector. Valid values 1 (true) and 0 (false). The default value is false.

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

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

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

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

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

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

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

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

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

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

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

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

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

Name of an existing Analytics Collector connection.

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

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

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

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

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

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

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

Name of the Analytics Collector application.

Optional. Name of the host on which the Analytics Collector is running. The default value is localhost.

Optional. Default port number on which the Analytics Collector listens. The default value is 31314.

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.

Optional. Indicates the network channel on which the Analytics Collector broadcasts a 'heartbeat' to advertise its location to event producers. Valid values are Broadcast and Multicast.

• Broadcast - use the standard network broadcast channel.

• Multicast - use a special fixed multicast address.

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

If set to 1, clusterName must also be defined.

Optional. Name of the Analytics Collector cluster.

Only required when clusterEnabled=1

Optional. Broadcast Analytics Collector listening information every 'n' seconds. The default frequency is 10 seconds.

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

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

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

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

Name of the Analytics Collector application.

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

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

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

Name of the Analytics Collector application.

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

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

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

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

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

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

Determines whether the export includes provider configuration metadata. Valid values are 1 (true) and 0 (false).

Provider configurations are a subset of Activity Graph metadata that you may want to manage separately from the other metadata.

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

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

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

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

Relative path to the XML file containing metadata definitions. For example, metadata/import-metadata.xml.

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

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

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

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

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

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

URN for the Activity Graph provider to export.

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

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

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

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

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

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

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

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

URN for the Activity Graph action to delete.

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

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

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

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

URN for the Activity Graph node class to delete.

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

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

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

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

URN for the Activity Graph similarity calculation to delete.

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

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

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

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

URN for the Activity Graph rank calculation to delete.

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

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

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

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

URN for the action.

URN for the source node class.

URN for the target node class.

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

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

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

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

URN for the QRPP to delete.

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

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

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

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

URN for the Activity Graph provider to delete.

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

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

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

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

Current action URN.

New action URN.

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

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

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

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

Current node class URN.

New node class URN.

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

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

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

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

Name of the Activity Graph property.

Value for the Activity Graph property.

Datatype of the property. Valid values are: String, Int, Float or Boolean.

Values are case sensitive.

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

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

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

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

Name of the Activity Graph property.

Datatype of the property. Valid values are: String, Int, Float or Boolean.

Values are case sensitive.

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

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

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

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

Name of the Activity Graph property that specifies credentials (and has PasswordCredential datatype).

User name associated with the credential property.

Password associated with the user name specified.

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

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

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

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

Year before which to archive activity stream data. For example, 2009.

Month before which to archive activity stream data. For example, enter 1 for January, 2 for February, and so on.

Day of the month before which to archive activity stream data.

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

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

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

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

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

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

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

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

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

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

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

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

Year the space became inactive. For example, 2009.

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

Day of the month the space became inactive.

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

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

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

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

Year from which to restore activity stream data. For example, 2009.

Month from which to restore activity stream data. For example, enter 1 for January, 2 for February, and so on.

Day of the month from which to restore activity stream data.

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

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

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

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

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

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

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

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

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

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

Choose from:

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

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

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

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

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

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

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

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

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

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

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

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

The key store location must be an absolute path.

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

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

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

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

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

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

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

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

• Using the document review functionality available in Oracle AutoVue.

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

• Editing advanced document properties.

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

• Viewing folder and file workflow details.

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

• Previewing files in a slide viewer.

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

• Site Studio integration

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

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

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

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

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

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

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

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.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Name of an existing Oracle WebCenter Content repository connection.

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

Choose from:

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

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

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

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

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

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

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

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

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

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

For example, 4444

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

The key store location must be an absolute path.

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

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

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

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

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

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

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

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

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

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

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.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Optional. Length of time allowed to log in to Oracle Portal (in ms) before issuing a connection timeout message.

If no timeout is set, the default concurrency timeout for the oracle.webcenter.content resource is used (30s or 30000ms). Refer to "Configuring Concurrency Management" Oracle Fusion Middleware Performance Guidefor more information.

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

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

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

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

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

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

Name of an existing Oracle Portal connection.

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

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

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

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

Optional. Length of time allowed to log in to Oracle Portal (in ms) before issuing a connection timeout message.

If no timeout is set, the default concurrency timeout for the oracle.webcenter.content resource is used (30s or 30000ms). Refer to "Configuring Concurrency Management" Oracle Fusion Middleware Performance Guidefor more information.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Application name in which to set Document service properties.

Name for the connection to be used by the Documents service.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Optional. Length of time allowed to log in to the SharePoint repository (in ms) before issuing a connection timeout message.

If no timeout is set, the default concurrency timeout for the oracle.webcenter.content resource is used (30s or 30000ms). Refer to "Configuring Concurrency Management" Oracle Fusion Middleware Performance Guidefor more information.

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

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

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

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

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

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

Name of an existing SharePoint connection.

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

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

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

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

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

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

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

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

Optional. Length of time allowed to log in to the SharePoint repository (in ms) before issuing a connection timeout message.

If no timeout is set, the default concurrency timeout for the oracle.webcenter.content resource is used (30s or 30000ms). Refer to "Configuring Concurrency Management" Oracle Fusion Middleware Performance Guidefor more information.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

<applicationName><WorkflowName>

<applicationName><WorkflowStepName>

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Valid client policy values include:

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

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

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

See also "Managing the Announcements and Discussions Services" in the Oracle Fusion Middleware Administrator's Guide for Oracle WebCenter.

Optional. URI to the policy required to enforce message security and integrity for public access to the discussions server Web service.

Default value is oracle/no_authentication_client_policy.

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

Valid client policy values include:

• oracle/no_authentication_client_policy (None)

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

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

Optional. Recipient key alias to be used for message protected policies (applicable to the OWCDiscussionsServicePublic and OWCDiscussionsServiceAuthenticated endpoints). This is the alias to the certificate that contains the public key of the discussions server in the configured keystore. The default is null.

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

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

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

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

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

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

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

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

Name of an existing discussions server connection.

Optional. URL to the discussions server.

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

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

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

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

Valid client policy values include:

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

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

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

See also "Managing the Announcements and Discussions Services" in the Oracle Fusion Middleware Administrator's Guide for Oracle WebCenter.

Optional. URI to the policy required to enforce message security and integrity for public access to the discussions server Web service.

Default value is oracle/no_authentication_client_policy.

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

Valid client values include:

• oracle/no_authentication_client_policy (None)

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

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

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

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

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

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

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

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

To disable this connection, use the removeDiscussionForumServiceProperty command:

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

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

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

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

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

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

Name of an existing discussions server connection.

Name of the connection property.

Value for the property. Allows any property to be modified on the connection with a key and value.

Optional. Indicates whether the property value must be stored securely using encryption. Valid options are 1 (true) and 0 (false). When 1, the value is encrypted. The default option is 0.

Set to 1 if you are storing passwords.

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

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

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

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

Name of an existing discussions server connection.

Name of the connection property you want to delete.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Name of an existing discussions server connection.

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

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

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

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

Name of the configuration property.

Value for the property.

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

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

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

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

Name of the configuration property.

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

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

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

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

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

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

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

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

Name of the configuration property.

Property value.

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

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

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

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

Name of the configuration property.

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

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

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

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

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

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

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

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

Name of the user or group to add as an administrator on the discussions server.

Optional. Identifies the type of identity. Valid values are USER and GROUP. The default value is USER.

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

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

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

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

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

Name of the user or group to add as an administrator for the category on the discussions server.

Optional. Identifies the type of identity. Valid values are USER and GROUP. The default value is USER.

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

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

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

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

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

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

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

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

Name of the discussions server property.

Value for the discussions server property.

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

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

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

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

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

Name of the discussions server property.

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

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

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

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

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

Name of the discussions server property.

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

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

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

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

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

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

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

Optional. External application login URL.

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

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

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

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

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

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

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

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

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

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

Name of an existing external application connection.

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

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.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Name of an existing external application connection.

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.

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.

Optional. Specifies whether the login field displays on the external application's login screen. Valid options are 1 (true) and 0 (false). This argument defaults to 0.

Note that if you set this argument to 0, you must specify the fieldValue.

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

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

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

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

Name of an existing external application connection.

Name of an existing login field.

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.

Optional. Specifies whether the login field displays on the external application's login screen. Valid options are 1 (true) and 0 (false).

If set to 0, fieldValue must be specified.

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

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

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

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

Connection name.

Login field that you want to remove.

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

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

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

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

Name of an existing external application connection.

Credential type. Valid values are SHARED and PUBLIC.

Name of the shared or public user.

Password for the shared or public user.

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

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

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

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

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

Name of an existing external application connection.

Credential type. Valid values are SHARED and PUBLIC.

Optional. User name of the shared or public user.

Optional. Password for the shared or public user.

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

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

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

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

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

Name of an existing external application connection.

Credential type. Valid values are SHARED and PUBLIC.

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

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

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

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

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

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

Choose LCS for Microsoft Live Communications Server 2005.

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

URL of the sever hosting instant messaging and presence services.

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

Deprecated.

Use the setIMPServiceProperty command to resolve IM addresses.

Optional. External application associated with the presence server connection.

If specified, external application credential information is used to authenticate users against the LCS, OCS, or Lync server. This argument is mandatory for LCS, OCS and Lync server connections.

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

See also addExtAppField and setExtAppField.

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

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

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

This argument is mandatory for OCS/Lync server connections.

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

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

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

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

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

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

Name of an existing presence server connection.