This chapter covers the following topics:
Information about what is a WebCenter Content service and how services can be used is provided in Using Services. Information about basic services structure, attributes, actions, and a service example is provided in Customizing Services. You should be familiar with this information before customizing current services or creating new services.
The locations for specific Imaging services are listed within each individual service.
The following services are described in this section::
Service that returns the TIFF version of a document with all annotations burned in. If a document has annotations, use this service to download the document in the TIFF format with all annotations (except hidden) burned in.
Service Class: intradoc.server.FileService
Location: IdcHomeDir/components/Imaging/resources/imaging_service.htm
Additional Required Service Parameters
dID: The ID of the document to be downloaded in the TIFF format with all annotations burned in.
Results
Response Template: null (Only the requested file is returned.)
Service that returns the PDF version of a document with all annotations burned in. If a document has annotations, use this service to download the document in the PDF format with all annotations (except hidden) burned in.
Service Class: intradoc.server.FileService
Location: IdcHomeDir/components/Imaging/resources/imaging_service.htm
Additional Required Service Parameters
dID: The ID of the document to be downloaded in the PDF format with all annotations burned in.
Results
Response Template: null (Only the requested file is returned.)
Service that checks in the primary file as well as the attachment in a single call.
Service Class: intradoc.server.DocService
Location: IdcHomeDir/components/Imaging/resources/imaging_service.htm
Additional Required Service Parameters
Checkin Parameters:
dDocAuthor: The content item author (contributor).
dDocTitle: The content item title.
dDocType: The content item Type.
dSecurityGroup: The security group such as Public or Secure.
dDocAccount: The account for the content item. Required only if accounts are enabled.
primaryFile: The absolute path to the location of the file as seen from the server. Use the slash as the file separator.
Note:
For other optional parameters, see checkin related services in Doc Services.Attachment (Rendition) Parameters:
Comma separated list of keys for each rendition to be added. Each rendition will have .action=edit, .name, .description, and .file.
.action=edit is always edit.
.name is the name of the rendition.
.description is the description of the rendition.
.file is the path of the rendition.
Optional Service Parameters
AuxRenditionType: To indicate if a rendition is a system rendition. For system renditions, set this parameter to system.
Results
Local Data:
Checkin metadata including VaultfilePath, WebFilePath, and so on.
ResultSets
DOC_INFO: Information about the new document created.
ZIP_LIST: Information about the new rendition created.
Example
requestBinder.putLocal("renditionKeys", "addRendition0");
requestBinder.putLocal("addRendition0.action", "edit");
requestBinder.putLocal("addRendition0.name", "testRendition");
requestBinder.addFile("addRendition0.file", new TransferFile(new File("D:\\CheckInAttachment\\annotationRendition_new.xml")));
requestBinder.putLocal("AuxRenditionType", "system");
Service that modifies the pages of a document.
Service Class: intradoc.server.DocService
Location: IdcHomeDir/components/Imaging/resources/imaging_service.htm
Additional Required Service Parameters
dID: The ID of the document whose pages are to be modified.
pageChangeKeys: Comma separated list of keys for each rendition to be added. Each rendition will have .changeType, .newPageNumber, .file, and .file:path.
.changeType can be appendPage or insertPage.
.newPageNumber is used with insertPage to mention the page number where the insert has to happen.
.file is the path of the new file.
Results
ResultSets
SystemRenditions: Lists the renditions of the document that were edited.
DOC_INFO: Information about the document that was edited.
REVISION_HISTORY: Revision history of the document that was edited.
Example
requestBinder.putLocal("pageChangesKeys", "pageChange0, pageChange1");
requestBinder.putLocal("pageChange0.changeType", "appendPage");
requestBinder.addFile("pageChange0.file", new TransferFile(new File("D:\\CheckInAttachment\\10_Page.tiff")));
requestBinder.putLocal("pageChange1.changeType", "insertPage");
requestBinder.putLocal("pageChange1.newPageNumber", "5");
requestBinder.addFile("pageChange1.file", new TransferFile(new File("D:\\CheckInAttachment\\11.tiff")));