A Using WSDL Generator and SOAP
This chapter describes using WSDL Generator and SOAP to manage Oracle Content Server. This feature is supported in Oracle Universal Content Management (Oracle UCM) 11g for backward compatibility.
This appendix includes the following sections:
-
Section A.7, "Creating a Custom WSDL Using Administration Pages"
-
Section A.8, "Sample Service Calls with SOAP Response/Request"
A.1 Overview
Web Services Definition Language (WSDL) files and SOAP (Simple Object Access Protocol) can be used to manage Oracle Content Server. SOAP is a lightweight XML-based messaging protocol used to encode the information in web service request and response messages before sending them over a network. The WSDL Generator component, which is installed (enabled) by default with Oracle Content Server, allows for creating WSDLs for the services of Oracle Content Server. Users can then take the WSDLs and plug them into APIs to create web services that can be used with Oracle Content Server.
Some SOAP functionality has been built into the core Oracle Content Server. The WSDL Generator component is not essential to use SOAP; administrators can still write or call Oracle Content Server service calls in SOAP if needed. The WSDL Generator provides flexibility in altering existing client applications.
Oracle UCM has a WSDL 1.1 implementation that exposes the Oracle UCM IDCService (Internet Distributed Content Service), which in turn extends all of the capabilities of the Unversal Content Management (UCM) system. Using the IDCService, content can be checked out and checked in, workflows can be created, run and approved, content can be made available for publishing, and content can be searched by category (metadata), content (full-text), or a combination of both.
You can use WSDL files to map to Oracle UCM and the SOAP to access the content and content management functions within Oracle UCM and to deploy your content management capabilities as a web service.
A.2 Using Web Services
This section provides an overview of web services, general information about WSDL files and the SOAP protocol, and installation information.
This section covers the following topics:
A.2.1 Web Services Framework
Web services reside as a layer on top of existing software systems such as application servers, .NET servers, and Oracle Content Server. Web services can be used as a bridge to dissimilar operating systems or programming languages. Web services are adapted to the Internet as the model for communication and rely on the HyperText Transfer Protocol (HTTP) as the default network protocol. Thus, using web services, you can build applications using a combination of components.
The core enabling technologies for web services are XML Data, WSDL Interface, SOAP Communication, and UDDI Registry. This section provides a general overview of the technologies in these sections:
A.2.1.1 XML Data
The eXtensible Markup Language (XML) is a bundle of specifications that provides the foundation of all web services technologies. Using the XML structure and syntax as the foundation allows for the exchange of data between differing programming languages, middleware, and database management systems.
The XML syntax incorporates instance data, typing, structure, and semantic information associated with data. XML describes data independently and also provides information for mapping the data to software systems or programming languages. Because of this flexibility, any software program can be mapped to web services.
When web services are invoked, the underlying XML syntax provides the data encapsulation and transmission format for the exchanged data. The XML elements and attributes define the type and structure information for the data. It is XML that provides the capability to model data and define the structure specific to the programming language (for example, Java, C#, or Visual Basic), the database management system, or software application. web services use the XML syntax to specify how data is represented, how the data is transmitted, and how the service interacts with the referenced application.
A.2.1.2 WSDL Interface
The Web Services Description Language (WSDL) provides the interface that is exposed to web services. It is the WSDL layer that enables web services to be mapped to underlying programs and software systems. A WSDL file is an XML file that describes how to connect to and use a web service.
A.2.1.3 SOAP Communication
The Simple Object Access Protocol (SOAP) provides communication for web services interfaces to communicate to each other over a network. SOAP is an XML-based communication protocol used to access web services. Web services receive requests and return responses using SOAP packets encapsulated within an XML document.
A.2.1.4 UDDI Registry
The Universal Description Discovery and Integration (UDDI) service provides registry and repository services for storing and retrieving web services interfaces. UDDI is a public or private XML-based directory for registration and lookup of web services.
Oracle Content Server currently does not publish to any public or private UDDI sources. However this does not prevent users from integrating Oracle UCM with other applications using web services.
A.2.1.5 DIME: Message Format
DIME is a lightweight, binary message format that can be used to encapsulate one or more application-defined groups of arbitrary type and size into a single message construct. This format can be used when uploading or downloading content. The payloads consist of the SOAP message and one or more groups of file content.
A.2.1.6 How the Enabling Technologies Work Together
The XML, WSDL, SOAP, and UDDI technologies work together as layers on the web services protocol stack. The web services protocol stack consists of these layers.
-
The service transport layer between applications (HTTP).
-
The messaging layer that provides a common communication method (XML and SOAP).
-
The service description layer that describes the public interface to a specific web service (WSDL).
-
The service discovery layer that provides registry and repository services for storing and retrieving web services interfaces (UDDI).
Note:
While several protocols are available as a transport layer (for example, HTTP, SMTP, FTP, and BEEP), the HTTP protocol is most commonly used. The WSDL Generator component relies on the HTTP protocol as the transport layer.To help grasp the connection between these technologies, consider this simple analogy: Think of HTTP as the telephone wire (transport between applications) and UDDI as a telephone book (where a developer can browse a UDDI registry to locate a registered service). SOAP could be described as the voices of the people talking on the telephone (the exchange of information), and XML as the language they are speaking in (the underlying structure for the exchange of data). To continue with the telephone analogy, WSDL would be the phone number that calls a specific web service (of course, WSDL is more than just a phone number as it includes information such as the available functions and data types).
A.2.2 Implementation Architecture
Web services are not executable, but rather exchange data within the development environment. Thus, web services are a means to exchange information with an application server or software package that is performing the communication between the programs exchanging data.
The following scenario provides a web services implementation architecture for the Oracle Content Server application. The primary value of this architecture remains in the features and functions of Oracle Content Server. Web services access Oracle Content Server through the WSDL Generator component and use the exposed Oracle Content Server services to execute actions and provide data transaction between the user employing web services and Oracle Content Server.
A.2.3 Implementation on .NET
The Microsoft .NET products including the .NET platform, .NET Framework, and Visual Studio .NET all support the XML schema, WSDL, and SOAP specifications:
-
The .NET platform is a designed as a programming model that enables developers to build XML web services and applications. The platform provides a set of servers that integrates, executes, and manages XML web services and applications.
-
The .NET Framework product enables developers to build and deploy web services and applications. It provides a structured environment for integrating web services and consists of a common language run-time, unified class libraries, and includes the ASP .NET server.
-
The Visual Studio .NET product provides the tools for developers to write application software according to the XML-based web service specifications.
Using the .NET architecture, development and deployment of a web service are integrated as a single step. Because every program written in a .NET language is designed to function as a web service, the .NET server is able to easily create and deploy the program as a web service.
A.2.4 The SOAP Protocol
Employing a SOAP integration provides a standardized interface for executing Oracle UCM services using the Java API (IdcCommand) and provides XML and non-XML content managed by Oracle Content Server.
Because SOAP uses the Hypertext Transfer Protocol (HTTP) for data transmission, it can be invoked across the Web and enable content to be accessible over a network in a platform-independent and language-neutral way.
SOAP is an XML-based messaging protocol consisting of these parts:
-
an envelope that defines what is in a message and how to process it
-
a set of encoding rules for defining application data types
-
a convention for representing remote procedure calls and responses
Using SOAP to access content management capabilities as a web service enables real-time programmatic interaction between applications and enables the integration of business processes and facilitates information exchange.
Web services are modular components that are contained in an XML wrapper and defined by the Web Services Description Language (WSDL) specifications. The Universal Description Discovery and Integration (UDDI) Web-based registry system is used to locate these services.
Tip:
While .NET servers support WSDL and integrate with the SOAP Toolkit, you must specify that the SOAP packet is sending a Remote Procedure Call (RPC). The default is to evaluate SOAP messages as document-style SOAP messages, rather than Remote Procedure Call (RPC) style SOAP messages. Using the SOAP Toolkit client with a .NET developed web service returns an error reading the WSDL document. To permit the SOAP Toolkit to read the generated WSDL and call your .NET web service, you must specify theSoapRpcService() attribute in your web service class.A.3 SOAP Clients
You can use SOAP to access the content and content management functions within Oracle Content Server and to deploy your content management capabilities as a web service.
Note:
If you are developing SOAP client implementations, make sure that chunking is disabled in your client API code.A.3.1 Using the Java SOAP Client
These are the command line parameters used as arguments for the Java programs.
| Parameters | Description |
|---|---|
-c <config file> |
The configuration file containing server settings (host, port, and so on). |
-x <xml file> |
The XML file containing the SOAP request to pass to Oracle Content Server. |
-p <primary file> |
The filename to upload as the primary file. |
-a <alternate file> |
The filename to upload as the alternate file (optional). |
-l <log file> |
The filename containing the request and response data (optional). |
A.4 SOAP Service Calls
This section discusses executing various Oracle Content Server IdcCommand services using the SOAP interface. Oracle Content Server IdcCommand services can be executed using the SOAP interface. The user must have appropriate permissions to execute the commands. Some commands require administrative access, other commands may require only write permission.
The WSDL Generator component is installed (enabled) by default with Oracle Content Server, and it must remain enabled to call services. See the Oracle Fusion Middleware Services Reference Guide for a list of available services and the required parameters.
This section covers these topics:
A.4.1 SOAP Packet Format
A SOAP request is an XML-based Remote Procedure Call (RPC) sent using the HTTP transport protocol. The payload of the SOAP packet is an XML document that specifies the call being made and the parameters being passed.
A.4.1.1 HTTP Headers
This entry is required in a SOAP request HTTP header:
Content-Type: text/xml; charset="utf-8"
This SOAPAction header is suggested, but not required:
SOAPAction: "http://www.oracle.com/IdcService/"
A.4.1.2 Namespaces
Within the body of a SOAP message the SOAP message XML namespaces are used to qualify element and attribute names within the parts of the document. Element names can be global (referenced throughout the SOAP message) or local. The local element names are provided by namespaces and are used in the particular part of the message where they are located. Thus, SOAP messages use namespaces to qualify element names in the separate parts of a message. Application specific namespaces are used to qualify application specific element names. Namespaces also identify the envelope version and encoding style.
Oracle Content Server defines a namespace called idc that explains the schema and allowable tags for the SOAP content.
A.4.1.3 Nodes
A SOAP node is the entity that processes a SOAP message according to the rules for accessing the services provided by the underlying protocols through the SOAP bindings. Thus, message processing involves mapping to the underlying services. The SOAP specification defines a correlation between the parts of a SOAP message and the software handlers that will process each part of the message.
The following nodes may be required for a service request or may be returned in the response:
-
Note:
On requests, Oracle Content Server services are lenient regarding where data is specified. If you specify a data field in a field node and it is supposed to be a document attribute, or vice versa, the service still processes the data correctly. The response puts the data in the correct node.
A.4.1.3.1 Service Node
This is the main node of the IDC namespace.
-
This node must exist to process a request.
-
The required attribute IdcService defines the service you are requesting.
-
It is not required that the subnodes of <service> carry the namespace in their tags. For example, <document> can be used rather than <idc:document>. However if you do define the namespace identifier in the child nodes, it must match the one specified in the service tag.
For example:
<idc:service xmlns:idc="http://www.oracle.com/IdcService/" IdcService="PING_SERVER"> </idc:service>
A.4.1.3.2 Document Node
This node contains all content item information and is the parent node of all data nodes.
Attributes that are valid for your content items are defined by your particular Oracle Content Server instance. For example, dID, dDocTitle, and dDocType are common attributes.
-
Custom content item information such as xSpec is valid if defined as metadata.
-
All known document fields can be used as attributes.
In the following document node example, the CHECKOUT_BY_NAME service is used:
<idc:service xmlns:idc="http://www.oracle.com/IdcService/" IdcService="CHECKOUT_BY_NAME"> <idc:document dDocName="soap_sample"> </idc:document> </idc:service>
A.4.1.3.3 User Node
This is the node to contain all user information:
-
Attributes that are valid for users are defined by your specific Oracle Content Server instance. For example, dName, dFullName, and dEmail are common attributes.
-
Custom user information is valid if defined as metadata.
-
All known user fields may be used as attributes.
For example:
<idc:service xmlns:idc="http://www.oracle.com/IdcService/" IdcService="GET_USER_INFO"> <idc:user dUser="sysadmin"> </idc:user> </idc:service>
A.4.1.3.4 Optionlist Node
This is the node to contain any option lists. The name attribute specifies the name of the option list. Each option subnode contains a value in the optionlist node.
For example:
<idc:optionlist name="Users_UserLocaleList"> <idc:option> English-US </idc:option> </idc:optionlist>
A.4.1.3.5 Option Subnode
This subnode is specified within the <optionlist> node. The option attribute specifies the name of the option for the option list.
For example:
<idc:optionlist name="dDocType"> <idc:option>ADACCT</idc:option> <idc:option>ADHR</idc:option> <idc:option>ADSALES</idc:option> </idc:optionlist>
A.4.1.3.6 Resultset Subnode
This subnode can be specified within a <document> or <user> node.
-
This subnode contains result set information in a request or response.
-
The name attribute specifies the name of the result set.
For example:
<idc:resultset name="REVISION_HISTORY"> <idc:row dFormat="text/plain" dInDate="4/12/02 1:27 PM" dOutDate="" dStatus="RELEASED" dProcessingState="Y" dRevLabel="1" dID="6" dDocName="stellent" dRevisionID="1"> </idc:row> </idc:resultset>
A.4.1.3.7 Row Subnode
This subnode is specified within a <resultset> subnode.
-
This subnode can appear multiple times within <resultset> and specifies each row in the result set.
-
Attributes that are valid are defined by your specific Oracle Content Server instance. These are the same fields that can appear as attributes in a document or user node.
For example:
<idc:resultset name="UserAttribInfo"> <idc:row dUserName="jsmith" AttributeInfo="role,contributor,15"> </idc:row> </idc:resultset>
A.4.1.3.8 Field Subnode
This subnode can be specified within a <document>, <user>, or <row> node. The name attribute specifies the name of the field.
It often represents data such as refreshSubjects or dSubscriptionID.
For example:
<idc:field name="dSubscriptionID"> stellent </idc:field>
-
It may represent document or user metadata that is user configurable or custom metadata such as xComments.
-
It is used to pass search result values such as QueryText and OriginalQueryText. For example:
<idc:field name="QueryText"> dDocType <Substring> "ADSALES&" </idc:field>
A.4.2 Special Characters
When passing special characters, such as a left angle bracket (<) or right angle bracket (>), to Oracle UCM, you must use the XML-encoding format.
| Standard Format | XML-Encoding |
|---|---|
| < | < |
| > | > |
| " | "
` (use back quote if using universal query syntax) |
| & | & |
| \ | ' |
Note:
Some search result values, such as the QueryText and OriginalQueryText values, are URL-encoded in the response.This example passes a string submitted for a Oracle Content Server content item query (using universal query syntax) as both a standard formatted string and an XML-encoded format:
-
Parameter with standard formatted string
QueryText=dDocType <Substring> "ADSALES"
-
Parameter with XML-encoded string
<idc:field name="QueryText"> dDocType <Substring> `ADSALES` </idc:field>
A.5 Using Active Server Pages
You can execute Oracle Content Server IdcCommand services from an Active Server Page by encapsulating a SOAP packet that defines the service to execute and the required parameters. You must have appropriate permissions to execute the commands. Some commands require administrative access, other commands may require only write permission.
This section covers these topics:
-
Section A.5.2, "Sample Active Server Page"
For information about formatting XML-encoded strings, see Section A.4.2, "Special Characters."
A.5.1 Sample SOAP Request
This section provides an example Active Server Page that calls a service from Oracle Content Server. A description of the service is provided including the required and optional parameters. This section also provides an XML-formatted version of the embedded SOAP request.
For more information about service calls, including required and optional parameters, see Section A.8, "Sample Service Calls with SOAP Response/Request."
In the following example, an XML-formatted SOAP request uses the GET_SEARCH_RESULTS service to retrieve the search results for the passed query text.
<?xml version='1.0' ?> <SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"> <SOAP-ENV:Body> <idc:service xmlns:idc="http://www.oracle.com/IdcService/" IdcService="GET_SEARCH_RESULTS"> <idc:document> <idc:field name="QueryText"> dDocType <Substring> "ADSALES" </idc:field> </idc:document> </idc:service> </SOAP-ENV:Body> </SOAP-ENV:Envelope>
A.5.2 Sample Active Server Page
The embedded SOAP request forms the basis of the Active Server Page. The following sample executes the GET_SEARCH_RESULTS.
For more information about service calls and examples of SOAP response/request messages, see Section A.8, "Sample Service Calls with SOAP Response/Request."
<%
' Sample ASP page of sending a DOC_INFO Soap request.
Option Explicit
Response.Write("Search Results")
%>
<br><br>
<%
' Construct the Soap request.
Dim strSoapRequest, strQueryText
strQueryText = Request.Form("QueryText")
strQueryText = Server.HtmlEncode(strQueryText)
strSoapRequest = "<?xml version='1.0' ?>" _
& "<SOAP-ENV:Envelope xmlns:SOAP-ENV=""http://schemas.xmlsoap.org/soap/envelope/"">" _
& "<SOAP-ENV:Body>" _
& "<idc:service xmlns:idc=""http://www.oracle.com/IdcService/"/" IdcService=""GET_SEARCH_RESULTS"">" _
& "<idc:document>" _
& "<idc:field name=""QueryText"">" & strQueryText & "</idc:field>" _
& "<idc:field name=""SortField"">" & Request.Form("SortField") & "</idc:field>" _
& "<idc:field name=""SortOrder"">" & Request.Form("SortOrder") & "</idc:field>" _
& "<idc:field name=""ResultCount"">" & Request.Form("ResultCount") & "</idc:field>" _
& "<idc:field name=""Auth"">Internet</idc:field>" _
& "</idc:document>" _
& "</idc:service>" _
& "</SOAP-ENV:Body>" _
& "</SOAP-ENV:Envelope>"
' Send the Soap request.
Dim objXmlHttp
Set objXmlHttp = Server.CreateObject("MSXML2.ServerXMLHTTP")
objXmlHttp.open "POST", "http://localhost/stellent/idcplg", False, "sysadmin", "idc"
objXmlHttp.setRequestHeader "Content-Type", "text/xml; charset=utf-8"
objXmlHttp.send(strSoapRequest)
' Parse the Soap response.
Dim objXmlDoc
Set objXmlDoc = Server.CreateObject("Msxml2.DOMDocument")
objXmlDoc.async = False
objXmlDoc.Load objXmlHttp.responseXml
' Check for errors.
Dim strResponseError
strResponseError = objXmlDoc.parseError.reason
If strResponseError <> "" Then
Response.Write(objXmlHttp.ResponseText)
DisplayBackButton()
Response.End
End If
' Check for a fault string.
Dim objXmlFaultNode
Set objXmlFaultNode = objXmlDoc.documentElement.selectSingleNode("//SOAP-ENV:Fault/faultstring")
If (Not (objXmlFaultNode Is Nothing)) Then
Response.Write(objXmlFaultNode.Text)
DisplayBackButton()
Response.End
End If
' Check the status code.
Dim objXmlStatusCodeNode, objXmlStatusMessageNode, strStatusCode, nStatusCode, strStatusMessage
Set objXmlStatusCodeNode = objXmlDoc.documentElement.selectSingleNode("//idc:field[@name='StatusCode']")
If (Not objXmlStatusCodeNode Is Nothing) Then
nStatusCode = CInt(objXmlStatusCodeNode.Text)
If (nStatusCode < 0) Then
Response.Write(objXmlDoc.documentElement.selectSingleNode("//idc:field[@name='StatusMessage']").Text)
DisplayBackButton()
Response.End
End If
End If
' Display search results
Dim strDocName, strDocTitle, strDocType, strInDate, strComments, nCurRow, nTotalRows
Dim objXmlResultNodeList, objXmlCommentNode
Set objXmlResultNodeList = objXmlDoc.documentElement.selectNodes("//idc:resultset[@name='SearchResults']/idc:row")
nTotalRows = objXmlResultNodeList.Length
%>
<table>
<tr>
<td><b>Content ID</b></td>
<td> </td>
<td><b>Title</b></td>
<td> </td>
<td><b>Type</b></td>
<td> </td>
<td><b>Release Date</b></td>
<td> </td>
<td><b>Comments</b></td>
</tr>
<%
For nCurRow = 0 To (nTotalRows - 1)
strDocName = GetXmlNodeValue(objXmlResultNodeList.Item(nCurRow), "dDocName")
strDocTitle = GetXmlNodeValue(objXmlResultNodeList.Item(nCurRow), "dDocTitle")
strDocType = GetXmlNodeValue(objXmlResultNodeList.Item(nCurRow), "dDocType")
strInDate = GetXmlNodeValue(objXmlResultNodeList.Item(nCurRow), "dInDate")
strComments = GetXmlNodeValue(objXmlResultNodeList.Item(nCurRow), "xComments")
%>
<tr>
<td><%=strDocName%></td>
<td> </td>
<td><%=strDocTitle%></td>
<td> </td>
<td><%=strDocType%></td>
<td> </td>
<td><%=strInDate%></td>
<td> </td>
<td><%=strComments%></td>
</tr>
<%
Next
%>
</table>
<%
DisplayBackButton()
'----------------------------
Function GetXmlNodeValue(objXmlRowNode, strNodeName)
'----------------------------
Dim objXmlNode, objXmlNodeValue
Set objXmlNode = objXmlRowNode.selectSingleNode("@" & strNodeName)
If (objXmlNode Is Nothing) Then
Set objXmlNode = objXmlRowNode.selectSingleNode("idc:field[@name='" & strNodeName & "']")
End If
If (Not (objXmlNode Is Nothing)) Then
GetXmlNodeValue = objXmlNode.Text
End If
'----------------------------
End Function
'----------------------------
'----------------------------
Sub DisplayBackButton()
'----------------------------
%>
<form method=POST action="request.asp">
<table>
<tr>
<td><input type=submit value="Back"></td>
</tr>
</table>
</form>
<%
'----------------------------
End Sub
'---------------------------
%>
A.6 Using WSDL Files
This section provides an overview of the Oracle Content Server WSDL files. In addition, information about generating WSDL files for interfacing with Oracle UCM services is provided.
This section covers these topics:
A.6.1 Understanding WSDL Files
WSDL files provide the ability to pass data that can be understood by Oracle Content Server services, which enables access to the content and content management functions within Oracle UCM. The WSDL files provided with the component are stored in the IntradocDir/weblayout/groups/secure/wsdl/custom directory.
These WSDL files are provided with the WSDL Generator component:
Additional WSDL files can be generated using the Soap Custom WSDL administrative pages. See Section A.6.2, "Sample WSDL File," for additional information.
A.6.1.1 WSDL File Structure
WSDL files are formally structured with elements that contain a description of the data to be passed to the web service. This structure enables both the sending application and the receiving application to interpret the data being exchanged.
WSDL elements contain a description of the operation to perform on the data and a binding to a protocol or transport. This permits the receiving application to both process the data and interpret how to respond or return data. Additional subelements may be contained within each WSDL element.
The WSDL file structure includes these major elements:
-
Data Types: Generally in the form of XML schema to be used in the messages.
-
Message: The definition of the data in the form of a message either as a complete document or as arguments to be mapped to a method invocation.
-
Port Type: A set of operations mapped to an address. This defines a collection of operations for a binding.
-
Binding: The actual protocol and data formats for the operations and messages defined for a particular port type.
-
Service and Port: The service maps the binding to the port and the port is the combination of a binding and the network address for the communication exchange.
Note:
The code fragments in this section are from the DocInfo.wsdl file provided with the WSDL Generator component. For a complete WSDL file, see Section A.6.2, "Sample WSDL File."
A.6.1.1.1 Data Type
The Data Type <types> defines the complex types and associated elements. Web services supports both simple data types (such as string, integer, or boolean) and complex data types. A complex type is a structured XML document that contains several simple types or an array of subelements.
The following code fragment for the ContentInfo set defines the Name, Title, Author, and Group elements and specifies that they are strings.
<s:complexType name="ContentInfo"> <s:sequence> <s:element minOccurs="0" maxOccurs="1" name="dDocName" type="s:string"/> <s:element minOccurs="0" maxOccurs="1" name="dDocTitle" type="s:string"/> <s:element minOccurs="0" maxOccurs="1" name="dDocType" type="s:string"/> <s:element minOccurs="0" maxOccurs="1" name="dDocAuthor" type="s:string"/> <s:element minOccurs="0" maxOccurs="1" name="dSecurityGroup" type="s:string"/> </s:sequence> </s:complexType>
A.6.1.1.2 Message
The Message <message> defines the data as arguments to be mapped to a method invocation.
<message name="DocInfoByIDSoapIn"> <part name="parameters" element="s0:DocInfoByID" /> </message> <message name="DocInfoByIDSoapOut"> <part name="parameters" element="s0:DocInfobyIDResponse" /> </message>
A.6.1.1.3 Port Type
The Port Type <portType> defines a collection of operations for a binding. The DocInfo.wsdl file provides the DocInfoSoap and the DocInfo operation name (method name) with I/O information for processing the message.
<portType name="DocInfoSoap"> <operation name="DocInfoByID"> <input message="s0:DocInfoByIDSoapIn" /> <output message="s0:DocInfoByIDSoapOut" /> </operation> </portType>
Note:
While a port type is a collection of operations (like classes in Java), WSDL is an independent data abstraction that provides more functionality than simply mapping to .NET, EJB, or CORBA objects.A.6.1.1.4 Binding
The binding <binding> defines the actual protocol and data formats for the operations and messages for the particular port type.
<binding name="DocInfoSoap" type="s0:DocInfoSoap"> <soap:binding transport="http://schemas.xmlsoap.org/soap/http" style="document" /> <operation name="DocInfoByID"> <soap:operation soapAction="http://wwww.oracle.com/Soap/DocInfo/" style="document" /> <input> <soap:body use="literal" /> </input> <output> <soap:body use="literal" /> </output> </operation> </binding>
A.6.1.1.5 Service and Port
The service <service> maps the binding to the port. The port is the combination of a binding and the network address for the communication exchange. The port is used to expose a set of port types (operations) on the defined transport.
<service name="DocInfo"> <port name="DocInfoSoap" binding="s0:DocInfoSoap"> <soap:address location="http://myhost.example.com:16200/_dav/cs/idcplg" /> </port> </service>
Tip:
You can add&IsSoap=1 to the URL of an Oracle Content Server browser window to view the underlying SOAP code for that page.A.6.2 Sample WSDL File
This sample code presents the complete DocInfo.wsdl file. This file and the CheckIn.wsdl, GetFile.wsdl, and Search.wsdl files are found in the IntradocDir/weblayout/groups/secure/wsdl/custom directory for the Oracle Content Server instance.
<?xml version='1.0' encoding='utf-8' ?> <definitions xmlns:http="http://schemas.xmlsoap.org/wsdl/http/" xmlns:soap="http://schemas.xmlsoap.org/wsdl/soap/" xmlns:s="http://www.w3.org/2001/XMLSchema" xmlns:s0="http://wwww.oracle.com/DocInfo/" targetNamespace="http://wwww.oracle.com/DocInfo/" xmlns="http://schemas.xmlsoap.org/wsdl/"> <types> <s:schema elementFormDefault="qualified" targetNamespace="http://www.oracle.com/DocInfo/"> <s:element name="DocInfoByID"> <s:complexType> <s:sequence> <s:element minOccurs="0" maxOccurs="1" name="dID" type="s:int" /> <s:element minOccurs="0" maxOccurs="1" name="extraProps" type="s0:IdcPropertyList" /> </s:sequence> </s:complexType> </s:element> <s:element name="DocInfoByIDResponse"> <s:complexType> <s:sequence> <s:element minOccurs="0" maxOccurs="1" name="DocInfoByIDResult" type="s0:DocInfoByIDResult" /> </s:sequence> </s:complexType> </s:element> <s:complexType name="DocInfoByIDResult"> <s:sequence> <s:element minOccurs="0" maxOccurs="unbounded" name="ContentInfo" type="s0:ContentInfo" /> <s:element minOccurs="0" maxOccurs="unbounded" name="Revisions" type="s0:Revisions" /> <s:element minOccurs="0" maxOccurs="unbounded" name="WorkflowInfo" type="s0:WorkflowInfo" /> <s:element minOccurs="0" maxOccurs="1" name="StatusInfo" type="s0:StatusInfo" /> </s:sequence> </s:complexType> <s:element name="DocInfoByName"> <s:complexType> <s:sequence> <s:element minOccurs="0" maxOccurs="1" name="dDocName" type="s:string" /> <s:element minOccurs="0" maxOccurs="1" name="extraProps" type="s0:IdcPropertyList" /> </s:sequence> </s:complexType> </s:element> <s:element name="DocInfoByNameResponse"> <s:complexType> <s:sequence> <s:element minOccurs="0" maxOccurs="1" name="DocInfoByNameResult" type="s0:DocInfoByNameResult" /> </s:sequence> </s:complexType> </s:element> <s:complexType name="DocInfoByNameResult"> <s:sequence> <s:element minOccurs="0" maxOccurs="unbounded" name="ContentInfo" type="s0:ContentInfo" /> <s:element minOccurs="0" maxOccurs="unbounded" name="Revisions" type="s0:Revisions" /> <s:element minOccurs="0" maxOccurs="unbounded" name="WorkflowInfo" type="s0:WorkflowInfo" /> <s:element minOccurs="0" maxOccurs="1" name="StatusInfo" type="s0:StatusInfo" /> </s:sequence> </s:complexType> <s:complexType name="ContentInfo"> <s:sequence> <s:element minOccurs="0" maxOccurs="1" name="dDocName" type="s:string" /> <s:element minOccurs="0" maxOccurs="1" name="dDocTitle" type="s:string" /> <s:element minOccurs="0" maxOccurs="1" name="dDocType" type="s:string" /> <s:element minOccurs="0" maxOccurs="1" name="dDocAuthor" type="s:string" /> <s:element minOccurs="0" maxOccurs="1" name="dSecurityGroup" type="s:string" /> <s:element minOccurs="0" maxOccurs="1" name="dDocAccount" type="s:string" /> <s:element minOccurs="0" maxOccurs="1" name="dID" type="s:int" /> <s:element minOccurs="0" maxOccurs="1" name="dRevClassID" type="s:int" /> <s:element minOccurs="0" maxOccurs="1" name="dRevisionID" type="s:int" /> <s:element minOccurs="0" maxOccurs="1" name="dRevLabel" type="s:string" /> <s:element minOccurs="0" maxOccurs="1" name="dIsCheckedOut" type="s:boolean" /> <s:element minOccurs="0" maxOccurs="1" name="dCheckoutUser" type="s:string" /> <s:element minOccurs="0" maxOccurs="1" name="dCreateDate" type="s:string" /> <s:element minOccurs="0" maxOccurs="1" name="dInDate" type="s:string" /> <s:element minOccurs="0" maxOccurs="1" name="dOutDate" type="s:string" /> <s:element minOccurs="0" maxOccurs="1" name="dStatus" type="s:string" /> <s:element minOccurs="0" maxOccurs="1" name="dReleaseState" type="s:string" /> <s:element minOccurs="0" maxOccurs="1" name="dFlag1" type="s:string" /> <s:element minOccurs="0" maxOccurs="1" name="dWebExtension" type="s:string" /> <s:element minOccurs="0" maxOccurs="1" name="dProcessingState" type="s:string" /> <s:element minOccurs="0" maxOccurs="1" name="dMessage" type="s:string" /> <s:element minOccurs="0" maxOccurs="1" name="dReleaseDate" type="s:string" /> <s:element minOccurs="0" maxOccurs="1" name="dRendition1" type="s:string" /> <s:element minOccurs="0" maxOccurs="1" name="dRendition2" type="s:string" /> <s:element minOccurs="0" maxOccurs="1" name="dIndexerState" type="s:string" /> <s:element minOccurs="0" maxOccurs="1" name="dPublishType" type="s:string" /> <s:element minOccurs="0" maxOccurs="1" name="dPublishState" type="s:string" /> <s:element minOccurs="0" maxOccurs="1" name="dDocID" type="s:int" /> <s:element minOccurs="0" maxOccurs="1" name="dIsPrimary" type="s:boolean" /> <s:element minOccurs="0" maxOccurs="1" name="dIsWebFormat" type="s:boolean" /> <s:element minOccurs="0" maxOccurs="1" name="dLocation" type="s:string" /> <s:element minOccurs="0" maxOccurs="1" name="dOriginalName" type="s:string" /> <s:element minOccurs="0" maxOccurs="1" name="dFormat" type="s:string" /> <s:element minOccurs="0" maxOccurs="1" name="dExtension" type="s:string" /> <s:element minOccurs="0" maxOccurs="1" name="dFileSize" type="s:int" /> <s:element minOccurs="0" maxOccurs="1" name="CustomDocMetaData" type="s0:IdcPropertyList" /> </s:sequence> </s:complexType> <s:complexType name="Revisions"> <s:sequence> <s:element minOccurs="0" maxOccurs="1" name="dFormat" type="s:string" /> <s:element minOccurs="0" maxOccurs="1" name="dInDate" type="s:string" /> <s:element minOccurs="0" maxOccurs="1" name="dOutDate" type="s:string" /> <s:element minOccurs="0" maxOccurs="1" name="dStatus" type="s:string" /> <s:element minOccurs="0" maxOccurs="1" name="dProcessingState" type="s:string" /> <s:element minOccurs="0" maxOccurs="1" name="dRevLabel" type="s:string" /> <s:element minOccurs="0" maxOccurs="1" name="dID" type="s:int" /> <s:element minOccurs="0" maxOccurs="1" name="dDocName" type="s:string" /> <s:element minOccurs="0" maxOccurs="1" name="dRevisionID" type="s:int" /> </s:sequence> </s:complexType> <s:complexType name="WorkflowInfo"> <s:sequence> <s:element minOccurs="0" maxOccurs="1" name="dWfID" type="s:int" /> <s:element minOccurs="0" maxOccurs="1" name="dDocName" type="s:string" /> <s:element minOccurs="0" maxOccurs="1" name="dWfDocState" type="s:string" /> <s:element minOccurs="0" maxOccurs="1" name="dWfComputed" type="s:string" /> <s:element minOccurs="0" maxOccurs="1" name="dWfCurrentStepID" type="s:int" /> <s:element minOccurs="0" maxOccurs="1" name="dWfDirectory" type="s:string" /> <s:element minOccurs="0" maxOccurs="1" name="dClbraName" type="s:string" /> <s:element minOccurs="0" maxOccurs="1" name="dWfName" type="s:string" /> <s:element minOccurs="0" maxOccurs="1" name="dWfDescription" type="s:string" /> <s:element minOccurs="0" maxOccurs="1" name="dCompletionDate" type="s:string" /> <s:element minOccurs="0" maxOccurs="1" name="dSecurityGroup" type="s:string" /> <s:element minOccurs="0" maxOccurs="1" name="dWfStatus" type="s:string" /> <s:element minOccurs="0" maxOccurs="1" name="dWfType" type="s:string" /> <s:element minOccurs="0" maxOccurs="1" name="dProjectID" type="s:string" /> <s:element minOccurs="0" maxOccurs="1" name="dIsCollaboration" type="s:boolean" /> </s:sequence> </s:complexType> <s:complexType name="StatusInfo"> <s:sequence> <s:element minOccurs="0" maxOccurs="1" name="statusCode" type="s:int" /> <s:element minOccurs="0" maxOccurs="1" name="statusMessage" type="s:string" /> </s:sequence> </s:complexType> <s:complexType name="IdcPropertyList"> <s:sequence> <s:element minOccurs="0" maxOccurs="unbounded" name="property" type="s0:IdcProperty" /> </s:sequence> </s:complexType> <s:complexType name="IdcProperty"> <s:sequence> <s:element minOccurs="0" maxOccurs="1" name="name" type="s:string" /> <s:element minOccurs="0" maxOccurs="1" name="value" type="s:string" /> </s:sequence> </s:complexType> </s:schema> </types> <message name="DocInfoByIDSoapIn"> <part name="parameters" element="s0:DocInfoByID" /> </message> <message name="DocInfoByIDSoapOut"> <part name="parameters" element="s0:DocInfoByIDResponse" /> </message> <message name="DocInfoByNameSoapIn"> <part name="parameters" element="s0:DocInfoByName" /> </message> <message name="DocInfoByNameSoapOut"> <part name="parameters" element="s0:DocInfoByNameResponse" /> </message> <portType name="DocInfoSoap"> <operation name="DocInfoByID"> <input message="s0:DocInfoByIDSoapIn" /> <output message="s0:DocInfoByIDSoapOut" /> </operation> <operation name="DocInfoByName"> <input message="s0:DocInfoByNameSoapIn" /> <output message="s0:DocInfoByNameSoapOut" /> </operation> </portType> <binding name="DocInfoSoap" type="s0:DocInfoSoap"> <soap:binding transport="http://schemas.xmlsoap.org/soap/http" style="document" /> <operation name="DocInfoByID"> <soap:operation soapAction="http://www.oracle.com/DocInfo/" style="document" /> <input> <soap:body use="literal" /> </input> <output> <soap:body use="literal" /> </output> </operation> <operation name="DocInfoByName"> <soap:operation soapAction="http://www.oracle.com/DocInfo/" style="document" /> <input> <soap:body use="literal" /> </input> <output> <soap:body use="literal" /> </output> </operation> </binding> <service name="DocInfo"> <port name="DocInfoSoap" binding="s0:DocInfoSoap"> <soap:address location="http://myhost.example.com:16200/_dav/cs/idcplg/idc_cgi_isapi.dll" /> </port> </service> </definitions>
A.6.3 Generating WSDL Files
When the WSDL Generator component is installed and enabled during Oracle Content Server installation, several folders and related HDA files are generated that expose several Services as web services. Two directories are created in the IntradocDir/data/soap directory. The /generic directory contains a generic.hda file and the /custom directory contains a wsdl_custom.hda file. Administrators can customize or add WSDL files using the Soap Wsdl administration pages. These pages are accessed by clicking the Soap WSDL link from the Administration section of the Admin Applet page.
Note:
The WSDL Generator component must be enabled to generate WSDL files.For step-by-step instructions on creating and editing a custom WSDL using the Soap Custom Wsdl administration pages, see Section A.7, "Creating a Custom WSDL Using Administration Pages."
A.6.4 Generating Proxy Class from WSDL Files
Using the WSDL files, developers may choose to create proxy classes to plug into a development tool. A number of software products and tool kits are available for converting WSDL files to programming class files in languages such as Java, Visual Basic, and C#. For example, Apache AXIS provides a SOAP to Java toolkit, and Microsoft .NET Development Environment provides functionality to convert WSDL files to C#.
If you are using Microsoft .NET, you can use utilitywsdl.exe to generate the proxy classes:
wsdl /l:CS DocInfo.wsdl
This utility generates the file DocInfoService.cs (C# class) which contains the class DocInfoService and the function DocInfo with the parameters specified. The return value is the DocInfoSet class, which is all the response parameters specified, along with ErrorCode and ErrorMessage values. If the ErrorCode is less than zero, an error has occurred in the service call, and you can see the specifics of it in the value ErrorMessage.
Note:
In addition to the WSDL files provided with the WSDL Generator component, you can generate WSDL files for any Oracle UCM service. For more information, see Section A.6.3, "Generating WSDL Files."A.7 Creating a Custom WSDL Using Administration Pages
The Soap Custom Wsdl administration pages provide an administrator with the ability to edit and customize WSDL files. This chapter provides an administrative tutorial that gives step-by-step instructions on creating and editing a custom WSDL.
The WSDL Generator component must be enabled to generate WSDL files. In addition to the WSDL files provided with the WSDL Generator component, you can generate additional WSDL files for any Oracle UCM service. See Section A.6.3, "Generating WSDL Files," for additional information.
See the Oracle Fusion Middleware Services Reference Guide for a list of available services and the required parameters.
This section provides step-by-step instructions on creating and editing a custom WSDL using the Soap Custom WSDL administration pages.
-
In a web browser, log in to Oracle Content Server as an administrator.
-
In the Administration tray, choose Soap Wsdls.
The Wsdl List page is displayed.
-
Click Data Lists from the Action menu.
The Data Lists page is displayed.
Data Lists are global lists of data that can be used with complex types, service parameters, or other DataLists. When a DataList is specified as a parameter or a subtype of a complex type, all the subtypes of the DataList will appear as data types. DataLists are defined once but can be referenced multiple times with different WSDLs and services. All the DataLists have a prefix of "d:" in the data type list.
Note:
System-specific WSDLs cannot be deleted. You can, however, edit the WSDL and enable or disable the complex type elements for that WSDL. -
Select Add Data List from the Actions menu.
The Add Data List page is displayed.
-
Enter the following information:
Name: UserMetaFields
Description: User Metadata Fields
-
Click Add.
The Data List Information / Data List Elements page is displayed.
-
Enter the following Data Elements information, selecting the Type from the menu.
Name Type Idc Name dName field:string dFullName field:string dPassword field:string dEmail field:string dUserAuthType field:string -
Click Update.
You are returned to the updated Data Lists page. Note that
UserMetaFieldsnow appears at the bottom of the list. -
Select Wsdls List from the Actions menu.
The Wsdl List page is displayed.
-
Select Add Wsdl from the Actions menu.
The Add Wsdl page is displayed.
-
Enter the following information:
Name: UserInfo
Description: User Services
-
Click Add.
The Wsdl Information page is displayed.
-
Select Add Complex Type from the Actions menu.
The Add Complex Type page is displayed.
Note:
Complex types contain other data types as subtypes. After these are created, any service in the WSDL can use these complex types as parameters. -
Enter the following Complex Type information:
Name: UserAttribInfo
Type: select resultset from the menu
-
Click Add.
The Wsdl Information page is displayed.
-
Select Edit from the UserAttribInfo line.
The Complex Type Information/Complex Type Elements page is displayed.
-
Enter the following Complex Type Elements, selecting the Type from the menu.
Name Type Idc Name dUserName field:string AttributeInfo field:string -
Click Update in the Complex Type Elements section.
You are returned to the updated Wsdl Information page. Note that
User AttribInfonow appears as a complex type. -
Select Add Service from the Actions menu.
The Add Service page is displayed.
-
Enter the following information:
Name: AddUser
IdcService: ADD_USER
-
Click Add.
The Wsdl Information page is displayed.
-
Select Edit from the AddUser Service line.
The Service Information page is displayed.
Note:
When you create a WSDL, you create services that correspond to the IdcServices feature of Oracle Content Server. You also specify the request and response parameters that you want the service to pass and receive from the Web Service call. -
Select Update Request Parameters from the Actions menu.
The Request Parameters page is displayed.
-
Enter the following information, selecting the Type from the menu.
Name Type Idc Name DataList d:UserMetaFields CustomUserData propertylist:CustomUserMeta -
Click Update.
You are returned to the updated Service Information page. Note that
DataListandCustomUserDatanow appear in the Request Parameters section. -
Click Update.
You are returned to the updated Wsdl Information page, showing the service that you just added.
-
Click Update again.
You are returned to the updated Wsdl List page. UserInfo appears at the bottom of the list.
-
Select Generate Wsdls from the Actions menu.
A confirmation message displays after the Wsdls are generated successfully.
-
Click Back.
You are returned to the Wsdl List page.
-
Click the UserInfo link in the Name column.
The source code for the generated Wsdl file is displayed (a portion is shown in Example A-1).
Example A-1 Partial source code, Wsdl file
<?xml version="1.0" encoding="utf-8" ?> - <definitions xmins:http="http://schemas.xmlsoap.org/wsdl/http/" xmlns:soap="http://schemas.smlsoap.org/wsdl/soap/" xmlns:s="http://www.w3.org/2001/XMLSchema" xmlns:s0="http://www.stellent.com/UserInfo/" targetNamespace="http://www.stellent.com/UserInfo/" xmlns="http://schemas.xmlsoap.org/wsdl/"> - <types> - <s:schema elementFormDefault="qualified" targetNamespace="http://www.stellent.com/UserInfo/"> - <s:element name="AddUser"> - <s:complexType> - <s:sequence> <s:element minOccurs="0" maxOccurs="1" name="dName" type="s:string" /> <s:element minOccurs="0" maxOccurs="1" name="dFullName" type="s:string" /> <s:element minOccurs="0" maxOccurs="1" name="dPassword" type="s:string" /> <s:element minOccurs="0" maxOccurs="1" name="dEmail" type="s:string" /> <s:element minOccurs="0" maxOccurs="1" name="dUserAuthType" type="s:string: /> <s:element minOccurs="0" maxOccurs="1" name="CustomUserData" type="s0:IdcPropertyList" /> <s:element minOccurs="0" maxOccurs="1" name="extraProps" type="s0:IdcPropertyList" /> </s:sequence> </s:complexType> </s:element> -
Click the browser Back button.
You are returned to the Soap Custom Wsdl page.
Tip:
You can right click View and save the Wsdl file to your desktop (for use with .NET, and so on). However, be sure to save the file with a .wsdl file extension rather than the default .XML file extension.
A.8 Sample Service Calls with SOAP Response/Request
This section provides sample service calls with SOAP response/request and presents information about executing Oracle Content Server services in a SOAP request. See the Oracle Fusion Middleware Services Reference Guide for a list of available services and the required parameters.
These IdcCommand services are used as SOAP request examples.
| IdcCommand | Description |
|---|---|
PING_SERVER |
This service evaluates whether a connection to the server exists. See Section A.8.1, "Ping the Server,". |
ADD_USER |
This service adds a new user to the system. See "Add a New User". |
EDIT_USER |
This service edits an existing user. See "Edit Existing User". |
GET_USER_INFO |
This service retrieves the user list. See "Get User Information". |
DELETE_USER |
This service deletes an existing user. See "Delete User". |
CHECKIN_UNIVERSAL |
This service performs an Oracle Content Server controlled check in. See "Check in Content Item". |
CHECKOUT_BY_NAME |
This service marks the latest revision of the specified content item as locked. See "Check out Content Item". |
UNDO_CHECKOUT_BY_NAME |
This service reverses a content item checkout using the Content ID. See "Undo Content Item Checkout". |
DOC_INFO |
This service retrieves content item revision information. See "Get Content Item Information". |
GET_FILE |
This service retrieves a copy of a content item without performing a check out. See "Get File". |
GET_SEARCH_RESULTS |
This service retrieves the search results for the passed query text. See "Get Search Results". |
GET_TABLE |
This service exports the specified table in Oracle Content Server database. See "Get Table Data". |
GET_CRITERIA_WORKFLOWS_FOR_GROUP |
This service returns criteria workflow information. See "Get Criteria Workflow Information". |
A.8.1 Ping the Server
The PING_SERVER service evaluates whether a connection to the server exists.
-
This service returns status information for Oracle Content Server.
-
If this service is unable to execute, this message is displayed to the user:
Unable to establish connection to the server.Tip:
Execute aPING_SERVERrequest before calling other services to ensure that there is a connection to the Oracle Content Server instance and that you are logged in as a user authorized to execute commands.
A.8.1.1 Required Parameters
These parameters must be specified.
| Parameter | Description |
|---|---|
| IdcService | Must be set to PING_SERVER. |
A.8.1.2 SOAP Request
<?xml version='1.0' ?> <SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"> <SOAP-ENV:Body> <idc:service xmlns:idc="http://www.oracle.com/IdcService/" IdcService="PING_SERVER"> </idc:service> </SOAP-ENV:Body> </SOAP-ENV:Envelope
A.8.1.3 Response
<?xml version='1.0' ?> <SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"> <SOAP-ENV:Body> <idc:service xmlns:idc="http://www.oracle.com/IdcService/" IdcService="PING_SERVER"> <idc:document> <idc:field name="changedSubjects"> </idc:field> <idc:field name="refreshSubjects"> </idc:field> <idc:field name="loadedUserAttributes"> 1 </idc:field> <idc:field name="StatusMessage"> You are logged in as 'sysadmin'. </idc:field> <idc:field name="changedMonikers"> </idc:field> <idc:field name="refreshSubMonikers"> </idc:field> <idc:field name="refreshMonikers"> </idc:field> </idc:document> <idc:user dUser="sysadmin"> </idc:user> </idc:service> </SOAP-ENV:Body> </SOAP-ENV:Envelope>
A.8.2 Add a New User
The ADD_USER service adds a new user to the system.
-
Given a user name, the service determines if the user is in the system. If the user does not exist, the service will add the user.
-
The most likely error is when the user name is not unique. If this service is unable to execute, an error message is displayed to the user.
A.8.2.1 Required Parameters
These parameters must be specified.
| Parameter | Description |
|---|---|
| dName | The unique name. |
| dUserAuthType | The user authorization type. This value must be set to either LOCAL or GLOBAL. |
| IdcService | Must be set to ADD_USER. |
A.8.2.2 Optional Parameters
These optional parameters may be specified.
| Parameter | Description |
|---|---|
| dEmail | The email address for the user. |
| dFullName | The full name of the user. |
| dPassword | The password for the user. |
A.8.2.3 Optional Attribute Information
This optional data defines the user's attribute information, the roles the user belongs to, and the accounts the user has access to. Attribute information consists of a list of three comma-delimited strings. The first string indicates the type of attribute, the second the name of the attribute, and the third is the access number.
Important:
The user attribute information is not pre-defined. The user by default will belong to no roles or accounts, and will become a guest in the system.| Attribute Information | Description |
|---|---|
| Access Number | The access number determines the level of access or privileges assigned to the user |
| Attribute Name | The attribute name is the name of the role or account to be assigned. For example, admin, contributor, or editor may be assigned. |
| Attribute Type | The attribute types consists of role or account. |
These access numbers can be assigned to the user.
| Access Level Flags | Description |
|---|---|
| 1 | Read only. |
| 3 | Read and write. |
| 7 | Read, write, and delete. |
| 15 | Administrative privileges. |
A user can belong to multiple roles and accounts, there may be multiple role and account information strings separated by commas in the attribute information column.
-
If the user is to have the admin role, define the user attribute information as follows:
<idc:resultset name="UserAttribInfo"> <idc:row dUserName="jsmith" AttributeInfo="role,contributor,15">
-
If the user is to belong to both the contributor and editor roles and has read privilege on the account books, define the user attribute information as follows:
<idc:resultset name="UserAttribInfo"> <idc:row dUserName="jsmith" AttributeInfo="role,contributor,15,role,editor,15,account,books,1">
When defining a role, the first string specifies that this is a role attribute, the second string is the name of the role, and the third is the default entry of 15.
When defining an account, the first string specifies that this is an account attribute, the second string is the name of the account, and the third is the access level.
-
For an attribute role, the information is in this form:
role,contributor,15
-
For an attribute account where the access level determines the users rights to the named account, the information is in this form:
account,books,1
A.8.2.4 SOAP Request
<?xml version='1.0' ?> <SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"> <SOAP-ENV:Body> <idc:service xmlns:idc="http://www.oracle.com/IdcService/" IdcService="ADD_USER"> <idc:user dName="Jennifer" dFullName="Jennifer Anton" dPassword="password" dEmail="email@email.com" dUserAuthType="local"> <idc:resultset name="UserAttribInfo"> <idc:row dUserName="Jennifer" AttributeInfo="role,contributor,3"> </idc:row> </idc:resultset> </idc:user> </idc:service> </SOAP-ENV:Body> </SOAP-ENV:Envelope>
A.8.2.5 Response
<?xml version='1.0' ?> <SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"> <SOAP-ENV:Body> <idc:service xmlns:idc="http://www.oracle.com/IdcService/" IdcService="ADD_USER"> <idc:document> <idc:field name="refreshMonikers"> </idc:field> <idc:field name="refreshSubMonikers"> </idc:field> <idc:field name="refreshSubjects"> </idc:field> <idc:field name="isAdd"> 1 </idc:field> <idc:field name="copyAll"> 1 </idc:field> <idc:field name="alwaysSave"> 1 </idc:field> <idc:field name="dAttributeName"> contributor </idc:field> <idc:field name="loadedUserAttributes"> 1 </idc:field> <idc:field name="doAdminFields"> 1 </idc:field> <idc:field name="dAttributePrivilege"> 3 </idc:field> <idc:field name="dAttributeType"> role </idc:field> <idc:field name="changedMonikers"> </idc:field> <idc:field name="changedSubjects"> userlist,1018884022874 </idc:field> </idc:document> <idc:user dUserAuthType="local" dEmail="email@email.com" dFullName="Jennifer Anton" dUser="sysadmin" dPassword="password" dName="Jennifer"> </idc:user> </idc:service> </SOAP-ENV:Body> </SOAP-ENV:Envelope>
A.8.3 Edit Existing User
The EDIT_USER service edits the information for an existing user.
-
Given a user name and user authorization type, the service determines if the user is in the system. If the user does not exist, the service fails. Otherwise the user information is updated and replaced.
-
The most likely error is the user does not have the security level to perform this action. If this service is unable to execute, an error message is displayed to the user.
Note:
The user attribute information replaces the current attributes. It does not add to the list. Consequently, if the user attribute information is not defined, the user will become a guest in the system.
A.8.3.1 Required Parameters
These parameters must be specified.
| Parameter | Description |
|---|---|
| dName | The unique name. |
| dUserAuthType | The user authorization type. This value must be set to either LOCAL or GLOBAL. |
| IdcService | Must be set to EDIT_USER. |
A.8.3.2 Optional Parameters
These optional parameters may be specified.
| Parameter | Description |
|---|---|
| dEmail | The email address of the user. |
| dFullName | The full name of the user. |
| dPassword | The password for the user. |
| dUserLocale | The locale designation such as English-US, English-UK, Deutsch, Français, Español. |
| dUserType | The defined user type. |
A.8.3.3 Optional Attribute Information
A result set containing the user's attribute information and referencing the roles the user belongs to and the accounts the user has access to. Attribute information consists of a list of three comma-delimited strings. The first string indicates the type of attribute, the second the name of the attribute, and the third is the access number.
Important:
The user attribute information is not pre-defined. The user by default will belong to no roles or accounts, and will become a guest in the system| Attribute Information | Description |
|---|---|
| Access Number | The access number determines the level of access or privileges assigned to the user |
| Attribute Name | The attribute name is the name of the role or account to be assigned. For example, admin, contributor, or editor may be assigned. |
| Attribute Type | The attribute types consist of role or account. |
These access numbers can be assigned to the user.
| Access Level Flags | Description |
|---|---|
| 1 | Read only. |
| 3 | Read and write. |
| 7 | Read, write, and delete. |
| 15 | Administrative privileges. |
A user can belong to multiple roles and accounts, there may be multiple role and account information strings separated by commas in the attribute information column.
-
If the user is to have the admin role, define the user attribute information as follows:
<idc:resultset name="UserAttribInfo"> <idc:row dUserName="jsmith" AttributeInfo="role,contribut or,15">
-
If the user is to belong to both the contributor and editor roles and has read privilege on the account books, define the user attribute information as follows:
<idc:resultset name="UserAttribInfo"> <idc:row dUserName="jsmith" AttributeInfo="role,contributor,15,role,editor,15,account,books,1">
When defining a role, the first string specifies that this is a role attribute, the second string is the name of the role, and the third is the default entry of 15.
When defining an account, the first string specifies that this is an account attribute, the second string is the name of the account, and the third is the access level.
-
For an attribute role, the information is in this form:
role,contributor,15
-
For an attribute account where the access level determines the users rights to the named account, the information is in this form:
account,books,1
A.8.3.4 SOAP Request
<?xml version='1.0' ?> <SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"> <SOAP-ENV:Body> <idc:service xmlns:idc="http://www.oracle.com/IdcService/" IdcService="EDIT_USER"> <idc:user dName="Jennifer" dFullName="Jennifer Anton" dPassword="password" dEmail="jennifer@email.com" dUserAuthType="local"> <idc:resultset name="UserAttribInfo"> <idc:row dUserName="Jennifer" AttributeInfo="role,guest,1"> </idc:row> </idc:resultset> </idc:user> </idc:service> </SOAP-ENV:Body> </SOAP-ENV:Envelope>
A.8.3.5 Response
<?xml version='1.0' ?> <SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"> <SOAP-ENV:Body> <idc:service xmlns:idc="http://www.oracle.com/IdcService/" IdcService="EDIT_USER"> <idc:document> <idc:field name="refreshMonikers"> </idc:field> <idc:field name="refreshSubMonikers"> </idc:field> <idc:field name="refreshSubjects"> </idc:field> <idc:field name="alwaysSave"> 1 </idc:field> <idc:field name="dAttributeName"> guest </idc:field> <idc:field name="loadedUserAttributes"> 1 </idc:field> <idc:field name="doAdminFields"> 1 </idc:field> <idc:field name="dAttributePrivilege"> 1 </idc:field> <idc:field name="dAttributeType"> role </idc:field> <idc:field name="changedMonikers"> </idc:field> <idc:field name="changedSubjects"> userlist,1018884022877 </idc:field> </idc:document> <idc:user dUserAuthType="local" dEmail="jennifer@email.com" dFullName="Jennifer Anton" dUser="sysadmin" dPassword="password" dName="Jennifer"> </idc:user> </idc:service> </SOAP-ENV:Body> </SOAP-ENV:Envelope>
A.8.4 Get User Information
The GET_USER_INFO service retrieves the user list.
-
Given a defined user, the service retrieves the user list.
-
If this service is unable to execute, this message is displayed to the user: Unable to retrieve user list.
A.8.4.1 Required Parameters
These parameters must be specified.
| Parameter | Description |
|---|---|
| dUser | The defined user. |
| IdcService | Must be set to GET_USER_INFO. |
A.8.4.2 SOAP Request
<?xml version='1.0' ?> <SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"> <SOAP-ENV:Body> <idc:service xmlns:idc="http://www.oracle.com/IdcService/" IdcService="GET_USER_INFO"> <idc:user dUser="sysadmin"> </idc:user> </idc:service> </SOAP-ENV:Body> </SOAP-ENV:Envelope>
A.8.4.3 Response
<?xml version='1.0' ?> <SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"> <SOAP-ENV:Body> <idc:service xmlns:idc="http://www.oracle.com/IdcService/" IdcService="GET_USER_INFO"> <idc:document> <idc:field name="changedSubjects"> </idc:field> <idc:field name="refreshSubjects"> </idc:field> <idc:field name="loadedUserAttributes"> 1 </idc:field> <idc:field name="changedMonikers"> </idc:field> <idc:field name="refreshSubMonikers"> </idc:field> <idc:field name="refreshMonikers"> </idc:field> <idc:optionlist name="Users_UserLocaleList"> <idc:option> English-US </idc:option> </idc:optionlist> </idc:document> <idc:user dUser="sysadmin" dName="sysadmin"> <idc:resultset name="UserMetaDefinition"> <idc:row umdName="dFullName" umdType="BigText" umdCaption="apTitleFullName" umdIsOptionList="0" umdOptionListType="0" umdOptionListKey="" umdIsAdminEdit="0" umdOverrideBitFlag="1"> </idc:row> <idc:row umdName="dEmail" umdType="BigText" umdCaption="apTitleEmailAddress" umdIsOptionList="0" umdOptionListType="" umdOptionListKey="" umdIsAdminEdit="0" umdOverrideBitFlag="2"> </idc:row> <idc:row umdName="dUserType" umdType="Text" umdCaption="apTitleUserType" umdIsOptionList="1" umdOptionListType="combo" umdOptionListKey="Users_UserTypeList" umdIsAdminEdit="0" umdOverrideBitFlag="4"> </idc:row> <idc:row umdName="dUserLocale" umdType="Text" umdCaption="apTitleUserLocale" umdIsOptionList="1" umdOptionListType="choice,locale" umdOptionListKey="Users_UserLocaleList" umdIsAdminEdit="0" umdOverrideBitFlag="8"> </idc:row> </idc:resultset> <idc:resultset name="USER_INFO"> <idc:row dName="sysadmin" dFullName="System Administrator" dEmail="" dPasswordEncoding="" dPassword="-----" dUserType="" dUserAuthType="LOCAL" dUserOrgPath="" dUserSourceOrgPath="" dUserSourceFlags="0" dUserArriveDate="" dUserChangeDate="" dUserLocale="" dUserTimeZone=""> </idc:row> </idc:resultset> </idc:user> </idc:service> </SOAP-ENV:Body> </SOAP-ENV:Envelope>
A.8.5 Delete User
The DELETE_USER service deletes an existing user.
-
Given a user name, the service deletes the user from the system.
-
The most likely error is when the user has been assigned to an alias.If this service is unable to execute, an error message is returned.
A.8.5.1 Required Parameters
These parameters must be specified.
| Parameter | Description |
|---|---|
| dName | The unique name. |
| IdcService | Must be set to DELETE_USER. |
A.8.5.2 SOAP Request
<?xml version='1.0' ?> <SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"> <SOAP-ENV:Body> <idc:service xmlns:idc="http://www.oracle.com/IdcService/" IdcService="DELETE_USER"> <idc:user dName="Jennifer" > </idc:user> </idc:service> </SOAP-ENV:Body> </SOAP-ENV:Envelope>
A.8.5.3 Response
<idc:service xmlns:idc="http://www.oracle.com/IdcService/" IdcService="DELETE_USER"> <idc:document> <idc:field name="changedSubjects"> userlist,1018884022876 </idc:field> <idc:field name="refreshSubjects"> </idc:field> <idc:field name="loadedUserAttributes"> 1 </idc:field> <idc:field name="changedMonikers"> </idc:field> <idc:field name="dUserName"> Jennifer </idc:field> <idc:field name="refreshSubMonikers"> </idc:field> <idc:field name="refreshMonikers"> </idc:field> </idc:document> <idc:user dUser="sysadmin" dName="Jennifer"> </idc:user> </idc:service> </SOAP-ENV:Body> </SOAP-ENV:Envelope>
A.8.6 Check in Content Item
The CHECKIN_UNIVERSAL service performs an Oracle Content Server controlled check-in.
-
This service determines if the content item is new or already exists in the system by querying the database using the content ID (dDocName) as the key.
-
If the content item exists in the system, the publish state (dPublishState) must be empty.
-
If a revision label (dRevLabel) is specified, this service will check if the content revision exists in the system; an exception is thrown if the revision exists.
-
This service will dispatch this request to one of these subservices:
-
CHECKIN_NEW_SUB- If the content item does not exist in the server. -
CHECKIN_SEL_SUB- If the content item exists on the system and no valid revision was specified and the content item is checked out. -
WORKFLOW_CHECKIN_SUB- If the content item exists and is part of a workflow.
-
-
The most likely errors are mismatched parameters or when the content item was not successfully checked in. If this service is unable to execute, this message is displayed to the user:
Content item ''{dDocName}'' was not successfully checked in.
The CHECKIN_UNIVERSAL service is an Oracle Content Server controlled check-in. The check in will fall into either a new, selected, or workflow check in process and follow the same logic as a check in through the browser or Repository Manager application. If the content item to be checked in already exists in the system, the content item must be checked out for the check in to succeed.
These are essentially the same subservices used during an Oracle Content Server controlled check-in. However, these subservices are not called during a BatchLoad or Archive import. This service will check security to determine if the user has sufficient privilege to perform a check in on the content item and if the content item (if it exists) has been checked out. Also, it will determine if the content item matches a workflow criteria or belongs to an active basic workflow.
If the content item is not found the content item is checked in using the CHECKIN_NEW_SUB subservice. This subservice validates the check in data and determines if this content item belongs to a criteria workflow. If the content item already exists in the system and the content item does not belong to a workflow, the CHECKIN_SEL_SUB is used. Otherwise the content item exists and belongs to a workflow and the WORKFLOW_CHECKIN_SUB is used.
Note:
All paths use the slash (/) as the file separator, because the backslash (\) is an escape character. For example,primaryFile=d:/temp/myfile.txt should point to the primary file to check in.A.8.6.1 Required Parameters
These parameters must be specified.
| Parameter | Description |
|---|---|
| dDocAuthor | The content item author (contributor). |
| dDocName | The content item identifier (Content ID).
|
| dDocTitle | The content item title. |
| dDocType | The content item type. |
| doFileCopy | Set this flag to TRUE (1) or the file will be removed from your hard drive. |
| dSecurityGroup | The security group such as PUBLIC or SECURE. |
| IdcService | Must be set to CHECKIN_UNIVERSAL. |
| primaryFile | The absolute path to the location of the file as seen from the server. Use the slash as the file separator.
A primary file must be specified unless checking in metadata only. If an alternate file is specified with the primary file, the content refinery will convert the alternate file. Otherwise, the primary file will be converted.
|
Important:
Custom metadata fields that are defined must also be specified.A.8.6.2 Additional Parameters
This parameter may be required.
| Parameter | Description |
|---|---|
| dDocAccount | The security account for the content item.
If you have accounts enabled, you must pass this parameter. |
A.8.6.3 Optional Parameters
These optional parameters may be specified.
| Parameter | Description |
|---|---|
| alternateFile | The alternate file for conversion.
|
| dCreateDate | The date the content item was created. By default, this is the current date. |
| dInDate | The content release date. The date the content item is to be released to the web. By default, this is the current date.
If the content release date (dInDate) is not specified, the creation date (dCreateDate) is used. This value is auto generated if it is not supplied. |
| dOutDate | The content expiration date. By default, this is blank and does not specify an expiration date.
If the content expiration date (dOutDate) is not entered, the value remains empty. This is a valid state. |
| dRevLabel | The revision label for the content item. If set, the label will be used to locate the specified revision. |
| isFinished | Set to TRUE (1) if this is a workflow check-in and you have finished editing it.
See |
Note:
Do not confuse the Content ID (dDocName) with the internal content item revision identifier (dID). The dID value is a generated reference to a specific rendition of a content itemA.8.6.4 SOAP Request
<?xml version='1.0' ?> <SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"> <SOAP-ENV:Body> <idc:service xmlns:idc="http://www.oracle.com/IdcService/" IdcService="CHECKIN_UNIVERSAL"> <idc:document dDocName="SoapUpload2" dDocAuthor="sysadmin" dDocTitle="Soap Upload 2 Document" dDocType="ADACCT" dSecurityGroup="Public" dDocAccount=""> <idc:file name="primaryFile" href="C:/stellent/custom/Soap/JavaSamples/SoapClientUpload/soaptest.doc"> </idc:file> </idc:document> </idc:service> </SOAP-ENV:Body> </SOAP-ENV:Envelope>
A.8.6.5 Response
<?xml version='1.0' ?> <SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"> <SOAP-ENV:Body> <idc:service xmlns:idc="http://www.oracle.com/IdcService/" IdcService="CHECKIN_UNIVERSAL"> <idc:document dDocAuthor="sysadmin" dDocName="SoapUpload2" dExtension="doc" dDocAccount="" dIsPrimary="1" dRevisionID="1" dPublishType="" dInDate="4/22/02 1:31PM" dReleaseState="N" dRevClassID="12" dCreateDate="4/22/02 1:31 PM" dIsWebFormat="0" dPublishState="" dLocation="" dStatus="DONE" dOriginalName="12.doc" dOutDate="" dDocID="24" dRevLabel="1" dProcessingState="Y" dDocTitle="Soap Upload 2 Document" dID="12" dDocType="ADACCT" dSecurityGroup="Public" dFileSize="19456" dFormat="application/msword"> <idc:field name="primaryFile:path"> c:/stellent/vault/~temp/1230750423.doc </idc:field> <idc:field name="dRawDocID"> 23 </idc:field> <idc:field name="changedSubjects"> documents,1019482656706 </idc:field> <idc:field name="StatusCode"> 0 </idc:field> <idc:field name="soapFile:path"> c:/stellent/vault/~temp/1230750422.xml </idc:field> <idc:field name="xComments"> </idc:field> <idc:field name="soapStartContentID"> SoapContent </idc:field> <idc:field name="refreshSubMonikers"> </idc:field> <idc:field name="changedMonikers"> </idc:field> <idc:field name="dActionDate"> 4/22/02 1:31 PM </idc:field> <idc:field name="dActionMillis"> 30263 </idc:field> <idc:field name="loadedUserAttributes"> 1 </idc:field> <idc:field name="WebfilePath"> c:/stellent/weblayout/groups/public/documents/adacct/soapupload2~1.doc </idc:field> <idc:field name="StatusMessage"> Successfully checked in content item 'SoapUpload2'. </idc:field> <idc:field name="refreshSubjects"> </idc:field> <idc:field name="dConversion"> PASSTHRU </idc:field> <idc:field name="primaryFile"> C:/stellent/custom/Soap/JavaSamples/SoapClientUpload/soaptest.doc </idc:field> <idc:field name="dAction"> Checkin </idc:field> <idc:field name="refreshMonikers"> </idc:field> <idc:field name="VaultfilePath"> c:/stellent/vault/adacct/12.doc </idc:field> </idc:document> <idc:user dUser="sysadmin"> </idc:user> </idc:service> </SOAP-ENV:Body> </SOAP-ENV:Envelope>
A.8.7 Check out Content Item
The CHECKOUT_BY_NAME checks out the latest revision of the specified content item.
-
Given a content item revision ID, this service attempts to locate the content item in the system and undo the checkout.
-
The service fails if the content item does not exist in the system, if the content item is not checked out, or the user does not have sufficient privilege to undo the checkout.
-
The most likely error is a content item name that does not exist. If this service is unable to execute, an error message is displayed to the user.
Note:
This service only marks the content item as locked. It does not perform a download.
A.8.7.1 Required Parameters
These parameters must be specified.
| Parameter | Description |
|---|---|
| dDocName | The content item identifier (Content ID). |
| IdcService | Must be set to CHECKOUT_BY_NAME. |
Note:
Do not confuse the Content ID (dDocName) with the internal content item revision identifier (dID). The dID value is a generated reference to a specific rendition of a content item.A.8.7.2 Optional Parameters
This optional parameter may be specified.
| Parameter | Description |
|---|---|
| dDocTitle | The content item title. |
A.8.7.3 SOAP Request
<?xml version='1.0' ?> <SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"> <SOAP-ENV:Body> <idc:service xmlns:idc="http://www.oracle.com/IdcService/" IdcService="CHECKOUT_BY_NAME"> <idc:document dDocName="soap_sample"> </idc:document> </idc:service> </SOAP-ENV:Body> </SOAP-ENV:Envelope>
A.8.7.4 Response
<?xml version='1.0' ?> <SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"> <SOAP-ENV:Body> <idc:service xmlns:idc="http://www.oracle.com/IdcService/" IdcService="CHECKOUT_BY_NAME"> <idc:document dDocTitle="soap_sample" dID="10" dRevLabel="1" dDocAccount="" dRevClassID="10" dDocName="soap_sample" dOriginalName="soap_sample.txt" dSecurityGroup="Public"> <idc:field name="dActionMillis"> 39964 </idc:field> <idc:field name="refreshMonikers"> </idc:field> <idc:field name="dActionDate"> 4/22/02 12:20 PM </idc:field> <idc:field name="latestID"> 10 </idc:field> <idc:field name="refreshSubMonikers"> </idc:field> <idc:field name="refreshSubjects"> </idc:field> <idc:field name="CurRevID"> 10 </idc:field> <idc:field name="CurRevIsCheckedOut"> 0 </idc:field> <idc:field name="dAction"> Check out </idc:field> <idc:field name="loadedUserAttributes"> 1 </idc:field> <idc:field name="CurRevCheckoutUser"> sysadmin </idc:field> <idc:field name="changedMonikers"> </idc:field> <idc:field name="changedSubjects"> documents,1019482656687 </idc:field> <idc:resultset name="DOC_INFO"> <idc:row dID="10" dDocName="soap_sample" dDocType="ADACCT" dDocTitle="soap_sample" dDocAuthor="sysadmin" dRevClassID="10" dRevisionID="1" dRevLabel="1" dIsCheckedOut="1" dCheckoutUser="sysadmin" dSecurityGroup="Public" dCreateDate="4/22/02 12:18 PM" dInDate="4/22/02 12:18 PM" dOutDate="" dStatus="RELEASED" dReleaseState="Y" dFlag1="" dWebExtension="txt" dProcessingState="Y" dMessage="" dDocAccount="" dReleaseDate="4/22/02 12:19 PM" dRendition1="" dRendition2="" dIndexerState="" dPublishType="" dPublishState="" dDocID="19" dIsPrimary="1" dIsWebFormat="0" dLocation="" dOriginalName="soap_sample.txt" dFormat="text/plain" dExtension="txt" dFileSize="12"> <idc:field name="xComments"> </idc:field> </idc:row> </idc:resultset> </idc:document> <idc:user dUser="sysadmin"> </idc:user> </idc:service> </SOAP-ENV:Body> </SOAP-ENV:Envelope>
A.8.8 Undo Content Item Checkout
The UNDO_CHECKOUT_BY_NAME service reverses a content item checkout using the Content ID.
-
Given a content item name, this service attempts to locate the content item in the system and undo the checkout.
-
The service fails if the content item does not exist in the system, if the content item is not checked out, or if the user does not have sufficient privilege to undo the checkout.
-
This service is used by an applet or application.
-
If this service is unable to execute, this message is displayed to the user:
Unable to undo checkout for ''{dDocName}''.
A.8.8.1 Required Parameters
These parameters must be specified.
| Parameter | Description |
|---|---|
| dDocName | The content item identifier (Content ID). |
| IdcService | Must be set to UNDO_CHECKOUT_BY_NAME. |
Note:
Do not confuse the Content ID (dDocName) with the internal content item revision identifier (dID). The dID value is a generated reference to a specific rendition of a content item.A.8.8.2 Optional Parameters
This optional parameter may be specified.
| Parameter | Description |
|---|---|
| dDocTitle | The content item title. |
A.8.8.3 SOAP Request
<?xml version='1.0' ?> <SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"> <SOAP-ENV:Body> <idc:service xmlns:idc="http://www.oracle.com/IdcService/" IdcService="UNDO_CHECKOUT_BY_NAME"> <idc:document dDocName="soap_sample"> </idc:document> </idc:service> </SOAP-ENV:Body> </SOAP-ENV:Envelope>
A.8.8.4 Response
<?xml version='1.0' ?> <SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"> <SOAP-ENV:Body> <idc:service xmlns:idc="http://www.oracle.com/IdcService/" IdcService="UNDO_CHECKOUT_BY_NAME"> <idc:document dCheckoutUser="sysadmin" dPublishState="" dDocTitle="soap_sample" dID="10" dRevLabel="1" dDocAccount="" dDocName="soap_sample" dRevClassID="10" dOriginalName="soap_sample.txt" dSecurityGroup="Public"> <idc:field name="dActionMillis"> 5317 </idc:field> <idc:field name="refreshMonikers"> </idc:field> <idc:field name="dActionDate"> 4/22/02 12:23 PM </idc:field> <idc:field name="latestID"> 10 </idc:field> <idc:field name="refreshSubMonikers"> </idc:field> <idc:field name="refreshSubjects"> </idc:field> <idc:field name="CurRevID"> 10 </idc:field> <idc:field name="CurRevIsCheckedOut"> 1 </idc:field> <idc:field name="dAction"> Undo Checkout </idc:field> <idc:field name="loadedUserAttributes"> 1 </idc:field> <idc:field name="CurRevCheckoutUser"> sysadmin </idc:field> <idc:field name="changedMonikers"> </idc:field> <idc:field name="changedSubjects"> documents,1019482656689 </idc:field> </idc:document> <idc:user dUser="sysadmin"> </idc:user> </idc:service> </SOAP-ENV:Body> </SOAP-ENV:Envelope>
A.8.9 Get Content Item Information
The DOC_INFO service retrieves content item revision information.
-
Given a content item revision ID, the service retrieves content item revision information
-
The most likely errors are when the content item no longer exists in the system or when the user does not have the security level to perform this action. If this service is unable to execute, an error message is displayed to the user.
A.8.9.1 Required Parameters
These parameters must be specified.
| Parameter | Description |
|---|---|
| dID | The generated content item revision ID. |
| IdcService | Must be set to DOC_INFO. |
A.8.9.2 SOAP Request
<?xml version='1.0' ?> <SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"> <SOAP-ENV:Body> <idc:service xmlns:idc="http://www.oracle.com/IdcService/" IdcService="DOC_INFO"> <idc:document dID="6"> </idc:document> </idc:service> </SOAP-ENV:Body> </SOAP-ENV:Envelope>
A.8.9.3 Response
<?xml version='1.0' ?> <SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"> <SOAP-ENV:Body> <idc:service xmlns:idc="http://www.oracle.com/IdcService/" IdcService="DOC_INFO"> <idc:document dStatus="RELEASED" dDocFormats="text/plain" dID="6" DocUrl="HTTP://wharristest/stellent/groups/public/documents/adacct/stellent.txt" dDocTitle="stellent"> <idc:field name="dSubscriptionAlias"> sysadmin </idc:field> <idc:field name="changedSubjects"> </idc:field> <idc:field name="dSubscriptionID"> stellent </idc:field> <idc:field name="refreshSubjects"> </idc:field> <idc:field name="loadedUserAttributes"> 1 </idc:field> <idc:field name="changedMonikers"> </idc:field> <idc:field name="refreshSubMonikers"> </idc:field> <idc:field name="refreshMonikers"> </idc:field> <idc:field name="dSubscriptionType"> Basic </idc:field> <idc:resultset name="REVISION_HISTORY"> <idc:row dFormat="text/plain" dInDate="4/12/02 1:27 PM" dOutDate="" dStatus="RELEASED" dProcessingState="Y" dRevLabel="1" dID="6" dDocName="stellent" dRevisionID="1"> </idc:row> </idc:resultset> <idc:resultset name="WF_INFO"> </idc:resultset> <idc:resultset name="DOC_INFO"> <idc:row dID="6" dDocName="stellent" dDocType="ADACCT" dDocTitle="stellent" dDocAuthor="sysadmin" dRevClassID="6" dRevisionID="1" dRevLabel="1" dIsCheckedOut="0" dCheckoutUser="" dSecurityGroup="Public" dCreateDate="4/12/02 1:27 PM" dInDate="4/12/02 1:27 PM" dOutDate="" dStatus="RELEASED" dReleaseState="Y" dFlag1="" dWebExtension="txt" dProcessingState="Y" dMessage="" dDocAccount="" dReleaseDate="4/12/02 1:27 PM" dRendition1="" dRendition2="" dIndexerState="" dPublishType="" dPublishState="" dDocID="11" dIsPrimary="1" dIsWebFormat="0" dLocation="" dOriginalName="stellent.txt" dFormat="text/plain" dExtension="txt" dFileSize="8"> <idc:field name="xComments"> stellent </idc:field> </idc:row> </idc:resultset> </idc:document> <idc:user dUser="sysadmin"> </idc:user> </idc:service> </SOAP-ENV:Body> </SOAP-ENV:Envelope>
A.8.10 Get File
The GET_FILE service returns a specific rendition of a content item, the latest revision, or the latest released revision. A copy of the file is retrieved without performing a check out.
-
This command computes the dID (content item revision ID) for the revision, and then determines the filename of a particular rendition of the revision with the computed dID. A specified dID or a dDocName (content item name) along with a RevisionSelectionMethod parameter can be used.
-
Given a dID or a dDocName along with a RevisionSelectionMethod parameter, the service determines the filename of a particular rendition of the revision and returns that file to the client.
-
The most likely errors are some form of mismatched parameters or a request for a revision or rendition that does not exist. If this service is unable to execute, an error message is displayed to the user.
Note:
Use dDocName in all requests for content items where the requester knows the dDocName value. Error messages in Oracle Content Server are based on the assumption that it is present, as are other features, such as forms.
A.8.10.1 Required Parameters
Important:
Either the content item revision ID (dID) must be specified or a content item name (dDocName) along with a RevisionSelectionMethod parameter must be defined.| Parameter | Description |
|---|---|
| dDocName | The content item identifier (Content ID).
|
| dID | The generated content item revision ID.
|
| RevisionSelection Method | The revision selection method.
If present, dDocName must be present. The value of this variable is the method used to compute a dID from the specified dDocName. Its value may be Specific, Latest, or LatestReleased.
|
| IdcService | Must be set to GET_FILE. |
A.8.10.2 Optional Parameters
These optional parameters may be specified.
| Parameter | Description |
|---|---|
| Rendition | The content item rendition. This parameter specifies the rendition of the content item and can be set to Primary, Web, or Alternate. If Rendition is not present, it defaults to Primary.
|
Note:
Do not confuse the Content ID (dDocName) with the internal content item revision identifier (dID). The dID value is a generated reference to a specific rendition of a content item.A.8.10.3 SOAP Request
<?xml version='1.0' ?> <SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"> <SOAP-ENV:Body> <idc:service xmlns:idc="http://www.oracle.com/IdcService/" IdcService="GET_FILE"> <idc:document dID="10"> </idc:document> </idc:service> </SOAP-ENV:Body> </SOAP-ENV:Envelope>
A.8.10.4 Response
<?xml version='1.0' ?> <SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"> <SOAP-ENV:Body> <idc:service xmlns:idc="http://www.oracle.com/IdcService/" IdcService="GET_FILE"> <idc:document dID="10"> </idc:document> </idc:service> </SOAP-ENV:Body> </SOAP-ENV:Envelope> Receving response... HTTP/1.1 200 OK Server: Microsoft-IIS/5.0 Connection: keep-alive Date: Mon, 29 Apr 2002 16:09:42 GMT Content-type: Multipart/Related; boundary=-----------------4002588859573015789; type=text/xml; start="<SoapContent>" Content-Length: 1717 -------------------4002588859573015789 Content-Type: text/xml; charset=utf-8 Content-ID: <SoapContent> <?xml version='1.0' ?> <SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"> <SOAP-ENV:Body> <idc:service xmlns:idc="http://www.oracle.com/IdcService/" IdcService="GET_FILE"> <idc:document dID="10" dExtension="txt"> <idc:field name="changedSubjects"> </idc:field> <idc:field name="refreshSubjects"> </idc:field> <idc:field name="loadedUserAttributes"> 1 </idc:field> <idc:field name="changedMonikers"> </idc:field> <idc:field name="refreshSubMonikers"> </idc:field> <idc:field name="refreshMonikers"> </idc:field> <idc:resultset name="FILE_DOC_INFO"> <idc:row dID="10" dDocName="soap_sample" dDocType="ADACCT" dDocTitle="soap_sample" dDocAuthor="sysadmin" dRevClassID="10" dRevisionID="1" dRevLabel="1" dIsCheckedOut="0" dCheckoutUser="" dSecurityGroup="Public" dCreateDate="4/22/02 12:18PM" dInDate="4/22/02 12:18 PM" dOutDate="" dStatus="RELEASED" dReleaseState="Y" dFlag1="" dWebExtension="txt" dProcessingState="Y" dMessage="" dDocAccount="" dReleaseDate="4/22/02 12:19 PM" dRendition1="" dRendition2="" dIndexerState="" dPublishType="" dPublishState="" dDocID="19" dIsPrimary="1" dIsWebFormat="0" dLocation="" dOriginalName="soap_sample.txt" dFormat="text/plain" dExtension="txt" dFileSize="12"> <idc:field name="xComments"> </idc:field> </idc:row> </idc:resultset> </idc:document> <idc:user dUser="sysadmin"> </idc:user> </idc:service> </SOAP-ENV:Body> </SOAP-ENV:Envelope> -------------------4002588859573015789 Content-Type: text/html Content-ID: <soap_sample.txt> ...File content... -------------------4002588859573015789--
A.8.11 Get Search Results
The GET_SEARCH_RESULTS service retrieves the search results for the passed query text.
-
Used to display the search results to a user making a content item query.
-
You can append values for Title, Content ID, and so on, on the QueryText parameter to refine this service.
The QueryText parameter defines the query. For use in a SOAP message, this query must be XML-encoded. This example passes a string submitted for a content item query as both a standard formatted string and XML-encoded format:
-
Parameter with standard formatted string.
QueryText=dDocType <Substring> "ADSALES"
-
Parameter with XML-encoded string
<idc:field name="QueryText"> dDocType <Substring> `ADSALES` </idc:field>
For more information about formatting XML-encoded strings, see Section A.4.2, "Special Characters."
-
-
If this service is unable to execute, this message is displayed to the user: Unable to retrieve search results.
A.8.11.1 Required Parameters
These parameters must be specified.
| Parameter | Description |
|---|---|
| IdcService | Must be set to GET_SEARCH_RESULTS. |
| QueryText | The user supplied text submitted for the content item query. |
A.8.11.2 Optional Parameters
These parameters may be specified.
| Parameter | Description |
|---|---|
| resultCount | The number of results to return, defaults to 25. |
| sortField | The name of the metadata field to sort on.
|
| sortOrder | The sort order. Allowed values are ASC (ascending) and DES (descending). |
| startRow | The row to begin the search results. For example, if a result returns 200 rows, and resultCount is 25, set startRow to 26 to obtain the second set of results. |
A.8.11.3 SOAP Request
<?xml version='1.0' ?> <SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"> <SOAP-ENV:Body> <idc:service xmlns:idc="http://www.oracle.com/IdcService/" IdcService="GET_SEARCH_RESULTS"> <idc:document> <idc:field name="QueryText"> dDocType <Substring> "ADSALES" </idc:field> </idc:document> </idc:service> </SOAP-ENV:Body> </SOAP-ENV:Envelope>
A.8.11.4 Response
<?xml version='1.0' ?> <SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"> <SOAP-ENV:Body> <idc:service xmlns:idc="http://www.oracle.com/IdcService/" IdcService="GET_SEARCH_RESULTS"> <idc:document StartRow="1" TotalDocsProcessed="6" TotalRows="0" QueryText="dDocType+%3cSubstring%3e+%22ADSALES%22" EndRow="25" SearchProviders="Master_on_wharristest" NumPages="0" PageNumber="1"> <idc:field name="refreshMonikers"> </idc:field> <idc:field name="refreshSubMonikers"> </idc:field> <idc:field name="refreshSubjects"> </idc:field> <idc:field name="EnterpriseSearchMaxRows"> 4 </idc:field> <idc:field name="FullRequest"> &QueryText=dDocType+%3cSubstring%3e+%22ADSALES%22 </idc:field> <idc:field name="loadedUserAttributes"> 1 </idc:field> <idc:field name="changedMonikers"> </idc:field> <idc:field name="changedSubjects"> </idc:field> <idc:field name="Text2"> <$dDocTitle$> </idc:field> <idc:field name="Text1"> <$dDocName$> </idc:field> <idc:field name="OriginalQueryText"> dDocType+%3cSubstring%3e+%22ADSALES%22 </idc:field> <idc:resultset name="SearchResults"> </idc:resultset> <idc:resultset name="NavigationPages"> </idc:resultset> <idc:resultset name="Master_on_wharristest"> </idc:resultset> <idc:resultset name="EnterpriseSearchResults"> <idc:row ProviderName="Master_on_wharristest" IDC_Name="Master_on_wharristest" TotalRows="0" TotalDocsProcessed="6"> <idc:field name="ProviderDescription"> !csProviderLocalContentServerLabel </idc:field> <idc:field name="InstanceMenuLabel"> Master_on_wharristest </idc:field> <idc:field name="InstanceDescription"> Master_on_wharristest </idc:field> <idc:field name="IntradocServerHostName"> wharristest </idc:field> <idc:field name="HttpRelativeWebRoot"> /stellent/ </idc:field> <idc:field name="IsImplicitlySearched"> </idc:field> <idc:field name="UserAccounts"> #all </idc:field> <idc:field name="IsLocalCollection"> true </idc:field> <idc:field name="Selected"> </idc:field> <idc:field name="StatusMessage"> Success </idc:field> <idc:field name="ResultSetName"> Master_on_wharristest </idc:field> <idc:field name="SearchCgiWebUrl"> /idcplg/idc_cgi_isapi.dll/stellent/pxs </idc:field> </idc:row> </idc:resultset> </idc:document> <idc:user dUser="sysadmin"> </idc:user> </idc:service> </SOAP-ENV:Body> </SOAP-ENV:Envelope>
A.8.12 Get Table Data
The GET_TABLE service exports the specified table in the Oracle Content Server database.
-
Exports the specified table by creating a result set and adding it to the serialized hda. If the table is not found, the service will fail. It is up to the calling program receiving the serialized hda to store this result set for later usage.
-
The most likely error is a table name that does not exist. If this service is unable to execute, an error message is displayed to the user.
A.8.12.1 Required Parameters
These parameters must be specified.
| Parameter | Description |
|---|---|
| IdcService | Must be set to GET_TABLE. |
| tableName | The name of table to export. |
A.8.12.2 SOAP Request
<?xml version='1.0' ?> <SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"> <SOAP-ENV:Body> <idc:service xmlns:idc="http://www.oracle.com/IdcService/" IdcService="GET_TABLE"> <idc:document> <idc:field name="tableName"> DocTypes </idc:field> </idc:document> </idc:service> </SOAP-ENV:Body> </SOAP-ENV:Envelope>
A.8.12.3 Response
<?xml version='1.0' ?> <SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"> <SOAP-ENV:Body> <idc:service xmlns:idc="http://www.oracle.com/IdcService/" IdcService="GET_TABLE"> <idc:document> <idc:field name="tableName"> DocTypes </idc:field> <idc:field name="changedSubjects"> </idc:field> <idc:field name="refreshSubjects"> </idc:field> <idc:field name="loadedUserAttributes"> 1 </idc:field> <idc:field name="changedMonikers"> </idc:field> <idc:field name="refreshSubMonikers"> </idc:field> <idc:field name="refreshMonikers"> </idc:field> <idc:resultset name="DocTypes"> <idc:row dDocType="ADACCT" dDescription="Acme Accounting Department" dGif="adacct.gif"> </idc:row> <idc:row dDocType="ADCORP" dDescription="Acme Corporate Department" dGif="adcorp.gif"> </idc:row> <idc:row dDocType="ADENG" dDescription="Acme Engineering Department" dGif="adeng.gif"> </idc:row> <idc:row dDocType="ADHR" dDescription="Acme Human Resources Department" dGif="adhr.gif"> </idc:row> <idc:row dDocType="ADMFG" dDescription="Acme Manufacturing Department" dGif="admfg.gif"> </idc:row> <idc:row dDocType="ADMKT" dDescription="Acme Marketing Department" dGif="admkt.gif"> </idc:row> <idc:row dDocType="ADSALES" dDescription="Acme Sales Department" dGif="adsales.gif"> </idc:row> </idc:resultset> </idc:document> <idc:user dUser="sysadmin"> </idc:user> </idc:service> </SOAP-ENV:Body> </SOAP-ENV:Envelope>
A.8.13 Get Criteria Workflow Information
The GET_CRITERIA_WORKFLOWS_FOR_GROUP service returns criteria workflow information.
-
Given a named security group, this service returns a list of workflows and related steps.
-
Returns the result sets WorkflowsForGroup and WorkflowStepsForGroup:
-
WorkflowsForGroup lists all of the workflows for this group (dWfID, dWfName).
-
WorkflowStepsForGroup lists all of the steps in all of the workflows for this group (dWfID, dWfName, dWfStepID, dWfStepName).
-
-
Criteria workflows and subworkflows can be added, edited, enabled, disabled, and deleted from the Criteria tab of the Workflow Admin administration applet.
-
The most likely error is a named security group that does not exist or a user failing the security check. The service throws reasonable exceptions for display to the user in these situations.
A.8.13.1 REquired Parameters
These parameters must be specified.
| Parameter | Description |
|---|---|
| dSecurityGroup | The security group such as PUBLIC or SECURE. |
| IdcService | Must be set to GET_CRITERIA_WORKFLOWS_FOR_GROUPS. |
A.8.13.2 SOAP Request
<?xml version="1.0" ?> <SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"> <SOAP-ENV:Body> <idc:service xmlns:idc="http://www.oracle.com/IdcService/" IdcService="GET_CRITERIA_WORKFLOWS_FOR_GROUP"> <idc:document dSecurityGroup="Public" /> </idc:service> </SOAP-ENV:Body> </SOAP-ENV:Envelope>
A.8.13.3 Response
<?xml version='1.0' ?> <SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"> <SOAP-ENV:Body> <idc:service xmlns:idc="http://www.oracle.com/IdcService/" IdcService="GET_CRITERIA_WORKFLOWS_FOR_GROUP"> <idc:document dSecurityGroup="Public"> <idc:field name="changedSubjects"> </idc:field> <idc:field name="refreshSubjects"> </idc:field> <idc:field name="loadedUserAttributes"> 1 </idc:field> <idc:field name="changedMonikers"> </idc:field> <idc:field name="refreshSubMonikers"> </idc:field> <idc:field name="refreshMonikers"> </idc:field> <idc:resultset name="WorkflowStepsForGroup"> <idc:row> <idc:field name="dWfID"> 1 </idc:field> <idc:field name="dWfName"> TestWorkflow </idc:field> <idc:field name="dWfStepID"> 1 </idc:field> <idc:field name="dWfStepName"> contribution </idc:field> </idc:row> <idc:row> <idc:field name="dWfID"> 1 </idc:field> <idc:field name="dWfName"> TestWorkflow </idc:field> <idc:field name="dWfStepID"> 2 </idc:field> <idc:field name="dWfStepName"> StepOne </idc:field> </idc:row> </idc:resultset> <idc:resultset name="WorkflowsForGroup"> <idc:row> <idc:field name="dWfID"> 1 </idc:field> <idc:field name="dWfName"> TestWorkflow </idc:field> </idc:row> </idc:resultset> </idc:document> <idc:user dUser="sysadmin"> </idc:user> </idc:service> </SOAP-ENV:Body> </SOAP-ENV:Envelope>