Calling an Oracle WebCenter Content service (making a service request) is the only way to communicate with the Oracle WebCenter Content system or access the Content Server database. This guide describes service usage and syntax, and provides detailed descriptions and examples of commonly used and predefined Oracle WebCenter Content services.
The information contained in this guide is based on 12c Release (12.2.1) . The information is subject to change as the product technology evolves and as hardware and operating systems are created and modified. Due to the technical nature of browsers, databases, Web servers, and operating systems, Oracle cannot warrant compatibility with all versions and features of third-party products.
For more information about customizing and integrating the Oracle WebCenter Content system, see Customization Types and About Integration Methods in Developing with Oracle WebCenter Content.
This chapter covers the following topics:
This guide is arranged according to Oracle WebCenter Content functionality or component, making it easier for you to find information about specific services. Services that are used extensively have an extended description. In addition, frequently-used services are marked with an asterisk (*) in introductory lists in each chapter.
Core Content Server Services, describes core Content Server services, grouped by common usage.
Workflow Services, describes workflow services used with Content Server.
Archive Services, describes archiving services used with Content Server.
Contribution Folders Services, describes services used with contribution folders (supported by the Folders_g component) in Content Server.
Folders Services, describes services used with folders (supported by the FrameworkFolders component) in Content Server.
Records Services, describes services used with Oracle WebCenter Content: Records.
Physical Content Management Services, describes services used with Physical Content Manager.
Extended User Attributes Services, describes services used with Extended User Attributes in Content Server.
Folios Services, describes services used with Folios in Content Server.
Link Manager Services, describes services used with Link Manager.
Virtual Content Repository Services, describes services used by applications that work with the Virtual Content Repository (VCR) service provider interfaces.
EventNotification Services, describes services available for generating and publishing events in Oracle WebCenter Content.
Imaging Services, describes services related to imaging and annotations in Oracle WebCenter Content.
Actions, describes the actions used by individual services.
Oracle WebCenter Content documentation uses the following terms when referring to variables in the directories associated with the Oracle WebCenter Content and Content Server configuration:
UCM_ORACLE_HOME: This variable refers to the ORACLE_HOME and Oracle WebLogic Server install directories for an Oracle WebCenter Content (WebCenter Content) domain. Default directories are provided, however, sites can specify alternative directories.
IdcHomeDir: This variable refers to the ucm/idc directory in the Oracle WebCenter Content home where the Oracle WebCenter Content server media is located. The server media can run Oracle WebCenter Content Server, Oracle WebCenter Content: Inbound Refinery, or Oracle WebCenter Content: Records software. This is essentially a read-only directory. The default location is WCC_ORACLE_HOME/ucm/idc. The variable portion of the default location can be changed, but the path cannot be changed from ucm/idc.
DomainHome: This variable refers to the user-specified directory where an Oracle WebCenter Content application is deployed to run on an Oracle WebLogic Server application server. The DomainHome/ucm/short-product-id/bin directory contains the intradoc.cfg file and executables. The default location for DomainHome is MW_HOME/user_projects/domains/base_domain, but you can change the path and domain name (base_domain) during the deployment of an Oracle WebCenter Content application to an application server.
short-product-id: This variable refers to the type of Oracle WebCenter Content server deployed to an application server. This name is used as the context root (default HttpRelativeWebRoot configuration value). Possible values include:
cs (Oracle WebCenter Content Server)
ibr (Oracle WebCenter Content: Inbound Refinery)
urm (Oracle WebCenter Content: Records)
IntradocDir: This variable refers to the root directory for configuration and data files specific to an Oracle WebCenter Content instance that is part of an Oracle WebCenter Content application deployed to an application server. This Idoc Script variable is configured for one type of Oracle WebCenter Content instance: Content Server (cs), Inbound Refinery (ibr), or Records (urm). This directory can be located elsewhere, but the default location is DomainHome/ucm/short-product-id. The specified directory must be an absolute path to the instance directory and must be unique to a particular server or node. The directory includes a bin/ directory, which contains the startup files (intradoc.cfg and executables).