9.2 Content Publisher Services

9.2.1 CHECKIN_PUBLISH

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.

Optional Service Parameters

• 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.

9.2.2 END_PUBLISHING

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.

9.2.3 GET_PREVIEW_LIST

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.

9.2.4 GET_PREVIEW_LIST_EX

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.

9.2.5 GET_PROJECT_ACTIONS

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.

9.2.6 GET_PROJECT_INFO

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.

Example

IdcService=GET_PROJECT_INFO
dProjectID=servG0SGXDW5YD55T80NHPR57MWW40

9.2.7 GET_PROJECT_REGISTRATION

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

Example

IdcService=GET_PROJECT_REGISTRATION
projectID=saviZN0LN18G9D6THX91KD4O9RTMKG

9.2.8 GET_REGISTEREDPROJECTS

Service that returns information about all registered Content Publisher projects.

Location: IdcHomeDir/resources/core/templates/workflow.htm

9.2.9 PREVIEW_DOCUMENT

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.

9.2.10 REGISTER_PROJECT

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.

9.2.11 START_PUBLISHING

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.

9.2.12 UNREGISTER_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.