Contents

Title and Copyright Information

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

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 - Elasticsearch
  • 2.16.1 createSearchConnection
• 2.17 Search - Oracle SES Search
  • 2.17.1 createSESConnection
  • 2.17.2 setSESConnection
  • 2.17.3 listSESConnections
  • 2.17.4 setSearchSESConfig
  • 2.17.5 listSearchSESConfig
  • 2.17.6 createFederationTrustedEntity
  • 2.17.7 setSESVersion
  • 2.17.8 listSESVersion
  • 2.17.9 createDefaultSourceGroup
• 2.18 Search - Oracle SES Search Crawlers
  • 2.18.1 createSpacesCrawler
  • 2.18.2 createDocumentsCrawler
  • 2.18.3 createDiscussionsCrawler
  • 2.18.4 listSpacesCrawler
  • 2.18.5 listDocumentsCrawler
  • 2.18.6 listDiscussionsCrawler
  • 2.18.7 startSpacesCrawler
  • 2.18.8 startDocumentsCrawler
  • 2.18.9 startDiscussionsCrawler
  • 2.18.10 stopSpacesCrawler
  • 2.18.11 stopDocumentsCrawler
  • 2.18.12 stopDiscussionsCrawler
  • 2.18.13 deleteSpacesCrawler
  • 2.18.14 deleteDocumentsCrawler
  • 2.18.15 deleteDiscussionsCrawler
• 2.19 Search - WebCenter Portal Search
  • 2.19.1 setSearchConfig
  • 2.19.2 listSearchConfig
  • 2.19.3 setSpacesCrawlProperties
  • 2.19.4 getSpacesCrawlProperties
• 2.20 WebCenter Portal Application
  • 2.20.1 getSpacesWorkflowConnectionName
  • 2.20.2 setSpacesWorkflowConnectionName
• 2.21 Identity Store
  • 2.21.1 setWebCenterIdStoreSearchConfig
  • 2.21.2 listWebCenterIdStoreSearchConfig
• 2.22 Lifecycle
  • 2.22.1 deployWebCenterPortal
  • 2.22.2 propagateWebCenterPortal
  • 2.22.3 exportWebCenterPortals
  • 2.22.4 exportWebCenterPortalTemplates
  • 2.22.5 importWebCenterPortals
  • 2.22.6 listWebCenterPortalArchive
  • 2.22.7 exportWebCenterPortalConnections
  • 2.22.8 importWebCenterPortalConnections
  • 2.22.9 setSpaceState
  • 2.22.10 exportWebCenterResource
  • 2.22.11 importWebCenterResource
  • 2.22.12 importWebCenterTranslations
  • 2.22.13 exportWebCenterApplication
  • 2.22.14 importWebCenterApplication
  • 2.22.15 exportPortletClientMetadata
  • 2.22.16 importPortletClientMetadata
  • 2.22.17 showProducerImportFailures
  • 2.22.18 retryAllFailedProducerImports
  • 2.22.19 cloneWebCenterManagedServer
• 2.23 Upgrade
  • 2.23.1 upgradeWebCenterPortal
  • 2.23.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 Content: Imaging Custom WLST Commands

• 4.1 Overview of Imaging WLST Command Categories
• 4.2 Diagnostic Commands
  • 4.2.1 clearIPMWorkflowFaults
  • 4.2.2 clearIPMWorkflowFaultsByDocId
  • 4.2.3 listIPMWorkflowFaults
  • 4.2.4 repairIPMWorkflowFaults
  • 4.2.5 repairIPMWorkflowFaultsByDocId
  • 4.2.6 sumIPMWorkflowFaults
  • 4.2.7 resetIPMDMSMetrics
• 4.3 Imaging Configuration Commands
  • 4.3.1 createIPMConnection
  • 4.3.2 modifyIPMConnection
  • 4.3.3 getIPMConfig
  • 4.3.4 getIPMParamLimits
  • 4.3.5 grantIPMCredAccess
  • 4.3.6 importIPMApplication
  • 4.3.7 importIPMInput
  • 4.3.8 importIPMSearch
  • 4.3.9 listIPMConfig
  • 4.3.10 listIPMDefinitions
  • 4.3.11 listIPMExportFile
  • 4.3.12 refreshIPMSecurity
  • 4.3.13 setIPMConfig
  • 4.3.14 submitIPMToWorkflow

5 Oracle WebCenter Enterprise Capture Custom WLST Commands

• 5.1 Overview of WLST Oracle WebCenter Enterprise Capture Command Categories
• 5.2 Configuration Commands
  • 5.2.1 listWorkspaces
  • 5.2.2 listBatches
  • 5.2.3 exportBatch
  • 5.2.4 exportWorkspace
  • 5.2.5 importWorkspace
  • 5.2.6 unlockBatch
  • 5.2.7 listLockedBatches
  • 5.2.8 listCaptureConfig
  • 5.2.9 getCaptureConfig
  • 5.2.10 setCaptureConfig
  • 5.2.11 scanForClientBundles
  • 5.2.12 deleteBundle
  • 5.2.13 setObjectProperty
  • 5.2.14 getObjectProperty
  • 5.2.15 setObjectCredentials
  • 5.2.16 updateScript
  • 5.2.17 cloneWorkspaceFromID
  • 5.2.18 cloneWorkspaceFromFile
  • 5.2.19 listImportHATokens
  • 5.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