Oracle® Fusion Middleware

WebCenter WLST Command Reference

12c (12.2.1.2.0)

E77130-01

October 2016

This document describes the custom WebLogic Scripting Tool (WLST) commands that can be used to manage installed Oracle Fusion Middleware components, such as WebCenter Portal, WebCenter Content, and WebCenter Enterprise Capture.

Oracle Fusion Middleware WebCenter WLST Command Reference, 12c (12.2.1.2.0)

E77130-01

Copyright © 2007, 2016, Oracle and/or its affiliates. All rights reserved.

Primary Author: Sacheth S

Contributing Author: Savita Thakur

This software and related documentation are provided under a license agreement containing restrictions on use and disclosure and are protected by intellectual property laws. Except as expressly permitted in your license agreement or allowed by law, you may not use, copy, reproduce, translate, broadcast, modify, license, transmit, distribute, exhibit, perform, publish, or display any part, in any form, or by any means. Reverse engineering, disassembly, or decompilation of this software, unless required by law for interoperability, is prohibited.

The information contained herein is subject to change without notice and is not warranted to be error-free. If you find any errors, please report them to us in writing.

If this is software or related documentation that is delivered to the U.S. Government or anyone licensing it on behalf of the U.S. Government, the following notice is applicable:

U.S. GOVERNMENT END USERS: Oracle programs, including any operating system, integrated software, any programs installed on the hardware, and/or documentation, delivered to U.S. Government end users are "commercial computer software" pursuant to the applicable Federal Acquisition Regulation and agency-specific supplemental regulations. As such, use, duplication, disclosure, modification, and adaptation of the programs, including any operating system, integrated software, any programs installed on the hardware, and/or documentation, shall be subject to license terms and license restrictions applicable to the programs. No other rights are granted to the U.S. Government.

This software or hardware is developed for general use in a variety of information management applications. It is not developed or intended for use in any inherently dangerous applications, including applications that may create a risk of personal injury. If you use this software or hardware in dangerous applications, then you shall be responsible to take all appropriate fail-safe, backup, redundancy, and other measures to ensure its safe use. Oracle Corporation and its affiliates disclaim any liability for any damages caused by use of this software or hardware in dangerous applications.

Oracle and Java are registered trademarks of Oracle and/or its affiliates. Other names may be trademarks of their respective owners.

Intel and Intel Xeon are trademarks or registered trademarks of Intel Corporation. All SPARC trademarks are used under license and are trademarks or registered trademarks of SPARC International, Inc. AMD, Opteron, the AMD logo, and the AMD Opteron logo are trademarks or registered trademarks of Advanced Micro Devices. UNIX is a registered trademark of The Open Group.

This software or hardware and documentation may provide access to or information about content, products, and services from third parties. Oracle Corporation and its affiliates are not responsible for and expressly disclaim all warranties of any kind with respect to third-party content, products, and services unless otherwise set forth in an applicable agreement between you and Oracle. Oracle Corporation and its affiliates will not be responsible for any loss, costs, or damages incurred due to your access to or use of third-party content, products, or services, except as set forth in an applicable agreement between you and Oracle.

Contents

Preface

- Documentation Accessibility

- Related Documents

- Conventions

1 Introduction and Roadmap

- 1.1 Document Scope and Audience

- 1.2 Guide to This Document

- 1.3 Related Documentation

- 1.4 What's New and Changed in This Guide

- 1.4.1 New and Changed Features for 12c Release (12.2.1.1)

2 WebCenter Portal Custom WLST Commands

- 2.1 Overview of Oracle WebCenter Portal WLST Command Categories

- 2.2 General

- 2.2.1 deleteConnection

- 2.2.2 setWebCenterServiceFrameworkConfig

- 2.2.3 getWebCenterServiceFrameworkConfig

- 2.2.4 webcenterErrorOccurred

- 2.2.5 getWebCenterConnectionTypes

- 2.3 Analytics

- 2.3.1 createAnalyticsCollectorConnection

- 2.3.2 setAnalyticsCollectorConnection

- 2.3.3 listAnalyticsCollectorConnections

- 2.3.4 setDefaultAnalyticsCollectorConnection

- 2.3.5 listDefaultAnalyticsCollectorConnection

- 2.3.6 setAnalyticsCollectorConfig

- 2.3.7 listAnalyticsCollectorConfig

- 2.3.8 listAnalyticsEventTypes

- 2.4 Activity Stream

- 2.4.1 archiveASByDate

- 2.4.2 archiveASByDeletedObjects

- 2.4.3 archiveASByClosedSpaces

- 2.4.4 archiveASByInactiveSpaces

- 2.4.5 restoreASByDate

- 2.4.6 truncateASArchive

- 2.4.7 archiveASBySpace

- 2.4.8 archiveASAllSpaces

- 2.4.9 archiveASByUser

- 2.4.10 archiveASAllUsers

- 2.4.11 archiveASByDeletedActors

- 2.4.12 showASStatistics

- 2.5 BPEL Server Connection

- 2.5.1 createBPELConnection

- 2.5.2 setBPELConnection

- 2.5.3 listBPELConnections

- 2.6 Content Repository

- 2.6.1 createContentServerConnection

- 2.6.2 setContentServerConnection

- 2.6.3 listContentServerConnections

- 2.6.4 listContentServerProperties

- 2.6.5 setContentServerProperties

- 2.6.6 deleteContentServerProperties

- 2.6.7 deleteContentServerConnection

- 2.6.8 exportFoldersGData

- 2.6.9 migrateFoldersGDataToFrameworkFolders

- 2.7 Discussions and Announcements

- 2.7.1 createDiscussionForumConnection

- 2.7.2 setDiscussionForumConnection

- 2.7.3 setDiscussionForumConnectionProperty

- 2.7.4 deleteDiscussionForumConnectionProperty

- 2.7.5 listDefaultDiscussionForumConnection

- 2.7.6 listDiscussionForumConnections

- 2.7.7 setDefaultDiscussionForumConnection

- 2.7.8 setDiscussionForumServiceProperty

- 2.7.9 removeDiscussionForumServiceProperty

- 2.7.10 listDiscussionForumServiceProperties

- 2.7.11 setAnnouncementServiceProperty

- 2.7.12 removeAnnouncementServiceProperty

- 2.7.13 listAnnouncementServiceProperties

- 2.7.14 addDiscussionsServerAdmin

- 2.7.15 addDiscussionsCategoryAdmin

- 2.7.16 setDiscussionsServerProperty

- 2.7.17 getDiscussionsServerProperty

- 2.7.18 removeDiscussionsServerProperty

- 2.8 External Applications

- 2.8.1 createExtAppConnection

- 2.8.2 setExtAppConnection

- 2.8.3 listExtAppConnections

- 2.8.4 addExtAppField

- 2.8.5 setExtAppField

- 2.8.6 removeExtAppField

- 2.8.7 addExtAppCredential

- 2.8.8 setExtAppCredential

- 2.8.9 removeExtAppCredential

- 2.9 Instant Messaging and Presence

- 2.9.1 createIMPConnection

- 2.9.2 setIMPConnection

- 2.9.3 setIMPConnectionProperty

- 2.9.4 deleteIMPConnectionProperty

- 2.9.5 listIMPAdapters

- 2.9.6 listIMPConnections

- 2.9.7 listDefaultIMPConnection

- 2.9.8 setDefaultIMPConnection

- 2.9.9 setIMPServiceProperty

- 2.9.10 removeIMPServiceProperty

- 2.9.11 listIMPServiceProperties

- 2.9.12 createIMPExtAppConnection

- 2.10 Mail

- 2.10.1 createMailConnection

- 2.10.2 setMailConnection

- 2.10.3 setMailConnectionProperty

- 2.10.4 deleteMailConnectionProperty

- 2.10.5 listMailConnections

- 2.10.6 listDefaultMailConnection

- 2.10.7 setDefaultMailConnection

- 2.10.8 setMailServiceProperty

- 2.10.9 removeMailServiceProperty

- 2.10.10 listMailServiceProperties

- 2.10.11 createMailExtApp

- 2.11 Notifications

- 2.11.1 setNotificationsConfig

- 2.11.2 getNotificationsConfig

- 2.12 People Connections

- 2.12.1 startSyncProfiles

- 2.12.2 stopSyncProfiles

- 2.12.3 isSyncProfilesRunning

- 2.12.4 syncProfile

- 2.12.5 setProfileConfig

- 2.12.6 getProfileConfig

- 2.12.7 listProfileConfig

- 2.12.8 setProfilePhotoSync

- 2.13 Personal Events

- 2.13.1 createPersonalEventConnection

- 2.13.2 setPersonalEventConnection

- 2.13.3 listPersonalEventConnections

- 2.14 Portlet Producers

- 2.14.1 registerWSRPProducer

- 2.14.2 setWSRPProducer

- 2.14.3 listWSRPProducers

- 2.14.4 deregisterWSRPProducer

- 2.14.5 listWSRPProducerRegistrationProperties

- 2.14.6 listWSRPProducerUserCategories

- 2.14.7 mapWSRPProducerUserCategory

- 2.14.8 registerPDKJavaProducer

- 2.14.9 setPDKJavaProducer

- 2.14.10 deregisterPDKJavaProducer

- 2.14.11 listPDKJavaProducers

- 2.14.12 registerPageletProducer

- 2.14.13 setPageletProducer

- 2.14.14 listPageletProducers

- 2.14.15 deregisterPageletProducer

- 2.14.16 refreshProducer

- 2.14.17 listPortletClientConfig

- 2.14.18 setPortletClientConfig

- 2.14.19 getPortletClientConfig

- 2.14.20 registerOOTBProducers

- 2.14.21 deregisterOOTBProducers

- 2.14.22 registerSampleProducers

- 2.14.23 deregisterSampleProducers

- 2.15 Proxy Server

- 2.15.1 getWebCenterProxyConfig

- 2.15.2 setWebCenterProxyConfig

- 2.15.3 unsetWebCenterProxyConfig

- 2.16 Search - Oracle SES Search

- 2.16.1 createSESConnection

- 2.16.2 setSESConnection

- 2.16.3 listSESConnections

- 2.16.4 setSearchSESConfig

- 2.16.5 listSearchSESConfig

- 2.16.6 createFederationTrustedEntity

- 2.16.7 setSESVersion

- 2.16.8 listSESVersion

- 2.16.9 createDefaultSourceGroup

- 2.17 Search - Oracle SES Search Crawlers

- 2.17.1 createSpacesCrawler

- 2.17.2 createDocumentsCrawler

- 2.17.3 createDiscussionsCrawler

- 2.17.4 listSpacesCrawler

- 2.17.5 listDocumentsCrawler

- 2.17.6 listDiscussionsCrawler

- 2.17.7 startSpacesCrawler

- 2.17.8 startDocumentsCrawler

- 2.17.9 startDiscussionsCrawler

- 2.17.10 stopSpacesCrawler

- 2.17.11 stopDocumentsCrawler

- 2.17.12 stopDiscussionsCrawler

- 2.17.13 deleteSpacesCrawler

- 2.17.14 deleteDocumentsCrawler

- 2.17.15 deleteDiscussionsCrawler

- 2.18 Search - WebCenter Portal Search

- 2.18.1 setSearchConfig

- 2.18.2 listSearchConfig

- 2.18.3 setSpacesCrawlProperties

- 2.18.4 getSpacesCrawlProperties

- 2.19 WebCenter Portal Application

- 2.19.1 getSpacesWorkflowConnectionName

- 2.19.2 setSpacesWorkflowConnectionName

- 2.20 Identity Store

- 2.20.1 setWebCenterIdStoreSearchConfig

- 2.20.2 listWebCenterIdStoreSearchConfig

- 2.21 Lifecycle

- 2.21.1 deployWebCenterPortal

- 2.21.2 propagateWebCenterPortal

- 2.21.3 exportWebCenterPortals

- 2.21.4 exportWebCenterPortalTemplates

- 2.21.5 importWebCenterPortals

- 2.21.6 listWebCenterPortalArchive

- 2.21.7 exportWebCenterPortalConnections

- 2.21.8 importWebCenterPortalConnections

- 2.21.9 setSpaceState

- 2.21.10 exportWebCenterResource

- 2.21.11 importWebCenterResource

- 2.21.12 importWebCenterTranslations

- 2.21.13 exportWebCenterApplication

- 2.21.14 importWebCenterApplication

- 2.21.15 exportPortletClientMetadata

- 2.21.16 importPortletClientMetadata

- 2.21.17 showProducerImportFailures

- 2.21.18 retryAllFailedProducerImports

- 2.21.19 cloneWebCenterManagedServer

- 2.22 Upgrade

- 2.22.1 upgradeWebCenterPortal

- 2.22.2 listDeprecatedFeaturesUsage

3 Oracle WebCenter Content Custom WLST Commands

- 3.1 Overview of WLST WebCenter Content Command Categories

- 3.2 WLST WebCenter Content Help

- 3.3 Getter and Setter Methods Implementation

- 3.4 Server Configuration Commands

- 3.4.1 getUCMHttpServerAddress

- 3.4.2 getUCMServerPort

- 3.4.3 setUCMServerPort

- 3.4.4 getUCMIpAddressFilter

- 3.4.5 setUCMIpAddressFilter

- 3.4.6 getUCMUseSSL

- 3.5 Email Configuration Commands

- 3.5.1 getUCMMailServer

- 3.5.2 setUCMMailServer

- 3.5.3 getUCMSmtpPort

- 3.5.4 getUCMSysAdminAddress

- 3.5.5 setUCMSysAdminAddress

- 3.6 System Status Commands

- 3.6.1 getUCMCSVersion

- 3.6.2 getUCMServerUptime

- 3.7 General Configuration Commands

- 3.7.1 getUCMOverRideFormat

- 3.7.2 setUCMOverRideFormat

- 3.7.3 getUCMDownloadApplet

- 3.7.4 setUCMDownloadApplet

- 3.7.5 getUCMMultiUpload

- 3.7.6 setUCMMultiUpload

- 3.7.7 getUCMUseAccounts

- 3.7.8 setUCMUseAccounts

- 3.7.9 getUCMIsAutoNumber

- 3.7.10 setUCMIsAutoNumber

- 3.7.11 getUCMAutoNumberPrefix

- 3.7.12 setUCMAutoNumberPrefix

- 3.7.13 getUCMMajorRevLabelSeq

- 3.7.14 setUCMMajorRevLabelSeq

- 3.7.15 getUCMMinorRevLabelSeq

- 3.7.16 setUCMMinorRevLabelSeq

- 3.7.17 getUCMJspServerEnabled

- 3.7.18 setUCMJspServerEnabled

- 3.7.19 getUCMJspEnabledGroups

- 3.7.20 setUCMJspEnabledGroups

- 3.8 Content Security Configuration Commands

- 3.8.1 getUCMCopyAccess

- 3.8.2 setUCMCopyAccess

- 3.8.3 getUCMExclusiveCheckout

- 3.8.4 setUCMExclusiveCheckout

- 3.8.5 getUCMAuthorDelete

- 3.8.6 setUCMAuthorDelete

- 3.8.7 getUCMShowOnlyKnownAccounts

- 3.8.8 setUCMShowOnlyKnownAccounts

- 3.9 Component Manager Configuration Commands

- 3.9.1 getUCMComponentStatus

- 3.9.2 setUCMComponentStatus

- 3.9.3 installUCMComponent

- 3.9.4 uninstallUCMComponent

- 3.9.5 downloadUCMComponent

- 3.9.6 getUCMComponentConfig

- 3.9.7 updateUCMComponentConfig

- 3.10 Records Management Configuration Commands

- 3.10.1 getRMLevel

- 3.10.2 getRMConfigurationLevel

- 3.10.3 getRMFeatures

- 3.10.4 getRMDispositionActions

- 3.10.5 rmUpdate

- 3.10.6 addOutgoingProvider

- 3.10.7 registerSource

- 3.11 User Interface Commands

- 3.11.1 displayWccAdfConfig

- 3.11.2 updateWccAdfConfig

- 3.12 User Interface Connection Commands

- 3.12.1 createRIDCConnection

- 3.12.2 updateRIDCConnection

- 3.12.3 listRIDCConnections

- 3.12.4 deleteRIDCConnection

- 3.12.5 displayRIDCConnection

4 Oracle WebCenter Enterprise Capture Custom WLST Commands

- 4.1 Overview of WLST Oracle WebCenter Enterprise Capture Command Categories

- 4.2 Configuration Commands

- 4.2.1 listWorkspaces

- 4.2.2 listBatches

- 4.2.3 exportBatch

- 4.2.4 exportWorkspace

- 4.2.5 importWorkspace

- 4.2.6 unlockBatch

- 4.2.7 listLockedBatches

- 4.2.8 listCaptureConfig

- 4.2.9 getCaptureConfig

- 4.2.10 setCaptureConfig

- 4.2.11 scanForClientBundles

- 4.2.12 deleteBundle

- 4.2.13 setObjectProperty

- 4.2.14 getObjectProperty

- 4.2.15 setObjectCredentials

- 4.2.16 updateScript

- 4.2.17 cloneWorkspaceFromID

- 4.2.18 cloneWorkspaceFromFile

- 4.2.19 listImportHATokens

- 4.2.20 deleteImportHAToken

A Capture Object Properties

- A.1 Client Profile Object Properties

- A.2 Import Processor Job Object Properties

- A.2.1 General Import Job Properties

- A.2.2 Folder Import Job Specific Properties

- A.2.3 List File Import Job Specific Properties

- A.2.4 Email Job Specific Properties

- A.3 Recognition Processor Job Object Properties

- A.3.1 General Recognition Job Properties

- A.3.2 BarcodeDefinition Class Properties

- A.3.3 DocumentDefinition Class Properties

- A.3.4 RecognitionJobField Class Properties

- A.3.5 SeparatorDefinition Class Properties

- A.4 Commit Profile Object Properties

- A.4.1 General Commit Profile Properties

- A.4.2 Text File Commit Profile Specific Properties

- A.4.3 Webcenter Content Commit Profile Specific Properties

- A.4.4 ContentAttributeMappingInfo Class Properties

- A.4.5 CaptureToContentFieldMapping Class Properties

- A.4.6 ContentFieldNameInfo Class Properties

- A.4.7 Webcenter Imaging Commit Profile Specific Properties

- A.4.8 PDF Searchable Document Output Specific Properties

- A.4.9 DOCS Commit Driver Properties

- A.5 Document Conversion Job Object Properties

Preface

This document describes the custom WebLogic Scripting Tool (WLST) commands that can be used to manage installed Oracle Fusion Middleware components, such as WebCenter Portal, WebCenter Content, and WebCenter Enterprise Capture.

Documentation Accessibility

For information about Oracle's commitment to accessibility, visit the Oracle Accessibility Program website at http://www.oracle.com/pls/topic/lookup?ctx=acc&id=docacc.

Access to Oracle Support

Oracle customers that have purchased support have access to electronic support through My Oracle Support. For information, visit http://www.oracle.com/pls/topic/lookup?ctx=acc&id=info or visit http://www.oracle.com/pls/topic/lookup?ctx=acc&id=trs if you are hearing impaired.

Related Documents

Complete documentation for all of the products mentioned in this guide is available from the Oracle Help Center at http://docs.oracle.com/en/middleware/.

Conventions

The following text conventions are used in this document:

Convention

Meaning

boldface

Boldface type indicates graphical user interface elements associated with an action, or terms defined in text or the glossary.

italic

Italic type indicates book titles, emphasis, or placeholder variables for which you supply particular values.

monospace

Monospace type indicates commands within a paragraph, URLs, code in examples, text that appears on the screen, or text that you enter.

1 Introduction and Roadmap

This section describes the contents and organization of this guide—WebCenter WLST Command Reference.

- Document Scope and Audience

- Guide to This Document

- Related Documentation

- What's New and Changed in This Guide

1.1 Document Scope and Audience

This document describes the custom WebLogic Scripting Tool (WLST) commands that can be used to manage installed Oracle Fusion Middleware components, such as WebCenter Portal, WebCenter Content, and WebCenter Enterprise Capture.

Note:

Custom WLST commands for a given Oracle Fusion Middleware component are available for use only if the component is installed in the ORACLE_HOME directory.

This document is written for WebLogic Server administrators and operators who deploy Java EE applications using the Java Platform, Enterprise Edition (Java EE) from Oracle. It is assumed that readers are familiar with Web technologies and the operating system and platform where WebLogic Server is installed.

1.2 Guide to This Document

This document is organized as follows:

- This chapter, "Introduction and Roadmap," introduces the organization of this guide and lists related documentation.

- WebCenter Portal Custom WLST Commands, provides detailed descriptions of the custom WLST commands for Oracle WebCenter Portal.

- Oracle WebCenter Content Custom WLST Commands, provides detailed descriptions of the custom WLST commands for Oracle WebCenter Content.

- Oracle WebCenter Enterprise Capture Custom WLST Commands , provides detailed descriptions of the custom WLST commands for Oracle WebCenter Capture.

1.3 Related Documentation

For information about how to use the WebLogic Scripting Tool, refer to Understanding the WebLogic Scripting Tool.

1.4 What's New and Changed in This Guide

This section introduces the new and changed Custom WLST Commands for WebCenter Content, WebCenter Enterprise Capture, and WebCenter Portal. This section contains the following topic:

- New and Changed Features for 12c Release (12.2.1.1)

1.4.1 New and Changed Features for 12c Release (12.2.1.1)

Oracle WebCenter Enterprise Capture

- Added a list of DOCS Commit Driver Properties that can be set for a Capture object.

- Added a new set of properties to the General Recognition Job Properties section.

2 WebCenter Portal Custom WLST Commands

This chapter describes WebLogic Scripting Tool (WLST) commands for Oracle WebCenter Portal. These commands enable you to configure WebCenter Portal and components from the command-line.

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

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

- Overview of Oracle WebCenter Portal WLST Command Categories

- General

- Analytics

- Activity Stream

- BPEL Server Connection

- Content Repository

- Discussions and Announcements

- External Applications

- Instant Messaging and Presence

- Mail

- Notifications

- People Connections

- Personal Events

- Portlet Producers

- Proxy Server

- Search - Oracle SES Search

- Search - Oracle SES Search Crawlers

- Search - WebCenter Portal Search

- WebCenter Portal Application

- Identity Store

- Lifecycle

- Upgrade

2.1 Overview of Oracle WebCenter Portal WLST Command Categories

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

General

Manage connections for WebCenter Portal.

Analytics

Manage analytics collector connections and configure the analytics collector.

Activity Stream

Archive and restore activity stream data.

Content Repository

Manage content repository connections and configure document services.

Discussions and Announcements

Manage discussions server connections and configure discussions and announcements.

External Applications

Manage external application connections.

Instant Messaging and Presence

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

Mail

Manage mail server connections and configure mail.

Notifications

Manage settings for notifications.

People Connections

Manage profile information.

Personal Events

Manage personal event server connections.

Portlet Producers

Manage portlet producers.

Proxy Server

Manage proxy settings for RSS and activity stream.

Search - Oracle SES Search

Manage Oracle Secure Enterprise Search (SES) connections and other search-related properties.

Search - Oracle SES Search Crawlers

Manage Oracle Secure Enterprise Search (SES) crawlers.

Search - WebCenter Portal Search

Manage search crawlers for WebCenter Portal.

BPEL Server Connection

Manage BPEL server connections.

WebCenter Portal Application

Manage WebCenter Portal workflow settings and portal metadata.

Identity Store

Configure options while searching an application's identity store.

Lifecycle

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

Upgrade

Upgrade from a previous Oracle WebCenter Portal release.

2.2 General

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

deleteConnection

Delete any connection.

Online

getWebCenterConnectionTypes

List all connection types.

Online

setWebCenterServiceFrameworkConfig

Set WebCenter Portal Service Framework configuration properties.

Online

getWebCenterServiceFrameworkConfig

Return WebCenter Portal Framework configuration properties.

Online

webcenterErrorOccurred

Return status information for the last Oracle WebCenter Portal command executed.

Online

2.2.1 deleteConnection

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

name

Connection name.

server

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

Required when applications with the same name are deployed to different servers and also when you have a 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')

2.2.2 setWebCenterServiceFrameworkConfig

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

Sets configuration properties for Oracle WebCenter Portal's services framework, such as the Resource Action Handler class and display as popup properties.

Syntax

setWebCenterServiceFrameworkConfig(appName, [resourceActionHandlerClassName, resourceActionHandlerDisplayInPopup, server, applicationVersion])

Argument

Definition

appName

Name of the application in which to perform this operation.

For WebCenter Portal, the application name is always webcenter.

resourceActionHandlerClassName

Optional. Class used by the Service Framework Resource Action Handler.

resourceActionHandlerDisplayInPopup

Optional. Indicates whether the Resource Action Handler displays resources in a popup or inline. Valid options are 1 (true) and 0 (false).

server

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

Required when applications with the same name are deployed to different servers and also when you have a 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.

2.2.3 getWebCenterServiceFrameworkConfig

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

Returns WebCenter Portal Service Framework configuration property settings, such as:

- resourceActionHandlerClassName: Class currently used by the WebCenter Portal Service Framework Resource Action Handler

- resourceActionHandlerDisplayInPopup: Indicates whether the Resource Action Handler displays resources in a popup or inline. Valid options are 1 (true) and 0 (false).

Syntax

getWebCenterServiceFrameworkConfig(appName, [server, applicationVersion])

Argument

Definition

appName

Name of the application in which to perform this operation.

For WebCenter Portal, the application name is always webcenter.

server

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

Required when applications with the same name are deployed to different servers and also when you have a 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

2.2.4 webcenterErrorOccurred

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

Returns the status of last WebCenter Portal command executed.

Use the webcenterErrorOccurred command to determine the status of the last WebCenter Portal command executed. The command returns 1 if an error occurred or 0 otherwise.

Syntax

webcenterErrorOccurred ()

Example

The following example returns 1 if an error occurred:

wls:/mydomain/serverConfig> webcenterErrorOccurred()

2.2.5 getWebCenterConnectionTypes

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

Lists all the Oracle WebCenter Portal connection types.

Syntax

getWebCenterConnectionTypes(appName, [server, applicationVersion])

Argument

Definition

appName

Name of the application in which to perform this operation.

For WebCenter Portal, the application name is always webcenter.

server

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

Required when applications with the same name are deployed to different servers and also when you have a 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')

2.3 Analytics

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. For details, see Oracle Fusion Middleware Administering Oracle WebCenter Portal.

Table 2-3  Analytics Collector Connection WLST Commands

Use this command...

To...

Use with WLST...

createAnalyticsCollectorConnection

Create a connection to an analytics collector for WebCenter Portal.

Online

setAnalyticsCollectorConnection

Edit an existing analytics collector connection.

Online

listAnalyticsCollectorConnections

List all of the analytics collector connections that are configured for WebCenter Portal.

Online

setDefaultAnalyticsCollectorConnection

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

Online

listDefaultAnalyticsCollectorConnection

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

setAnalyticsCollectorConfig

Set analytics collector options, and cluster options if operating a clustered environment.

Online

listAnalyticsCollectorConfig

Return analytics collector settings.

Online

listAnalyticsEventTypes

List events currently registered with the analytics collector.

Online

2.3.1 createAnalyticsCollectorConnection

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

Creates a connection to an analytics collector for a named application.

Events raised in WebCenter Portal 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 webcenter.

connectionName

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

isUnicast

Optional. Specifies whether events are sent to a clustered analytics collector in multicast mode or whether a single analytics collector using unicast communication is required.

Valid values are 1 (true) and 0 (false). The default value is 1 (unicast).

collectorHost

Optional. Host name where the analytics collector is running. The default value is localhost.

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

clusterName

Optional. Name of the cluster where a clustered analytics collector is running.

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

collectorPort

Optional. Port on which the analytics collector listens for events. The default value is 31314.

isEnabled

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

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

timeout

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

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

default

Optional. Indicates whether this connection is the default (or active) analytics collector connection for the application.

Valid values are 1 (true) and 0 (false). When set to 1, the application sends events on this connection. When set to 0, the connection is not used. The default for this argument is 0.

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

server

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

Required when applications with the same name are deployed to different servers and also when you have a 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)

2.3.2 setAnalyticsCollectorConnection

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

Edits an existing analytics collector connection for a named application.

Events raised in WebCenter Portal 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 webcenter.

connectionName

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

isUnicast

Optional. Specifies whether events are sent to a clustered analytics collector in multicast mode or whether a single analytics collector using unicast communication is required.

Valid values are 1 (true) and 0 (false). The default value is 1 (unicast).

collectorHost

Optional. Host name where the analytics collector is running. The default value is localhost.

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

clusterName

Optional. Name of the cluster where a clustered analytics collector is running.

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

collectorPort

Optional. Port on which the analytics collector listens for events.

The default value is 31314.

isEnabled

Optional. Specifies whether to send analytics events raised using OpenUsage APIs to the analytics collector.

Valid values are 1 (true) and 0 (false). The default value is false.

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

timeout

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

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

default

Optional. Indicates whether this connection is the default (or active) analytics collector connection for the application.

Valid values are 1 (true) and 0 (false). When set to 1, the application sends events on this connection. When set to 0, the connection is not used. The default for this argument is 0.

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

server

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

Required when applications with the same name are deployed to different servers and also when you have a 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)

2.3.3 listAnalyticsCollectorConnections

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

Lists connection names and details for all analytics collector connections that are configured for a named application.

Syntax

listAnalyticsCollectorConnections(appName, [server, applicationVersion])

Argument

Definition

appName

Name of the application in which to perform this operation.

For WebCenter Portal, the application name is always webcenter.

server

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

Required when applications with the same name are deployed to different servers and also when you have a 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)
------------------

2.3.4 setDefaultAnalyticsCollectorConnection

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

Specifies the default analytics collector connection for a named application.

The default analytics collector connection is used to send events raised in WebCenter Portal 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 webcenter.

name

Name of an existing analytics collector connection.

server

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

Required when applications with the same name are deployed to different servers and also when you have a 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='')

2.3.5 listDefaultAnalyticsCollectorConnection

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

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

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

Syntax

listDefaultAnalyticsCollectorConnection(appName, [server, applicationVersion])

Argument

Definition

appName

Name of the application in which to perform this operation.

For WebCenter Portal, the application name is always webcenter.

server

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

Required when applications with the same name are deployed to different servers and also when you have a 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)
------------------

2.3.6 setAnalyticsCollectorConfig

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

Configure the analytics collector deployed on the WC_Utilities managed server. Additionally, in a clustered environment, use this commands to set cluster settings.

Syntax

setAnalyticsCollectorConfig(appName, [collectorHost, defaultPort, maxPort, broadcastType, clusterEnabled, clusterName, heartbeatFrequency, server, applicationVersion])

Argument

Definition

appName

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

collectorHost

Optional. Name of the host on which the analytics collector is running.

The default value is localhost.

defaultPort

Optional. Default port number on which the analytics collector listens.

The default value is 31314.

maxPort

Optional. Highest port number that the analytics collector can use when allocating a listener.

This property is mostly used in a clustered environment where more than one collector is running in the same box. Each collector listens for incoming UDP messages on a free port within a given port range. The range is from the default port number to the maxPort number.

broadcastType

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

- Broadcast - use the standard network broadcast channel.

- Multicast - use a special fixed multicast address.

clusterEnabled

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

If set to 1, clusterName must also be defined.

clusterName

Optional. Name of the analytics collector cluster.

Only required when clusterEnabled=1

heartbeatFrequency

Optional. Broadcast analytics collector listening information every 'n' seconds. The default frequency is 10 seconds.

The analytics collector periodically broadcasts a 'heartbeat' to advertise its location (hostName). In a clustered environment, WebCenter Portal uses the heartbeat to determine which analytics collectors are available.

server

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

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

applicationVersion

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

Example

The following example changes the default port to 31315:

wls:/weblogic/serverConfig>setAnalyticsCollectorConfig(appName='analytics-collector', defaultPort=31315)

2.3.7 listAnalyticsCollectorConfig

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

Returns analytics collector settings.

Syntax

listAnalyticsCollectorConfig(appName, [server, applicationVersion])

Argument

Definition

appName

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

server

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

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

applicationVersion

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

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

2.3.8 listAnalyticsEventTypes

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

Lists all the events currently registered with the analytics collector.

Syntax

listAnalyticsEventTypes(appName, [server, applicationVersion])

Argument

Definition

appName

Name of the application in which to perform this operation.

For WebCenter Portal, the application name is always webcenter.

server

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

Required when applications with the same name are deployed to different servers and also when you have 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}DISCUSSION_ANNOUNCEMENTEDIT
{HTTP://WWW.ORACLE.COM/ANALYTICS/WC}DISCUSSION_TOPICDELETE
{HTTP://WWW.ORACLE.COM/ANALYTICS/WC}PAGEEDIT
{HTTP://WWW.ORACLE.COM/ANALYTICS/WC}DOCLIB_DOCUMENTCREATE
{HTTP://WWW.ORACLE.COM/ANALYTICS/WC}LOGINS
...

2.4 Activity Stream

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

archiveASByDate

Archive activity stream data that is older than a specified date.

Online

archiveASByDeletedObjects

Archive activity stream data associated with deleted objects.

Online

archiveASByClosedSpaces

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

Online

archiveASByInactiveSpaces

Archive activity stream data associated with portals that have been inactive since a specified date.

Online

restoreASByDate

Restore archived activity stream data from a specified date into production tables.

Online

truncateASArchive

Truncates activity stream archive data.

Online

archiveASBySpace

Archive activity stream data associated with a portal.

Online

archiveASAllSpaces

Archive activity stream data associated with all portals.

Online

archiveASByUser

Archive activity stream data associated with a user.

Online

archiveASAllUsers

Archive activity stream data associated with all users.

Online

archiveASByDeletedActors

Archive activity stream data associated with deleted actors.

Online

showASStatistics

Report activity stream statistics.

Online

2.4.1 archiveASByDate

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

Archives activity stream data that is older than a specified date.

This command moves data from production tables to archive tables. Exceptions include WC_ACTOR_DETAIL and WC_OBJECT_DETAIL—data in these tables is copied to archive tables rather than moved.

Rows in WC_OBJECT_DETAIL that are not used by any activity element are deleted.

Syntax

archiveASByDate(appName, year, month, day, [server, applicationVersion])

Argument

Definition

appName

Name of the application in which to perform this operation.

For WebCenter Portal, the application name is always webcenter.

year

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

month

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

day

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

server

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

Required when applications with the same name are deployed to different servers and also when you have a 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)

2.4.2 archiveASByDeletedObjects

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

server

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

Required when applications with the same name are deployed to different servers and also when you have a 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

2.4.3 archiveASByClosedSpaces

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

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

This command moves data from production tables to archive tables, except for WC_ACTOR_DETAIL—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 webcenter.

server

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

Required when applications with the same name are deployed to different servers and also when you have a 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')

2.4.4 archiveASByInactiveSpaces

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

Archives activity stream data associated with portals that have been inactive since a specified date. An inactive 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 webcenter.

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, WC_Portal.

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)

2.4.5 restoreASByDate

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

Restores archived activity stream data from a specified date into production tables.

This command moves data from archive tables to production tables, except for WC_ACTOR_DETAIL—data in this table is not restored because data is not deleted from this table during the archive process.

Rows that already exist in the production tables are not changed during the restore process.

Syntax

restoreASByDate(appName, year, month, day, [server, applicationVersion])

Argument

Definition

appName

Name of the application in which to perform this operation.

For WebCenter Portal, the application name is always webcenter.

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, WC_Portal.

Required when applications with the same name are deployed to different servers and also when you have a 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)

2.4.6 truncateASArchive

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

Truncates activity stream archive data.

Syntax

truncateASArchive(appName, [server, applicationVersion])

Argument

Definition

appName

Name of the application in which to perform this operation.

For WebCenter Portal, the application name is always webcenter.

server

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

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

2.4.7 archiveASBySpace

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

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

This command moves data from production tables to archive tables.

Syntax

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

Argument

Definition

appName

Name of the application in which to perform this operation.

For WebCenter Portal, the application name is always webcenter.

space

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

cnt

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

server

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

Required when applications with the same name are deployed to different servers and also when you have a 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)

2.4.8 archiveASAllSpaces

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

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

This command moves data from production tables to archive tables.

Syntax

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

Argument

Definition

appName

Name of the application on which to perform this operation.

For WebCenter Portal, the application name is always webcenter.

cnt

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

server

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

Required when applications with the same name are deployed to different servers and also when you have a 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)

2.4.9 archiveASByUser

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

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

This command moves data from production tables to archive tables.

Syntax

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

Argument

Definition

appName

Name of the application in which to perform this operation.

For WebCenter Portal, the application name is always webcenter.

actor

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

cnt

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

server

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

Required when applications with the same name are deployed to different servers and also when you have a 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)

2.4.10 archiveASAllUsers

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

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

This command moves data from production tables to archive tables.

Syntax

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

Argument

Definition

appName

Name of the application in which to perform this operation.

For WebCenter Portal, the application name is always webcenter.

cnt

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

server

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

Required when applications with the same name are deployed to different servers and also when you have a 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)

2.4.11 archiveASByDeletedActors

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

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

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

Syntax

archiveASByDeletedActors(appName, [server, applicationVersion])

Argument

Definition

appName

Name of the application in which to perform this operation.

For WebCenter Portal, the application name is always webcenter.

server

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

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

2.4.12 showASStatistics

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

Reports various activity stream statistics:

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

- Number of activities for top "N" users, 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 webcenter.

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, 50.

server

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

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

2.5 BPEL Server Connection

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

createBPELConnection

Create a connection to a BPEL server for a named application.

Online

setBPELConnection

Edit an existing BPEL server connection.

Online

listBPELConnections

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

Online

2.5.1 createBPELConnection

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

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: protocol://host:port

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:

- oracle/wss10_saml_token_client_policy—use to access the BPEL server with the default, non message protected policy.

- oracle/wss10_saml_token_with_message_protection_client_policy—use to access the BPEL server with a message protected policy. If selected, you must configure keys stores both in your application and in the BPEL application.

- GPA—use if your environment supports Global Policy Attachments (GPA).

If you omit this argument, the connection defaults to oracle/wss10_saml_token_client_policy.

recipientKeyAlias

Optional. Recipient key alias to be used for message protected SAML policy authentication. Only required when the BPEL server connection is using a SAML token policy for authentication and the application's worklist 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 url argument. For example, when SSO or HTTPS is configured.

Use the format: protocol://host:port

The default is null.

For performance reasons, in an HTTPS or SSO environment, linkUrl specifies user access to BPEL worklist items, through HTTPS or SSO web servers, whereas 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, WC_Portal.

Required when applications with the same name are deployed to different servers and also 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')

2.5.2 setBPELConnection

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

name

Existing BPEL server connection name.

url

Optional. URL required to access the BPEL server.

Use the format: <protocol>://<host>:<port>

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:

- oracle/wss10_saml_token_client_policy—use to access the BPEL server with the default, non message protected policy.

- oracle/wss10_saml_token_with_message_protection_client_policy—use to access the BPEL server with a message protected policy. If selected, you must configure keys stores both in your application and in the BPEL application.

- GPA—use if your environment supports Global Policy Attachments (GPA).

If you omit this argument, the connection defaults to oracle/wss10_saml_token_client_policy.

recipientKeyAlias

Optional. Recipient key alias to be used for message protected SAML policy authentication. Only required when the BPEL server connection is using a SAML token policy for authentication and the application's worklist 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 url argument. For example, when SSO or https is configured. Use the format: protocol://host:port

For example, http://mySSO.host.com:7777

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, WC_Portal.

Required when applications with the same name are deployed to different servers and also 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')

2.5.3 listBPELConnections

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

Without any arguments, this command lists all the BPEL connections that are configured for a 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 webcenter.

verbose

Optional. Displays BPEL server connection details in verbose mode. Valid options are 1 (true) and 0 (false).

When set to 1, listBPELConnections lists all of the BPEL server connections that are configured, along with their details.

When set to 0, listBPELConnections lists connection names only. This argument defaults to 0.

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

name

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

To list all the connections, omit the name argument.

server

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

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

2.6 Content Repository

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

createContentServerConnection

Create a connection to an Oracle WebCenter Content repository.

Online

setContentServerConnection

Edit an existing Oracle WebCenter Content repository connection.

Online

listContentServerConnections

List individual or all Oracle WebCenter Content repository connections that are configured for a named application.

Online

listContentServerProperties

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

Online

setContentServerProperties

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

Online

deleteContentServerProperties

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

Online

deleteContentServerConnection

Delete a connection to an Oracle WebCenter Content repository.

Online

exportFoldersGData

Export Folders_g data to a specified location.

Online

migrateFoldersGDataToFrameworkFolders

Migrate Folders_g data to FrameworkFolders.

Online

2.6.1 createContentServerConnection

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

name

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

socketType

Specifies whether Oracle WebCenter Content's Content Server connects on the content server listener port or the web server filter, and whether the listener port is SSL enabled.

Valid values are socket, web, socketssl, and jaxws. This option has no default.

Choose from:

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

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

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

- jaxws—Use a Java API for XML web services connection to connect to the Content Server.

url

Optional. Content Server URL. Required only if socketType is set to web or jaxws.

URL should be in the format:

http://hostname:port/web_root/plugin_root

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

serverHost

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

serverPort

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

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

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

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

keystoreLocation

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

The key store location must be an absolute path.

keystorePassword

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

privateKeyAlias

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

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

privateKeyPassword

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

webContextRoot

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

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

Note: To fully enable these Oracle WebCenter Content features you must access WebCenter Portal 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 socketType is jaxws. For example: oracle/wss11_saml_token_with_message_protection_service_policy

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

cacheInvalidationInterval

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

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

binaryCacheMaxEntrySize

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

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 socketType is jaxws. User name with administrative rights for this Content Server instance. This user will be used to fetch content type information based on profiles and track document changes for cache invalidation purpose.

Defaults to sysadmin.

adminPassword

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

extAppId

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

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

timeout

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

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

- Login timeout - the default concurrency timeout for the oracle.webcenter.content resource is used (30s or 30000ms).

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

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

isPrimary

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

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

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

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

Note: If you mark a connection as primary, you must run the setContentServerProperties WLST command to specify certain additional properties required for the primary WebCenter Content Server connection.

server

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

Required when applications with the same name are deployed to different servers and also when you have a 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')

2.6.2 setContentServerConnection

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

name

Name of an existing Oracle WebCenter Content repository connection.

socketType

Optional. Specifies whether the Oracle WebCenter Content's Content Server connects on the content server listener port or the web server filter, and whether the listener port is SSL enabled.

Valid values are socket, web, and socketssl. This option has no default.

Choose from:

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

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

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

- jaxws—Use a Java API for XML web services connection to connect to the Content Server.

url

Optional. Content Server URL. Required only if socketType is set to web or jaxws.

URL should be in the format:

http://hostname:port/web_root/plugin_root

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

serverHost

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

serverPort

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

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

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

For example, 4444

keystoreLocation

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

The key store location must be an absolute path.

keystorePassword

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

privateKeyAlias

Optional. Client private key alias in the key store. Required only if socketType is set to socketssl.

The value for this argument must be a string that contains neither special characters nor white space.

privateKeyPassword

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

webContextRoot

Optional. Web server context root for the Content Server if Content Server is front-ended with Oracle HTTP Server (OHS). Use the format /<context_root>. For example, /cs.

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. For information about setting up OHS to front-end WebCenter Portal, see Oracle HTTP Server Configuration for WebCenter Portal in Oracle Fusion Middleware Administering Oracle WebCenter Portal.

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

clientSecurityPolicy

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

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

cacheInvalidationInterval

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

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

binaryCacheMaxEntrySize

Optional. Maximum cacheable size (in bytes) for Content Server binary documents. Documents larger than this size are not cached by WebCenter Portal. Defaults is 102400 bytes (100K).

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

adminUsername

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

Defaults to sysadmin.

adminPassword

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

extAppId

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

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

timeout

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

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

- Login timeout - the default concurrency timeout for the oracle.webcenter.content resource is used (30s or 30000ms). For more information, refer to Configuring Concurrency Management in Tuning Performance.

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

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

isPrimary

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

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

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

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

server

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

Required when applications with the same name are deployed to different servers and also when you have a 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')

2.6.3 listContentServerConnections

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

verbose

Optional. Displays content repository connection details in verbose mode. Valid options are 1 (true) and 0(false).

When set to 1, listJCRContentServerConnections lists all Oracle WebCenter Content repository connections that are configured for the named application, along with their details.

When set to 0, only connection names are listed.

This argument defaults to 0.

name

Optional. Name of an existing Oracle WebCenter Content repository connection.

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

server

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

Required when applications with the same name are deployed to different servers and also when you have a 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')

2.6.4 listContentServerProperties

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

server

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

Required when applications with the same name are deployed to different servers and also when you have a 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"

2.6.5 setContentServerProperties

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

portalServerIdentifier

Optional. Root folder under which WebCenter Portal content is stored. The value for this argument must use the format: /folderName.

For example, /WebCenter or /WCPMain.

The portalServerIdentifier 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: If you change the value of this argument, you must also provide the value for the adminUserName and securityGroup arguments.

adminUserName

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

Administrative privileges are required for this connection so that operations can be performed on behalf of WebCenter Portal users. 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 portalServerIdentifier and adminUserName arguments.

server

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

Required when applications with the same name are deployed to different servers and also when you have a 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')

2.6.6 deleteContentServerProperties

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

server

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

Required when applications with the same name are deployed to different servers and also when you have a 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')

2.6.7 deleteContentServerConnection

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

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

2.6.8 exportFoldersGData

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

server

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

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 isPrimary=1.

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 FRAMEWORK_FOLDER_MIGRATION under WCP_ORACLE_HOME/common/wlst.

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

2.6.9 migrateFoldersGDataToFrameworkFolders

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

server

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

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.

contentDbConnectionUrl

Connection URL for the database where WebCenter Content schema (named OCS) is present.

Use the connection URL format host:port:sid.

contentDbUserName

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 isPrimary=1.

directoryPath

Optional. Directory containing the Folders_g data that you want to migrate.

If not specified, Folders_g data is migrated from WCP_ORACLE_HOME/common/wlst/FRAMEWORK_FOLDER_MIGRATION directory. This is the default location for Folders_g data exported using the WLST command exportFoldersGData.

reportMode

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 true and false.

true - Generates a report that describes all the metadata changes that will be made when the Folders_g data is migrated to FrameworkFolders. No actual data migration takes place.

false - Pre-migration report not required. Folders_g data is migrated to FrameworkFolders.

The default value is false.

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

2.7 Discussions and Announcements

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

createDiscussionForumConnection

Create a new discussions server connection for a named application.

Online

setDiscussionForumConnection

Edit an existing discussions server connection.

Online

setDefaultDiscussionForumConnection

Specify the default connection for discussions and announcements.

Online

listDiscussionForumConnections

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

Online

listDefaultDiscussionForumConnection

List the default discussions server connection for a named application.

Online

setDiscussionForumConnectionProperty

Set an additional discussions server connection property.

Online

deleteDiscussionForumConnectionProperty

Delete a discussions server connection property.

Online

setDiscussionForumServiceProperty

Specify defaults for discussions.

Online

removeDiscussionForumServiceProperty

Remove defaults for discussions.

Online

listDiscussionForumServiceProperties

List discussions settings.

Online

setAnnouncementServiceProperty

Specify defaults for announcements.

Online

removeAnnouncementServiceProperty

Remove defaults for announcements.

Online

listAnnouncementServiceProperties

List announcements settings.

Online

addDiscussionsServerAdmin

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

Online

addDiscussionsCategoryAdmin

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

Online

setDiscussionsServerProperty

Set discussions server properties.

Online

getDiscussionsServerProperty

Return discussions server property values.

Online

removeDiscussionsServerProperty

Remove current discussions server property values.

Online

2.7.1 createDiscussionForumConnection

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

Creates a new discussions server connection for a named application.

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

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

Syntax

createDiscussionForumConnection(appName, name, url, adminUser,
[timeout, default, policyURIForAuthAccess, policyURIForPublicAccess, recipientKeyAlias, server, applicationVersion])

Argument

Definition

appName

Name of the application in which to perform this operation.

For WebCenter Portal, the application name is always webcenter.

name

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

url

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

adminUser

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

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

policyURIForAuthAccess

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

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

Valid client policy values include:

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

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

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

See also "Managing Announcements and Discussions" in Administering Oracle WebCenter Portal.

policyURIForPublicAccess

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

Default value is oracle/no_authentication_client_policy.

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

Valid client policy values include:

- oracle/no_authentication_client_policy (None)

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

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

recipientKeyAlias

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

See also "Configuring WS-Security" in Administering Oracle WebCenter Portal.

timeout

Optional. Length of time (in seconds) discussions waits for a response from the discussions server before issuing a connection timeout message.

This argument defaults to -1. When set to -1, the service default (10 seconds) applies.

default

Optional. Indicates that this connection is the default connection for discussions and announcements.

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

When set to 1, discussions and announcements both use this connection.

When set to 0, the connection is not used. The default is 0.

server

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

Required when applications with the same name are deployed to different servers and also when you have a 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)

2.7.2 setDiscussionForumConnection

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

Edits an existing discussions server connection. Use this command to update connection attributes.

The connection is created using the createDiscussionForumConnection command.

Syntax

setDiscussionForumConnection(appName, name, [url, adminUser, policyURIForAuthAccess, policyURIForPublicAccess, recipientKeyAlias, timeout, default, server, applicationVersion])

Argument

Definition

appName

Name of the application in which to perform this operation.

For WebCenter Portal, the application name is always webcenter.

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 super admin. However, the user must have administrative privileges on the current application root category for WebCenter Portal, that is, the category (on the discussions server) under which all portal-related discussions and announcements are stored.

policyURIForAuthAccess

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

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

Valid client policy values include:

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

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

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

See also "Managing Announcements and Discussions" in Administering Oracle WebCenter Portal.

policyURIForPublicAccess

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

Default value is oracle/no_authentication_client_policy.

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

Valid client values include:

- oracle/no_authentication_client_policy (None)

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

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

recipientKeyAlias

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

See also "Configuring WS-Security" in Administering Oracle WebCenter Portal.

timeout

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

default

Optional. Indicates that this connection is the default connection for discussions and announcements. Required only if more than one connection is defined.

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

To specify that discussion and announcements use this connection, change the value from 0 to 1.

To disable this connection, use the removeDiscussionForumServiceProperty command:

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

Note: While you can register multiple discussions server connections for an application, only one connection is used for discussions and announcements— the default (or active) connection.

server

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

Required when applications with the same name are deployed to different servers and also when you have a 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)

2.7.3 setDiscussionForumConnectionProperty

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

Sets a discussions server connection property. Use this command when additional parameters are required to connect to your discussions server.

This commands provides an extensible way to add any connection property using a key and a value. (You are not limited to connection properties specified by createDiscussionForumConnection and setDiscussionForumConnection .)

Note:

Do not use the setDiscussionForumConnectionProperty to set connection properties available through createDiscussionForumConnection or setDiscussionForumConnection . Attempting to do so, has no effect.

All known, additional connection properties are listed in Table 2-9.

Table 2-9 Additional Discussion Server Connection Properties

Additional Connection Property

Description

application.root.category.id

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

linkURL

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

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

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

Syntax

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

Argument

Definition

appName

Name of the application in which to perform this operation.

For WebCenter Portal, the application name is always webcenter.

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 1 (true) and 0 (false). When 1, the value is encrypted. The default option is 0.

Set to 1 if you are storing passwords.

server

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

Required when applications with the same name are deployed to different servers and also when you have a 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)

2.7.4 deleteDiscussionForumConnectionProperty

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

Deletes a discussions server connection property. Take care when deleting connection properties because the connection may not work as expected if the configuration becomes invalid as a result.

This command can only delete additional connection properties added using the setDiscussionForumConnectionProperty command.

Syntax

deleteDiscussionForumConnectionProperty(appName, name, key, [server,
applicationVersion])

Argument

Definition

appName

Name of the application in which to perform this operation.

For WebCenter Portal, the application name is always webcenter.

name

Name of an existing discussions server connection.

key

Name of the connection property you want to delete.

server

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

Required when applications with the same name are deployed to different servers and also when you have a 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')

2.7.5 listDefaultDiscussionForumConnection

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

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

Syntax

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

Argument

Definition

appName

Name of the application in which to perform this operation.

For WebCenter Portal, the application name is always webcenter.

verbose

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

When set to 1, the name and details of the discussions server connections are listed.

When set to 0, only the connection name displays. This argument defaults to 0.

server

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

Required when applications with the same name are deployed to different servers and also when you have a 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)

2.7.6 listDiscussionForumConnections

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

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

Syntax

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

Argument

Definition

appName

Name of the application in which to perform this operation.

For WebCenter Portal, the application name is always webcenter.

verbose

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

When set to 1, listDiscussionForumConnections lists all of the discussions server connections that are configured for an application, along with their details.

When set to 0, only connection names are listed. This argument defaults to 0.

name

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

server

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

Required when applications with the same name are deployed to different servers and also when you have a 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')

2.7.7 setDefaultDiscussionForumConnection

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

Specifies the default discussions server connection for discussions and announcements in a named application.

While you can register multiple discussions server connections with an application, discussions and announcements only uses one connection—this is known as the default (or active) connection.

Syntax

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

Argument

Definition

appName

Name of the application in which to perform this operation.

For WebCenter Portal, the application name is always webcenter.

name

Name of an existing discussions server connection.

server

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

Required when applications with the same name are deployed to different servers and also when you have a 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')

2.7.8 setDiscussionForumServiceProperty

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

Specifies default values for discussions, for a named application.

Configurable properties for discussions are listed in Table 2-10.

Table 2-10 Discussions - Configurable Properties

Configuration Property

Description

topics.fetch.size

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

forums.fetch.size

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

recentTopics.fetch.size

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

watchedTopics.fetch.size

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

watchedForums.fetch.size

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

application.root.category.id

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

ForumGatewayManager.AUTO_START

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

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

Syntax

setDiscussionForumServiceProperty(appName, property, value, [server,
applicationVersion])

Argument

Definition

appName

Name of the application in which to perform this operation.

For WebCenter Portal, the application name is always webcenter.

property

Name of the configuration property.

value

Value for the property.

server

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

Required when applications with the same name are deployed to different servers and also when you have a 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')

2.7.9 removeDiscussionForumServiceProperty

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

Removes the current value that is set for a discussions property. Use this command to remove any of the properties listed in Table 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 webcenter.

property

Name of the configuration property.

server

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

Required when applications with the same name are deployed to different servers and also when you have a 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')

2.7.10 listDiscussionForumServiceProperties

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

Lists all configurable properties for discussions.

Syntax

listDiscussionForumServiceProperties(appName, [server, applicationVersion])

Argument

Definition

appName

Name of the application in which to perform this operation.

For WebCenter Portal, the application name is always webcenter.

server

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

Required when applications with the same name are deployed to different servers and also when you have a 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')

2.7.11 setAnnouncementServiceProperty

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

Specifies default values for announcements in a named application.

Configurable properties for announcements are listed in Table 2-11.

Table 2-11 Announcements - Configurable Properties

Configuration Property

Description

miniview.page_size

Maximum number of announcements displayed in the announcements mini view.

mainview.page_size

Maximum number of announcements displayed in the announcements main view.

linksview.page_size

Maximum number of announcements displayed in the announcements links view.

announcements.expiration.days

Number of days that announcements display and remain editable.

Syntax

setAnnouncementServiceProperty(appName, property, value, [server, applicationVersion})

Argument

Definition

appName

Name of the application in which to perform this operation.

For WebCenter Portal, the application name is always webcenter.

property

Name of the configuration property.

value

Property value.

server

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

Required when applications with the same name are deployed to different servers and also when you have a 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')

2.7.12 removeAnnouncementServiceProperty

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

Removes the current value that is set for an announcements property. Use this command to remove any of the properties listed in Table 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 webcenter.

property

Name of the configuration property.

server

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

Required when applications with the same name are deployed to different servers and also when you have a 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')

2.7.13 listAnnouncementServiceProperties

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

Lists all configurable properties for announcements, in a named application.

Syntax

listAnnouncementServiceProperties(appName, [server, applicationVersion])

Argument

Definition

appName

Name of the application in which to perform this operation.

For WebCenter Portal, the application name is always webcenter.

server

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

Required when applications with the same name are deployed to different servers and also when you have a 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')

2.7.14 addDiscussionsServerAdmin

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

Grants system administrator permissions on the discussions server to a user or a group. This command is useful when you connect the discussions server to a new identity store that does not contain any of the current administrators.

Syntax

addDiscussionsServerAdmin(appName, name, [type, server, applicationVersion])

Argument

Definition

appName

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

name

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

type

Optional. Identifies the type of identity. Valid values are USER and GROUP.

The default value is USER.

server

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

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

applicationVersion

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

Example

The following example grants system administrator permissions on the discussions server to the user weblogic:

addDiscussionsServerAdmin(appName='owc_discussions', name='weblogic', type='USER')

The following example grants system administrator permissions on the discussions server to all users in the Administrators user group:

addDiscussionsServerAdmin(appName='owc_discussions', name='Administrators', type='GROUP')

2.7.15 addDiscussionsCategoryAdmin

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

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

Syntax

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

Argument

Definition

appName

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

categoryId

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

name

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

type

Optional. Identifies the type of identity. Valid values are USER and GROUP.

The default value is USER.

server

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

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

applicationVersion

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

Example

The following example grants category administrator permissions on the discussions server to the user weblogic for a category with an ID=2:

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

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

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

2.7.16 setDiscussionsServerProperty

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

Sets a discussions server property. Use this command to set a system property on the discussions server.

Note:

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

Syntax

setDiscussionsServerProperty(appName, key, value, [server, applicationVersion])

Argument

Definition

appName

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

key

Name of the discussions server property.

For example, owc_discussions.sso.mode, AuthFactory.className, UserManager.className, and GroupManager.className.

value

Value for the discussions server property.

server

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

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

applicationVersion

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

Example

The following example sets properties that configures the discussions server for SSO, where example.com:8890/owc_discussions is the base URL of the webtier on which the discussions server is deployed:

wls:/weblogic/serverConfig>setDiscussionsServerProperty(appName='owc_discussions', key='owc_discussions.sso.mode', value='true')

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

2.7.17 getDiscussionsServerProperty

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

Returns the current value of a discussions server property.

Note:

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

Syntax

getDiscussionsServerProperty(appName, key, [server, applicationVersion])

Argument

Definition

appName

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

key

Name of the discussions server property.

For example, owc_discussions.sso.mode, AuthFactory.className, UserManager.className,and GroupManager.className.

server

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

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

applicationVersion

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

Example

The following examples return the current value for some key discussions server properties:

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

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

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

2.7.18 removeDiscussionsServerProperty

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

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

Note:

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

Syntax

removeDiscussionsServerProperty(appName, key, [server, applicationVersion])

Argument

Definition

appName

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

key

Name of the discussions server property.

For example, owc_discussions.sso.mode, AuthFactory.className, UserManager.className, and GroupManager.className.

server

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

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

applicationVersion

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

Example

The following example removes the current value for the 'SSO mode' property on the discussions server:

wls:/weblogic/serverConfig>removeDiscussionsServerProperty(appName='owc_discussions', key='owc_discussions.sso.mode')

2.8 External Applications

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

createExtAppConnection

Create an external application connection, for a named application.

Online

setExtAppConnection

Edit an existing external application connection.

Online

listExtAppConnections

List individual or all external applications that are configured for a named application.

Online

addExtAppField

Add another login field for a specific external application connection.

Online

setExtAppField

Edit the value and display-to-user setting for a specific external application login field.

Online

removeExtAppField

Remove an external application login field.

Online

addExtAppCredential

Specify shared or public credentials for an external application.

Online

setExtAppCredential

Edit shared or public credentials for an external application.

Online

removeExtAppCredential

Remove shared or public credentials currently configured for an external application.

Online

2.8.1 createExtAppConnection

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

Creates an external application connection for a named application.

Syntax

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

Argument

Definition

appName

Name of the application in which to perform this operation.

For WebCenter Portal, the application name is always webcenter.

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: http://login.yahoo.com/config/login

authMethod

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

This argument defaults to POST.

userFieldName

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

Mandatory if 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, WC_Portal.

Required when applications with the same name are deployed to different servers and also when you have a 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')

2.8.2 setExtAppConnection

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

Edits an existing external application connection.

Syntax

setExtAppConnection(appName, name, [displayName, url, authMethod,
userFieldName, pwdFieldName, server, applicationVersion])

Argument

Definition

appName

Name of the application in which to perform this operation.

For WebCenter Portal, the application name is always webcenter.

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 GET, POST, and BASIC. This argument defaults to POST.

userFieldName

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

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

pwdFieldName

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

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

server

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

Required when applications with the same name are deployed to different servers and also when you have a 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!')

2.8.3 listExtAppConnections

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

When used with only the appName argument, this command lists the names of all the external applications currently configured for a named WebCenter Portal application.

Syntax

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

Argument

Definition

appName

Name of the application in which to perform this operation.

For WebCenter Portal, the application name is always webcenter.

verbose

Optional. Displays external application details in verbose mode. Valid options are 1 (true) and 0 (false).

When set to 1, listExtAppConnections lists all of the external applications that are configured for WebCenter Portal, along with their details.

When set to 0, listExtAppConnections lists only the names of the external applications. This argument defaults to 0.

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

name

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

server

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

Required when applications with the same name are deployed to different servers and also when you have a 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

2.8.4 addExtAppField

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

Adds another login field for a specific external application connection. For example, in addition to user name and password, an external application may require other login criteria such as Host and MailAddress.

Optionally, additional login fields can appear on the external application's login for a user to specify.

If you add another login field and the external application uses shared or public credentials, you can use the WLST commands addExtAppCredential and setExtAppCredential to update the shared/public credentials. See addExtAppCredential and setExtAppCredential.

Syntax

addExtAppField(appName, name, fieldName, [fieldValue, displayToUser, server,
applicationVersion])

Argument

Definition

appName

Name of the application in which to perform this operation.

For WebCenter Portal, the application name is always webcenter.

name

Name of an existing external application connection.

fieldName

Login field name. The name that identifies the field on the HTML login form. This field is not applicable if the application uses BASIC authentication.

fieldValue

Optional. Login field value. Enter a default value for the login field or leave blank for a user to specify. This argument is blank by default.

displayToUser

Optional. Specifies whether the login field displays on the external application's login screen.

Valid options are 1 (true) and 0 (false). This argument defaults to 0.

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

server

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

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

2.8.5 setExtAppField

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

Modifies the field value and display-to-user setting for one or more login fields currently configured for an external application. Either fieldValue or displayToUser must be specified along with the external application name and login field name. The fieldValue and displayToUser arguments are optional.

Using this command has implications on any shared or public credentials that you might have created for this external application. If you modify displayToUser to 1, you may also need to update existing shared user or public user credentials. See also setExtAppCredential.

Syntax

setExtAppField(appName, name, fieldName, [fieldValue, displayToUser, server,
applicationVersion])

Argument

Definition

appName

Name of the application in which to perform this operation.

For WebCenter Portal, the application name is always webcenter.

name

Name of an existing external application connection.

fieldName

Name of an existing login field.

fieldValue

Optional. New or changed login field value.

Enter a default value for the login field or leave blank for a user to specify. This argument is blank by default.

displayToUser

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

If set to 0, fieldValue must be specified.

server

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

Required when applications with the same name are deployed to different servers and also when you have a 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)

2.8.6 removeExtAppField

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

Removes a login field from an external application connection.

This command has implications on any shared or public credentials that you may have created for this external application, that is, you may need to remove the login field from shared user or public user credentials.

You can use the setExtAppCredential command to remove a login field, if required. For example, external application myApp has an additional field called Account and public credentials were previously specified using:

addExtAppCredential(appName='webcenter', name='myApp', type='PUBLIC',
username='admin', password='mypublic.password', field='Account:admin@myhost.com')

If you remove the Account field, you can modify the credentials by running:

setExtAppCredential(appName='webcenter', name='myApp', type='PUBLIC',
username='admin', password='mypublic.password')

For details on using setExtAppCredential, see setExtAppCredential

Syntax

removeExtAppField(appName, name, fieldName, [server, applicationVersion])

Argument

Definition

appName

Name of the application in which to perform this operation.

For WebCenter Portal, the application name is always webcenter.

name

Connection name.

fieldName

Login field that you want to remove.

server

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

Required when applications with the same name are deployed to different servers and also when you have a 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')

2.8.7 addExtAppCredential

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

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

When shared credentials are specified, every user accessing WebCenter Portal, 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 webcenter.

name

Name of an existing external application connection.

type

Credential type. Valid values are SHARED and PUBLIC.

username

Name of the shared or public user.

password

Password for the shared or public user.

field

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

server

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

Required when applications with the same name are deployed to different servers and also when you have a 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')

2.8.8 setExtAppCredential

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

Modifies shared user or public user credentials currently configured for an external application. If the credential has already not been specified, then a warning indicates that addExtAppCredential needs to be used instead. See addExtAppCredential.

The arguments username and password are optional because setExtAppCredential only manipulates existing credentials. At least one of the parameters, username, password or field, must be specified.

You can use setExtAppCredential command to update passwords in systems that require changing passwords every few days.

Syntax

setExtAppCredential(appName, name, type, [username, password, field,
server, applicationVersion])

Argument

Definition

appName

Name of the application in which to perform this operation.

For WebCenter Portal, the application name is always webcenter.

name

Name of an existing external application connection.

type

Credential type. Valid values are SHARED and PUBLIC.

username

Optional. User name of the shared or public user.

password

Optional. Password for the shared or public user.

field

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

server

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

Required when applications with the same name are deployed to different servers and also when you have a 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')

2.8.9 removeExtAppCredential

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

Removes shared user or public user credentials currently configured for an external application.

If credentials do not exist, an error displays.

Syntax

removeExtAppCredential(appName, name, type, [server, applicationVersion])

Argument

Definition

appName

Name of the application in which to perform this operation.

For WebCenter Portal, the application name is always webcenter.

name

Name of an existing external application connection.

type

Credential type. Valid values are SHARED and PUBLIC.

server

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

Required when applications with the same name are deployed to different servers and also when you have a 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')

2.9 Instant Messaging and Presence

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

createIMPConnection

Create a new instant messaging and presence server connection for a named application.

Online

setIMPConnection

Edit an existing instant messaging and presence server connection.

Online

setIMPConnectionProperty

Modify instant messaging and presence server connection properties.

Online

deleteIMPConnectionProperty

Delete an instant messaging and presence server connection property.

Online

listIMPAdapters

List which presence servers a named application supports.

Online

listIMPConnections

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

Online

listDefaultIMPConnection

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

Online

setDefaultIMPConnection

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

Online

setIMPServiceProperty

Specify defaults for instant messaging and presence.

Online

removeIMPServiceProperty

Remove defaults for instant messaging and presence.

Online

listIMPServiceProperties

List instant messaging and presence properties.

Online

createIMPExtAppConnection

Create an external application suitable for instant messaging and presence server connection.

Online

2.9.1 createIMPConnection

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

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

Use the listIMPAdapters command to find out which types of instant messaging and presence servers are supported. Out-of-the-box, WebCenter Portal 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 webcenter.

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

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

url

URL of the sever hosting instant messaging and presence services.

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

domain

Deprecated.

Use the setIMPServiceProperty command to resolve IM addresses.

appId

Optional. External application associated with the presence server connection.

If specified, external application credential information is used to authenticate users against the 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 authMethod=POST, and specify an additional field with fieldName='Account' and displaytoUser=1. If an external application does not exist yet, use the WLST command createIMPExtAppConnection to create an external application that automatically has all the required additional fields.

See also addExtAppField and setExtAppField.

poolName

Optional. Pool name that is required to create an 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 -1.

When set to -1, the service default (10 seconds) applies.

default

Optional. Indicates whether this connection is the default connection for instant messaging and presence services.

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

server

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

Required when applications with the same name are deployed to different servers and also when you have a 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))

2.9.2 setIMPConnection

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

Edits an existing instant messaging and presence server connection. Use this command to update connection attributes.

The connection is created using the createIMPConnection command.

Syntax

setIMPConnection(appName, name, [adapter, url, appId, poolName,
userDomain, timeout, default, server, applicationVersion])

Argument

Definition

appName

Name of the application in which to perform this operation.

For WebCenter Portal, the application name is always webcenter.

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

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

url

Optional. URL of the server hosting instant messaging and presence services.

domain

Deprecated.

Use the setIMPServiceProperty command to resolve IM addresses.

appId

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 authMethod=POST, and specify an additional field with fieldName='Account' and displaytoUser=1. If an external application does not exist yet, use the WLST command createIMPExtAppConnection to create an external application that automatically has all the required additional fields.

See also addExtAppField and setExtAppField.

poolName

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 -1. When set to -1, the service default (10 seconds) applies.

default

Optional. Indicates whether this connection is the default connection for instant messaging and presence services. Valid values are 1 (true) and 0 (false). The default for this argument is 0.

To specify that instant messaging and presence uses this connection, change the value from 0 to 1.

To disable this connection, use the removeIMPServiceProperty command:

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

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

server

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

Required when applications with the same name are deployed to different servers and also when you have a 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)

2.9.3 setIMPConnectionProperty

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

Sets an instant messaging and presence server connection property. Use this command if additional parameters are required to connect to your presence server. This is an extensible way to add any connection property using a key and a value. (You are not limited to connection properties specified by createIMPConnection and setIMPConnection .)

All known, additional connection properties are listed in Table 2-14.

Table 2-14 Additional Instant Messaging and Presence Connection Properties

Additional Connection Property

Description

presence.url

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

contacts.url

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

call.url

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

call.method

Supports values sip and pstn:

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

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

call.domain

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

contact.number.attribute

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

primary.domain

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

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

Note:

Do not use the setIMPConnectionProperty to set connection properties available through createIMPConnection or setIMPConnection . Attempting to do so has no effect.

Syntax

setIMPConnectionProperty(appName, name, key, value, [secure, server,
applicationVersion])

Argument

Definition

appName

Name of the application in which to perform this operation.

For WebCenter Portal, the application name is always webcenter.

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 1 (true) and 0 (false). When 1, the value is encrypted. The default option is 0.

server

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

Required when applications with the same name are deployed to different servers and also when you have a 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')

2.9.4 deleteIMPConnectionProperty

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

Deletes an instant messaging and presence server connection property. Use caution when deleting connection properties because the connection might not work as expected if the configuration becomes invalid as a result.

This command can only delete additional connection properties added using the setIMPConnectionProperty command.

Syntax

deleteIMPConnectionProperty(appName, name, key, [server, applicationVersion])

Argument

Definition

appName

Name of the application in which to perform this operation.

For WebCenter Portal, the application name is always webcenter.

name

Name of an existing presence server connection.

key

Name of the connection property you want to delete.

server

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

Required when applications with the same name are deployed to different servers and also when you have a 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')

2.9.5 listIMPAdapters

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

Lists which types of instant messaging and presence servers Oracle WebCenter Portal supports. Out-of-the-box, WebCenter Portal 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()

2.9.6 listIMPConnections

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

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

Syntax

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

Argument

Definition

appName

Name of the application in which to perform this operation.

For WebCenter Portal, the application name is always webcenter.

verbose

Optional. Displays presence server connection details in verbose mode. Valid values are 1 (true) and 0 (false).

When set to 1, listIMPConnections lists all of the presence server connections that are configured for the named application, along with their details.When set to 0, only connection names are listed. This argument defaults to 0.

name

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

Note that if you use the name argument when verbose argument set to 1, the verbose argument is ignored.

server

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

Required when applications with the same name are deployed to different servers and also when you have a 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')

2.9.7 listDefaultIMPConnection

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

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

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

Syntax

listDefaultIMPConnection(appName, verbose, [server, applicationVersion])

Argument

Definition

appName

Name of the application in which to perform this operation.

For WebCenter Portal, the application name is always webcenter.

verbose

Optional. Displays the default presence server connection in verbose mode, if available.

Valid options are 1 (true) and 0 (false). When set to 1, the name and details of the presence server connection are listed.

When set to 0, only the connection name displays. This argument defaults to 0.

server

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

Required when applications with the same name are deployed to different servers and also when you have a 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)

2.9.8 setDefaultIMPConnection

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

Specifies the default connection for instant messaging and presence in a named application. While you can register multiple presence server connections with an application, instant messaging and presence only uses one connection—the default (or active) connection.

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

Syntax

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

Argument

Definition

appName

Name of the application in which to perform this operation.

For WebCenter Portal, the application name is always webcenter.

name

Name of an existing instant messaging and presence connection.

server

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

Required when applications with the same name are deployed to different servers and also when you have a 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')

2.9.9 setIMPServiceProperty

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

Specifies default values for instant messaging and presence.

Configurable properties for instant messaging and presence are listed in Table 2-15.

Table 2-15 Instant Messaging and Presence - Configurable Properties

Configuration Property

Description

selected.connection

Connection used by instant messaging and presence.

rtc.cache.time

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

resolve.display.name.from.user.profile

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

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

im.address.resolver.class

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

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

- User Preferences

- User Credentials

- User Profiles

im.address.profile.attribute

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

Syntax

setIMPServiceProperty(appName, property, value, [server, applicationVersion])

Argument

Definition

appName

Name of the application in which to perform this operation.

For WebCenter Portal, the application name is always webcenter.

property

Name of the configuration property.

value

Value for the property.

server

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

Required when applications with the same name are deployed to different servers and also when you have a 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')

2.9.10 removeIMPServiceProperty

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

Removes the current value that is set for an instant messaging and presence property. Use this command to remove any of the properties listed in Table 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 webcenter.

property

Name of the configuration property.

server

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

Required when applications with the same name are deployed to different servers and also when you have a 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')

2.9.11 listIMPServiceProperties

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

Lists all configurable properties for instant messaging and presence.

Syntax

listIMPServiceProperties(appName, [server, applicationVersion])

Argument

Definition

appName

Name of the application in which to perform this operation.

For WebCenter Portal, the application name is always webcenter.

server

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

Required when applications with the same name are deployed to different servers and also when you have a 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')

2.9.12 createIMPExtAppConnection

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

Creates an external application suitable for instant messaging and presence server connections. The external application is configured with the required additional properties: authMethod=POST, and additional fields fieldName='Account' and displaytoUser=1.

Syntax

createIMPExtAppConnection(appName, name, [displayName, server, applicationVersion])

Argument

Definition

appName

Name of the application in which to perform this operation.

For WebCenter Portal, the application name is always webcenter.

name

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

displayName

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

The display name must be unique across all external applications within the application.

server

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

Required when applications with the same name are deployed to different servers and also when you have a 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')

2.10 Mail

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

createMailConnection

Create a mail server connection for a named application.

Online

setMailConnection

Edit an existing mail server connection.

Online

setMailConnectionProperty

Set mail server connection properties.

Online

deleteMailConnectionProperty

Delete a mail server connection property.

Online

listMailConnections

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

Online

listDefaultMailConnection

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

Online

setDefaultMailConnection

Set a specified connection as the default mail server connection.

Online

setMailServiceProperty

Specify defaults for mail.

Online

removeMailServiceProperty

Remove defaults for mail.

Online

listMailServiceProperties

List properties for mail.

Online

createMailExtApp

Create an external application suitable for mail connections.

Online

2.10.1 createMailConnection

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

name

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

imapHost

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

imapPort

Optional. Port on which the IMAP service listens.

smtpHost

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

smtpPort

Optional. Port on which the SMTP service listens.

imapSecured

Optional. Specifies whether the mail server connection to the IMAP server is SSL-enabled.

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

smtpSecured

Optional. Specifies whether the SMTP server is secured.

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

appId

External application associated with the mail server connection.

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

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

fieldName='Email Address' and displaytoUser=1

fieldName='Your Name' and displaytoUser=1

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

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

See also createExtAppConnection.

timeout

Optional. Length of time (in seconds) that the mail waits to acquire a connection before terminating.

This argument defaults to -1. When set to -1, the service default (10 seconds) applies.

default

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

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

server

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

Required when applications with the same name are deployed to different servers and also when you have a 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)

2.10.2 setMailConnection

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

Edits an existing mail connection. Use this command to update connection attributes.

The connection is created using the createMailConnection command.

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

Syntax

setMailConnection(appName, name, [imapHost, imapPort, smtpHost, smtpPort,
imapSecured, smtpSecured, appId, default, ldapHost, ldapPort, ldapBaseDN,
ldapAdminUser, ldapAdminPassword, ldapSecured, domain, defaultUser, timeout,
server, applicationVersion])

Argument

Definition

appName

Name of the application in which to perform this operation.

For WebCenter Portal, the application name is always webcenter.

name

Name of an existing mail server connection.

imapHost

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

imapPort

Optional. Port on which the IMAP service listens.

smtpHost

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

smtpPort

Optional. Port on which the SMTP service listens.

imapSecured

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

smtpSecured

Optional. Specifies whether the connection to the SMTP server is secured (SSL-enabled).

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

appId

Optional. External application associated with the mail server connection.

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

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

fieldName='Email Address' and displaytoUser=1

fieldName='Your Name' and displaytoUser=1

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

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

See also createExtAppConnection.

ldapHost

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

ldapPort

Optional. Port on which the LDAP directory server listens.

ldapBaseDN

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

ldapAdminUser

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

ldapAdminPassword

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

ldapSecured

Optional. Specifies whether the connection to the LDAP server is secured (SSL enabled).

Valid values are 1 (true) and 0 (false). The default for this argument is 0. Set this to 1 for all LDAP communications over SSL.

domain

Optional. Domain name appended to portal distribution lists.

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

defaultUser

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

timeout

Optional. Length of time (in seconds) that mail waits to acquire a connection before terminating.

This argument defaults to -1. When set to -1, the service default (10 seconds) applies.

default

Optional. Indicates whether this connection is the default (or active) connection for mail.

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

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

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

To stop using a default connection, use the removeMailServiceProperty command as follows:

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

server

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

Required when applications with the same name are deployed to different servers and also when you have a 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)

2.10.3 setMailConnectionProperty

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

Sets a mail server connection property. Use this command if additional parameters are required to connect to your mail server. This is an extensible way to add any connection property using a key and a value. (You are not limited to connection properties specified by createMailConnection and setMailConnection .)

Syntax

setMailConnectionProperty(appName, name, key, value, [secure, server,
applicationVersion])

Argument

Definition

appName

Name of the application in which to perform this operation.

For WebCenter Portal, the application name is always webcenter.

name

Name of an existing mail server connection.

key

Name of the connection property.

value

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

secure

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

server

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

Required when applications with the same name are deployed to different servers and also when you have a 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')

2.10.4 deleteMailConnectionProperty

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

Deletes a mail server connection property. Take care when deleting connection properties because the connection may not work as expected if the configuration becomes invalid as a result.

This command can only delete additional connection properties added using the setMailConnectionProperty command.

Syntax

deleteMailConnectionProperty(appName, name, key, [server, applicationVersion])

Argument

Definition

appName

Name of the application in which to perform this operation.

For WebCenter Portal, the application name is always webcenter.

name

Name of an existing mail server connection.

key

Name of the connection property you want to delete.

server

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

Required when applications with the same name are deployed to different servers and also when you have a 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')

2.10.5 listMailConnections

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

Lists all of the mail server connections that are configured for a named application.

Syntax

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

Argument

Definition

appName

Name of the application in which to perform this operation.

For WebCenter Portal, the application name is always webcenter.

verbose

Optional. Displays mail server connection details in verbose mode. Valid options are 1 (true) and 0 (false).

When set to 1, listMailConnections lists all of the mail server connections that are configured for an application, along with their details.

When set to 0, only connection names are listed. This argument defaults to 0.

name

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

server

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

Required when applications with the same name are deployed to different servers and also when you have a 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')

2.10.6 listDefaultMailConnection

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

Lists the default mail server connection that mail is using in a named application.

You can register multiple mail server connections but there can only be one default connection. 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 webcenter.

verbose

Optional. Displays the default mail server connection in verbose mode, if available. Valid options are 1 (true) and 0 (false).

When set to 1, the name and details of the mail server connection are listed.

When set to 0, only the connection name displays. This argument defaults to 0.

server

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

Required when applications with the same name are deployed to different servers and also when you have a 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)

2.10.7 setDefaultMailConnection

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

Specifies the default mail server connection for mail in a named application.

You can register multiple mail server connections but there can only be one default connection. 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 webcenter.

name

Name of an existing mail connection.

server

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

Required when applications with the same name are deployed to different servers and also when you have a 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')

2.10.8 setMailServiceProperty

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

address.delimiter

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

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

mail.emailgateway.polling.frequency

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

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

mail.messages.fetch.size

Maximum number of messages displayed in mail inboxes.

resolve.email.address.to.name

Determines whether user email addresses are resolved to WebCenter Portal user names when LDAP is configured. Valid values are 1 (true) and 0 (false). The default value is 0.

When set to 1, WebCenter Portal user names display instead of email addresses in mail task flows.

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

mail.recipient.limit

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

Syntax

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

Argument

Definition

appName

Name of the application in which to perform this operation.

For WebCenter Portal, the application name is always webcenter.

property

Name of the configuration property

value

Value for the property.

server

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

Required when applications with the same name are deployed to different servers and also when you have a 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')

2.10.9 removeMailServiceProperty

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

Removes the current value that is set for a mail property. Use this command to remove any of the properties listed in Table 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 webcenter.

property

Name of the configuration property.

server

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

Required when applications with the same name are deployed to different servers and also when you have a 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')

2.10.10 listMailServiceProperties

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

Lists all configurable properties for mail.

Syntax

listMailServiceProperties(appName, [server, applicationVersion])

Argument

Definition

appName

Name of the application in which to perform this operation.

For WebCenter Portal, the application name is always webcenter.

server

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

Required when applications with the same name are deployed to different servers and also when you have a 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')

2.10.11 createMailExtApp

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

Creates an external application suitable for mail server connections. The external application is configured with all the required additional properties: authMethod=POST, and specify several additional login fields:

fieldName='Email Address' and displaytoUser=1

fieldName='Your Name' and displaytoUser=1

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

Syntax

createMailExtAppConnection(appName, name, [displayName, server, applicationVersion])

Argument

Definition

appName

Name of the application in which to perform this operation.

For WebCenter Portal, the application name is always webcenter.

name

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

displayName

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

server

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

Required when applications with the same name are deployed to different servers and also when you have a 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')

2.11 Notifications

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

setNotificationsConfig

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

Online

getNotificationsConfig

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

Online

2.11.1 setNotificationsConfig

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

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

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

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

Syntax

setNotificationsConfig(appName, type, name, [senderMailAddress, senderSMSAddress, server, applicationVersion])

Argument

Definition

appName

Name of the application in which to perform this operation.

For WebCenter Portal, the application name is always webcenter.

type

Type of connection used to send notifications. Valid values are MAIL and BPEL.

name

Name of an existing connection.

Consider the following:

- Mail server connection—The external application associated with the mail server connection must contain shared credentials.

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

senderMailAddress

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

Use the format:

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

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

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

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

senderSMSAddress

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

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

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

server

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

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

2.11.2 getNotificationsConfig

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

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

Syntax

getNotificationsConfig(appName, [server, applicationVersion])

Argument

Definition

appName

Name of the application in which to perform this operation.

For WebCenter Portal, the application name is always webcenter.

server

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

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

2.12 People Connections

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

startSyncProfiles

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

Online

syncProfile

Synchronize profile information for a specific user.

Online

stopSyncProfiles

Stop the profile synchronization process.

Online

isSyncProfilesRunning

Check whether profile synchronization is in progress.

Online

setProfileConfig

Set profile properties.

Online

getProfileConfig

Return current profile properties.

Online

listProfileConfig

List current profile properties.

Online

setProfilePhotoSync

Specify whether to synchronize user profile photos in the WebCenter schema from the LDAP server.

Online

2.12.1 startSyncProfiles

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

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

Syntax

startSyncProfiles(appName, [server, applicationVersion])

Argument

Definition

appName

Name of the application in which to perform this operation.

For WebCenter Portal, the application name is always webcenter.

server

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

Required when applications with the same name are deployed to different servers and also when you have a 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')

2.12.2 stopSyncProfiles

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

Stops the profile synchronization process, if currently in progress.

Syntax

stopSyncProfiles(appName, [server, applicationVersion])

Argument

Definition

appName

Name of the application in which to perform this operation.

For WebCenter Portal, the application name is always webcenter.

server

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

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

2.12.3 isSyncProfilesRunning

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

Checks whether profile synchronization is in progress.

Syntax

isSyncProfilesRunning(appName, [server, applicationVersion])

Argument

Definition

appName

Name of the application in which to perform this operation.

For WebCenter Portal, the application name is always webcenter.

server

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

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

2.12.4 syncProfile

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

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

Syntax

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

Argument

Definition

appName

Name of the application in which to perform this operation.

For WebCenter Portal, the application name is always webcenter.

userName

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

server

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

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

2.12.5 setProfileConfig

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

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

Syntax

setProfileConfig(appName, ProfilePageVersion, ProfileSyncHourOfDay, ProfileSyncFrequencyInDays, server, applicationVersion])

Argument

Definition

appName

Name of the application in which to perform this operation.

For WebCenter Portal, the application name is always webcenter.

ProfilePageVersion

Optional. Specifies the profile page version to use.

Valid values for ProfilePageVersion are:

v1 - Use old-style profile pages

v2 - Use the new profile page format

The default value is v2.

ProfileSyncHourOfDay

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

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

ProfileSyncFrequencyInDays

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

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

server

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

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)

2.12.6 getProfileConfig

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

Returns current profile settings for a named application.

Syntax

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

Argument

Definition

appName

Name of the application in which to perform this operation.

For WebCenter Portal, the application name is always webcenter.

key

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, WC_Portal.

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

2.12.7 listProfileConfig

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

Lists the current profile settings for a named application.

Syntax

listProfileConfig(appName, [server, applicationVersion])

Argument

Definition

appName

Name of the application in which to perform this operation.

For WebCenter Portal, the application name is always webcenter.

server

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

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

2.12.8 setProfilePhotoSync

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

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

Syntax

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

Argument

Definition

appName

Name of the application in which to perform this operation.

For WebCenter Portal, the application name is always webcenter.

enablePhotoSync

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

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

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

The default value is 1.

server

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

Required when applications with the same name are deployed to different servers and also when you have a 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)

2.13 Personal Events

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

createPersonalEventConnection

Create a personal events server connection for a named application.

Online

setPersonalEventConnection

Edit an existing personal events server connection.

Online

listPersonalEventConnections

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

Online

2.13.1 createPersonalEventConnection

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

Creates a personal events server connection for a named application.

Personal events supports connections to Microsoft Exchange Server 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 webcenter.

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 MSEx2007, MSEx2010, and MSEx2013. Choose MSEx2007 for Microsoft Exchange Server 2007, MSEx2010 for Microsoft Exchange Server 2010, andMSEx2013 for Microsoft Exchange Server 2013.

Each adapter has its own mechanism of authenticating and exchanging data

appId

External application associated with the Microsoft Exchange Server providing personal events services. If specified, external application credential information is used to authenticate users against the Microsoft Exchange Server.

default

Optional. Indicates whether this connection is the default connection for personal event services. Valid values are 1 (true) and 0 (false). The default for this argument is 0.

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

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

server

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

Required when applications with the same name are deployed to different servers and also when you have a 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')

2.13.2 setPersonalEventConnection

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

Edits an existing personal events server connection configured for a named application.

Syntax

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

Argument

Definition

appName

Name of the application in which to perform this operation.

For WebCenter Portal, the application name is always webcenter.

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 MSEx2007, MSEx2010, and MSEx2013. Choose MSEx2007 for Microsoft Exchange Server 2007, MSEx2010 for Microsoft Exchange Server 2010, and MSEx2013 for Microsoft Exchange Server 2013.

Each adapter has its own mechanism of authenticating and exchanging data

appId

Optional. External application associated with the Microsoft Exchange Server providing personal events services. If specified, external application credential information is used to authenticate users against the Microsoft Exchange Server.

default

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

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

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

server

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

Required when applications with the same name are deployed to different servers and also when you have a 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)

2.13.3 listPersonalEventConnections

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

Lists all of the personal events server connections that are configured for a named application.

Syntax

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

Argument

Definition

appName

Name of the application in which to perform this operation.

For WebCenter Portal, the application name is always webcenter.

verbose

Optional. Displays connection details for personal events in verbose mode. Valid options are 1 (true) and 0 (false).

When set to 1, listPersonalEventConnections lists all of the personal events server connections that are configured for a named application, along with their details.

When set to 0, only connection names are listed. This argument defaults to 0.

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

name

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

server

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

Required when applications with the same name are deployed to different servers and also when you have a 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')

2.14 Portlet Producers

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

registerWSRPProducer

Create and register a WSRP producer.

Online

setWSRPProducer

Edit WSRP producer registration details.

Online

listWSRPProducers

List WSRP producer registration details.

Online

deregisterWSRPProducer

Deregister a WSRP producer, and delete the associated WSRP and web service connections.

Online

listWSRPProducerRegistrationProperties

List registration properties supported by a WSRP producer.

Online

listWSRPProducerUserCategories

List any user categories that the WSRP producer might support.

Online

mapWSRPProducerUserCategory

Map a role that is defined in the specified application to a user category supported by a WSRP producer.

Online

registerPDKJavaProducer

Create and register an Oracle PDK-Java producer.

Online

setPDKJavaProducer

Edit PDK-Java producer registration details.

Online

listPDKJavaProducers

List registered Oracle PDK-Java producers.

Online

deregisterPDKJavaProducer

Deregister an Oracle PDK-Java producer, deleting the associated connection.

Online

registerPageletProducer

Create and register a pagelet producer.

Online

setPageletProducer

Edit pagelet producer registration details.

Online

listPageletProducers

List pagelet producer registration details.

Online

deregisterPageletProducer

Deregister a pagelet producer, deleting the associated connection.

Online

refreshProducer

Refresh the metadata stored for the named producer to reflect the portlets currently offered by that producer.

Online

listPortletClientConfig

List portlet client configuration for a named application.

Online

setPortletClientConfig

Edit portlet client configuration settings.

Online

getPortletClientConfig

Return portlet client configuration settings.

Online

registerOOTBProducers

Register out-of-the-box producers provided with Oracle WebCenter Portal.

Online

deregisterOOTBProducers

Deregister out-of-the-box producers provided with Oracle WebCenter Portal.

Online

registerSampleProducers

Register the sample producers provided with Oracle WebCenter Portal.

Online

deregisterSampleProducers

Deregister sample producers.

Online

2.14.1 registerWSRPProducer

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

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

Syntax

registerWSRPProducer(appName, name, url, [proxyHost], [proxyPort],
[timeout],[externalApp],[registrationProperties],[tokenType],[issuer],[defUser],
[keyStorePath],[keyStorePswd],[sigKeyAlias],[sigKeyPswd],[encKeyAlias],
[encKeyPswd],[recptAlias], [enforcePolicyURI], [server],[applicationVersion])

Argument

Definition

appName

Name of the application in which to perform this operation.

For WebCenter Portal, the application name is always webcenter.

name

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

The name you specify here will appear in Composer (under the Portlets folder).

url

Producer WSDL URL. The syntax will vary according to your WSRP implementation, for example:

http://host_name:port_number/context_root/portlets/wsrp2?WSDL

http://host_name:port_number/context_root/portlets/wsrp1?WSDL

http://host_name:port_number/context_root/portlets/?WSDL (WSRP 1.0 for backward compatibility)

Where:

- host_name is the server where your producer is deployed

- port_number is the HTTP listener port number

- context_root is the web application's context root

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

For example:

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

proxyHost

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

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

proxyPort

Optional. Port number on which the proxy server listens.

timeout

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

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

registrationProperties

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

tokenType

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

When the argument enforcePolicyURI=1, valid values are:

- USERNAME_WITHOUT_PASSWORD (oracle/wss10_username_id_propagation_with_msg_protection_client_policy)—This policy provides message protection (integrity and confidentiality) and identity propagation for outbound SOAP requests in accordance with the WS-Security 1.0 standard. Credentials (user name only) are included in outbound SOAP request messages through a WS-Security UsernameToken header. No password is included.
Message protection is provided using WS-Security 1.0's Basic128 suite of asymmetric key technologies. Specifically, RSA key mechanisms for message confidentiality, SHA-1 hashing algorithm for message integrity, and AES-128 bit encryption.

- USERNAME_WITH_PASSWORD (oracle/wss10_username_token_with_message_protection_client_policy)—This policy provides message protection (integrity and confidentiality) and authentication for outbound SOAP requests in accordance with the WS-Security v1.0 standard. Both plain text and digest mechanisms are supported.
This policy uses WS-Security's Basic 128 suite of asymmetric key technologies. Specifically, RSA key mechanism for message confidentiality, SHA-1 hashing algorithm for message integrity, and AES-128 bit encryption.

Use this token profile if the WSRP producer has a different identity store. You will need to define an external application pertaining to the producer and associate the external application with this producer.

- SAML_TOKEN_WITH_MSG_INTEGRITY (wss10_saml_token_with_message_integrity_client_policy)—This policy provides message-level integrity protection and SAML-based authentication for outbound SOAP requests in accordance with the WS-Security 1.0 standard. A SAML token, included in the SOAP message, is used in SAML-based authentication with sender vouches confirmation.
This policy uses WS-Security's Basic 128 suite of asymmetric key technologies and SHA-1 hashing algorithm for message integrity.

When this policy is selected, the recipient key alias (recptAlias) must be disabled.

- SAML_TOKEN_WITH_MSG_PROTECTION (oracle/wss10_saml_token_with_message_protection_client_policy)—This policy provides message-level protection (integrity and confidentiality) and SAML-based authentication for outbound SOAP requests in accordance with the WS-Security 1.0 standard. The web service consumer includes a SAML token in the SOAP header and the confirmation type is sender-vouches.
This policy uses WS-Security's Basic 128 suite of asymmetric key technologies. Specifically, RSA key mechanisms for message confidentiality, SHA-1 hashing algorithm for message integrity, and AES-128 bit encryption. and SHA-1 hashing algorithm for message integrity.

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

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

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

issuer

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

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

defUser

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

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

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

extApp

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

keyStorePath

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

keyStorePswd

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

sigKeyAlias

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

sigKeyPswd

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

encKeyAlias

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

encKeyPswd

Optional. Password for accessing the encryption key.

recptAlias

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

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

enforcePolicyURI

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

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

The default value is 1.

server

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

Required when applications with the same name are deployed to different servers and also when you have a 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')

2.14.2 setWSRPProducer

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

Edits registration details for an existing WSRP producer.

Syntax

setWSRPProducer(appName, name, [url], [proxyHost], [proxyPort], [timeout],
[externalApp], [tokenType],[issuer], [defUser], [keyStorePath], [keyStorePswd]
[sigKeyAlias], [sigKeyPswd], [encKeyAlias], [encKeyPswd], [recptAlias],
[enforcePolicyURI], [server], [applicationVersion])

Argument

Definition

appName

Name of the application in which to perform this operation.

For WebCenter Portal, the application name is always webcenter.

name

Name of an existing WSRP producer.

url

Optional. WSRP producer URL. The syntax will vary according to your WSRP implementation, for example:

http://host_name:port_number/context_root/portlets/wsrp2?WSDL

http://host_name:port_number/context_root/portlets/wsrp1?WSDL

http://host_name:port_number/context_root/portlets/?WSDL (WSRP 1.0 for backward compatibility)

Where:

- host_name is the server where your producer is deployed

- port_number is the HTTP listener port number

- context_root is the Web application's context root

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

For example:

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

proxyHost

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

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

proxyPort

Optional. Port number on which the proxy server listens.

timeout

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

This argument defaults to 30.

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

extApp

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

tokenType

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

When the argument enforcePolicyURI=1, valid values are:

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

Message protection is provided using WS-Security 1.0's Basic 128 suite of asymmetric key technologies. Specifically, RSA key mechanisms for message confidentiality, SHA-1 hashing algorithm for message integrity, and AES-128 bit encryption.

- USERNAME_WITH_PASSWORD
(oracle/wss10_username_token_with_message_protection_client_policy)—This policy provides message protection (integrity and confidentiality) and authentication for outbound SOAP requests in accordance with the WS-Security v1.0 standard. Both plain text and digest mechanisms are supported.

This policy uses WS-Security's Basic 128 suite of asymmetric key technologies. Specifically, RSA key mechanism for message confidentiality, SHA-1 hashing algorithm for message integrity, and AES-128 bit encryption.

Use this token profile if the WSRP producer has a different identity store. You will need to define an external application pertaining to the producer and associate the external application with this producer.

- SAML_TOKEN_WITH_MSG_INTEGRITY
(wss10_saml_token_with_message_integrity_client_policy)—This policy provides message-level integrity and SAML-based authentication for outbound SOAP requests in accordance with the WS-Security 1.0 standard. A SAML token, included in the SOAP message, is used in SAML-based authentication with sender vouches confirmation.

This policy uses WS-Security's Basic 128 suite of asymmetric key technologies and SHA-1 hashing algorithm for message integrity.

When this policy is selected, the recipient key alias (recptAlias) must be disabled.

- SAML_TOKEN_WITH_MSG_PROTECTION
(oracle/wss10_saml_token_with_message_protection_client_policy)—This policy provides message-level protection (integrity and confidentiality) and SAML-based authentication for outbound SOAP requests in accordance with the WS-Security 1.0 standard. The Web service consumer includes a SAML token in the SOAP header and the confirmation type is sender-vouches.

This policy uses WS-Security's Basic 128 suite of asymmetric key technologies. Specifically, RSA key mechanisms for message confidentiality, SHA-1 hashing algorithm for message integrity, and AES-128 bit encryption. and SHA-1 hashing algorithm for message integrity.

tokenType
continued...

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

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

This policy does not require any keystore configuration.

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

issuer

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

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

defUser

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

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

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

keyStorePath

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

keyStorePswd

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

sigKeyAlias

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

sigKeyPswd

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

encKeyAlias

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

encKeyPswd

Optional. Password for accessing the encryption key.

recptAlias

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

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

enforcePolicyURI

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

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

The default value is 1.

server

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

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

2.14.3 listWSRPProducers

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

Lists WSRP producer registration details for a named application.

Syntax

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

Argument

Definition

appName

Name of the application in which to perform this operation.

For WebCenter Portal, the application name is always webcenter.

name

Optional. Name of an existing WSRP producer. If omitted, connection details for all WSRP producers configured for this application are listed.

verbose

Optional. Displays WSRP producer connection details in verbose mode. Valid options are 1 (true) and 0 (false).

When set to 1, listWSRPProducers lists all connection properties.

When set to 0, listWSRPProducers lists connection names only. This argument defaults to 1.

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

server

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

Required when applications with the same name are deployed to different servers and also when you have a 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

2.14.4 deregisterWSRPProducer

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

Deregisters a WSRP producer, and deletes the associated WSRP and web service connections.

Syntax

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

Argument

Definition

appName

Name of the application in which to perform this operation.

For WebCenter Portal, the application name is always webcenter.

name

Name of an existing WSRP producer.

server

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

Required when applications with the same name are deployed to different servers and also when you have a 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')

2.14.5 listWSRPProducerRegistrationProperties

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

Lists registration properties supported by a WSRP portlet producer.

Syntax

listWSRPProducerRegistrationProperties(appName, url, [proxyHost, proxyPort, server, applicationVersion])

Argument

Definition

appName

Name of the application in which to perform this operation.

For WebCenter Portal, the application name is always webcenter.

url

WSRP producer URL. The syntax will vary according to your WSRP implementation, for example:

http://host_name:port_number/context_root/portlets/wsrp2?WSDL

http://host_name:port_number/context_root/portlets/wsrp1?WSDL

http://host_name:port_number/context_root/portlets/?WSDL (WSRP 1.0 for backward compatibility)

Where:

- host_name is the server where your producer is deployed

- port_number is the HTTP listener port number

- context_root is the Web application's context root

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

For example:

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

proxyHost

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

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

proxyPort

Optional. Port number on which the proxy server listens.

server

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

Required when applications with the same name are deployed to different servers and also when you have a 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

2.14.6 listWSRPProducerUserCategories

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

Lists any user categories that a WSRP producer might support. WebCenter Portal users can use the WLST command mapWSRPProducerUserCategory to map application roles to a producer's user category.

Syntax

listWSRPProducerUserCategories(appName, name, [server, [pplicationVersion])

Argument

Definition

appName

Name of the application in which to perform this operation.

For WebCenter Portal, the application name is always webcenter.

name

Name of an existing WSRP producer.

server

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

Required when applications with the same name are deployed to different servers and also when you have a 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

2.14.7 mapWSRPProducerUserCategory

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

Maps a role that is defined in the named application to a user category supported by a WSRP producer. The user categories may be found using listWSRPProducerUserCategories.

Syntax

mapWSRPProducerUserCategory(appName, name, localRole, producerUserCategory, [server, applicationVersion])

Argument

Definition

appName

Name of the application in which to perform this operation.

For WebCenter Portal, the application name is always webcenter.

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, WC_Portal.

Required when applications with the same name are deployed to different servers and also when you have a 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')

2.14.8 registerPDKJavaProducer

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

Creates a connection to an Oracle PDK-Java portlet producer and registers the Oracle PDK-Java producer with a named application.

Syntax

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

Argument

Definition

appName

Name of the application in which to perform this operation.

For WebCenter Portal, the application name is always webcenter.

name

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

url

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

http://host_name:port_number/context_root/providers

Where:

- host_name is the server where the producer is deployed

- port_number is the HTTP Listener port number

- context_root is the web application's context root.

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

For example:

http://myHost:7778/myEnterprisePortlets/providers

serviceId

Optional. Service ID of the producer.

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

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

http://domain.example.com:7778/axyz/providers

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

http://domain.example.com:7778/axyz/providers/sample

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

proxyHost

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

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

proxyPort

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

sharedKey

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

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

subscriberId

Optional. Consumer's identifier, if required.

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

timeout

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

This argument defaults to 30.

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

establishSession

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

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

externalApp

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

mapUser

Optional. Flag indicating whether the mapped user name from the external application should be passed to the producer.

Valid values are 1 (true) and 0 (false). This argument defaults to 1.

server

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

Required when applications with the same name are deployed to different servers and also when you have a 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')

2.14.9 setPDKJavaProducer

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

Edits registration details for an existing PDK-Java producer.

Syntax

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

Argument

Definition

appName

Name of the application in which to perform this operation.

For WebCenter Portal, the application name is always webcenter.

name

Name of an existing PDK-Java producer.

url

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

http://host_name:port_number/context_root/providers

Where:

- host_name is the server where the producer is deployed

- port_number is the HTTP Listener port number

- context_root is the Web application's context root.

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

For example:

http://myHost:7778/myEnterprisePortlets/providers

serviceId

Optional. Service ID of the producer.

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

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

http://domain.example.com:7778/axyz/providers

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

http://domain.example.com:7778/axyz/providers/sample

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

proxyHost

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

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

proxyPort

Optional. Port number on which the proxy server listens.

subscriberId

Optional. Consumer's identifier, if required.

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

sharedKey

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

timeout

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

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

establishSession

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

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

externalApp

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

mapUser

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

server

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

Required when applications with the same name are deployed to different servers and also when you have a 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)

2.14.10 deregisterPDKJavaProducer

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

Deregisters an Oracle PDK-Java producer and deletes the associated connection, for a named application.

Syntax

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

Argument

Definition

appName

Name of the application in which to perform this operation.

For WebCenter Portal, the application name is always webcenter.

name

Name of an existing PDK-Java producer.

server

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

Required when applications with the same name are deployed to different servers and also when you have a 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

2.14.11 listPDKJavaProducers

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

Lists details for one or more Oracle PDK-Java producers registered with a named application.

Syntax

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

Argument

Definition

appName

Name of the application in which to perform this operation.

For WebCenter Portal, the application name is always webcenter.

name

Optional. Name of an existing PDK-Java portlet producer. If omitted, connection details for all PDK-Java producers configured for this application are listed.

verbose

Optional. Displays PDK-Java producer connection details in verbose mode. Valid options are 1 (true) and 0 (false).

When set to 1, listPDKJavaProducers lists all connection properties.

When set to 0, listPDKJavaProducers lists connection names only. This argument defaults to 1.

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

server

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

Required when applications with the same name are deployed to different servers and also when you have a 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

2.14.12 registerPageletProducer

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

Registers a pagelet producer with a named application.

Syntax

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

Argument

Definition

appName

Name of the application in which to perform this operation.

For WebCenter Portal, the application name is always webcenter.

name

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

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

url

URL required to access the server where the Pagelet Producer is deployed. Use the syntax:

protocol://host.domain:port_number/pagelets

The URL must include a fully-qualified domain name. For example:

http://myhost.example.com:7778/pagelets

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

https://myhost.com:7779/pagelets

Note: In WebCenter Portal, if the Pagelet Producer URL is protected by Oracle Access Manager (OAM), the URL to the pagelet catalog must be excluded (mapped directly without access control), or the catalog will appear to be empty when using REST. The pagelet catalog URL is:

http://proxy_host:proxy_port/api/v2/ensemble/pagelets

server

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

Required when applications with the same name are deployed to different servers and also when you have a 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')

2.14.13 setPageletProducer

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

Edits connection details for an existing pagelet producer.

Syntax

setPageletProducer(appName, name, [url, server, applicationVersion])

Argument

Definition

appName

Name of the application in which to perform this operation.

For WebCenter Portal, the application name is always webcenter.

name

Name of an existing pagelet producer connection.

url

Optional. URL required to access the server where the Pagelet Producer is deployed. Use the syntax:

protocol://host.domain:port_number/pagelets

The URL must include a fully-qualified domain name. For example:

http://myhost.example.com:7778/pagelets

Note: In WebCenter Portal, if the Pagelet Producer URL is protected by Oracle Access Manager (OAM), the URL to the pagelet catalog must be excluded (mapped directly without access control), or the catalog will appear to be empty when using REST. The pagelet catalog URL is:

http://proxy_host:proxy_port/api/v2/ensemble/pagelets

server

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

Required when applications with the same name are deployed to different servers and also when you have a 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')

2.14.14 listPageletProducers

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

Lists connection details for one or all pagelet producers registered with a named application.

Syntax

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

Argument

Definition

appName

Name of the application in which to perform this operation.

For WebCenter Portal, the application name is always webcenter.

name

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

If omitted, connection details for all pagelet producers configured for this application are listed.

verbose

Optional. Displays pagelet producer connection details in verbose mode. Valid options are 1 (true) and 0 (false).

When set to 1, listPageletProducers lists all connection properties.

When set to 0, listPageletProducers lists connection names only. This argument defaults to 1.

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

server

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

Required when applications with the same name are deployed to different servers and also when you have a 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

2.14.15 deregisterPageletProducer

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

Deregisters a pagelet producer currently registered with a named application.

Syntax

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

Argument

Definition

appName

Name of the application in which to perform this operation.

For WebCenter Portal, the application name is always webcenter.

name

Name of an existing pagelet producer connection.

server

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

Required when applications with the same name are deployed to different servers and also when you have a 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')

2.14.16 refreshProducer

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

Refreshes the metadata stored for a named producer to reflect the portlets that are currently offered by that producer.

Syntax

refreshProducer(appName, producerName, [server, applicationVersion])

Argument

Definition

appName

Name of the application in which to perform this operation.

For WebCenter Portal, the application name is always webcenter.

producerName

Name of an existing producer.

server

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

Required when applications with the same name are deployed to different servers and also when you have a 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.

2.14.17 listPortletClientConfig

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

Lists portlet client's configuration for a named application.

Syntax

listPortletClientConfig(appName, [server, applicationVersion])

Argument

Definition

appName

Name of the application in which to perform this operation.

For WebCenter Portal, the application name is always webcenter.

server

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

Required when applications with the same name are deployed to different servers and also when you have a 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

2.14.18 setPortletClientConfig

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

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

Note:

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

Syntax

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

Argument

Definition

appName

Name of the application in which to perform this operation.

For WebCenter Portal, the application name is always webcenter.

applicationStriping

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

The default value is 0 (false).

contentCacheEnabled

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

The default value is 1 (true).

contentCacheMaxObjects

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

The default value is 0 (unlimited).

contentCacheMaxSize

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

The default value is 0 (unlimited).

defaultTimeout

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

The default value is 10 seconds.

maximumIframeQueryStringLength

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

The default value is 0 (always shorten URLs).

maximumResourceUrlLength

Optional. Maximum length of portlet resource URLs.

The default value is 1500.

maximumTimeout

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

The default value is 300 seconds.

minimumTimeout

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

The default value is 1.

parallelPoolSize

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

The default value is 10.

parallelQueueSize

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

The default value is 20.

renditionCacheMaxObjects

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

The default value is 25.

resourceProxyPath

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

The default value is '/resourceproxy'.

supportedLocales

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

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

server

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

Required when applications with the same name are deployed to different servers and also when you have a 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')

2.14.19 getPortletClientConfig

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

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

Syntax

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

Argument

Definition

appName

Name of the application in which to perform this operation.

For WebCenter Portal, the application name is always webcenter.

configSetting

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

ApplicationStriping

ContentCacheEnabled

ContentCacheMaxObjects

ContentCacheMaxSize

DefaultTimeout

MaximumIframeQueryStringLength

MaximumResourceUrlLength

MaximumTimeout

MinimumTimeout

ParallelPoolSize

ParallelQueueSize

RenditionCacheMaxObjects

ResourceProxyPath

SupportedLocales

Note: The values are case-sensitive.

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

server

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

Required when applications with the same name are deployed to different servers and also when you have a 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')

2.14.20 registerOOTBProducers

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

server

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

Required when applications with the same name are deployed to different servers and also when you have a 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.

2.14.21 deregisterOOTBProducers

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

server

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

Required when applications with the same name are deployed to different servers and also when you have a 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

2.14.22 registerSampleProducers

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

Registers the sample producers provided with Oracle WebCenter Portal with a named application. There are two sample producers— WSRP Samples and JPDK Samples.

Syntax

registerSampleProducers(producerHost, producerPort, appName, [server,
applicationVersion])

Argument

Definition

producerHost

Host name or IP address of the server hosting the sample producers.

producerPort

Port number for the server hosting the sample producers.

appName

Name of the application in which the sample producers are to be registered.

For WebCenter Portal, the application name is always webcenter.

server

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

Required when applications with the same name are deployed to different servers and also when you have a 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')

2.14.23 deregisterSampleProducers

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

Deregisters Oracle WebCenter Portal's sample producers (WSRP Samples and JPDK Samples) from a named application.

Syntax

deregisterSampleProducers(appName, [server, applicationVersion])

Argument

Definition

appName

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

For WebCenter Portal, the application name is always webcenter.

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

server

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

Required when applications with the same name are deployed to different servers and also when you have a 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')

2.15 Proxy Server

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

getWebCenterProxyConfig

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

Online

setWebCenterProxyConfig

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

Online

unsetWebCenterProxyConfig

Delete proxy host and proxy port settings.

Online

2.15.1 getWebCenterProxyConfig

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

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

Syntax

getWebCenterProxyConfig(appName, [server, applicationVersion])

Argument

Definition

appName

Name of the application in which to perform this operation.

For WebCenter Portal, the application name is always webcenter.

server

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

Required when applications with the same name are deployed to different servers and also when you have a 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')

2.15.2 setWebCenterProxyConfig

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

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

Syntax

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

Argument

Definition

appName

Name of the application in which to perform this operation.

For WebCenter Portal, the application name is always webcenter.

proxyHost

Host name of the proxy server.

proxyPort

Port on which the proxy server is running.

server

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

Required when applications with the same name are deployed to different servers and also when you have a 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')

2.15.3 unsetWebCenterProxyConfig

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

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

Syntax

unsetWebCenterProxyConfig(appName, [server, applicationVersion])

Argument

Definition

appName

Name of the application in which to perform this operation.

For WebCenter Portal, the application name is always webcenter.

server

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

Required when applications with the same name are deployed to different servers and also when you have a 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')

2.16 Search - Oracle SES Search

Use the commands listed in Table 2-23 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-23 Search - Oracle SES WLST Commands

Use this command...

To...

Use with WLST...

createSESConnection

Create a connection to an Oracle SES instance for a named application.

Online

setSESConnection

Edit an existing Oracle SES search connection.

Online

listSESConnections

List individual or all Oracle SES search connections that are configured for a named application.

Online

setSearchSESConfig

Configure search settings for an existing Oracle SES search connection.

Online

listSearchSESConfig

List Oracle SES properties for a named application.

Online

createFederationTrustedEntity

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

Online

setSESVersion

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

Online

listSESVersion

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

Online

createDefaultSourceGroup

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

Online

2.16.1 createSESConnection

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

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

Syntax

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

Argument

Definition

appName

Name of the application in which to perform this operation.

For WebCenter Portal, the application name is always webcenter.

name

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

url

Web services URL that Oracle Secure Enterprise Search exposes to enable Search requests.

Use the format:

http://host:port/search/query/OracleSearch

appUser

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

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

appPassword

Password for the user name specified.

default

Optional. Configures search to actively use the search connection. Valid options are 1 (true) and 0 (false).

Setting to 1 replaces any other search connection that is being used.

Setting to 0 does not change the current search configuration.

This argument defaults to 0.

server

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

Required when applications with the same name are deployed to different servers and also when you have a 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)

2.16.2 setSESConnection

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

Edits an existing Oracle Secure Enterprise Search (SES) search connection for a named application.

Syntax

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

Argument

Definition

appName

Name of the application in which to perform this operation.

For WebCenter Portal, the application name is always webcenter.

name

Name of an existing search connection.

url

Optional. Web services URL that Oracle Secure Enterprise Search exposes to enable Search requests.

Use the format:

http://host:port/search/query/OracleSearch

appUser

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

appPassword

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

default

Optional. Configures search to actively use the search connection. Valid options are 1 (true) and 0 (false).

Setting to 1 replaces any other search connection that is being used.

Setting to 0 does not change the current search configuration.

This argument defaults to 0.

server

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

Required when applications with the same name are deployed to different servers and also when you have a 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)

2.16.3 listSESConnections

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

Lists the names of all Oracle Secure Enterprise Search (SES) search connections configured for a named application.

Syntax

listSESConnections(appName, [verbose, name, server, applicationVersion])

Argument

Definition

appName

Name of the application in which to perform this operation.

For WebCenter Portal, the application name is always webcenter.

verbose

Optional. Displays search connection details in verbose mode. Valid options are 1 (true) and 0 (false).

When set to 1, listSESConnections lists all of the SES search connections that are configured for an application, along with their details.

When set to 0, listSESConnections lists connection names only.

This argument defaults to 0.

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

name

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

server

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

Required when applications with the same name are deployed to different servers and also 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')

2.16.4 setSearchSESConfig

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

Configures search settings for an existing Oracle Secure Enterprise Search (SES) search connection. If a parameter is not specified it is not modified.

Syntax

setSearchSESConfig(appName,[connectionName, dataGroup, topNRows, server, applicationVersion])

Argument

Definition

appName

Name of the application in which to perform this operation.

For WebCenter Portal, the application name is always webcenter.

connectionName

Optional. Names the connection used for search.

dataGroup

Optional. Names the Secure Enterprise Search data group in which to search. If a value is not provided, everything in the Oracle Secure Enterprise Search instance will be searched.

topNRows

Optional. Number of top N rows of search results for gathering refinement data.

server

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

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

2.16.5 listSearchSESConfig

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

Lists Oracle SES search settings for a named application.

Syntax

listSearchSESConfig(appName, [server, applicationVersion])

Argument

Definition

appName

Name of the application in which to perform this operation.

For WebCenter Portal, the application name is always webcenter.

server

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

Required when applications with the same name are deployed to different servers and also when you have a 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

2.16.6 createFederationTrustedEntity

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

Creates a federation trusted entity on an Oracle Secure Enterprise Search (SES) instance for a given entity name and password.

Syntax

createFederationTrustedEntity(appName, sesUrl, sesPassword, entityName, entityPassword, desc,  [sesSchema, server, applicationVersion])

Argument

Definition

appName

Name of the application in which to perform this operation.

For WebCenter Portal, the application name is always webcenter.

sesUrl

Web service URL for the Oracle SES Administration API.

Use the format:

http://host:port/search/api/admin/AdminService

sesPassword

Password for the Oracle SES administrative user (eqsys).

entityName

Entity name.

entityPassword

Entity password.

desc

Short description of the entity.

Alternatively, specify an empty string ''.

sesSchema

Username for the Oracle SES administrative user. The default value is eqsys.

server

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

Required when applications with the same name are deployed to different servers and also when you have a 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')

2.16.7 setSESVersion

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

Obtains version information for the Oracle Secure Enterprise Search (SES) instance that is configured for a named application, and stores the version for use by search queries later on.

Version information is used when the Oracle SES connection is set as the default connection for search queries.

Syntax

setSESVersion(appName, sesUrl, sesSchema, sesPassword, [server, applicationVersion])

Argument

Definition

appName

Name of the application in which to perform this operation.

For WebCenter Portal, the application name is always webcenter.

sesUrl

Web service URL for the Oracle SES Administration API.

Use the format:

http://host:port/search/api/admin/AdminService

sesSchema

Username for the Oracle SES administrative user. For example, searchsys.

sesPassword

Password for the Oracle SES administrative user.

server

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

Required when applications with the same name are deployed to different servers and also when you have a 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')

2.16.8 listSESVersion

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

Returns the version number of the Oracle Secure Enterprise Search (SES) instance that is being used by a named application.

Syntax

listSESVersion(appName, sesUrl, [server, applicationVersion])

Argument

Definition

appName

Name of the application in which to perform this operation.

For WebCenter Portal, the application name is always webcenter.

sesUrl

Web service URL for the Oracle SES Administration API.

Use the format:

http://host:port/search/api/admin/AdminService

sesUrl

Web service URL for the Oracle SES Administration API.

Use the format:

http://host:port/search/api/admin/AdminService

sesSchema

Username for the Oracle SES administrative user. For example, searchsys.

sesPassword

Password for the Oracle SES administrative user.

server

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

Required when applications with the same name are deployed to different servers and also when you have a 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

2.16.9 createDefaultSourceGroup

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

Creates a source group in an Oracle Secure Enterprise Search (SES) instance with a default name, for a given host, port and application name, as well as the shared documents and discussions/announcement sources.

Syntax

createDefaultSourceGroup(appName, sesUrl, sesPassword, host, port, defaultHost, defaultPort, [sesSchema, server, applicationVersion])

Argument

Definition

appName

Name of the application in which to perform this operation.

For WebCenter Portal, the application name is always webcenter.

sesUrl

Web service URL for the Oracle SES Administration API.

Use the format:

http://host:port/search/api/admin/AdminService

sesPassword

Password for the Oracle SES administrative user.

host

Host name of the machine where the application is running.

port

Port number used to access the application.

defaulthost

Host name of the machine where the default sources are configured.

defaultport

Port number used where the default sources are configured.

sesSchema

Optional. Username for the Oracle SES administrative user. Default value is eqsys.

server

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

Required when applications with the same name are deployed to different servers and also when you have a 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')

2.17 Search - Oracle SES Search Crawlers

Use the commands listed in Table 2-24 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-24 Search - Oracle SES Crawler WLST Commands

Use this command...

To...

Use with WLST...

createSpacesCrawler

Create a crawler forWebCenter Portal objects on an Oracle SES instance.

Online

createDocumentsCrawler

Create a documents crawler for a named application, on an Oracle SES instance.

Online

createDiscussionsCrawler

Create a discussions crawlers and an announcement crawler for a named application, on an Oracle SES instance.

Online

listSpacesCrawler

Return the Spaces crawler configured for WebCenter Portal, on an Oracle SES instance.

Online

listDocumentsCrawler

Return the documents crawler configured for a named application, on an Oracle SES instance.

Online

listDiscussionsCrawler

Return the discussion and announcement crawlers configured for a named application, on an Oracle SES instance.

Online

startSpacesCrawler

Start the Spaces crawler configured for WebCenter Portal, on an Oracle SES instance.

Online

startDocumentsCrawler

Start the documents crawler configured for a named application, on an Oracle SES instance.

Online

startDiscussionsCrawler

Start the discussion and announcement crawlers configured for a named application, on an Oracle SES instance.

Online

stopSpacesCrawler

Stop the Spaces crawler configured for WebCenter Portal, on an Oracle SES instance.

Online

stopDocumentsCrawler

Stop the documents crawler configured for a named application, on an Oracle SES instance.

Online

stopDiscussionsCrawler

Stop discussion and announcement crawlers configured for a named application, on an Oracle SES instance.

Online

deleteSpacesCrawler

Delete the Spaces crawler configured for WebCenter Portal, on an Oracle SES instance.

Online

deleteDocumentsCrawler

Delete the documents crawler configured for a named application, on an Oracle SES instance.

Online

deleteDiscussionsCrawler

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

Online

2.17.1 createSpacesCrawler

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

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

Syntax

createSpacesCrawler(appName,  host, port, sesUrl, sesPassword, crawlUser,
crawlPassword, scratchDir, authUserIdFormat, crawlingMode, recrawlPolicy,
freqType, startHour, hoursBetweenLaunches, startDayOfWeek, startDayOfMonth,
daysBetweenLaunches, weeksBetweenLaunches, monthsBetweenLaunches, [server,
applicationVersion])

Argument

Definition

appName

Name of the application in which to perform this operation.

For WebCenter Portal, the application name is always webcenter.

host

Host name of the machine where WebCenter Portal is running.

port

Port number used to access WebCenter Portal.

sesUrl

Web service URL for the Oracle SES Administration API. Use the format:

http://host:port/search/api/admin/AdminService

sesPassword

Password for the Oracle SES administrative user (eqsys).

crawlUser

Crawl administration user in WebCenter Portal.

This user must exist in WebCenter Portal and in your back-end identity management server with appropriate permissions and roles. For example: mycrawladmin)

crawlPassword

Password for the WebCenter Portal user that is specified in the crawlUser argument.

scratchDir

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

authUserIdFormat

Format of the user ID in the active identity plug-in. For example, username, email, nickname, user_name.

crawlingMode

Mode for crawling URLs in the source. The default mode is ACCEPT_ALL. Valid values are: ACCEPT_ALL, INDEX_ONLY, EXAMINE_URL:

ACCEPT_ALL—Automatically Accept All URLs for Indexing: Crawls and indexes all URLs in the source. It also extracts and indexes any links found in those URLs. Previously crawled URLs are only reindexed if they have changed.

EXAMINE_URL—Examine URLs Before Indexing: Crawls but does not index any URLs in the source. It also crawls any links found in those URLs.

INDEX_ONLY—Index Only: Crawls and indexes all URLs in the source. It does not extract any links found in those URLs. Select this option for a source previously crawled using EXAMINE_URL.

recrawlPolicy

Specifies whether to crawl all documents or only documents that have changed. Valid values are PROCESS_ALL and PROCESS_CHANGED:

PROCESS_ALL—All documents are crawled. Use this option to force a full crawl.

PROCESS_CHANGED—Only crawl documents that have changed since the previous crawl. This setting can significantly speed up the crawling process.

freqType

Frequency of scheduled crawls. Valid values are: MANUAL, MONTHLY, WEEKLY, DAILY, HOURLY.

To schedule crawls MONTHLY, WEEKLY, DAILY, or HOURLY, specify additional arguments as follows:

MONTHLY: startHour, startDayOfTheMonth, monthsBetweenLaunches

WEEKLY: startHour, startDayOfTheWeek, weeksBetweenLaunches

DAILY: startHour, daysBetweenLaunches

HOURLY: hoursBetweenLaunches

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

startHour

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

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

hoursBetweenLaunches

Number of hours between crawls.

Only valid when freqType='HOURLY'.

startDayOfWeek

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

Only valid when freqType='WEEKLY'.

startDayOfMonth

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

Only valid when freqType='MONTHLY'.

daysBetweenLaunches

Number of days between crawls.

Only valid when freqType='DAILY'.

weeksBetweenLaunches

Number of weeks between crawls.

Only valid when freqType='WEEKLY'.

monthsBetweenLaunches

Number of months between crawls.

Only valid when freqType='MONTHLY'.

server

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

Required when applications with the same name are deployed to different servers and also when you have a 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)

2.17.2 createDocumentsCrawler

Module: Oracle WebCenter Portal

Use with WLST: Online

Description

Creates a documents crawler for a named application, on an Oracle SES instance.

The command creates an Oracle WebCenter Content repository datasource and specifies a schedule for crawling documents in the Oracle WebCenter Content repository.

Syntax

createDocumentsCrawler(appName,  host, port, sesUrl, sesPassword, configUrl,
user, password, scratchDir, httpEndpoint, displayUrl, realm, authUserIdFormat,
pipelineName, crawlingMode, recrawlPolicy, freqType, startHour,
hoursBetweenLaunches, startDayOfWeek, startDayOfMonth,
daysBetweenLaunches, weeksBetweenLaunches, monthsBetweenLaunches,
[server, applicationVersion])

Argument

Definition

appName

Name of the application in which to perform this operation.

For WebCenter Portal, the application name is always webcenter.

host

Host name of the machine where the application is running.

port

Port number used to access the application.

sesUrl

Web service URL for the Oracle SES Administration API. Use the format:

http://host:port/search/api/admin/AdminService

sesPassword

Password for the Oracle SES administrative user (eqsys).

configUrl

URL of the XML configuration file providing details of the source, such as the data feed type, location, security attributes, and so on.Use the URL format:

http://host:port/cs/idcplg?IdcService=SES_CRAWLER_DOWNLOAD_CONFIG&source=sourcename

user

Administrative user for Oracle WebCenter Content's Content Server. For example, sysadmin.

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

password

Password for the administrative user specified.

scratchDir

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

httpEndpoint

HTTP endpoint for Content Server authorization. For example:

http://host:port/idc/idcplg

displayUrl

HTTP host information string to prefix the relative access URL to form the complete display URL. For example:

http://host:port/idc

realm

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

For example, jazn.com

authUserIdFormat

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.

pipelineName

Document service pipeline created for this source in Oracle SES.

crawlingMode

Mode for crawling URLs in the source. The default mode is ACCEPT_ALL. Valid values are: ACCEPT_ALL, INDEX_ONLY, EXAMINE_URL:

ACCEPT_ALL—Automatically Accept All URLs for Indexing: Crawls and indexes all URLs in the source. It also extracts and indexes any links found in those URLs. Previously crawled URLs are only reindexed if they have changed.

EXAMINE_URL—Examine URLs Before Indexing: Crawls but does not index any URLs in the source. It also crawls any links found in those URLs.

INDEX_ONLY—Index Only: Crawls and indexes all URLs in the source. It does not extract any links found in those URLs. Select this option for a source previously crawled using EXAMINE_URL

recrawlPolicy

Specifies whether to crawl all documents or only documents that have changed. Valid values are PROCESS_ALL and PROCESS_CHANGED:

PROCESS_ALL—All documents are crawled. Use this option to force a full crawl.

PROCESS_CHANGED—Only crawl documents that have changed since the previous crawl. This setting can significantly speed up the crawling process.

freqType

Frequency of scheduled crawls. Valid values are: MANUAL, MONTHLY, WEEKLY, DAILY, HOURLY.

To schedule crawls MONTHLY, WEEKLY, DAILY, or HOURLY, specify additional arguments as follows:

MONTHLY: startHour, startDayOfTheMonth, monthsBetweenLaunches

WEEKLY: startHour, startDayOfTheWeek, weeksBetweenLaunches

DAILY: startHour, daysBetweenLaunches

HOURLY: hoursBetweenLaunches

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

startHour

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

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

hoursBetweenLaunches

Number of hours between crawls.

Only valid when freqType='HOURLY'.

startDayOfWeek

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

Only valid when freqType='WEEKLY'.

startDayOfMonth

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

Only valid when freqType='MONTHLY'.

daysBetweenLaunches

Number of days between crawls.

Only valid when freqType='DAILY'.

weeksBetweenLaunches

Number of weeks between crawls.

Only valid when freqType='WEEKLY'.

monthsBetweenLaunches

Number of months between crawls.

Only valid when freqType='MONTHLY'.

server

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

Required when applications with the same name are deployed to different servers and also when you have a 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)

2.17.3 createDiscussionsCrawler

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

host

Host name of the machine where the application is running.

port

Port number used to access the application.

sesUrl

Web service URL for the Oracle SES Administration API. Use the format:

http://host:port/search/api/admin/AdminService

sesPassword

Password for the Oracle SES administrative user (eqsys).

dbConnString

Connection URL for the database on which the discussions server is installed. Use the format:

Oracle: jdbc:oracle:thin:@<host>:<port>/<oracle-sid>

IBM DB2: jdbc:db2://<host>:<port>/<database_name>

Microsoft SQL Server: jdbc:sqlserver://<host_or_IP_address>:<port>/<database_name>

user

Administrative user for the database on which the discussions server is installed.

Oracle: The user MyPrefix_DISCUSSIONS_CRAWLER is created during installation.

IBM DB2: The user MyPrefix_DC is created during installation (where MyPrefix is five characters)

Microsoft SQL Server: The user MyPrefix_DISCUSSIONS_CRAWLER is created during installation.

password

Password for the administrative discussions server user specified.

authUserIdFormat

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.

crawlingMode

Mode for crawling URLs in the source. The default mode is ACCEPT_ALL. Valid values are: ACCEPT_ALL, INDEX_ONLY, EXAMINE_URL:

ACCEPT_ALL—Automatically Accept All URLs for Indexing: Crawls and indexes all URLs in the source. It also extracts and indexes any links found in those URLs. Previously crawled URLs are only reindexed if they have changed.

EXAMINE_URL—Examine URLs Before Indexing: Crawls but does not index any URLs in the source. It also crawls any links found in those URLs.

INDEX_ONLY—Index Only: Crawls and indexes all URLs in the source. It does not extract any links found in those URLs. Select this option for a source previously crawled using EXAMINE_URL.

recrawlPolicy

Specifies whether to crawl all documents or only documents that have changed. Valid values are PROCESS_ALL and PROCESS_CHANGED:

PROCESS_ALL—All documents are crawled. Use this option to force a full crawl.

PROCESS_CHANGED—Only crawl documents that have changed since the previous crawl. This setting can significantly speed up the crawling process.

freqType

Frequency of scheduled crawls. Valid values are: MANUAL, MONTHLY, WEEKLY, DAILY, HOURLY.

To schedule crawls MONTHLY, WEEKLY, DAILY, or HOURLY, specify additional arguments as follows:

MONTHLY: startHour, startDayOfTheMonth, monthsBetweenLaunches

WEEKLY: startHour, startDayOfTheWeek, weeksBetweenLaunches

DAILY: startHour, daysBetweenLaunches

HOURLY: hoursBetweenLaunches

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

startHour

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

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

hoursBetweenLaunches

Number of hours between crawls.

Only valid when freqType='HOURLY'.

startDayOfWeek

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

Only valid when freqType='WEEKLY'.

startDayOfMonth

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

Only valid when freqType='MONTHLY'.

daysBetweenLaunches

Number of days between crawls.

Only valid when freqType='DAILY'.

weeksBetweenLaunches

Number of weeks between crawls.

Only valid when freqType='WEEKLY'.

monthsBetweenLaunches

Number of months between crawls.

Only valid when freqType='MONTHLY'.

server

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

Required when applications with the same name are deployed to different servers and also when you have a 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)

2.17.4 listSpacesCrawler

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

sesUrl

Web service URL for the Oracle SES Administration API. Use the format:

http://host:port/search/api/admin/AdminService

sesPassword

Password for the Oracle SES administrative user (eqsys).

host

Host name of the machine where WebCenter Portal is running.

port

Port number used to access WebCenter Portal.

sesSchema

Optional. Username for the Oracle SES administrative user. Default value is eqsys.

verbose

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

When set to 1, listSpacesCrawler returns the Spaces crawler configured for WebCenter Portal in Oracle SES, along with details.

When set to 0, only source names are listed. This argument defaults to 0.

server

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

Required when applications with the same name are deployed to different servers and also when you have a 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

2.17.5 listDocumentsCrawler

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

sesUrl

Web service URL for the Oracle SES Administration API. Use the format:

http://host:port/search/api/admin/AdminService

sesPassword

Password for the Oracle SES administrative user (eqsys).

host

Host name of the machine where the application is running.

port

Port number used to access the application.

sesSchema

Optional. Username for the Oracle SES administrative user. Default value is eqsys.

verbose

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

When set to 1, listDocumentsCrawler returns the documents crawler that is configured for the application in Oracle SES, along with details.

When set to 0, only source names are listed. This argument defaults to 0.

server

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

Required when applications with the same name are deployed to different servers and also when you have a 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

2.17.6 listDiscussionsCrawler

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

sesUrl

Web service URL for the Oracle SES Administration API. Use the format:

http://host:port/search/api/admin/AdminService

sesPassword

Password for the Oracle SES administrative user (eqsys).

host

Host name of the machine where the application is running.

port

Port number used to access the application.

sesSchema

Optional. Username for the Oracle SES administrative user. Default value is eqsys.

verbose

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

server

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

Required when applications with the same name are deployed to different servers and also when you have a 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

2.17.7 startSpacesCrawler

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

sesUrl

Web service URL for the Oracle SES Administration API. Use the format:

http://host:port/search/api/admin/AdminService

sesPassword

Password for the Oracle SES administrative user (eqsys).

host

Host name of the machine where WebCenter Portal is running.

port

Port number used to access WebCenter Portal.

sesSchema

Optional. Username for the Oracle SES administrative user. Default value is eqsys.

server

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

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

2.17.8 startDocumentsCrawler

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

sesUrl

Web service URL for the Oracle SES Administration API. Use the format:

http://host:port/search/api/admin/AdminService

sesPassword

Password for the Oracle SES administrative user (eqsys).

host

Host name of the machine where the application is running.

port

Port number used to access the application.

sesSchema

Optional. Username for the Oracle SES administrative user. Default value is eqsys.

server

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

Required when applications with the same name are deployed to different servers and also when you have a 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')

2.17.9 startDiscussionsCrawler

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

sesUrl

Web service URL for the Oracle SES Administration API. Use the format:

http://host:port/search/api/admin/AdminService

sesPassword

Password for the Oracle SES administrative user (eqsys).

host

Host name of the machine where the application is running.

port

Port number used to access the application.

sesSchema

Optional. Username for the Oracle SES administrative user. Default value is eqsys.

server

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

Required when applications with the same name are deployed to different servers and also when you have a 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')

2.17.10 stopSpacesCrawler

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

sesUrl

Web service URL for the Oracle SES Administration API. Use the format:

http://host:port/search/api/admin/AdminService

sesPassword

Password for the Oracle SES administrative user (eqsys).

host

Host name of the machine where WebCenter Portal is running.

port

Port number used to access WebCenter Portal.

sesSchema

Optional. Username for the Oracle SES administrative user. Default value is eqsys.

server

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

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

2.17.11 stopDocumentsCrawler

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

sesUrl

Web service URL for the Oracle SES Administration API. Use the format:

http://host:port/search/api/admin/AdminService

sesPassword

Password for the Oracle SES administrative user (eqsys).

host

Host name of the machine where the application is running.

port

Port number used to access the application.

sesSchema

Optional. Username for the Oracle SES administrative user. Default value is eqsys.

server

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

Required when applications with the same name are deployed to different servers and also when you have a 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')

2.17.12 stopDiscussionsCrawler

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

sesUrl

Web service URL for the Oracle SES Administration API. Use the format:

http://host:port/search/api/admin/AdminService

sesPassword

Password for the Oracle SES administrative user (eqsys).

host

Host name of the machine where the application is running.

port

Port number used to access the application.

sesSchema

Optional. Username for the Oracle SES administrative user. Default value is eqsys.

server

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

Required when applications with the same name are deployed to different servers and also when you have a 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')

2.17.13 deleteSpacesCrawler

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

sesUrl

Web service URL for the Oracle SES Administration API. Use the format:

http://host:port/search/api/admin/AdminService

sesPassword

Password for the Oracle SES administrative user (eqsys).

host

Host name of the machine where WebCenter Portal is running.

port

Port number used to access WebCenter Portal.

sesSchema

Optional. Username for the Oracle SES administrative user. Default value is eqsys.

server

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

Required when applications with the same name are deployed to different servers and also when you have a 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')

2.17.14 deleteDocumentsCrawler

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

sesUrl

Web service URL for the Oracle SES Administration API. Use the format:

http://host:port/search/api/admin/AdminService

sesPassword

Password for the Oracle SES administrative user (eqsys).

host

Host name of the machine where the application is running.

port

Port number used to access the application.

sesSchema

Optional. Username for the Oracle SES administrative user. Default value is eqsys.

server

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

Required when applications with the same name are deployed to different servers and also when you have a 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')

2.17.15 deleteDiscussionsCrawler

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

sesUrl

Web service URL for the Oracle SES Administration API. Use the format:

http://host:port/search/api/admin/AdminService

sesPassword

Password for the Oracle SES administrative user (eqsys).

host

Host name of the machine where the application is running.

port

Port number used to access the application.

sesSchema

Optional. Username for the Oracle SES administrative user. Default value is eqsys.

server

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

Required when applications with the same name are deployed to different servers and also when you have a 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')

2.18 Search - WebCenter Portal Search

Use the commands listed in Table 2-25 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-25 WebCenter Portal Search WLST Commands

Use This Command...

To...

Use with WLST...

setSearchConfig

Modify search settings for a named application.

Online

listSearchConfig

List search properties for a named application.

Online

setSpacesCrawlProperties

Specify crawl properties for a named application.

Online

getSpacesCrawlProperties

Return the current crawl settings for a named application.

Online

2.18.1 setSearchConfig

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

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, WC_Portal.

Required when applications with the same name are deployed to different servers and also 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);

2.18.2 listSearchConfig

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

server

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

Required when applications with the same name are deployed to different servers and also when you have a 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')

2.18.3 setSpacesCrawlProperties

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

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

When set to 0, Oracle WebCenter Portal's internal search adapters return search results.

documentCrawlEnabled

Optional. Specifies whether the Documents crawler is enabled in Oracle SES. Valid values are 1 (true) and 0 (false). This argument defaults to 0.

When set to 0, Oracle WebCenter Portal's internal search adapters return search results.

discussionsCrawlEnabled

Optional. Specifies whether the Discussions and Announcement crawlers are enabled in Oracle SES. Valid values are 1 (true) and 0 (false). This argument defaults to 0.

When set to 0, Oracle WebCenter Portal's internal search adapters return search results.

server

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

Required when applications with the same name are deployed to different servers and also when you have a 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)

2.18.4 getSpacesCrawlProperties

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

server

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

Required when applications with the same name are deployed to different servers and also when you have a 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

2.19 WebCenter Portal Application

Use the commands listed in Table 2-26 to manage workflow settings and metadata for WebCenter Portal.

Table 2-26 WebCenter Portal Application WLST Commands

Use This Command...

To...

Use with WLST...

getSpacesWorkflowConnectionName

Return the name of the BPEL server connection that WebCenter Portal is using for internal workflows.

Online

setSpacesWorkflowConnectionName

Specify the BPEL server connection used for WebCenter Portal workflows.

Online

2.19.1 getSpacesWorkflowConnectionName

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

server

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

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

2.19.2 setSpacesWorkflowConnectionName

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

name

Name of an existing BPEL server connection.

server

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

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

2.20 Identity Store

Use the commands listed in Table 2-27 to configure options for searching an application's identity store.

Table 2-27 WebCenter Portal Identity Store WLST Commands

Use this command...

To...

Use with WLST...

setWebCenterIdStoreSearchConfig

Modify configuration options for searching a named applications's identity store.

Online

listWebCenterIdStoreSearchConfig

List current configuration options for searching a named application's identity store.

Online

2.20.1 setWebCenterIdStoreSearchConfig

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

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 maxSearchFilters property to match your LDAP server setting.

maxFetchRecords

Optional. Maximum number of records to be returned from each search query. Out-of-the-box, the default is 100.

The value of this setting will impact the performance of your LDAP server so take this into consideration when increasing the search result limit.

Note that the LDAP server imposes its own search result limit, so the actual limit that is used will be the lesser of these two values.

server

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

Required when applications with the same name are deployed to different servers and also when you have a 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);

2.20.2 listWebCenterIdStoreSearchConfig

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

server

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

Required when applications with the same name are deployed to different servers and also when you have a 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

2.21 Lifecycle

Use the commands listed in Table 2-28 to perform lifecycle operations for WebCenter Portal.

Table 2-28 Lifecycle WLST Commands

Use this command...

To...

Use with WLST...

deployWebCenterPortal

Deploy a portal from a stage environment to a production environment.

Online

propagateWebCenterPortal

Propagate metadata for a named portal, from a stage environment to a production environment.

Online

exportWebCenterPortals

Export one or more named portals to a portal archive (.par file).

Online

exportWebCenterPortalTemplates

Export one or more named portal templates to a portal archive (.par file).

Online

importWebCenterPortals

Import one or more portals or portal templates from a portal archive (.par file).

Online

listWebCenterPortalArchive

List the content of a portal archive and extract the portal archive to a specified location

Online or Offline

exportWebCenterPortalConnections

Export connection configuration information from a source WebCenter Portal environment to a named file.

Online

importWebCenterPortalConnections

Import new WebCenter Portal connections from a named connection properties file.

Online

setSpaceState

Take a portal offline or bring a portal online.

Online

exportWebCenterResource

Export a portal asset to an export archive (.aar file).

Online

importWebCenterResource

Import a portal asset from an export archive (.aar file)

Online

importWebCenterTranslations

Import translations for WebCenter Portal.

Online

exportWebCenterApplication

Export the WebCenter Portal application to an export archive (.par file).

Online

importWebCenterApplication

Import the WebCenter Portal application from an export archive (.par file).

Online

exportPortletClientMetadata

Export portlet client metadata and producer customizations and personalizations to an export archive.

Online

importPortletClientMetadata

Import portlet client metadata and producer customizations and personalizations from an export archive.

Online

showProducerImportFailures

Display names of producers where metadata imports have failed and reasons for those failures.

Online

retryAllFailedProducerImports

Attempt to import outstanding producer metadata.

Online

cloneWebCenterManagedServer

Clone a Managed Server used by WebCenter Portal.

Online

2.21.1 deployWebCenterPortal

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

portalName

Name of the portal that you want to deploy. For example, portalName='myPortal'.

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 adf_createHttpUrlConnection to configure the connection if it does not exist.

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.

- 1 - Deploys the portal's content folder.

- 0 - Excludes portal content.

This argument defaults to 0.

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 deployData=1.

Valid values are 1 and 0.

- 1 - Activity stream messages from the source portal are deployed on the target.

- 0 - Activity stream messages from the source portal are not deployed to the target. Activity on the target (if any) is preserved. This option is useful when migrating between stage and production environments and where test activity data is not required.

This argument defaults to 1.

deploySharedAssets

Optional. Indicates whether to deploy non-seeded shared assets to the target.Valid values are 1 and 0.

- 1 - Deploy shared assets.

- 0 - Do not deploy shared assets.

This argument defaults to 0.

deployConnections

Optional. Indicates whether to deploy connections associated with portal to the target. Valid values are 1 and 0.

- 1 - Deploy connections.

- 0 - Do not deploy connections.

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.

- 1 - Redeploys the portal.

- 0 - Prevents redeployment if the portal exists.

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.

- 1 - Backs up the portal before deployment. The backup archive is saved to the temporary directory on the target machine.

- 0 - Does not perform a portal back up before deployment.

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 PortalDeploy_timestamp.log is generated in the temporary directory.

server

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

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

2.21.2 propagateWebCenterPortal

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

portalName

Name of the portal that you want to propagate. For example, portalName='myPortal'.

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 adf_createHttpUrlConnection to configure the connection if it does not exist.

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:

- 1 - Back up the target portal to an archive before propagation. If created, the backup archive is saved to the /tmp directory on the target machine.

- 0 - Do not back up the target portal before propagating changes.

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 PortalPropagation_timestamp.log is generated in the temporary directory.

propagateSharedAssets

Optional. Specifies whether to propagate non-seeded shared assets metadata changes to the target.

Valid values are 1 and 0:

- 1 - Include shared assets changes.

- 0 - Do not include shared assets changes.

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:

- 1 -Propagate portal content.

- 0 - Exclude portal content.

The default value is 0.

server

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

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

2.21.3 exportWebCenterPortals

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

fileName

Name and location of the export archive (.par file). For example, /myExports/myPortalExport.par.

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: names='sales,finance'

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 names argument blank, all the portals are exported (up to a maximum of ten portals). If your instance contains more than ten portals you must name each portal individually, using the names argument.

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.

- 1 - Take online portals (if any) offline before starting the export process and at the end of the export process, return those portals back to their original online state.
To prevent data loss during the export process, Oracle recommends that you set offlineDuringExport=1.

- 0 - Export the portals in their current state.

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.

- 1 - Export the portal's content folder.

- 0 - Exclude portal content.

The default value is 0.

exportConnections

Optional. Specifies whether to export WebCenter Portal connections into a file named connection.properties and include it in the portal archive (.par file).

In addition, a copy of connection.properties is included outside the archive at the same location, that is, the location specified using the fileName option.

Valid values are 1 and 0.

- 1 - Export WebCenter Portal connections

- 0 - Do not export WebCenter Portal connections.

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.

- 1 - Export shared assets.

- 0 - Do not export shared assets.

The default value is 0.

server

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

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

2.21.4 exportWebCenterPortalTemplates

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

fileName

Name and location of the export archive (.par file). For example, /myExports/myPortalTemplateExport.par.

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: names='mySalesTemplate,myHRTemplate'

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 names argument blank, all the templates are exported (up to a maximum of ten templates). If your instance contains more than ten portal templates you must name each template individually, using the names argument.

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.

- 1 - Export the portal template's content folder.

- 0 - Exclude portal template content.

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.

- 1 - Extract WebCenter Portal connections.

- 0 - Do not extract WebCenter Portal connections.

The default value is 1.

server

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

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

2.21.5 importWebCenterPortals

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

fileName

Name of the portal archive (.par file) containing the portals or portal templates you want to import. For example, mySalesPortal.par.

names

Optional. Name of one or more portals or portal templates that you want to import. For example: names='sales'.

Separate multiple names with a comma. For example: names='sales,finance'

Note: Do not enter display names here. You must enter the name that is specified in the portal or portal template URL:

- Portal names are available from the About Portal dialog.

- Portal template names are available from the About Portal Template dialog.

Note: If a .par file has multiple portals, then names is used to selectively import portals; that is, portal names specified against this parameter are imported. If this is omitted, all the portals in the .par file are imported.  For a .par file with a single portal, this parameter can be ignored.

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.

- 1 - Import portal content.

- 0 - Exclude portal content. This option is useful when migrating between stage and production environments where test content is no longer required.

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.

- 1 - Activity messages stored in the portal archive are imported.

- 0 - Activity messages are not imported.

This argument defaults to 1.

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 1 and 0.

- 1 - Overwrite the portal.

- 0 - Prevent import if the portal exists. Only import new portals (or portal templates).

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:

- 1 - Before importing, save any of the specified portals that exist on the target to an archive. If created, the archive is copied to the /tmp directory on the target machine.

- 0 - Do not save existing portals before the import operation. .

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.

- 1 - Take the portals offline before starting the import process.

- 0 - Attempt to import the portals. If one or more portals are currently online, you are prompted to take the portals offline.

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 PortalImport_ timestamp.log is generated in the temporary directory.

importConnections

Optional. Specifies whether to import connections associated with the portal on the instance. Valid values are 1 and 0.

Valid values are 1 and 0.

- 1 - Import connections used by the portal.

- 0 - Exclude connections.

The default is 1.

connPropertiesFile

Optional. Specifies the name and location of a connection properties file. For example: /myConnections/connection.properties

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 importConnections is set to 0, this argument is ignored.

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 1 and 0.

- 1 - Import shared assets.

- 0 - Do not import shared assets.

The default is 0.

server

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

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

2.21.6 listWebCenterPortalArchive

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

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, WC_Portal.

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

2.21.7 exportWebCenterPortalConnections

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

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:

connectionType='wsrpProducerConnection, webServiceConnection'

If left blank, all connection types are exported.

Valid connection types are:

- analyticsCollectorConnection (Analytics collector)

- webcenterContentServerConnection (Oracle WebCenter Content)

- discussionConnection (Discussions server)

- personalEventConnection (Presence server)

- externalAppConnection (External application)

- mailConnection (Mail server)

- sesConnection (Oracle Secure Enterprise Search)

- wsrpProducerConnection (WSRP portlet producer)

- jpdkProducerConnection (PDK-Java portlet producer)

- pageletProducerConnection (Pagelet producer)

- impConnection (Presence server)

- urlConnection (URL)

- webServiceConnection (Web service)

- bpelConnection ( BPEL server)

- restConnection

Note: This argument is mandatory if you specify connectionName.

connectionName

Optional. Names specific connections you want to export for a single connectionType. Separate multiple connection names with a comma.

For example, if connectionType='wsrpProducerConnection', you can specify to export one or more connections of this type: connectionName='myWSRPProducer1,myWSRPProducer2'

When you specify a value for connectionName, you must specify the connectionType argument as well. For example: exportWebCenterPortalConnections(appName='webcenter', fileName='/scratch/conn.properties', connectionType='wsrpProducerConnection', connectionName='MyWSRPConn')

Note: If no names are specified, all connections are exported for the specified connectionType.

logFile

Specifies a name of a local log file containing detailed information about the export connection operation.

If not specified, a log file named ConnectionExport_< timestamp>.log is generated in the temporary directory.

server

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

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

2.21.8 importWebCenterPortalConnections

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

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:

- 1 - Prompts the user to enter credentials if a password is required.

- 0 - Do not prompt the user to enter passwords if required to create a new connection. Always set this argument to 0 if you run this command within a script.

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 ConnectionImport_< timestamp>.log is generated in the temporary directory.

server

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

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

2.21.9 setSpaceState

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

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 1 and 0:

- 1 takes the portal offline

- 0 brings the portal online

server

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

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

2.21.10 exportWebCenterResource

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

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: pageTemplate, contentPresenter, pageStyle, resourceCatalog, skin, layout,taskFlow, dataControl, device, deviceGroup,dataSource, sqlDataSource, appIntgVisualization ,visualizationTemplate.

Where:

- pageTemplate - page template

- contentPresenter - Content presenter display template

- pageStyle - page style

- resourceCatalog - resource catalog

- skin - skin

- taskFlow - task flow

- taskflowStyle - task flow style

- dataControl - data control

- device - device

- deviceGroup - device group

- dataSource - data source

- sqlDataSource - SQL data source

- appIntgVisualization - Application integration visualization

- visualizationTemplate - Visualization template

You cannot export or import out-of-the-box assets, devices, or device groups.

Note: In this release, taskFlowStyle replaces the asset type mashupStyle. The mashupStyle option is deprecated but continues to work in this release for backward compatibility.

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 resourceType is set to device or deviceGroup.

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 resourceType is set to device or deviceGroup.

exportContentDirectory

Deprecated.

You can no longer include MDS content associated with assets in export archives. Use the standard MDS WLST command exportMetadata to migrate legacy MDS content, if required.

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

2.21.11 importWebCenterResource

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

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: pageTemplate, contentPresenter, pageStyle, navigation, resourceCatalog, skin, taskFlow, mashupStyle, dataControl, device, deviceGroup

Where:

- pageTemplate - page template

- contentPresenter - Content presenter display template

- pageStyle - page style

- navigation - navigation models

- resourceCatalog - resource catalog

- skin - skin

- taskFlow - task flow

- taskflowStyle - task flow style

- dataControl - data control

- device - device

- deviceGroup - device group

If the archive (.aar file) contains one or more devices or device groups, then this argument is mandatory:

- When resourceType='device', all devices in the archive are imported.

- When resourceType='deviceGroup', all device groups in the archive and their associated devices are imported.

Note: In this release, taskFlowStyle replaces the asset type mashupStyle. The mashupStyle option is deprecated but continues to work in this release for backward compatibility.

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 resourceType is set to device or deviceGroup.

overwriteContentDirectory

Deprecated.

You can no longer include MDS content associated with assets in export archives. Use the standard MDS WLST command importMetadata to migrate legacy MDS content, if required.

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

2.21.12 importWebCenterTranslations

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

server

Name of the target managed server on which WebCenter Portal is deployed. For example, WC_Portal.

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

2.21.13 exportWebCenterApplication

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

fileName

Name of the export archive (.par file) to which you want the export to be written.

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, WC_Portal.

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

2.21.14 importWebCenterApplication

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

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, WC_Portal.

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

2.21.15 exportPortletClientMetadata

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

fileName

Name of the export archive (.ear file) to which you want the export to be written.

exportPersonalizations

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

- 1 - Personalizations for all producers are exported.

- 0 - Personalizations are not exported.

This argument defaults to 1.

server

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

Required when applications with the same name are deployed to different servers and also when you have a 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')

2.21.16 importPortletClientMetadata

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

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, WC_Portal.

Required when applications with the same name are deployed to different servers and also when you have a 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')

2.21.17 showProducerImportFailures

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

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

2.21.18 retryAllFailedProducerImports

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

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.

2.21.19 cloneWebCenterManagedServer

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.

verbose

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.

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)

2.22 Upgrade

Use the commands listed in Table 2-29 when upgrading from a previous Oracle WebCenter Portal release.

Table 2-29 Oracle WebCenter Portal Upgrade WLST Commands

Use this command...

To...

Use with WLST...

upgradeWebCenterPortal

Upgrade WebCenter Portal.

Online

listDeprecatedFeaturesUsage

List deprecated connections, taskflows and portlets used in the upgraded WebCenter Portal application.

Online

2.22.1 upgradeWebCenterPortal

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 the upgradeWebCenterPortal 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 webcenter.

server

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

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, UCM_server1.

Specify this argument if WebCenter Portal is configured to use Content Server.

contentDbConnectionUrl

Optional.

Connection URL for the database where WebCenter Content schema (named OCS) is present. Use the connection URL format host:port:sid.

contentDbUserName

Optional.

Note: Mandatory if contentDbConnectionUrl is specified.

User name of the WebCenter Content schema (named OCS) that you want to migrate.

includeFolders

Optional. Comma separated list of folders to be included for migration from Folders_g to FrameworkFolders. The PersonalSpaces folder and the WebCenter Portal root folder are migrated by default.

For example, if you want to migrate Contribution Folders and Common Templates, specifyincludeFolders='Contribution Folders,Common Templates'. After migration, Contribution Folders will be migrated as /Enterprise Libraries/Contribution Folders and Common Templates will be migrated as /Enterprise Libraries/Common Templates.

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 the upgradeWebCenterPermissions 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.

2.22.2 listDeprecatedFeaturesUsage

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

server

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

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

3 Oracle WebCenter Content Custom WLST Commands

This chapter provides detailed descriptions of custom WLST commands for Oracle WebCenter Content, including command syntax, arguments and command examples.

The following sections describe the custom WLST commands for Oracle WebCenter Content. These commands enable you to configure and monitor the Oracle WebCenter Content server and the Oracle WebCenter Content Server instance from the command line. Topics include:

- Overview of WLST WebCenter Content Command Categories

- WLST WebCenter Content Help

- Getter and Setter Methods Implementation

- Server Configuration Commands

- Email Configuration Commands

- System Status Commands

- General Configuration Commands

- Content Security Configuration Commands

- Component Manager Configuration Commands

- Records Management Configuration Commands

- User Interface Commands

- User Interface Connection Commands

For additional information about Oracle WebCenter Content and Content Server administration and configuration, see Administering Oracle Fusion Middleware.

Note:

To use the Oracle WebCenter Content custom commands, you must invoke the WLST script from the Oracle Common home in which the component has been installed. For more information, see Using WLST with Java Components and Oracle Fusion Middleware Services in Administering Oracle Fusion Middleware.

3.1 Overview of WLST WebCenter Content Command Categories

WLST WebCenter Content commands are divided into the following categories:

Table 3-1 WLST WebCenter Content Command Categories

Command Category

Description

Server Configuration Commands

View and manage server configuration options for the Content Server instance.

Email Configuration Commands

View and manage email configuration options for the Content Server instance.

System Status Commands

View system status information for the Content Server instance.

General Configuration Commands

View and manage general configuration options for the Content Server instance.

Content Security Configuration Commands

View and manage content security configuration options for the Content Server instance.

Component Manager Configuration Commands

View and manage Component Manager configuration options for the Content Server instance.

Records Management Configuration Commands

View and manage records management configuration options for the Content Server instance.

User Interface Commands

View and manage configuration for the optional Oracle WebCenter Content user interface.

User Interface Connection Commands

View and manage connections for the Oracle WebCenter Content user interface introduced in WebCenter Content 11g Release 1 (11.1.1.8)

3.2 WLST WebCenter Content Help

To view the WebCenter Content UCM commands that can be invoked from WLST, enter the following command at the WLST prompt:

help('UCM')

To view help for a specific Oracle Webcenter Content command, specify the name of the command; for example:

help('getUCMServerPort')

help('wccAdfConfig')

3.3 Getter and Setter Methods Implementation

The WLST component for Oracle Webcenter Content uses getter and setter methods to handle a situation where multiple applications register their corresponding Mbeans on a managed server, but WLST can talk to only one application.

Getter Method

The getter method is designed to handle zero or one argument.

If you do not provide an argument to an WLST WebCenter Content command, then one of two things occurs:

- If only one application has registered its Mbean on the server, then the WLST WebCenter Content command should work successfully and display the output.

- If multiple applications have registered Mbeans on the server, then an error message is displayed to prompt you to enter the specific application name in the argument.

If there is one argument to an WLST WebCenter Content command, then the following occurs:

- You must enter the correct application name when entering an argument. If the name is not entered properly, then an error message is displayed to prompt you to enter the valid application name in the argument.

Setter Method

The setter method is designed to handle one or two arguments.

- The first argument is the value to which you want to set the parameter.

- The second argument is the application name, which can be null or a string.

3.4 Server Configuration Commands

Use the commands in Table 3-2 to configure the Oracle WebCenter Content Server instance.

Before you use these custom commands, set up the initial WLST connection as follows:

1. Set the environment variable ORACLE_HOME to <Middleware_Home>/Oracle_ECM1.

2. Run the WLST script from the following location: <middleware_home>/Oracle_ECM1/common/bin.

3. Connect to the WebCenter Content Server instance using the connect() command, for example, connect("weblogic","password","t3://localhost:16200").

Table 3-2 WLST Server Configuration Commands

Use this command...

To...

Use with WLST...

getUCMHttpServerAddress

Display the HTTP Server Address value.

Online

getUCMServerPort

Display the Intradoc Server Port configuration parameter.

Online

setUCMServerPort

Set the Intradoc Server Port configuration parameter.

Online

getUCMIpAddressFilter

Display the IP Address Filter value.

Online

setUCMIpAddressFilter

Set the IP Address Filter value.

Online

getUCMUseSSL

Display the Use SSL value.

Online

3.4.1 getUCMHttpServerAddress

Use with WLST: Online

Description

Gets the HTTP Server Address value from the config.cfg file and displays it.

Syntax

getUCMHttpServerAddress(['appName'])

Argument

Definition

appName

Optional. Name of the deployed application.

Example

The following command displays the Oracle Webcenter Content HTTP server address for the application "Oracle Universal Content Management - Content Server":

getUCMHttpServerAddress('Oracle Universal Content Management - Content Server')
server.example.com

3.4.2 getUCMServerPort

Use with WLST: Online

Description

Gets the Intradoc Server Port configuration parameter from the config.cfg file and displays it.

Syntax

getUCMServerPort(['appName'])

Argument

Definition

appName

Optional. Name of the deployed application.

Example

The following command displays the Intradoc Server Port value for the application "Oracle Universal Content Management - Content Server":

getUCMServerPort('Oracle Universal Content Management - Content Server')
4442

3.4.3 setUCMServerPort

Use with WLST: Online

Description

Sets the Server Port configuration parameter.

Syntax

setUCMServerPort(value,['appName'])

Argument

Definition

value

Server Port number. This number must be a positive integer between 0 and 65535.

appName

Optional. Name of the deployed application.

Example

The following command sets the Server Port configuration parameter for the application '"Oracle Universal Content Management - Content Server":

setUCMServerPort(4442,'Oracle Universal Content Management - Content Server')

3.4.4 getUCMIpAddressFilter

Use with WLST: Online

Description

Gets the IP Address Filter value from the config.cfg file and displays it.

Syntax

getUCMIPpAddressFilter(['appName'])

Argument

Definition

appName

Optional. Name of the deployed application.

Example

The following command displays the IP address filter value for the application "Oracle Universal Content Management - Content Server":

getUCMIpAddressFilter('Oracle Universal Content Management - Content Server')
10.131.123.*

3.4.5 setUCMIpAddressFilter

Use with WLST: Online

Description

Sets the Webcenter Content IP Address Filter value.

Syntax

setUCMIpAddressFilter(value,['appName'])

Argument

Definition

value

WebCenter Content IP Address Filter number. This number must be of "*.*.*.*" format or IPV6 Format. The value must be taken from a list of IP Addresses allowed to communicate with the Content Server instance through the Intradoc Server Port.

appName

Optional. Name of the deployed application.

Example

The following command sets the value for the WebCenter Content IP address filter for the application "Oracle Universal Content Management - Content Server":

setUCMIpAddressFilter(10.131.123.*,'Oracle Universal Content Management - Content Server')

3.4.6 getUCMUseSSL

Use with WLST: Online

Description

Gets the Use SSL value from the config.cfg file and displays it. The value can be True or False.

Syntax

getUCMUseSSL(['appName'])

Argument

Definition

appName

Optional. Name of the deployed application.

Example

The following command displays the Use SSL value for the application "Oracle Universal Content Management - Content Server":

getUCMUseSSL('Oracle Universal Content Management - Content Server')
True

3.5 Email Configuration Commands

Use the commands in Table 3-3 to configure email for the Oracle WebCenter Content Server instance.

Table 3-3 WLST E-Mail Configuration Commands

Use this command...

To...

Use with WLST...

getUCMMailServer

Display the Mail Server value.

Online

setUCMMailServer

Set the Mail Server value.

Online

getUCMSmtpPort

Display the SMTP Port value.

Online

getUCMSysAdminAddress

Display the Admin Address value.

Online

setUCMSysAdminAddress

Set the Admin Address value.

Online

3.5.1 getUCMMailServer

Use with WLST: Online

Description

Gets the Mail Server value from the config.cfg file and displays it.

Syntax

getUCMMailServer(['appName'])

Argument

Definition

appName

Optional. Name of the deployed application.

Example

The following command displays the Mail Server value for the application "Oracle Universal Content Management - Content Server":

getUCMMailServer('Oracle Universal Content Management - Content Server')
mymailserver.example.com

3.5.2 setUCMMailServer

Use with WLST: Online

Description

Sets the Mail Server value in the config.cfg file.

Syntax

setUCMMailServer(value,['appName'])

Argument

Definition

value

Value for the Mail Server. The value is the name of the mail server that the Content Server instance uses to send SMTP based email.

appName

Optional. Name of the deployed application.

Example

The following command sets the value for the Mail Server for the application "Oracle Universal Content Management - Content Server":

setUCMMailServer(mymailserver.example.com,'Oracle Universal Content Management - Content Server')

3.5.3 getUCMSmtpPort

Use with WLST: Online

Description

Gets the SMTP Port value in the config.cfg file and displays it.

Syntax

getUCMSmtpPort(['appName'])

Argument

Definition

appName

Optional. Name of the deployed application.

Example

The following command displays the SMTP port value for the application "Oracle Universal Content Management - Content Server":

getUCMSmtpPort('Oracle Universal Content Management - Content Server')
4055

3.5.4 getUCMSysAdminAddress

Use with WLST: Online

Description

Gets the Admin Address value from the config.cfg file and displays it. The value can be of the form abc@xyz.def.

Syntax

getUCMSysAdminAddress(['appName'])

Argument

Definition

appName

Optional. Name of the deployed application.

Example

The following command displays the Admin Address value for the application "Oracle Universal Content Management - Content Server":

getUCMSysAdminAddress('Oracle Universal Content Management - Content Server')
mymail@example.com

3.5.5 setUCMSysAdminAddress

Use with WLST: Online

Description

Sets the Admin Address value in the config.cfg file.

Syntax

setUCMSysAdminAddress(value,['AppName'])

Argument

Definition

value

Value for the Admin Address. The Admin Address can be of the form abc@xyz.def.

appName

Optional. Name of the deployed application.

Example

The following command sets the Admin Address value for the application "Oracle Universal Content Management - Content Server":

setUCMSysAdminAddress(mymail@example.com,'Oracle Universal Content Management - Content Server')

3.6 System Status Commands

Use the commands in Table 3-4 to configure additional settings to monitor the WebCenter Content Server instance.

Table 3-4 WLST Additional Configuration Commands

Use this command...

To...

Use with WLST...

getUCMCSVersion

Display the version number.

Online

getUCMServerUptime

Display the uptime value.

Online

3.6.1 getUCMCSVersion

Use with WLST: Online

Description

Gets the version number of the Content Server running instance.

Syntax

getUCMCSVersion(['appName'])

Argument

Definition

appName

Optional. Name of the deployed application.

Example

The following command displays the version number of the active instance of the application "Oracle Universal Content Management - Content Server":

getUCMCSVersion('Oracle Universal Content Management - Content Server')
11g R1

3.6.2 getUCMServerUptime

Use with WLST: Online

Description

Gets the amount of time the Content Server instance has been up.

Syntax

getUCMServerUptime(['appName'])

Argument

Definition

appName

Optional. Name of the deployed application.

Example

The following command displays the amount of time the application "Oracle Universal Content Management - Content Server" has been up:

getUCMServerUptime('Oracle Universal Content Management - Content Server')
00H:01 Min:12 Sec

3.7 General Configuration Commands

Use the commands in Table 3-5 to configure general configuration options for the Oracle WebCenter Content Server instance.

Table 3-5 WLST General Configuration Options Commands

Use this command...

To...

Use with WLST...

getUCMOverRideFormat

Display the OverRideFormat value.

Online

setUCMOverRideFormat

Set the OverRideFormat value.

Online

getUCMDownloadApplet

Display the DownloadApplet value.

Online

setUCMDownloadApplet

Set the DownloadApplet value.

Online

getUCMMultiUpload

Display the MultiUpload value.

Online

setUCMMultiUpload

Set the MultiUpload value.

Online

getUCMUseAccounts

Display the UseAccount value.

Online

setUCMUseAccounts

Set the UseAccount value.

Online

getUCMIsAutoNumber

Display the AutoNumber value.

Online

setUCMIsAutoNumber

Set the AutoNumber value.

Online

getUCMAutoNumberPrefix

Display the AutoNumberPrefix value.

Online

setUCMAutoNumberPrefix

Set the AutoNumberPrefix value.

Online

getUCMMajorRevLabelSeq

Display the MajorRevLabelSeq value.

Online

setUCMMajorRevLabelSeq

Set the MajorRevLabelSeq value.

Online

getUCMMinorRevLabelSeq

Display the MinorRevLabelSeq value.

Online

setUCMMinorRevLabelSeq

Set the MinorRevLabelSeq value.

Online

getUCMJspServerEnabled

Display the JspServerEnabled value

Online

setUCMJspServerEnabled

Set the JspServerEnabled value.

Online

getUCMJspEnabledGroups

Display the JspEnabledGroups value.

Online

setUCMJspEnabledGroups

Set the JspEnabledGroups value.

Online

3.7.1 getUCMOverRideFormat

Use with WLST: Online

Description

Gets the value from the config.cfg file, indicating whether the OverrideFormat parameter is set. The OverrideFormat parameter enables users to choose the application format of their content items.

Syntax

getUCMOverRideFormat(['appName'])

Argument

Definition

appName

Optional. Name of the deployed application.

Example

The following command displays the OverRideFormat parameter value:

getUCMOverRideFormat()
true

3.7.2 setUCMOverRideFormat

Use with WLST: Online

Description

Sets the OverrideFormat parameter to enable or disable the ability for users to choose the application format of their content items.

Syntax

getUCMOverRideFormat('value',['appName'])

Argument

Definition

value

Specifies whether to enable or disable the OverrideFormat option. Values can be: Yes, No, True, False, 1, 0.

appName

Optional. Name of the deployed application.

Example

The following command enables the OverRideFormat parameter:

getUCMOverRideFormat('True')

3.7.3 getUCMDownloadApplet

Use with WLST: Online

Description

Gets the value from the config.cfg file indicating whether the DownloadApplet parameter is set. DownloadApplet enables users to download multiple files from a search results page.

Syntax

getUCMDownloadApplet(['appName'])

Argument

Definition

appName

Optional. Name of the deployed application.

Example

The following command gets the value for the DownloadApplet parameter:

getUCMDownloadApplet()
true

3.7.4 setUCMDownloadApplet

Use with WLST: Online

Description

Sets the DownloadApplet parameter value to enable or disable the ability for users to download multiple files from a search results page.

Syntax

setUCMDownloadApplet('value',['appName'])

Argument

Definition

value

Specifies whether to enable or disable the DownloadApplet option. Values can be: Yes, No, True, False, 1, 0.

appName

Optional. Name of the deployed application.

Example

The following command sets the value for the DownloadApplet to enable the functionality:

setUCMDownloadApplet('Yes')

3.7.5 getUCMMultiUpload

Use with WLST: Online

Description

Gets the value from the config.cfg file indicating whether the MultiUpload parameter is set. MultiUpload allows multiple files to be zipped and checked in as a single content item.

Syntax

getUCMMultiUpload(['appName'])

Argument

Definition

appName

Optional. Name of the deployed application.

Example

The following command displays the value for the MultiUpload parameter:

getUCMMultiUpload()
true

3.7.6 setUCMMultiUpload

Use with WLST: Online

Description

Sets the MultiUpload parameter value to allow or disallow multiple files to be zipped and checked in as a single content item.

Syntax

setUCMMultiUpload('value',['appName'])

Argument

Definition

value

Specifies whether to enable or disable the MultiUpload option. Values can be: Yes, No, True, False, 1, 0.

appName

Optional. Name of the deployed application.

Example

The following command sets MultiUpload to allow multiple files to be zipped and check in as a single content item:

setUCMMultiUpload('1')

3.7.7 getUCMUseAccounts

Use with WLST: Online

Description

Gets the value from the config.cfg file indicating whether the UseAccounts parameter is set. UseAccounts enables the use of accounts in Oracle WebCenter Content.

Syntax

getUCMUseAccounts(['appName'])

Argument

Definition

appName

Optional. Name of the deployed application.

Example

The following command displays the value for the UseAccounts option:

getUCMUseAccounts()
True

3.7.8 setUCMUseAccounts

Use with WLST: Online

Description

Sets the UseAccounts parameter value to enable to disable the use of accounts in Oracle WebCenter Content.

Syntax

setUCMUseAccounts('value',['appName'])

Argument

Definition

value

Specifies whether to enable or disable the UseAccounts option. Values can be: Yes, No, True, False, 1, 0.

appName

Optional. Name of the deployed application.

Example

The following command sets UseAccounts to enable accounts in Oracle WebCenter Content:

setUCMUseAccounts('True')

3.7.9 getUCMIsAutoNumber

Use with WLST: Online

Description

Gets the value from the config.cfg file indicating whether the IsAutoNumber parameter is set. The IsAutoNumber parameter enables automatic numbering of Content IDs.

Syntax

getUCMIsAutoNumber(['appName'])

Argument

Definition

appName

Optional. Name of the deployed application.

Example

The following command displays the value for the IsAutoNumber parameter:

getUCMIsAutoNumber()
True

3.7.10 setUCMIsAutoNumber

Use with WLST: Online

Description

Sets the IsAutoNumber parameter value to enable or disable automatic numbering of Content IDs.

Syntax

setUCMIsAutoNumber('value',['appName'])

Argument

Definition

value

Specifies whether to enable or disable the AutoNumber option. Values can be: Yes, No, True, False, 1, 0.

appName

Optional. Name of the deployed application.

Example

The following command sets IsAutoNumber to enable automatic numbering of Content IDs:

setUCMIsAutoNumber('True')

3.7.11 getUCMAutoNumberPrefix

Use with WLST: Online

Description

Gets the value from the config.cfg file for the AutoNumberPrefix parameter. The prefix is used in all automatically numbered content IDs for newly checked-in files, if the AutoNumber parameter is enabled.

Syntax

getUCMAutoNumberPrefix(['appName'])

Argument

Definition

appName

Optional. Name of the deployed application.

Example

The following command displays the value for the AutoNumberPrefix parameter:

getUCMAutoNumberPrefix()
dadvml0231usor

3.7.12 setUCMAutoNumberPrefix

Use with WLST: Online

Description

Sets the AutoNumberPrefix parameter value to a prefix used in all automatically numbered content IDs for newly checked-in files (if the AutoNumber parameter is enabled).

Syntax

setUCMUseAutoNumberPrefix('value',['appName'])

Argument

Definition

value

The prefix used in all automatically numbered content IDs for newly checked-in files. Only applies if the AutoNumber parameter is enabled.

appName

Optional. Name of the deployed application.

Example

The following command sets the AutoNumberPrefix:

setUCMAutoNumberPrefix('dadvml0231usor')

3.7.13 getUCMMajorRevLabelSeq

Use with WLST: Online

Description

Gets the value from the config.cfg file for MajorRevLabelSeq, which defines the major sequence for revision numbers. MajorRevLabelSeq is the first part of the Revision Label.

Syntax

getUCMMajorRevLabelSeq(['appName'])

Argument

Definition

appName

Optional. Name of the deployed application.

Example

The following command displays the value for the MajorRevLabelSeq parameter:

getUCMMajorRevLabelSeq()
A1

3.7.14 setUCMMajorRevLabelSeq

Use with WLST: Online

Description

Sets the value for the MajorRevLabelSeq parameter, which defines the major sequence for revision numbers. MajorRevLabelSeq is the first part of the Revision Label.

Syntax

setUCMMajorRevLabelSeq('value',['appName'])

Argument

Definition

value

Value can be any of the following: A through D, 1 through 8.

appName

Optional. Name of the deployed application.

Example

The following command sets MajorRevLabelSeq to 'A1':

setUCMMajorRevLabelSeq('A1')

3.7.15 getUCMMinorRevLabelSeq

Use with WLST: Online

Description

Gets the value from the config.cfg file for MinorRevLabelSeq, which defines the minor sequence for revision numbers. MinorRevLabelSeq is the second part of the Revision Label.

Syntax

getUCMMinorRevLabelSeq(['appName'])

Argument

Definition

appName

Optional. Name of the deployed application.

Example

The following command displays the value for the MinorRevLabelSeq parameter:

getUCMMinorRevLabelSeq()
b2

3.7.16 setUCMMinorRevLabelSeq

Use with WLST: Online

Description

Sets the value for the MinorRevLabelSeq parameter, which defines the minor sequence for revision numbers. MinorRevLabelSeq is the second part of the Revision Label.

Syntax

setUCMMinorRevLabelSeq('value',['appName'])

Argument

Definition

value

Value can be any of the following: a through c, 1 through 7.

appName

Optional. Name of the deployed application.

Example

The following command sets MinorRevLabelSeq to 'b2':

setUCMMinorRevLabelSeq('b2')

3.7.17 getUCMJspServerEnabled

Use with WLST: Online

Description

Gets the value from the config.cfg file indicating whether the JspServerEnabled is set. If the parameter is turned on, Content Server can execute Java Server Pages. The Java Server Pages must be checked in to Content Server.

Syntax

getUCMJspServerEnabled(['appName'])

Argument

Definition

appName

Optional. Name of the deployed application.

Example

The following command displays the value for the JspServerEnabled parameter:

getUCMJspServerEnabled()
true

3.7.18 setUCMJspServerEnabled

Use with WLST: Online

Description

Sets the value for the JspServerEnabled parameter. If the parameter is turned on, Content Server can execute Java Server Pages. The Java Server Pages must be checked in to Content Server.

Syntax

setUCMJspServerEnabled('value',['appName'])

Argument

Definition

value

Specifies whether to enable or disable the parameter. Values can be: Yes, No, True, False, 1, 0.

appName

Optional. Name of the deployed application.

Example

The following command sets JspServerEnabled to 'true':

setUCMJspServerEnabled('true')

3.7.19 getUCMJspEnabledGroups

Use with WLST: Online

Description

Gets the value from the config.cfg file for the JspEnabledGroups parameter and lists is. JspEnabledGroups lists security groups enabled for Java Server Page functionality. Security groups have certain permissions for contributors and administrators.

Syntax

getUCMJspEnabledGroups(['appName'])

Argument

Definition

appName

Optional. Name of the deployed application.

Example

The following command displays the value for the JspEnabledGroups parameter:

getUCMJspEnabledGroups()
group1
Jsp

3.7.20 setUCMJspEnabledGroups

Use with WLST: Online

Description

Sets the value for the JspEnabledGroups parameter, which specifies security groups to be enabled for Java Server Page functionality.

Syntax

setUCMJspEnabledGroups('value',['appName'])

Argument

Definition

value

Specifies the security groups to be enabled for Java Server Page functionality.

appName

Optional. Name of the deployed application.

Example

The following command sets JspEnabledGroups to 'group1':

setUCMJspEnabledGroups('group1')

3.8 Content Security Configuration Commands

Use the commands in Table 3-6 to configure content security options for the Oracle WebCenter Content Server instance.

Table 3-6 WLST Content Security Configuration Commands

Use this command...

To...

Use with WLST...

getUCMCopyAccess

Display the CopyAccess parameter value.

Online

setUCMCopyAccess

Set the CopyAccess parameter value.

Online

getUCMExclusiveCheckout

Display the ExclusiveCheckout parameter value.

Online

setUCMExclusiveCheckout

Set the ExclusiveCheckout parameter value.

Online

getUCMAuthorDelete

Display the AuthorDelete parameter value.

Online

setUCMAuthorDelete

Set the AuthorDelete parameter value.

Online

getUCMShowOnlyKnownAccounts

Display the ShowOnlyKnownAccounts parameter value.

Online

setUCMShowOnlyKnownAccounts

Set the ShowOnlyKnownAccounts parameter value.

Online

3.8.1 getUCMCopyAccess

Use with WLST: Online

Description

Gets the value from the config.cfg file and displays it. When CopyAccess is enabled, users with Read privilege on a content item can get a copy of the native file.

Syntax

getUCMCopyAccess(['appName'])

Argument

Definition

appName

Optional. Name of the deployed application.

Example

The following command displays the CopyAccess value:

getUCMCopyAccess()
True

3.8.2 setUCMCopyAccess

Use with WLST: Online

Description

Sets the CopyAccess value in the config.cfg file. When CopyAccess is enabled, users with Read privilege on a content item can get a copy of the native file.

Syntax

setUCMCopyAccess('value',['appName'])

Argument

Definition

value

Specifies whether to enable or disable the parameter. Values can be: Yes, No, True, False, 1, 0.

appName

Optional. Name of the deployed application.

Example

The following command sets the value to enable the CopyAccess parameter:

setUCMCopyAccess('True')

3.8.3 getUCMExclusiveCheckout

Use with WLST: Online

Description

Gets the value in the config.cfg file and displays it. When the ExclusiveCheckout parameter is enabled, Admin privilege is required to check out a content item checked in by another user.

Syntax

getUCMExclusiveCheckout(['appName'])

Argument

Definition

appName

Optional. Name of the deployed application.

Example

The following command displays the value for the ExclusiveCheckout parameter:

getUCMExclusiveCheckout()
True

3.8.4 setUCMExclusiveCheckout

Use with WLST: Online

Description

Sets the value in the config.cfg file. When the ExclusiveCheckout parameter is enabled, Admin privilege is required to check out a content item checked in by another user.

Syntax

setUCMExclusiveCheckout('value',['appName'])

Argument

Definition

value

Specifies whether to enable or disable the parameter. Values can be: Yes, No, True, False, 1, 0.

appName

Optional. Name of the deployed application.

Example

The following command sets the value to enable the ExclusiveCheckout parameter:

setUCMExclusiveCheckout('True')

3.8.5 getUCMAuthorDelete

Use with WLST: Online

Description

Gets the value from the config.cfg file and displays it. When the AuthorDelete parameter is enabled, authors are allowed to delete their revisions without having Delete privilege.

Syntax

getUCMAuthorDelete(['appName'])

Argument

Definition

appName

Optional. Name of the deployed application.

Example

The following command displays the AuthorDelete parameter value:

getUCMAuthorDelete()
1

3.8.6 setUCMAuthorDelete

Use with WLST: Online

Description

Sets the AuthorDelete parameter value in the config.cfg file. When the AuthorDelete parameter is enabled, authors are allowed to delete their revisions without having Delete privilege.

Syntax

setUCMAuthorDelete('value',['appName'])

Argument

Definition

value

Specifies whether to enable or disable the parameter. Values can be: Yes, No, True, False, 1, 0.

appName

Optional. Name of the deployed application.

Example

The following command enables the AuthorDelete parameter:

setUCMAuthorDelete('1')

3.8.7 getUCMShowOnlyKnownAccounts

Use with WLST: Online

Description

Gets the value from the config.cfg file and displays it. When the ShowOnlyKnownAccounts parameter is enabled, the list of Content Server accounts on a check-in page will contain only globally-predefined accounts.

Syntax

getUCMShowOnlyKnownAccounts(['appName'])

Argument

Definition

appName

Optional. Name of the deployed application.

Example

The following command displays the ShowOnlyKnownAccounts parameter value as enabled:

getUCMShowOnlyKnownAccounts()
Yes

3.8.8 setUCMShowOnlyKnownAccounts

Use with WLST: Online

Description

Sets the ShowOnlyKnownAccount parameter value in the config.cfg file. When the ShowOnlyKnownAccounts parameter is enabled, the list of Content Server accounts on a check-in page will contain only globally-predefined accounts.

Syntax

setUCMShowOnlyKnownAccounts('value',['appName'])

Argument

Definition

value

Specifies whether to enable or disable the parameter. Values can be: Yes, No, True, False, 1, 0.

appName

Optional. Name of the deployed application.

Example

The following command enables the ShowOnlyKnownAccounts parameter:

setUCMShowOnlyKnownAccounts('yes')

3.9 Component Manager Configuration Commands

Use the commands in Table 3-7 to configure Component Manager options for the Oracle WebCenter Content Server instance.

Table 3-7 WLST Component Manager Configuration Commands

Use this command...

To...

Use with WLST...

getUCMComponentStatus

Display the status of a component.

Online

setUCMComponentStatus

Set the status of a component.

Online

installUCMComponent

Install a component.

Online

uninstallUCMComponent

Uninstall a component.

Online

getUCMComponentConfig

Display the configuration for a component.

Online

updateUCMComponentConfig

Set configuration parameters for a component.

Online

3.9.1 getUCMComponentStatus

Use with WLST: Online

Description

Gets the status of a component. The status can be enabled or disabled.

Syntax

getUCMComponentStatus('componentName',['appName'])

Argument

Definition

componentName

Specifies a valid Content Server component name. For example, 'ContentFolios'.

appName

Optional. Name of the deployed application.

Example

The following command displays the status of the component "ContentFolios':

getUCMComponentStatus('ContentFolios')
Enabled

3.9.2 setUCMComponentStatus

Use with WLST: Online

Description

Sets the status of a component in the config.cfg file.

Syntax

setUCMComponentStatus('componentName','status',['appName'])

Argument

Definition

componentName

Specifies a valid Content Server component name. For example, 'ContentFolios'.

status

Specifies whether the status of the component is enabled or disabled. Values can be: Enable, Disable.

appName

Optional. Name of the deployed application.

Example

The following command sets the status of 'ContentFolios' to 'Enable':

setUCMComponentStatus('ContentFolios','Enable')

3.9.3 installUCMComponent

Use with WLST: Online

Description

Installs the component present at the specified file location.

Syntax

installUCMComponent('filePath',['appName'])

Argument

Definition

filePath

Specifies a valid file path to a component.

appName

Optional. Name of the deployed application.

Example

The following command installs the component at the location 'C:/manifest.zip':

installUCMComponent('C:/manifest.zip')

3.9.4 uninstallUCMComponent

Use with WLST: Online

Description

Uninstalls the specified component.

Syntax

uninstallUCMComponent('componentName',['appName'])

Argument

Definition

componentName

Specifies a valid Content Server component name. For example, 'ContentFolios'.

appName

Optional. Name of the deployed application.

Example

The following command uninstalls the component named 'ContentFolios':

uninstallUCMComponent('ContentFolios')

3.9.5 downloadUCMComponent

Use with WLST: Online

Description

Downloads the specified component to the specified file location.

Syntax

downloadUCMComponent('componentName','filePath',['appName'])

Argument

Definition

componentName

Specifies a valid Content Server component name. For example, 'ContentFolios'.

filePath

Specifies a valid file path to a component.

appName

Optional. Name of the deployed application.

Example

The following command downloads the component 'ContentFolios' to 'C:/manifest.zip':

downloadUCMComponet('ContentFolios', 'C:/manifest.zip')

3.9.6 getUCMComponentConfig

Use with WLST: Online

Description

Gets the configuration of the specified component and displays it.

Syntax

getUCMComponentConfig('componentName',['appName'])

Argument

Definition

componentName

Specifies a valid component name. For example, 'ContentFolios'.

appName

Optional. Name of the deployed application.

Example

The following command displays the configuration for the component 'ContentFolios':

getUCMComponentConfig('ContentFolios')

3.9.7 updateUCMComponentConfig

Use with WLST: Online

Description

Sets the specified component with the configuration options provided.

Syntax

updateUCMComponentConfig('componentName','updateParams',['appName'])

Argument

Definition

componentName

Specifies a valid component name. For example, 'Folders_g'.

updateParams

Specifies valid parameters for the component.

appName

Optional. Name of the deployed application.

Example

The following command sets configuration parameters for the component 'Folders_g':

updateUCMComponentConfig('Folders_g','GetCopyAccess:true,CollectionHiddenMeta:xHidden')

3.10 Records Management Configuration Commands

Use the commands in Table 3-8 to configure records management options for the Oracle WebCenter Content Server instance.

Table 3-8 WLST Records Management Configuration Commands

Use this command...

To...

Use with WLST...

getRMLevel

Display the type of records management configuration.

Online

getRMConfigurationLevel

Display the records management configuration level.

Online

getRMFeatures

Display records management features.

Online

getRMDispositionActions

Display records management dispositions actions.

Online

rmUpdate

Update the records management configuration.

Online

addOutgoingProvider

Add an outgoing provider for the Adapter server used to store records management content.

Online

registerSource

Register the source for the Adapter server repository so records management can find it.

Online

3.10.1 getRMLevel

Use with WLST: Online

Description

Gets the type of records management configuration and displays it. The type can have the following values:

- none

- standalone

- adapter

Syntax

getRMLevel(['appName'])

Argument

Definition

appName

Optional. Name of the deployed application.

Example

The following command displays the type of records management configuration:

getRMLevel()
adapter

3.10.2 getRMConfigurationLevel

Use with WLST: Online

Description

Gets the records management configuration level and displays it. The configuration level can have the following values:

- minimal: Enables minimal amount of functionality and excludes some disposition actions and most of the application features. This is the default when the software is enabled.

- typical: Enables all disposition actions and all features except for DoD Configuration, Classified Topics, FOIA/PA tracking (Freedom of Information Act/Privacy Act), and E-mail.

- dod2: Enables the features from a Typical installation with the addition of DoD Configuration and E-mail.

- dodclassified: Enables all features except for FOIA/PA.

- custom: Enables the ability to choose a variety of features. Some disposition actions are dependent on other actions. If an action is selected, dependent actions are also automatically selected.

Syntax

getRMConfigurationLevel(['appName'])

Argument

Definition

appName

Optional. Name of the deployed application.

Example

The following command displays the type of records management configuration:

getRMConfigurationLevel(['appName'])
minimal

3.10.3 getRMFeatures

Use with WLST: Online

Description

Gets a list of records management features and displays it. The list can have the following values:

- feature_related_content

- feature_audit_trigger

- feature_subject_to_review

- feature_revision_dates

- feature_security_markings

- feature_email_fields

- feature_dod_config

- feature_foia_privacyact

Syntax

getRMFeatures(['appName'])

Argument

Definition

appName

Optional. Name of the deployed application.

Example

The following command displays the records management features:

getRMFeatures()
feature_related_content
feature_audit_trigger
feature_subject_to_review

3.10.4 getRMDispositionActions

Use with WLST: Online

Description

Gets the values for records management disposition actions and displays them. The list can have the following values:

- actions_activate

- actions_obsolete

- actions_cancel

- actions_rescind

- actions_expire

- actions_cutoff

- actions_approve_deletion

- actions_destroy

Syntax

getRMDispositionActions(['appName'])

Argument

Definition

appName

Optional. Name of the deployed application.

Example

The following command displays a list of records management disposition actions:

getRMDispositionActions()
actions_active
actions_obsolete
actions_cancel

3.10.5 rmUpdate

Use with WLST: Online

Description

Sets the records management configuration with feature and disposition actions and enables it.

Syntax

rmUpdate(urmLevel, level, featuresList, dispositionActionsList, enableRTMandURMAgent,['appName'])

Argument

Definition

urmLevel

Specifies a valid records management configuration type.

level

Specifies a valid records management level.

featuresList

Specifies valid records management features.

dispositionActionsList

Specifies valid disposition actions.

enableRTMandURMAgent

Specifies whether to enable the RTM and URM Agent.'.

appName

Optional. Name of the deployed application.

Example

The following command sets the records management configuration and enables it:

rmUpdate(urmLevel='standalone',level='custom',featuresList='feature_related_content:feature_revision_dates',dispositionActionsList='actions_activate:actions:obsolete',enableRTMandURMAgent='1')

3.10.6 addOutgoingProvider

Use with WLST: Online

Description

Defines the outgoing provider that enables the Adapter server to connect to the Content Server instance with records management enabled.

Syntax

addOutgoingProvider(ProviderName, ProviderDescription, ServerHostName, HTTPServerAddress,
ServerPort, InstanceName, RelativeWebRoot, extraUpdateParams,['appName'])

Argument

Definition

ProviderName

Name of the outgoing provider.

ProviderDescription

Description of the outgoing provider.

ServerHostname

Name of the server host.

HTTPServerAddress

Address of the HTTP server.

ServerPort

Number of the server port.

IntanceName

Name of the instance for the Content Server with records management enabled.

RelativeWebRoot

Name of the relative web root.

extraUpdateParams

Extra parameters that can be used are: ClientHostIpFilter, ConnectionPassword, ConnectionPasswordName, IsRefinery, ProviderClass, ProviderConfig, ProviderConnection, RefineryMaxProJobs, RefineryReadOnly.

appName

Optional. Name of the deployed application.

Example

The following command defines an outgoing provider for the Adapter server to connect to the records management instance.:

addOutgoingProvider(ProviderName='x',ProviderDescription='y',ServerHostName='localhost',HTTPServerAddress='z',ServerPort='4444',InstanceName='w',
RelativeWebRoot='cs',updateParams='RefineryMasJobs:100,IsRefinery:1')

3.10.7 registerSource

Use with WLST: Online

Description

Registration ensures that records management is aware of the Adapter and is ready to manage the stored content in the Adapter server's repository.

Syntax

registerSource(ProviderName, SourceName, SourceTableName, SourceDisplayName, ['appName'])

Argument

Definition

ProviderName

Name of the outgoing provider.

SourceName

Description of the source in the Adapter repository.

SourceTableName

Name of the source table in the Adapter repository.

SourceDisplayName

Display name for the source in the Adapter repository.

appName

Optional. Name of the deployed application.

Example

The following command registers the Adapter server's repository source for the records management stored content:

registerSource(ProviderName='x',SourceName='y',SourceTableName='z',SourceDisplayName='w")

3.11 User Interface Commands

Use the commands in Table 3-9 to display and update the configuration of the Oracle WebCenter Content user interface introduced in Oracle WebCenter Content 11g Release 1 (11.1.1.8). For more information about this user interface, see Getting Started with the WebCenter Content User Interface in Using Oracle WebCenter Content.

To use these custom commands, you must invoke the WLST script from the appropriate Oracle home. Do not use the WLST script in the WebLogic Server home. For Oracle WebCenter Content user interface commands, the script is located at:

- UNIX: MW_HOME/oracle_common/common/bin/wlst.sh

- Windows: MW_HOME\oracle_common\common\bin\wlst.cmd

The WLST process must connect to the WebCenter Content UI server before you run the commands listed in the following table.

You can connect to the Content UI server instance using the connect() command, for example:

connect("weblogic","password","t3://localhost:16225").

Configuration changes made using these WLST commands are only effective after you restart the Managed Server on which the WebCenter Content - Web UI application is deployed.

Table 3-9 WLST WebCenter Content User Interface Commands

Use this command...

To...

Use with WLST...

displayWccAdfConfig

Display the configuration of the WebCenter Content user interface application.

Online

updateWccAdfConfig

Update the configuration of the WebCenter Content user interface application.

Online

3.11.1 displayWccAdfConfig

Use with WLST: Online

Description

Displays the configuration of the Oracle WebCenter Content user interface application.

Syntax

displayWccAdfConfig(appName='value',[attrName='value'])

Argument

Definition

appName value

Name of the deployed application.

attrName value

Optional. Name of the attribute to display If omitted all attributes are displayed.

Examples

The following command displays all configuration attributes for the Oracle WebCenter Content user interface deployed with the application name "Oracle WebCenter Content - Web UI".

wls:/wccadf_domain/serverConfig> displayWccAdfConfig(appName='Oracle WebCenter Content - Web UI')
WccInstanceName = Default
WccInstanceConnectionName = WccAdfServerConnection
ProxyContent = true
DocumentPreview = DOCUMENT_VIEWER
DefaultLocale = en_US
DefaultTimeZone = America/Los_Angeles
ApplicationUrl = null
ClusterCompatible = false
TemporaryDirectory = null
MaximumUploadedFileSize = 52428800
MaximumWindowsPerSession = 7
WccLoginPageEnabled = true
SkinFamily = wcc-skin
SkinVersion = null
CustomBrandingLogo = null
CustomBrandingTitle = null
WccCustomizationLayerValues = null
OracleCustomizationLayerValues = null
CustomerCustomizationLayerValues = null
CustomRequestBinderProperties = null
UnfiledDocumentProhibited = false

The following command displays the value of the configuration attribute named "WccInstanceConnectionName".

wls:/wccadf_domain/serverConfig> displayWccAdfConfig(appName='Oracle WebCenter Content - Web UI', attrName='WccInstanceConnectionName')
Attribute WccInstanceConnectionName value is: WccAdfServerConnection

3.11.2 updateWccAdfConfig

Use with WLST: Online

Description

Updates the configuration of the Oracle WebCenter Content user interface application. The command can be used to update a single attribute or multiple attributes.

Syntax

updateWccAdfConfig(appName, [wccInstanceName], [wccInstanceConnectionName],
[proxyContent], [documentPreview], [defaultLocale], [defaultTimeZone],
[applicationUrl], [clusterCompatible], [temporaryDirectory],
[maximumUploadedFileSize], [maximumWindowsPerSession],
[wccLoginPageEnabled], [skinFamily], [skinVersion], [customBrandingLogo],
[customBrandingTitle], [wccCustomizationLayerValues],
[oracleCustomizationLayerValues], [customerCustomizationLayerValues],
[customRequestBinderProperties], [unfiledDocumentProhibited])

Argument

Definition

appName

Name of the deployed application.

wccInstanceName

Reserved for future use.

wccInstanceConnectionName

Name of the Content Server connection in Connection Architecture (connections.xml).

proxyContent

Controls how a browser retrieves document content, including the native file, the web-viewable rendition, thumbnails, and attachments. Must be "true" or "false". If "true" the browser requests this content from the Oracle WebCenter Content user interface, which in turn retrieves it from Content Server. If "false" the browser requests this content directly from Content Server.

documentPreview

Controls the preview displayed for a document. Must be one of the following case-sensitive values:

- DOCUMENT_VIEWER: Use the document viewer (if available)

- WEB_VIEWABLE: Display the web-viewable rendition (if available)

- NONE: No preview

defaultLocale

Locale to use if a user's locale cannot be otherwise determined. Must be in the format used by the Java class java.util.Locale (for example, "en_US").

defaultTimeZone

Time zone to use if the user's time zone cannot be otherwise determined. Must be in the format used by the Java method java.util.TimeZone#getTimeZone (for example, "America/Los_Angeles")

applicationUrl

Specifies the scheme, hostname, and port of URLs generated by the Oracle WebCenter Content user interface (for example, https://wcc.example.com:16225). Optional. If not set, the scheme, hostname, and port are determined from the HTTP request.

clusterCompatible

Specifies whether the Oracle WebCenter Content user interface supports session replication among nodes in a cluster. Either "true" or "false". Must be "true" if session replication is enabled on the Java EE Web Container.

temporaryDirectory

Base directory for temporary files created by the Oracle WebCenter Content user interface, such as in-progress uploads. This directory should be empty, on a fast file system with adequate free space, and readable and writable by only the owner of the process running the Oracle WebCenter Content user interface. The Oracle WebCenter Content user interface will create and manage a subdirectory structure. If clusterCompatible is "true" this directory must also be on a filesystem shared across all nodes in the cluster. Oracle recommends setting this attribute even if clusterCompatible is "false". If not set, the value of the Java system property java.io.tmpdir is used.

maximumUploadedFileSize

Maximum size of uploaded files (in bytes). If less than zero, there is no maximum size. If zero, file upload is disabled.

maximumWindowsPerSession

Maximum number of active windows (or browser tabs, depending on browser configuration) per session. When this limit is reached, the least recently used window expires and subsequent interaction with that window displays an error message.

The Oracle WebCenter Content user interface main page, wccmain, does not contribute to the session's window count and only expires when the session expires or is logged out. The document properties page, wccdoc, counts as two windows if documentPreview is "DOCUMENT_VIEWER", but counts as one window if documentPreview is "WEB_VIEWABLE" or "NONE".

Use this attribute to control the maximum application server memory consumed by each session. Set to 0 to not limit the number of windows per session.

wccLoginPageEnabled

Specifies whether the "wcclogin" page is enabled or disabled. Either "true" or "false". When Single Sign-On (SSO) authentication is enabled, the attribute value should be set to "false" to prevent users from using the "wcclogin" page instead of SSO.

skinFamily

Name of the skin family. The <skin-family> element in trinidad-config.xml is set to the value of this attribute.

skinVersion

Skin version. The <skin-version> element in trinidad-config.xml is set to the value of this attribute. Optional. If not set, no skin version is specified.

customBrandingLogo

HTTP URL of an image to display in the branding bar. Optional. If not set, a default image is displayed.

customBrandingTitle

The title to display in the branding bar. Optional. If not set, a default title is displayed.

wccCustomizationLayerValue

The values for the 'wcc' customization layer. Use comma-separated format to define multiple values. Optional. If not set, no customization is available for this layer. Example: demo, test, or production.

oracleCustomizationLayerValues

The values for the 'oracle' customization layer. Use comma-separated format to define multiple values. Optional. If not set, no customization is available for this layer. Example: demo, test, or production.

customerCustomizationLayerValues

The values for the 'customer' customization layer. Use comma-separated format to define multiple values. Optional. If not set, no customization is available for this layer. Example: demo, test, or production.

customRequestBinderProperties

The list of supported custom properties that can be injected to Content Server service calls via ContentProxyServlet requests. Use comma-separated format to define multiple values. Optional. If not set, no injection would happen in Content Server service calls. Example: XFND_SCHEME_ID, XFND_RANDOM, and XFND_EXPIRES.

unfiledDocumentProhibited

Controls the creation of unfiled documents. When its value is true, uploading unfiled documents and unfiling filed documents are both disabled. Optional. The default value is false.

Examples

The following command sets the proxyContent attribute to "true" for the Oracle WebCenter Content user interface deployed with the application name "Oracle WebCenter Content - Web UI". With this setting, browsers will retrieve document content from the Oracle WebCenter Content user interface, rather than directly from Content Server.

updateWccAdfConfig(appName='Oracle WebCenter Content - Web UI', proxyContent=true)

The following command sets the defaultLocale attribute to "en_US" and the defaultTimeZone attribute to "America/Los_Angeles". If the Oracle WebCenter Content user interface cannot determine a user's preferred locale and time zone (for example, based on user preferences), it will default to the English language and display times using the America/Los_Angeles time zone.

updateWccAdfConfig(appName='Oracle WebCenter Content - Web UI', defaultLocale='en_US', defaultTimeZone='America/Los_Angeles')

The following command sets the temporaryDirectory attribute to "/prod/wcctmp". The Oracle WebCenter Content user interface will store temporary files in this directory on the application server.

updateWccAdfConfig(appName='Oracle WebCenter Content - Web UI', temporaryDirectory='/prod/wcctmp')

The following command sets the wccLoginPageEnagled property to "false". This prevents users from authenticating to the Oracle WebCenter Content user interface using its "wcclogin" page, requiring them to use Single Sign-On (SSO).

updateWccAdfConfig(appName='Oracle WebCenter Content - Web UI', wccLoginPageEnabled=false)

We strongly recommend to set a value for the applcationUrl attribute.

updateWccAdfConfig(appName='Oracle WebCenter Content - Web UI', applicationUrl='https://wcc.example.com:16225')

The default value for the maximumWindowsPerSession attribute is set to 7. If the WebCenter Content instance is experiencing higher than desired memory consumption, the setting can be changed to 4 to reduce the required heap size.

updateWccAdfConfig(appName='Oracle WebCenter Content - Web UI', maximumWindowsPerSession=4)

3.12 User Interface Connection Commands

Use the commands in Table 3-10 to manage connections for the Oracle WebCenter Content user interface introduced in WebCenter Content 11g Release 1 (11.1.1.8). For more information about this user interface, see Getting Started with the WebCenter Content User Interface in Using Oracle WebCenter Content.

To use these custom commands, you must invoke the WLST script from the appropriate Oracle home. Do not use the WLST script in the WebLogic Server home. For the Oracle WebCenter Content user interface commands, the script is located at:

- UNIX: MW_HOME/oracle_common/common/bin/wlst.sh

- Windows: MW_HOME\oracle_common\common\bin\wlst.cmd

The WLST process must connect to the WebCenter Content UI server before you run the connection commands listed in the following table.

You can connect to the Content UI server instance using the connect() command, for example:

connect("weblogic","password","t3://localhost:16225").

Configuration changes made using these WLST commands are only effective after you restart the Managed Server on which the WebCenter Content - Web UI application is deployed.

Table 3-10 WLST WebCenter Content User Interface Connection Commands

Use this command...

To...

Use with WLST...

createRIDCConnection

Create a new RIDC connection.

Online

updateRIDCConnection

Update existing RIDC connection properties.

Online

listRIDCConnections

List all the RIDC connection Mbeans present in an application.

Online

deleteRIDCConnection

Remove an existing RIDC connection.

Online

displayRIDCConnection

Get all the attributes and their values associated with an RIDC connection Mbean with an option to get the value for a given attribute name.

Online

3.12.1 createRIDCConnection

Use with WLST: Online

Description

Creates a new RIDC connection reference and adds the connection name to the mds layer.

Syntax

createRIDCConnection('appName','conName')

Argument

Type

Description

appName

java.lang.String

Name of the application for which the connection will be created.

connName

java.lang.String

Name of the connection which is the placeholder for RIDC connection reference.

Example

The following command creates an RIDC connection 'WccAdfServerConnection' in the application 'Oracle WebCenter Content - Web UI':

createRIDCConnection('Oracle WebCenter Content - Web UI','WccAdfServerConnection')

3.12.2 updateRIDCConnection

Use with WLST: Online

Description

Updates the connection properties for an existing RIDC connection reference. These changes and additions are read as runtime data and saved in the mds layer.

Syntax

updateRIDCConnection(appName, connName, ['connUrl'], ['connSockettimeout'],
['connPoolMethod'], ['connPoolSize'], ['connWaitTime'], ['credUsername'],
['credPassword'], ['credAppidkey'], ['credImpersonationAllowed'], ['jaxwsStack'],
['jaxwsPolicy'], ['jaxwsJpsconfigfile'], ['jaxwsSkipstackoptimizations'],
['jaxwsServerInstancename'], ['jaxwsRegisteridentityswitchfilter'],
['httpLibrary'], ['idcsAlgorithm'], ['idcsKeystoreFile'],
['idcsKeystorePassword'], ['idcsKeystoreAlias'], ['idcsKeystoreAliasPassword'],
['idcsTrustmanagerFile'], ['idcsTrustmanagerPassword'], [sessionPoolSupport],
[sessionPoolAnonymousFallback], [sessionPoolCredentialProviderClass])

Argument

Type

Definition

appName

java.lang.String

Name of the application for which the connection has to be updated.

connName

java.lang.String

Name of the connection which will be placeholder for RIDC connection properties.

connURL

java.lang.String

RIDC connection URL property.

connSockettimeout

java.lang.Integer

RIDC connection socket timeout property in seconds.

connPoolMethod

java.lang.String

RIDC connection pool method property.

connPoolSize

java.lang.Integer

RIDC connection pool size property.

connWaitTime

java.lang.Integer

RIDC connection wait time property.

credUsername

java.lang.String

RIDC authorization credential username property.

credPassword

java.lang.String

RIDC authorization credential password property.

credAppidkey

java.lang.String

RIDC authorization credential appid key property.

credImpersonationAllowed

java.lang.Boolean

Credential impersonation allowed property.

jaxwsStack

java.lang.String

JaxWs protocol stack property.

jaxwsPolicy

java.lang.String

JaxWs protocol policy property.

jaxwsJpsconfigfile

java.lang.String

JaxWs protocol Jps config file property.

jaxwsSkipstackoptimizations

java.lang.Boolean

JaxWs protocol skip stack optizations property.

jaxwsServerInstancename

java.lang.String

JaxWs protocol server instance name property.

jaxwsRegisteridentityswitchfilter

java.lang.Boolean

JaxWs protocol register identity switch filter property.

httpLibrary

java.lang.String

Http protocol library property.

idcsAlgorith

java.lang.String

Secure Intradoc Protocol Algorithm property.

idcsKeystoreFile

java.lang.String

Secure Intradoc Protocol Keystore File property.

idcsKeystorePassword

java.lang.String

Secure Intradoc Protocol Keystore Password property.

idcsKeystorealias

java.lang.String

Secure Intradoc Protocol Keystore Alias property.

idcsKeystoreAliasPassword

java.lang.String

Secure Intradoc Protocol Keystore Alias password property.

idcsTrustmanagerFile

java.lang.String

Secure Intradoc Protocol TrustManager File property.

idcsTrustmanagePassword

java.lang.String

Secure Intradoc Protocol TrustManager Password property.

sessionPoolSupport

java.lang.Boolean

RIDC Session Pool Supported property.

sessionPoolAnonymousFallback

java.lang.Boolean

RIDC Session Pool Anonymous Fallback property.

sessionPoolCredentialProviderClass

java.lang.String

RIDC Session Pool Credential Provider Class property.

Example

The following command updates the Intradoc Protocol Connection with a 90 second socket timeout.

updateRIDCConnection('Oracle WebCenter Content - Web UI','WccAdfServerConnection',
connUrl='idc://contentserver:4444',credUsername='weblogic',connSockettimeout=90)

3.12.3 listRIDCConnections

Use with WLST: Online

Description

Lists all the RIDC connection Mbeans present in an ADF connection architecture based application.

Syntax

listRIDCConnections('appName')

Argument

Type

Description

appName

java.lang.String

Name of the application for which the connection mbeans has to be returned.

Example

The following command returns all the connection Mbeans with connection type 'RIDC' present in application 'Oracle WebCenter Content - Web UI'.

listRIDCConnections('Oracle WebCenter Content - Web UI')

3.12.4 deleteRIDCConnection

Use with WLST: Online

Description

Lists all the RIDC connection Mbeans present in an ADF connection architecture based application.

Syntax

deleteRIDCConnection('appName','connName')

Argument

Type

Description

appName

java.lang.String

Name of the application for which the connection will be removed.

connName

java.lang.String

Name of the connection to be removed for the given application.

Example

The following command removes the connection name 'WccAdfServerConnection' present in application 'Oracle WebCenter Content - Web UI'.

deleteRIDCConnection('Oracle WebCenter Content - Web UI','WccAdfServerConnection')

3.12.5 displayRIDCConnection

Use with WLST: Online

Description

Gets all the attribute name-value pairs present in a given connection Mbean of an application, with an option to get the value of an attribute present in a given connection Mbean of an application.

Syntax

displayRIDCConnection(appName,connName,['attrName'])

Argument

Type

Description

appName

java.lang.String

Name of the application for which the connection Mbean attribute value is desired.

connName

java.lang.String

Name of the connection that contains the mbean property.

attrName

java.lang.String

Optional. Attribute name in connection Mbean for which value is desired.

Examples

The following command retrieves the connection property value of 'PropConnectionUrl'.

displayRIDCConnection('Oracle WebCenter Content - Web UI',
'WccAdfServerConnection','PropConnectionUrl')

The following command retrieves all the connection properties present in connection 'WccAdfServerConnection'.

ddisplayRIDCConnection('Oracle WebCenter Content - Web UI', 'WccAdfServerConnection')

4 Oracle WebCenter Enterprise Capture Custom WLST Commands

This chapter provides detailed descriptions of custom WLST commands for Oracle WebCenter Enterprise Capture, including command syntax, arguments and command examples.

The following sections describe the custom WLST commands for Oracle WebCenter Enterprise Capture. These commands enable you to access and modify various configuration parameters for Oracle WebCenter Enterprise Capture from the command line. Topics include:

- Overview of WLST Oracle WebCenter Enterprise Capture Command Categories

- Configuration Commands

To display all the supported Capture commands that can be invoked from WLST, enter the following command at the WLST prompt:

help('capture')

For information about Enterprise Capture workspace console use, see About the Capture Workspace Console in Managing Oracle WebCenter Enterprise Capture.

Note:

To use the Oracle WebCenter Enterprise Capture custom commands, you must invoke the WLST script from the Oracle Common home in which the component has been installed. Either connect to the Oracle WebLogic Server managed server (default port 16400) on which the Oracle WebCenter Enterprise Capture application is deployed, or connect to the Oracle WebLogic Server administration server and change your location to domainRuntime by executing the command: domainRuntime()

For more information, see Using WLST with Java Components and Oracle Fusion Middleware Services in Administering Oracle Fusion Middleware.

4.1 Overview of WLST Oracle WebCenter Enterprise Capture Command Categories

WLST Oracle WebCenter Enterprise Capture commands are covered in the following category:

Table 4-1 WLST Oracle WebCenter Enterprise Capture Command Categories

Command Category

Description

Configuration Commands

View and manage configuration for Oracle WebCenter Enterprise Capture.

4.2 Configuration Commands

Use the commands in Table 4-2 to configure Oracle WebCenter Enterprise Capture.

Table 4-2 WLST Server Oracle WebCenter Enterprise Capture Configuration Commands

Use this command...

To...

Use with WLST...

listWorkspaces

List all of the Capture workspaces to which the administrator or workspace manager has access.

Online

listBatches

List all of the batches within a specified workspace.

Online

exportBatch

Export a batch including images and metadata to a ZIP file.

Online

exportWorkspace

Export an entire Capture workspace including documents, metadata, scripts, profiles and jobs to an XML file.

Online

importWorkspace

Import a workspace from an XML file generated with the exportWorkspace command

Online

unlockBatch

Delete the batch lock record for the specified batch.

Online

listLockedBatches

Display a list of locked batches for a specified workspace.

Online

listCaptureConfig

Display the list of all Enterprise Capture configuration attributes with their values.

Online

getCaptureConfig

Fetch the value of the attribute specified as an argument.

Online

setCaptureConfig

Set the value of the Enterprise Capture attribute to the provided value.

Online

scanForClientBundles

Scan the client bundle directory for updated bundles.

Online

deleteBundle

Delete an existing client bundle.

Online

setObjectProperty

Set the value of a property defined in a Capture object which could be a client profile, processor job, or a commit profile.

Online

getObjectProperty

Print the specific value of a property of a Capture object which could be a client profile, processor job, or a commit profile.

Online

setObjectCredentials

Set the user name and password associated with a Capture object (processor job or commit profile).

Online

updateScript

Update a script within a workspace.

Online

cloneWorkspaceFromID

Copy an existing workspace and create a new workspace.

Online

cloneWorkspaceFromFile

Read an output file created by the exportWorkspace command and create a unique copy of the workspace.

Online

listImportHATokens

Display all the Import Processor tokens for a specific workspace.

Online

deleteImportHAToken

Delete a specific Import Processor HA Token from the ECIMPORTHATOKEN and ECIMPORTHATOKENITEMS tables.

Online

4.2.1 listWorkspaces

Use with WLST: Online.

Description

Lists all Capture workspaces to which the administrator or workspace manager has access.

Syntax

listWorkspaces()

Example

The following example lists all of the workspaces, preceded by their IDs.

listWorkspaces()
4 bills_workspace
2 certificates_workspace
5 receipts_workspace

4.2.2 listBatches

Use with WLST: Online.

Description

Lists all batches for the workspace specified by its ID. Each batch listed has five columns (displayed in this order): Batch ID, Batch Name, Created By (user), Last Updated By (user), and Last Modified (date).

Syntax

listBatches (WORKSPACE_ID)

Argument

Definition

WORKSPACE_ID

ID number for a workspace. Can be optionally specified within single quotes. For example, both 3 and '3' are valid arguments for a workspace with ID 3.

Note:
To obtain a list of valid workspace IDs, use the listWorkspaces command.

Example

The following example lists the batches for a specific workspace with ID = 1.

wls:/base_domain/domainRuntime> listBatches(1)
14 ABI1 <anonymous> <anonymous> 4/26/13
15 ABI2 <anonymous> <anonymous> 4/26/13
1 BCP11 captureuser <anonymous> 4/17/13

4.2.3 exportBatch

Use with WLST: Online.

Description

Exports a batch including images and metadata to a ZIP file containing an XML file and the batch item files.

Syntax

exportBatch(BATCH_ID,'FILE_NAME')

Argument

Definition

BATCH_ID

ID number for a batch. Can be optionally specified within single quotes. For example, both 3 and '3' are valid arguments for a batch with ID 3.

Note:
To obtain a list of valid batch IDs, use the listBatches command.

FILE_NAME

Name of the ZIP file to which the batch will be exported. The file name must be specified along with its complete path.

Note:

The path should be separated by forward slashes "/" regardless of the operating system.

Example

The following example exports a batch.

exportBatch(8,'/home/abc/batch8.zip')
Batch successfully exported

4.2.4 exportWorkspace

Use with WLST: Online.

Description

Exports an entire workspace including documents, metadata, scripts, profiles and jobs to an XML file.

Note:
Workspace security settings will not be exported into the resulting XML file.

Syntax

exportWorkspace(WORKSPACE_ID,'FILE_NAME')

Argument

Definition

WORKSPACE_ID

ID number for a workspace. Can be optionally specified within single quotes. For example, both 3 and '3' are valid arguments for a workspace with ID 3.

Note:
To obtain a list of valid workspace IDs, use the listWorkspaces command.

FILE_NAME

Name of the file to which the workspace will be exported. The file name must be specified along with its complete path.

Note:

The path should be separated by forward slashes "/" regardless of the operating system.

Example

The following example exports the workspace with the ID of 3.

exportWorkspace(3,'/home/abc/workspace3.xml')
Workspace successfully exported

4.2.5 importWorkspace

Use with WLST: Online.

Description

Imports a workspace from a XML file generated with the exportWorkspace command. The workspace being imported must not exist in the Oracle WebCenter Enterprise Capture database.

Note:
The security settings are not imported when you import a workspace.

Syntax

importWorkspace('FILE_NAME')

Argument

Definition

FILE_NAME

Name of the XML file from which a workspace is imported. The file name must be specified along with its complete path.

Example

The following example imports a workspace with the file name of workspace3.xml.

importWorkspace('/home/abc/workspace3.xml')
Workspace successfully imported

4.2.6 unlockBatch

Use with WLST: Online.

Description

Deletes the batch lock record for the specified batch. The batch will be put into a READY state so that it can be opened by the client.

Syntax

unlockBatch('BATCH_ID')

Argument

Definition

BATCH_ID

ID number for a batch. Can be optionally specified within single quotes. For example, both 3 and '3' are valid arguments for a batch with ID 3.

Note:
To obtain a list of locked batches, use the listLockedBatches command.

Example

The following example unlocks a batch with ID = 8.

unlockBatch('8')
Batch successfully unlocked

4.2.7 listLockedBatches

Use with WLST: Online.

Description

Displays the list of locked batches. Each batch listed has six columns (displayed in this order): Workspace ID, Batch ID, Batch Name, Created By (user), Workstation (name/IP address), Last Modified (date).

Syntax

listLockedBatches('WORKSPACE_ID')

Argument

Definition

WORKSPACE_ID

ID number for a workspace. Can be optionally specified within single quotes. For example, both 3 and '3' are valid arguments for a workspace with ID 3.

Note:
To obtain a list of valid workspace IDs, use the listWorkspaces command.

Example

The following example lists locked batches for the workspace with ID = 1.

wls:/base_domain/domainRuntime> listLockedBatches(1)
1 14 ABI1 <anonymous> sic01lzz.example.com 4/26/13
1 15 ABI2 <anonymous> slc01lzz.example.xom 4/26/13
1 17 BCP16 <captureuser> 10.159.104.189 4/30/13

4.2.8 listCaptureConfig

Use with WLST: Online.

Description

Displays the list of all Enterprise Capture configuration attributes with their values. If a value cannot be fetched, it will be shown as "VALUE CANNOT BE DISPLAYED". The most likely cause of an unfetched value is insufficient privilege.

Syntax

listCaptureConfig()

Example

The following example lists Enterprise Capture configuration attributes and values.

listCaptureConfig()
CaptureSystemID CAPTURE_01
BatchRefreshLimit 5

4.2.9 getCaptureConfig

Use with WLST: Online.

Description

Fetches the value of the attribute specified as an argument. Use the listCaptureConfig command to list possible attribute names.

Syntax

getCaptureConfig(['NAME_OF_ATTRIBUTE'])

Argument

Definition

NAME_OF_ATTRIBUTE

Name of attribute (as a string) for Enterprise Capture configuration.

Example

The following example fetches the value of the attribute for the Enterprise Capture system ID.

getCaptureConfig('CaptureSystemID')
CAPTURE_01

4.2.10 setCaptureConfig

Use with WLST: Online.

Description

Sets the value of the Enterprise Capture attribute to the provided value.

Syntax

setCaptureConfig(['NAME_OF_ATTRIBUTE'],['VALUE_OF_ATTRIBUTE'])

Argument

Definition

NAME_OF_ATTRIBUTE

Name of Enterprise Capture configuration attribute to configure.

VALUE_OF_ATTRIBUTE

Value to set for the Enterprise Capture configuration attribute.

Example

The following example sets the CaptureSystemID attribute to the value CAPTURE_02.

setCaptureConfig('CaptureSystemID','CAPTURE_02')
Attribute 'CaptureSystemID' changed to "CAPTURE_02'

4.2.11 scanForClientBundles

Use with WLST: Online.

Description

Scans the client bundle directory for bundles. Data for existing bundles will be updated and information for new bundles will be loaded and cached in the database.

Syntax

scanForClientBundles()

Example

The following example scans for bundles and lists processed bundles.

scanForclientBundles()
Processed capture bundle.jar

4.2.12 deleteBundle

Use with WLST: Online.

Description

Deletes an existing bundle.

Syntax

deleteBundle('bundlename')

Argument

Definition

bundlename

Name of an existing bundle to delete.

Example

The following example deletes the specified bundle.

deleteBundle('Example')

4.2.13 setObjectProperty

Use with WLST: Online.

Description

Sets the value of a property defined in a Capture Object, which could be a client profile, processor job, or a commit profile.

For information on the properties that can be set for each Capture object, see Capture Object Properties.

Syntax

setObjectProperty('<WORKSPACE_NAME>','<CLASS_NAME>','<OBJECT_IDENTIFIER>','<PROPERTY_ASSIGNMENT_STRING>')

This command requires the following parameters:

Argument

Definition

WORKSPACE_NAME

The name of the Capture workspace that contains the objects that will be modified. If the calling user has rights to more than one workspace with the specified name, the first workspace found will be used.

Note:
To obtain a list of workspaces, use the listWorkspaces command.

CLASS_NAME

The name of the class that defines the client profile, processor job, or commit profile.

OBJECT_IDENTIFIER

A key/value pair consisting of the name of a property that can be used to locate the object and the expected value of that property.

PROPERTY_ASSIGNMENT_STRING

The name and value of the property to update, separated by an equal sign.

Points to Note

The following list provides some additional points to note when you use the setObjectProperty command:

- Modifiable objects expose their properties using the standard JavaBean getter/setter pattern. In the example below it is assumed the methods getProfileDesc and setProfileDesc exist in the Profile class.

- The value being assigned to the property should be compatible with the property's data type. If a value is not compatible with the property's data type, an exception will occur.

- The following are valid class names:

- oracle.oddc.data.Profile (Capture object being modified: Client Profile)

- oracle.odc.recognition.RecognitionJob (Capture object being modified: Recognition Processor Job)

- oracle.odc.importprocessor.ImportJob (Capture object being modified: Import Processor Job)

- oracle.odc.entity.CommitProfileEntity (Capture object being modified: Commit Profile)

- oracle.odc.docconverter.DocConverterJob (Capture object being modified: Document Conversion Job)

- In cases where a value needs to be set on an object nested within a profile or job, “dot" notation can be used to access the nested property: propertyName.propertyName=value.

- Multiple levels of nesting are supported. The following could be used to modify the barcodeName property of a Recognition Processor job's docTypeBarcode property: docTypeBarcode.barcodeName=value.

- To support accessing a property of an object contained in a collection, the following “angle bracket" notation can be used: propertyName<identifierPropertyName=value>.propertyName=value.

- The value between the angle brackets will be used to locate the object to modify within the collection. The identifierPropertyName is the name of a property that can be used to identify the object in the collection and value is the value that property should contain to be considered a match. For example: barcodes<barcodeName=barcode 1>.barcodeName=barcode 2.

Example

- The following is an example of <Object Identifier> that would apply to commit profiles:

profileName=Commit to CS

- The following is an example of <Property Assignment String> for updating the property profileDesc for a client profile:

profileDesc=Test Profile Desc

- The following is an example of setting the property <serverURL> associated with a WebCenter Content commit profile named Commit to CS:

setObjectProperty('TEST_WORKSPACE','oracle.odc.entity.CommitProfileEntity','profileName=Commit to CS','serverURL=http://myhost.example.com:16200/cs/idcplg/')

4.2.14 getObjectProperty

Use with WLST: Online.

Description

Prints the value of a specific property of a Capture Object (client profile, processor job, or commit profile).

Syntax

getObjectProperty('<WORKSPACE_NAME>','<CLASS_NAME>','<OBJECT_IDENTIFIER>','<PROPERTY_NAME>')

This method requires the following parameters:

Argument

Definition

WORKSPACE_NAME

The name of the Capture workspace that contains the object that will be modified. If the calling user has rights to more than one workspace with the specified name, the first workspace found will be used.

Note:
To obtain a list of workspaces, use the listWorkspaces command.

CLASS_NAME

The name of the class that defines the client profile, processor job or commit profile.

OBJECT_IDENTIFIER

A key/value pair consisting of the name of a property that can be used to locate the object and the expected value of that property.

PROPERTY_NAME

The name of the property to access. The “dot" notation and “angle bracket" notation described in setObjectProperty can be used to isolate the property to access.

Note:

The backing MBean method for this command can be used in automated tests to validate if the changes made with the setObjectProperty command have taken effect.

Example

- The following are valid class names:

oracle.oddc.data.Profile
oracle.odc.recognition.RecognitionJob
oracle.odc.importprocessor.ImportJob
oracle.odc.entity.CommitProfileEntity
oracle.odc.docconverter.DocConverterJob

- The following is an example of <Object Identifier> that would apply to import jobs:

jobName=Import Email

- The following is an example for retrieving the value of the property <serverName> associated with an email import job.

getObjectProperty('TEST-WORKSPACE','oracle.odc.importprocessor.ImportJob','jobName=Import Email','serverName')

4.2.15 setObjectCredentials

Use with WLST: Online.

Description

It is used to set the user name and password associated with a profile or job.

Syntax

setObjectCredentials('<WORKSPACE_NAME>','<CLASS_NAME>','<OBJECT_IDENTIFIER>','<USER_NAME>','<PASSWORD>')

This method requires the following parameters:

Argument

Definition

WORKSPACE_NAME

The name of the Capture workspace that contains the credential that will be modified. If the calling user has rights to more than one workspace with the specified name, the first workspace found will be used.

Note:
To obtain a list of workspaces, use the listWorkspaces command.

CLASS_NAME

The name of the class required to modify the credentials.

OBJECT_IDENTIFIER

A key/value pair consisting of the property name of the object to modify and the expected value.

USER_NAME

The user name to assign to the object's credential.

PASSWORD

The password to assign to the object's credential.

Example

- Valid class names include the following:

oracle.odc.importprocessor.ImportJob
oracle.odc.entity.CommitProfileEntity

- The following is an example for setting credentials associated with an Email Import Job:

setObjectCredentials('TEST-WORKSPACE','oracle.odc.importprocessor.ImportJob','jobName=import Email','xyz@example.com','welcome123')

- The following is an example for setting credentials associated with a WebCenter Imaging commit profile:

setObjectCredentials('TEST-WORKSPACE','oracle.odc.entity.CommitProfileEntity','profileName=commit to Imaging','admin','welcome123')

4.2.16 updateScript

Use with WLST: Online.

Description

Updates a script within a workspace.

Syntax

updateScript('<WORKSPACE_NAME>','<SCRIPT_NAME>','<SCRIPT_FILE>')

This command requires the following parameters:

Argument

Definition

WORKSPACE_NAME

The name of the workspace that contains the script. The name should be used to lookup the unique identifier of the workspace. If the name is not found, an error message is displayed.

Note:
To obtain a list of workspaces, use the listWorkspaces command.

SCRIPT_NAME

The name of the script to update. If the script cannot be found, an error message is displayed.

SCRIPT_FILE

The absolute path to the script file that should be updated. The script should be updated with the contents of this file.

Example

The following example updates a script within a workspace:

updateScript('TEST-WORKSPACE','Client_Script','/scratch/aime/scripts/client.txt')

4.2.17 cloneWorkspaceFromID

Use with WLST: Online.

Description

Creates a unique copy of a workspace specified by its ID.

Syntax

cloneWorkspaceFromID(WORKSPACE_ID, 'WORKSPACE_NAME', 'WORKSPACE_DESCRIPTION')

This command requires the following parameters:

Argument

Definition

WORKSPACE_ID

The ID number of the workspace to be copied. Can be optionally specified within single quotes. For example, both 3 and '3' are valid arguments for a workspace with ID 3.

Note:
To obtain a list of valid workspace IDs, use the listWorkspaces command.

WORKSPACE_NAME

Name for the new workspace being created.

WORKSPACE_DESCRIPTION

Description for the new workspace being created.

Example

The following example clones an existing workspace:

cloneWorkspaceFromID(3,'Expenses','Expenses Workspace')

4.2.18 cloneWorkspaceFromFile

Use with WLST: Online.

Description

Reads an output file created by the exportWorkspace command and creates a unique copy of the workspace.

Syntax

cloneWorkspaceFromFile('FILE_NAME', 'WORKSPACE_NAME', 'WORKSPACE_DESCRIPTION')

This command requires the following parameters:

Argument

Definition

FILE_NAME

The name of the output file from which the content has to be copied.

WORKSPACE_NAME

Name for the new workspace being created.

WORKSPACE_DESCRIPTION

Description for the new workspace being created.

Example

The following example reads an output file to create a workspace:

cloneWorkspaceFromFile('/home/bills/expense1.xml','Expenses','Expenses Workspace')

4.2.19 listImportHATokens

Use with WLST: Online.

Description

Displays all the Import Processor tokens for a specific workspace.

Syntax

listImportHATokens(WORKSPACE_ID)

This command requires the following parameters:

Argument

Definition

WORKSPACE_ID

The ID number of the workspace for which the tokens have to be displayed. Can be optionally specified within single quotes. For example, both 3 and '3' are valid arguments for a workspace with ID 3.

Note:
To obtain a list of valid workspace IDs, use the listWorkspaces command.

Example

The following example displays Import Processor tokens for the workspace with ID = 3:

listImportHATokens(3)

4.2.20 deleteImportHAToken

Use with WLST: Online.

Description

Deletes a specific Import Processor HA token from the ECIMPORTHATOKEN and ECIMPORTHATOKENITEMS tables.

Syntax

deleteImportHAToken('TOKEN_ID')

This command requires the following parameters:

Argument

Definition

TOKEN_ID

ID of the token to be deleted.

Example

The following example deletes a specific Import Processor HA token:

deleteImportHAToken('d:\bills\ha_token.lst')

A Capture Object Properties

This appendix lists all the properties that can be set for each Capture object using the setObjectProperty command.

This appendix contains the following sections:

- Client Profile Object Properties

- Import Processor Job Object Properties

- Recognition Processor Job Object Properties

- Commit Profile Object Properties

- Document Conversion Job Object Properties

A.1 Client Profile Object Properties

The following table lists all the properties that can be set for a Client Profile object (class name: oracle.oddc.data.Profile).

Property Name (on the UI)

Property Name (in the Class)

Data Type

Valid Options

Profile Name

profileName

String

Any value

Description

profileDesc

String

Any value

Online

profileStatus

boolean

Any value

Apply Default Brightness and Contrast

applyBrightness

boolean

Any value

Batch Prefix

batchPrefix

String

Any value

Profile Type

scanningType

int

1 - Capture only

2 - Capture and Index

3 - Index only

Non-Image File Preview Page Limit

maxPages

int

Any value

Default Status

defaultStatus

String

Any value

Batch Priority

defaultPriority

int

Any value

Document Creation Option

docOption

int

1 - One page (for example, Simplex)

2 - Two pages (for example, Duplex)

3 - Variable number of pages

4 - Prompt the user

Separator Sheet Byte Threshold

sepByteThreshold

int

Any value

Blank Page Byte Threshold:

blankByteThreshold

long

Any value

Database Lookup Profile

dbLookupProfile

String

Any value

Always Display Records

dbLookupHitList

boolean

Any value

Dependent Choice List

pickListRelationshipProfile

String

Any value

Records Returned Limit

dbLookupMaxRecords

int

Any value

Brightness

brightness

int

Any value

Contrast

contrast

int

Any value

Batch Visibility

batchVisibility

int

0 - User and workstation

1 - User

2 - All users

Non-Image File Import Action

nonImageImportAction

int

0 - Do not import

1 - Import in native format

2 - Convert to image format

Additional Batch Prefixes (separate by ;)

filterPrefix

String

Any value

Days Old: From

filterDaysFrom

int

Any value

Days Old: To

filterDaysTo

int

Any value

Batch Statuses

filterStatus

List<String>

Any value

Priorities

filterPriority

List<Integer>

[0,1,2,3,4,5,6,7,8,9,10]

Primary Sort

filterPrimarySort

String

BatchName/BatchPageCount/BatchDate/BatchPriority/BatchStatus

Primary Sort Order

filterPrimaryOrder

int

0 - Ascending

1 - Descending

Secondary Sort

filterSecondarySort

String

BatchName/BatchPageCount/BatchDate/BatchPriority/BatchStatus

Secondary Sort Order

filterSecondaryOrder

int

Any value

Document Profiles

supportedDocumentTypes

List<String>

Any value

Batch Processor

batchProcessorID

String

oracle.odc.docconverterprocessor.DocumentConverterProcessor/oracle.odc.commitprocessor.CommitProcessor/oracle.odc.recognitionprocessor.RecognitionProcessor

Batch Processor Job

batchProcessorJobID

String

Any value

Default Color

defaultColor

int

0 - Not specified

1 - Black and white

2 - Gray scale

3 - Color

Default DPI:

defaultDPI

int

0(Not specified)/100 /150/200/240/300/400/600

Prevent Default Override

preventDefaultColorOverride

boolean

Any value

Prevent Default Override

preventDefaultDPIOverride

boolean

Any value

Non-Image conversion : Color

convertColor

int

0 - TIFF: black and white

1 - JPEG: color

Non-Image conversion :JPEG Image Quality

convertQuality

int

Any value

Non-Image conversion:DPI

convertDPI

int

0(Not specified)/100 /150/200/240/300/400/600

A.2 Import Processor Job Object Properties

The following section lists all the properties that can be set for an Import Processor Job object (class name: oracle.odc.importprocessor.ImportJob).

This section contains the following topics:

- General Import Job Properties

- Folder Import Job Specific Properties

- List File Import Job Specific Properties

- Email Job Specific Properties

A.2.1 General Import Job Properties

The following table lists the General Import Job properties that can be set (use class name: oracle.odc.importprocessor.ImportJob).

Property Name (on the UI)

Property Name (in the Class)

Data Type

Valid Options

Online

isJobOnline

Boolean

Any value

Import Job Name

jobName

String

Any value

Image Down-Sample

imageDownsample

Integer

0 - None (retain image format)

1 - Down-sample color to 8 bit (gray scale)

2 - Down-sample color or gray scale to black and white

JPEG Image Quality

jpegQuality

Integer

Any value

Batch Prefix

batchPrefix

String

Any value

Default Batch Status

defaultBatchStatusID

String

Any value

Default Batch Priority

defaultPriority

Integer

Any value

Database Lookup Profile

dbSearchID

String

Any value

Database Search Field

dbSearchFieldID

String

Any value

Default Document Profile

defaultDocumentTypeID

String

Any value

When more than one record is found

searchResultOption

Integer

0 - Use first record

1 - Do not select a record

Script

scriptID

String

Any value

Import Frequency

importFrequency

Integer

15: 15 seconds

30: 30 seconds

60: 1 minute

300: 5 minutes

900: 15 minutes

1800: 30 minutes

3600: 1 hour

-1: Daily

Import Source

importSourceClassName

String

oracle.odc.importprocessor.folder.FolderSource /oracle.odc.importprocessor.email.EmailSource /oracle.odc.importprocessor.listfile.ListFileSource

Batch Processor

batchProcessorClassName

String

oracle.odc.docconverterprocessor.DocumentConverterProcessor/oracle.odc.commitprocessor.CommitProcessor/oracle.odc.recognitionprocessor.RecognitionProcessor

Batch Processor Job

batchProcessorJobID

String

Any value

Import Freq: Every Day: Time Hr:

hour

Integer

Any value

Import Freq: Every Day: Time Min:

minute

Integer

Any value

Default Locale

locale

Locale

Any value

If Image Validation Fails:

imageFailureAction

Integer

0 - Delete the batch

1 - Skip the file

Default Date Format

defaultDateFormat

String

Any value

Description

description

String

Any value

Encoding

encoding

String

Any value

A.2.2 Folder Import Job Specific Properties

The following table lists the Folder Import Job properties that can be set (use class name: oracle.odc.importprocessor.ImportJob).

Property Name (on the UI)

Property Name (in the Class)

Data Type

Valid Options

Import Folder Path

folder

String

Any value

Process subfolders

processSubfolders

boolean

Any value

Create a New Batch

batchCreationOption

int

0 - Per file

1 - Per folder

File Mask(s)

fileMasks

String

Any value

Primary Sort Type

primarySortType

FolderSortType

0 - None

1 - File Name

2 - File Extension

3 - File Modified Date

Primary Sort Order

primarySortOrder

FolderSortOrder

0 - Ascending

1 - Descending

Secondary Sort Type

secondarySortType

FolderSortType

0 - None

1 - File name

2 - File extension

3 - File modified date

Secondary Sort Order

secondarySortOrder

FolderSortOrder

0(Ascending) / 1(Descending)

Ready File

readyFile

String

Any value

After Import

postProcessingOption

int

0 - Delete file

1 - Change file extension

2 - Add file prefix

New Extension

fileExtension

String

Any value

Prefix

filePrefix

String

Any value

Delete processed subfolder if empty

deleteSubfolders

boolean

Any value

A.2.3 List File Import Job Specific Properties

The following table lists the List File Import Job properties that can be set (use class name: oracle.odc.importprocessor.ImportJob).

Property Name (on the UI)

Property Name (in the Class)

Data Type

Valid Options

Import Folder Path

folder

String

Any value

Create a New Batch:

batchCreationOption

int

0 - Per list file

1 - Per folder

File Mask(s)

fileMasks

String

Any value

Process subfolders

processSubfolders

boolean

Any value

Field Delimiter

fieldDelimiter

String

Any value

Maximum Fields Per Document

maxFieldsPerRecord

int

Any value

Document File Field Position

documentFieldPosition

int

Any value

After Import

postProcessingOption

int

0 - Delete file

1 - Change file extension

2 - Add file prefix

New Extension

fileExtension

String

Any value

Prefix

filePrefix

String

Any value

Delete document files after successful import

deleteDocumentFiles

boolean

Any value

A.2.4 Email Job Specific Properties

The following table lists the Email Job properties that can be set (use class name: oracle.odc.importprocessor.ImportJob).

Property Name (on the UI)

Property Name (in the Class)

Data Type

Valid Options

IMAP Connection Security

imapConnectSecurity

EmailConnectionSecurity

0 - NONE

1 - STARTTLS

2 - SSL_TLS

Email Server Name (DNS name or IP address)

serverName

String

Any value

Port

port

int

Any value

Folders to Process

folderList

List<String>

Any value

Message Filters: From Address

filterFromAddressEnabled

boolean

Any value

Message Filters: From Address Field Contains

filterFromAddress

String

Any value

Message Filters: Subject

filterSubjectEnabled

boolean

Any value

Message Filters: Subject Field Contains

filterSubject

String

Any value

Message Filters: Message Body

filterMessageBodyEnabled

boolean

Any value

Message Filters: Message Body Field Contains

filterMessageBody

String

Any value

Include attachments matching these mask(s)

attachmentsMask

String

Any value

Exclude attachments matching these mask(s)

attachmentsExcludeMask

String

Any value

Email Message Options

includeMessageBodyOption

int

0 - Import as text

1 - Import in EML format

Import message body file

includeMessageBodyFile

boolean

Any value

Import entire message in EML format

includeEntireEMLFile

boolean

Any value

Document Ordering

emailDocumentOrder

List<Integer>

0 - Message body (text file)

1 - Message body (EML file)

2 - Email message (EML file)

3 - Attachment(s)

Include when no attachments exist

includeMessageBodyWithoutAttachments

boolean

Any value

Upon Failed Import

postProcessingFailureOption

int

0 - Delete the message

1 - Move the message to another folder

2 - Do not delete the message

Upon Successful Import:

postProcessingSuccessOption

int

0 - Delete message

1 - Move message to another folder

Folder Name:

postProcessingFailureMoveFolder

String

Any value

Folder Name

postProcessingSuccessMoveFolder

String

Any value

Search Operator

searchOperator

int

0 - AND

1 - OR

Determined based on email importance

determineBatchPriority

boolean

Any value

Email Importance Low: Batch Priority

batchPriorityLow

int

Any value

Email Importance Normal: Batch Priority

batchPriorityNormal

int

Any value

Email Importance High: Batch Priority

batchPriorityHigh

int

Any value

Email Accounts to Process

emailAccounts

List<String>

Any value

A.3 Recognition Processor Job Object Properties

The following table lists all the properties that can be set for a Recognition Processor Job object (class name: oracle.odc.recognition.RecognitionJob).

This section contains the following topics:

- General Recognition Job Properties

- BarcodeDefinition Class Properties

- DocumentDefinition Class Properties

- RecognitionJobField Class Properties

- SeparatorDefinition Class Properties

A.3.1 General Recognition Job Properties

The following table lists the General Recognition Job properties that can be set (use class name: oracle.odc.recognition.RecognitionJob).

Property Name (on the UI)

Property Name (in the Class)

Data Type

Valid Options

Recognition Job Name

name

String

Any value

Description

description

String

Any value

Script

scriptID

String

Any value

Online

online

Boolean

Any value

Bar Codes

barcodes

List<BarcodeDefinition>

Any value

Enable Auto-Detect

autoDetectBarcodes

Boolean

Any value

Validate optional checksum

validateCheckSum

Boolean

Any value

Bar Code Recognition

symbologies

List<Integer>

[0,1,2,3,4,5,6,7,8,9] (Auto-Detectable 1-D Symbologies) / [10,11,12,13,14,15,16,17,18](Other 1-D Symbologies) / [19,20,21](2-D Symbologies)

Organize documents based on

batchOrganization

Integer

0 - Fixed number of pages per document

1 - None: Do not perform document organization

2 - Same bar code value on each page

3 - Separator pages

4 - Hierarchical separator pages

Number of Pages Per Document:

documentPageCount

Integer

Any value

Number of pages per document to read bar codes:

pagesPerDoc2ReadBarcodes

Integer

Any value

Maximum Number of Pages Per Document:

maxPageCountPerDoc

Integer

Any value

Optimistic bar code detection

optimizeBarcodeDetection

Boolean

Any value

Separator Page:

coverPages

List<SeparatorDefinition>

Any value

If more than one value is found for a bar code within a document

multiBarcodeValuesOption

Integer

0 - Use the first value found

1 - Always overwrite the bar code value

2 - Clear the bar code value

Source Document Attachments:

sourceDocAttachments

Integer

0 - Include all attachments to created documents

1 - Include attachments with matching Document Profile attachment types

2 - Do not include attachments

Dynamic Document Profile Option:

dynamicDocType

Integer

0 - Do not determine dynamically

1 - Determine dynamically using bar code

2 - Determine dynamically using separator page

Default Document Profile:

defaultDocTypeID

String

Any value

Document Profile and Bar Code Value Mappings

docTypeMappings

List<DocumentDefinition>

Any value

Fields

jobFields

List<RecognitionJobField>

Any value

DB Lookup Using:

dblookupUsing

Integer

0 - None

1 - Bar code

2 - Field value

Field Name

dblookupIndexDefID

String

Any value

Database Lookup Profile

dblookupProfile

String

Any value

Database Search Field:

dblookupSearchField

String

Any value

When more than one record is found:

dblookupMultipleRecordAction

Integer

0 - Use first record

1 - Do not link

When no record is found:

dblookupNoMatchAction

Integer

0 - Allow document commit

1 - Prevent document commit

To rename the batch, enter a prefix:

renamePrefix

String

Any value

To send email notification, enter email address:

renameEmail

String

Any value

To change batch status, select a status:

renameStatus

String

Any value

To change batch priority, enter a priority between 1 to 10:

renamePriority

Integer

Number between 1 to 10

Batch Processor

processorID

String

Any value

Batch Processor Job:

processorJobID

String

Any value

To rename the batch, enter a prefix:

failureRenamePrefix

String

Any value

To send email notification, enter email address:

failureRenameEmail

String

Any value

To change batch status, select a status:

failureRenameStatus

String

Any value

To change batch priority, enter a priority between 1 to 10:

failureRenamePriority

Integer

Number between 1 to 10

Batch Processor

failureProcessorID

String

Any value

Batch Processor Job:

failureProcessorJobID

String

Any value

Bar Code Engine

decoder

Integer

0 - Universal Decoder

1 - Windows Decoder

Maximum Bar Codes per Image

maxBarcodes

Integer

Number between 1 to 10

Minimum Bar Code Height

minHeight

Double

Any valid value between 0.2 to 3.0

Unit of Measure

unitMeasure

Integer

0 - Inch

1 - Centimeter

Maximum Bar Code Width

maxWidth

Double

Any valid value between minHeight to 10

Minimum Bar Code Characters

minChars

Integer

Number between 1 to 1000

A.3.2 BarcodeDefinition Class Properties

The following table lists the BarcodeDefinition properties that can be set (use class name: oracle.odc.recognition.RecognitionJob).

Property Name (on the UI)

Property Name (in the Class)

Data Type

Valid Options

Name

barcodeName

String

Any value

Validation Rules

validationRule

Integer

0 - None

1 - Length

2 - Mask

3 - Regular expression

4 - Choice list

Length

validationLength

Integer

Any value

Mask

validationMask

String

Any value

Regular Expression

validationRegularExpression

String

Any value

Choice List Source

pickListSourceID

String

Any value

Choice List Source

pickListID

String

Any value

A.3.3 DocumentDefinition Class Properties

The following table lists the DocumentDefinition properties that can be set (use class name: oracle.odc.recognition.RecognitionJob).

Property Name (on the UI)

Property Name (in the Class)

Data Type

Valid Options

Bar Code Value Matches:

mappingType

Integer

0 - Single value

1 - Choice list

Single Value:

value

String

Any value

A.3.4 RecognitionJobField Class Properties

The following table lists the RecognitionJobField properties that can be set (use class name: oracle.odc.recognition.RecognitionJob).

Property Name (on the UI)

Property Name (in the Class)

Data Type

Valid Options

Auto Populate

autoPopulate

Integer

0 - None

1 - Bar code

2 - Batch name

3 - Default

4 - Index date

5 - Scan date

Barcode

populateValue

String

Any value

A.3.5 SeparatorDefinition Class Properties

The following table lists the SeparatorDefinition properties that can be set (use class name: oracle.odc.recognition.RecognitionJob).

Property Name (on the UI)

Property Name (in the Class)

Data Type

Valid Options

Rule Name

name

String

Any value

Delete this separator page upon commit

deleteUponCommit

Boolean

Any value

Operator

operator

Integer

0 - OR

1 - AND

Document Profile

docTypeID

String

Any value

Attachment Type

attachmentTypeID

String

Any value

A.4 Commit Profile Object Properties

The following table lists all the properties that can be set for a Commit Profile object (class name: oracle.odc.entity.CommitProfileEntity).

This section contains the following topics:

- General Commit Profile Properties

- Text File Commit Profile Specific Properties

- Webcenter Content Commit Profile Specific Properties

- ContentAttributeMappingInfo Class Properties

- CaptureToContentFieldMapping Class Properties

- ContentFieldNameInfo Class Properties

- Webcenter Imaging Commit Profile Specific Properties

- PDF Searchable Document Output Specific Properties

- DOCS Commit Driver Properties

A.4.1 General Commit Profile Properties

The following table lists the General Commit Profile properties that can be set (use class name: oracle.odc.entity.CommitProfileEntity).

Property Name (on the UI)

Property Name (in the Class)

Data Type

Valid Options

Commit Profile Name

profileName

String

Any value

Document Output Format

exportDriverID

String

oracle.odc.export.PDFSearchable/oracle.odc.export.PDFImageOnly/oracle.odc.export.TIFFMultiImage

Attachment Document Output Format

attachExportDriverID

String

oracle.odc.export.PDFSearchable/oracle.odc.export.PDFImageOnly/oracle.odc.export.TIFFMultiImage

Commit Driver

commitDriverID

String

oracle.odc.commit.TextFileCommitDriver(Text File)/oracle.odc.commit.cs.ContentCommitDriver(WebCenter Content) / oracle.odc.commit.ipm.IPMCommitDriver(WebCenter Content Imaging)

Online

active

Boolean

Any value

Edit Execution Order

executionOrder

Integer

Any value

Error Handling Policy

errorHandlingPolicy

Integer

0 - Continue to the next document

1 - Cancel to next commit profile

2 - Cancel commit

Restrict Commit to Document Profiles

documentTypes

List<DocumentTypeEntity>

Any value

Default Locale

defaultLocaleString

String

Any value

Default Date Format

defaultDateFormat

String

Any value

Encoding

encoding

String

Any value

Note:

To update the Default Locale field associated with a commit profile, pass a value that includes all the three parts of a locale, that is, language, country, and variant. Use a vertical bar (|) to separate the parts of the locale. The following example sets the locale to Chinese (China): defaultLocaleString = zh|CN|.

A.4.2 Text File Commit Profile Specific Properties

The following table lists the Text File Commit Profile properties that can be set (use class name: oracle.odc.entity.CommitProfileEntity).

Property Name (on the UI)

Property Name (in the Class)

Data Type

Valid Options

Do not create Commit Text File

doNotCreateTextFile

boolean

Any value

Store in subfolders

useTextSubFolder

boolean

Any value

Exclude Attachments

excludeAttachment

boolean

Any value

Text File Folder : Subfolder Options

textSubFolderOption

int

0 - Year

1 - Year and month

2 - Year, month, and date

Commit Text File Folder

textFileFolder

String

Any value

File Prefix

textFilePrefix

String

Any value

File Extension

textFileExtension

String

Any value

Create a copy for each page

duplicateLinkedItems

boolean

Any value

Create a folder per committed batch

oneFolderPerBatch

boolean

Any value

Store in subfolders

useDocSubFolder

boolean

Any value

Document Folder :Subfolder Options

docSubFolderOption

int

0 - Year

1 - Year and month

2 - Year, month, and date

3 - Metadata field(s)

Document Folder

docFolder

String

Any value

Selected Metadata Fields

subFolderIndexes

List<String>

Any value

SubFolder Path

subFolderPath

String

Any value

Field Delimiter

delimiterOption

int

0 - Comma

1 - Semicolon

2 - Other

Text Qualifier

textQualifier

int

0 -None

1 - Double quote

2 - Single quote

Other Character

formatDelimiter

String

Any value

Text Qualifier

formatFields

List<String>

Any value

Name document file based on metadata field values

nameDoc

boolean

Any value

If File Name Consists of Invalid Characters

docNameInvalidCharOption

int

0 - Remove invalid characters

1 - Cancel document commit

Document File Naming: Field Delimiter

docNameDelimiter

String

Any value

Fields to Include in Document File Name

docNameFields

List<String>

Any value

A.4.3 Webcenter Content Commit Profile Specific Properties

The following table lists the Webcenter Content Commit Profile properties that can be set (use class name: oracle.odc.entity.CommitProfileEntity).

Property Name (on the UI)

Property Name (in the Class)

Data Type

Valid Options

Server URL

serverURL

String

Any value

Name document file based on metadata values

documentFileNaming

boolean

Any value

Document File Name

documentFilename

String

Any value

If file name consists of invalid characters:

removeDocFilenameInvalidChars

boolean

Any value

Document Title

documentTitle

String

Any value

Default Account

documentAccount

String

Any value

Default Security Group

documentSecurityGroup

String

Any value

Default Type

documentType

String

Any value

Assign Values Dynamically

dynamicAssignment

boolean

Any value

Assign Value

dynamicMappingOption

int

0 - By field mappings

1 - By metadata field

Metadata Field

dynamicMappingIndexField

String

Any value

Choice List Source

dynamicMappingPicklistSourceId

String

Any value

Choice List

dynamicMappingPicklistId

String

Any value

Account

accountMappingField

String

Any value

Type

contentTypeMappingField

String

Any value

Security Group

securityGroupMappingField

String

Any value

Content Attribute Mapping

attributeMappingList

List<ContentAttributeMappingInfo>

Any value

Bypass Workflows

bypassWorkflow

boolean

Any value

Alternative Check-In Service

alternateCheckInService

String

Any value

Select Capture metadata fields to assign to Content Server fields

fieldMappingList

List<CaptureToContentFieldMapping>

Any value

Custom Fields

customMetadataList

List<ContentFieldNameInfo>

Any value

Exclude Attachments

excludeAttachments

boolean

Any value

A.4.4 ContentAttributeMappingInfo Class Properties

The following table lists the ContentAttributeMappingInfo Class properties that can be set (use class name: oracle.odc.entity.CommitProfileEntity).

Property Name (on the UI)

Property Name (in the Class)

Data Type

Valid Options

Field Value

fieldValue

String

Any value

Type

docType

String

Any value

Security Group

docSecurityGroup

String

Any value

Account

docAccount

String

Any value

A.4.5 CaptureToContentFieldMapping Class Properties

The following table lists the CaptureToContentFieldMapping Class properties that can be set (use class name: oracle.odc.entity.CommitProfileEntity).

Property Name (on the UI)

Property Name (in the Class)

Data Type

Valid Options

Content Server Field

captureField

String

Any value

Capture Field

contentField

String

Any value

A.4.6 ContentFieldNameInfo Class Properties

The following table lists the ContentFieldNameInfo Class properties that can be set (use class name: oracle.odc.entity.CommitProfileEntity).

Property Name (on the UI)

Property Name (in the Class)

Data Type

Valid Options

Custom Field Name

name

String

Any value

Custom Field Caption

caption

String

Any value

A.4.7 Webcenter Imaging Commit Profile Specific Properties

The following table lists the Webcenter Imaging Commit Profile properties that can be set (use class name: oracle.odc.entity.CommitProfileEntity).

Property Name (on the UI)

Property Name (in the Class)

Data Type

Valid Options

Commit Methods

commitMethod

int

0 - Direct commit

1 - Input agent commit

Search and append to matching Imaging documents

append

boolean

Any value

Imaging WebService URL

url

String

Any value

Security Policy

policy

int

0 - Basic security

1 - Token security

Capture Output Directory

inputDir

String

Any value

Input Agent Directory

inputAgentDir

String

Any value

Search Definition

searchName

String

Any value

A.4.8 PDF Searchable Document Output Specific Properties

The following table lists the PDF Searchable Document Output properties that can be set (use class name: oracle.odc.entity.CommitProfileEntity).

Property Name (on the UI)

Property Name (in the Class)

Data Type

Valid Options

Create Text File

textFormat

Integer

0 - Do not create text file

1 - Create text file format

Languages:

language

String

comma separated language IDs [0-122] For example, “0, 2, 3, 18"

Text File Code Page

codePage

String

Any value

Professional Dictionaries

profDictionary

String

Comma separated professional dictionary name. For example, “English Medical Dictionary, German Legal Dictionary"

Color Image Quality

colorImageQuality

int

0 - Minimum: minimum size

1 - Good: medium size

2 - Best: large size

Compatibility

compatibility

String

PDF14/PDF15/PDF16/PDF17/PDFA1B/PDFA2B/PDFA2U

Create Linear PDF for Efficient Web Viewing

linearized

boolean

Any value

Preserve Original Image Orientation

keepImgOrientation

boolean

Any value

Single Language Detection per Page

singleLangPerPage

boolean

Any value

A.4.9 DOCS Commit Driver Properties

The following table lists the DOCS Commit Driver properties that can be set (use class name: oracle.odc.entity.CommitProfileEntity).

Property Name (on the UI)

Property Name (in the Class)

Data Type

Valid Options

Server URL

serverURL

String

Any value

Name

parentFolderName

String

Any value

ID

parentFolderID

String

Any value

Sub-Folder Fields:

subFolderFields

List<String>

Any value

Create Sub-Folders using Field Values

createSubFolders

boolean

Any value

If folder name consists of invalid characters:

folderInvalidCharOption

int

0 - Remove invalid characters

1 - Cancel document commit

Use original file name for non-image files

useOriginalFileName

boolean

Any value

Name document file based on metadata field values

nameDoc

boolean

Any value

Fields to Include in Document File Name:

docFileFields

List<String>

Any value

Field Delimiter

docFileDelimiter

String

Any value

If file name consists of invalid characters:

docFileInvalidCharOption

int

0 - Remove invalid characters

1 - Cancel document commit

A.5 Document Conversion Job Object Properties

The following table lists all the properties that can be set for a Document Conversion Job object (class name: oracle.odc.docconverter.DocConverterJob).

Property Name (on the UI)

Property Name (in the Class)

Data Type

Valid Options

Name:

jobName

String

Any value

Online:

online

boolean

Any value

JPEG Image Quality

jpegQuality

Integer

1<jpegQuality<=99

Documents to Convert:

docFilter

Boolean

true: Selected non-image documents

false: All non-image documents

Attachments to Convert:

docAttachmentFilter

Boolean

Any value

Output Image Format:

outputImageFormat

Integer

0 - TIFF: black and white

1 - JPEG: color

File Name Filter:

filterpattern

String

Any value

Batch Merge Option:

documentMergeType

Integer

0 - Do not merge documents

1 - Merge the first document with all other documents

2 - Merge the last document with all other documents

3 - Merge all documents

Source Document Page Placement:

mergeToBeginning

boolean

true: Start of the target document

false: End of the target document

Apply source document's metadata values

applySourceMetadata

boolean

Any value

Allow target document's metadata values to be overwritten

overwriteDestinationMetadata

boolean

Any value

Description:

description

String

Any value

Batch Processor:

processorID

String

Any value

Batch Processor Job:

processorJobID

String

Any value

To rename the batch, enter a prefix:

renamePrefix

String

Any value

To send email notification, enter email address:

renameEmail

String

Any value

To change batch status, select a status:

renameStatus

String

Any value

To change batch priority, enter a priority between 1 to 10:

renamePriority

Integer

[1-10]

Batch Processor:

errProcessorID

String

Any value

Batch Processor Job:

errProcessorJobID

String

Any value

To rename the batch, enter a prefix:

errRenamePrefix

String

Any value

To send email notification, enter email address:

errRenameEmail

String

Any value

To change batch status, select a status:

errRenameStatus

String

Any value

To change batch priority, enter a priority between 1 to 10:

errRenamePriority

Integer

[1-10]

DPI:

dpi

Integer

100 / 150 /200 / 240/300/400/600

External Conversion Use:

extConvEnabled

Boolean

true: On

false: Off

File Name Filter(s):

extConvFilterPattern

String

Any value

External Conversion Program:

extConvProgram

String

Any value

Command Line Parameters:

extConvCommandLine

String

Any value

Process Monitoring Method:

extConvMonitoringMethod

Integer

0 - Duration time out

1 - Output file inactivity time out

Timeout (minutes):

extConvTimeout

Integer

[1-1000]

Success Return Code

extConvSuccessReturnCode

Integer

Any value

Do not convert:

doNotConvertDocs

Boolean

Any value

Do not convert:

doNotConvertDocAttachments

Boolean

Any value

File Name Filter:

attachmentFilterPattern

String

Any value

Source Attachments:

documentAttachmentMergeType

Integer

0 - Do not include attachments

1 - Include all attachments to the merged documents

2 - Include attachments with the matching Document Profile Attachment Types

Restrict to Document Profiles:

documentTypes

List<DocumentTypeEntity>

Any value

Restrict to Attachment Types:

attachmentTypes

List<DocumentAttachmentTypeEntity>

Any value

Oracle Legal Notices

Copyright Notice

Copyright © 1994-2018, Oracle and/or its affiliates. All rights reserved.

License Restrictions Warranty/Consequential Damages Disclaimer

This software and related documentation are provided under a license agreement containing restrictions on use and disclosure and are protected by intellectual property laws. Except as expressly permitted in your license agreement or allowed by law, you may not use, copy, reproduce, translate, broadcast, modify, license, transmit, distribute, exhibit, perform, publish, or display any part, in any form, or by any means. Reverse engineering, disassembly, or decompilation of this software, unless required by law for interoperability, is prohibited.

Warranty Disclaimer

The information contained herein is subject to change without notice and is not warranted to be error-free. If you find any errors, please report them to us in writing.

Restricted Rights Notice

If this is software or related documentation that is delivered to the U.S. Government or anyone licensing it on behalf of the U.S. Government, then the following notice is applicable:

U.S. GOVERNMENT END USERS: Oracle programs, including any operating system, integrated software, any programs installed on the hardware, and/or documentation, delivered to U.S. Government end users are "commercial computer software" pursuant to the applicable Federal Acquisition Regulation and agency-specific supplemental regulations. As such, use, duplication, disclosure, modification, and adaptation of the programs, including any operating system, integrated software, any programs installed on the hardware, and/or documentation, shall be subject to license terms and license restrictions applicable to the programs. No other rights are granted to the U.S. Government.

Hazardous Applications Notice

This software or hardware is developed for general use in a variety of information management applications. It is not developed or intended for use in any inherently dangerous applications, including applications that may create a risk of personal injury. If you use this software or hardware in dangerous applications, then you shall be responsible to take all appropriate fail-safe, backup, redundancy, and other measures to ensure its safe use. Oracle Corporation and its affiliates disclaim any liability for any damages caused by use of this software or hardware in dangerous applications.

Trademark Notice

Oracle and Java are registered trademarks of Oracle and/or its affiliates. Other names may be trademarks of their respective owners.

Intel and Intel Xeon are trademarks or registered trademarks of Intel Corporation. All SPARC trademarks are used under license and are trademarks or registered trademarks of SPARC International, Inc. AMD, Opteron, the AMD logo, and the AMD Opteron logo are trademarks or registered trademarks of Advanced Micro Devices. UNIX is a registered trademark of The Open Group.

Third-Party Content, Products, and Services Disclaimer

This software or hardware and documentation may provide access to or information about content, products, and services from third parties. Oracle Corporation and its affiliates are not responsible for and expressly disclaim all warranties of any kind with respect to third-party content, products, and services unless otherwise set forth in an applicable agreement between you and Oracle. Oracle Corporation and its affiliates will not be responsible for any loss, costs, or damages incurred due to your access to or use of third-party content, products, or services, except as set forth in an applicable agreement between you and Oracle.

Pre-General Availability Draft Documentation Notice

If this document is in public or private pre-General Availability status:

This documentation is in pre-General Availability status and is intended for demonstration and preliminary use only. It may not be specific to the hardware on which you are using the software. Oracle Corporation and its affiliates are not responsible for and expressly disclaim all warranties of any kind with respect to this documentation and will not be responsible for any loss, costs, or damages incurred due to the use of this documentation.

Private Pre-General Availability Draft Documentation Notice

If this document is in private pre-General Availability status:

The information contained in this document is for informational sharing purposes only and should be considered in your capacity as a customer advisory board member or pursuant to your pre-General Availability trial agreement only. It is not a commitment to deliver any material, code, or functionality, and should not be relied upon in making purchasing decisions. The development, release, and timing of any features or functionality described in this document remains at the sole discretion of Oracle.

This document in any form, software or printed matter, contains proprietary information that is the exclusive property of Oracle. Your access to and use of this confidential material is subject to the terms and conditions of your Oracle Master Agreement, Oracle License and Services Agreement, Oracle PartnerNetwork Agreement, Oracle distribution agreement, or other license agreement which has been executed by you and Oracle and with which you agree to comply. This document and information contained herein may not be disclosed, copied, reproduced, or distributed to anyone outside Oracle without prior written consent of Oracle. This document is not part of your license agreement nor can it be incorporated into any contractual agreement with Oracle or its subsidiaries or affiliates.

Documentation Accessibility

For information about Oracle's commitment to accessibility, visit the Oracle Accessibility Program website at http://www.oracle.com/pls/topic/lookup?ctx=acc&id=docacc.

Access to Oracle Support

Oracle customers that have purchased support have access to electronic support through My Oracle Support. For information, visit http://www.oracle.com/pls/topic/lookup?ctx=acc&id=info or visit http://www.oracle.com/pls/topic/lookup?ctx=acc&id=trs if you are hearing impaired.