This chapter covers the following topics:
A typical Content Publisher service entry is similar to the following:
GET_FILE FileService 3 null null null !csUnableToDownloadFile 3:computeDocID::0:!csUnableToDownload(dDocName) 5:QdocInfo:FILE_DOC_INFO:2:!csItemNoLongerInSystem 3:checkSecurity:FILE_DOC_INFO:0:!csUnableToDownload(dDocName) 3:createFileName:FILE_DOC_INFO:0:null</td><ADD EXAMPLE
The first line indicates the service name: GET_FILE
The second line lists the service's attributes:
Service class: FileService
Access level: 3
Template: null (none used)
Service type: null (not a subservice)
Subjects Notified: null
Error message: Unable to Download File
The remainder of the entry lists the service's actions, each line designating one action:
action type: for example, 3, indicating a Java method.
action name: for example, checkSecurity
action parameters: for example, FILE_DOC_INFO. If no parameters are specified, double-colons (::) are included.
action control mask: for example, 0, indicating no control mask. The double-colon indicator (::) can also be included.
action error message: for example, Unable to Download (dDocName), or null if no message is available.
Each element of the service's action is separated by a colon (:).
Important:
All services have at least one required parameter. The IdcService parameter takes the name of the service as its argument. If other parameters are required, they are noted in the description of the service.See "Customizing Services" for details about a service's attributes and actions.
The following services are used with Content Publisher and are described elsewhere in this documentation. Any specific parameters necessary for Content Publisher are noted in those descriptions:
The following services are described in this chapter:
Service used to check in a project for Publisher.
Location: IdcHomeDir/resources/core/templates/workflow.htm
Additional Required Service Parameters
dProjectID: The Content Publisher project ID generated by Content Publisher.
dPrjTopParent: The publication ID of the topmost publication in the project to which the document belongs.
dPrjMiddleParent: The path of publication ID values leading from the dPrjTopParent to the dPrjIntermediateParent.
dPrjImmediateParent: The publication ID of the immediate parent publication to which the project belongs.
agentID: An identifier for the software that is calling the service. Content Publisher uses the reserved agentID ContentPublisher.
Action: Always set to the value update.
isStaging: set to 1 if staging, 0 if publishing.
docPublishType: A comma-delimited list containing the type of document being published. Acceptable values include: entrypoint, toc, lof, lot, index, query, results, frameset, page, splitpage, firstpage, graphic, gallery, assoc, mapfile, passthru, unknown.
isPendingContributorRelease: An indicator of whether the document producing this output is in a released state.
A service that signals the end of a publishing operation.
Location: IdcHomeDir/resources/core/templates//workflow.htm
Additional Required Service Parameters
dProjectID: The Content Publisher project ID generated by Content Publisher.
agentID: An identifier for the software that is calling the service. Content Publisher uses the reserved agentID ContentPublisher.
Service that retrieves the list of Content Publisher projects the specified item falls into or matches. From a page generated by this service, the user can decide to preview the content item in the context of the selected Content Publisher project.
This service queries the checkin cache for information to create the preview list. The cached data determines the metadata for the content item and is used to discover which projects the content item may be previewed in. If the content item is no longer in the cache, the service fails.
Location: IdcHomeDir/resources/core/templates/std_services.htm
Additional Required Service Parameters
dDocName: The document ID for the content item.
Service similar to GET_PREVIEW_LIST except it does not use cached data to compute the potential Content Publisher projects. The content information or metadata is retrieved from the database. See "GET_PREVIEW_LIST" for details.
Location: IdcHomeDir/resources/core/templates/std_services.htm
Additional Required Service Parameters
dDocName: The document ID for the content item.
dID: The content ID for the content item.
Service that lists actions associated with a project.
Location: IdcHomeDir/resources/core/templates/workflow.htm
Additional Required Service Parameters
dProjectID: The Content Publisher project ID generated by Content Publisher.
agentID: An identifier for the software that is calling the service. Content Publisher uses the reserved agentID ContentPublisher.
Service that returns information about all content items associated with a Content Publisher project.
Location: IdcHomeDir/resources/core/templates/workflow.htm
Additional Required Service Parameters
dProjectID: The Content Publisher project ID generated by Content Publisher.
IdcService=GET_PROJECT_INFO dProjectID=servG0SGXDW5YD55T80NHPR57MWW40
Service that returns workflow registration information for a Content Publisher project.
Location: IdcHomeDir/resources/core/templates/workflow.htm
Additional Required Service Parameters
projectID: The Content Publisher project ID generated by Content Publisher.
Important:
Use projectID for this service (not dProjectID).IdcService=GET_PROJECT_REGISTRATION projectID=saviZN0LN18G9D6THX91KD4O9RTMKG
Service that returns information about all registered Content Publisher projects.
Location: IdcHomeDir/resources/core/templates/workflow.htm
Service that submits the designated content item to the Content Publisher preview engine through HTMLPreview.
Location: IdcHomeDir/resources/core/templates/std_services.htm
Additional Required Service Parameters
dDocName: The Content ID for the content item.
projectID: The unique identifier for the Content Publisher project.
pagePathID: The Content Publisher node.
Both projectID and pagePathID are computed from the information retrieved from GET_PREVIEW_LIST.
Service used to register a Content Publisher project.
Location: IdcHomeDir/resources/core/templates/workflow.htm
Additional Required Service Parameters
projectID: The Content Publisher project ID generated by Content Publisher.
functions: An indicator of the intended usage of the project. Acceptable values include: registered, preview, stagingworkflow.
A service that signals the start of a publishing operation.
Location: IdcHomeDir/resources/core/templates/workflow.htm
Additional Required Service Parameters
projectID: The Content Publisher project ID generated by Content Publisher.
Location: IdcHomeDir/resources/core/templates/workflow.htm
Additional Required Service Parameters
projectID: The Content Publisher project ID generated by Content Publisher.
functions: An indicator of the intended usage of the project. Acceptable values include: registered, preview, stagingworkflow.