6.2 Doc and General Services (Workflows)

Doc Services are those that are used to manage and manipulate documents or provide information about documents. General services are common or default services. Frequently used services are marked with an asterisk (*) in the following list.

The following services are described in this section:

ADD_PROBLEMREPORT
DELETE_PROBLEMREPORT
GET_CRITERIA_WORKFLOWS_FOR_GROUP
GET_DOCUMENT_PROBLEMREPORTS
GET_PROBLEMREPORTS_SEARCH_FORM
GET_PROBLEMREPORTS_SEARCH_RESULTS
GET_UPDATE_PROBLEMREPORT_FORM
GET_WORKFLOWDOCUMENTS
GET_WORKFLOWS_FOR_ALL
*LOAD_WORKFLOW_QUEUE
NOTIFY_CONTRIBUTOR
PROBLEMREPORT_INFO
RESEND_PROBLEMREPORT
REVIEW_WORKFLOW_DOC
UPDATE_PROBLEMREPORT
WORKFLOW_CHECKIN_SUB
WORKFLOW_EDIT_REV
WORKFLOW_NEW_REV
WORKFLOW_REJECT_FORM

6.2.1 ADD_PROBLEMREPORT

Service that adds a problem report to a content item. This is a Content Publisher related service used on Staging Workflow.

The most likely errors are mismatched parameters, when the system is unable to add a problem report to the content item, or when the content item no longer exists in the system.

Service Class: Doc Service

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

Additional Required Service Parameters

dDocName: The content item identifier (Content ID).
dID: The generated content item revision ID.
dPrCaption: The caption for the problem report.
dPrSeverity: The problem report severity level such as Critical, Moderate, or Minor. This option has no effect on how a problem report is handled within the workflow process.
dPrState: The problem report state such as Open, Closed, or Fixed.

Note:
Do not confuse the Content ID (dDocName) with the internal content item revision identifier (dID). The dID is a generated reference to a specific rendition of a content item.

Example

IdcService=ADD_PROBLEMREPORT
dPrCaption=Problem report for this content.
dDocName=PublicDoc1_ia3c488971
dID=67
dPrState=OPEN
dPrSeverity=MINOR

6.2.2 DELETE_PROBLEMREPORT

Service that deletes an existing problem report. The most likely errors are mismatched parameters or when the content item no longer exists in the system.

Service Class: Doc Service

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

Additional Required Service Parameters

dPrID: The problem report ID.

Example

IdcService=DELETE_PROBLEMREPORT
dPrID=1

6.2.3 GET_CRITERIA_WORKFLOWS_FOR_GROUP

Service that returns a list of Criteria workflows and workflow steps for a specific security group.

Returns the WorkflowsForGroup and WorkflowStepsForGroup ResultSets:

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).
The most likely error is a security group that does not exist or a user failing the security check.

Service class: Service (general service).

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

Additional Required Service Parameters

dSecurityGroup: The security group such as Public or Secure.

Example

IdcCommand command file format:

# Retrieves criteria workflow information
IdcService=GET_CRITERIA_WORKFLOWS_FOR_GROUP
dSecurityGroup=Public

HDA format:

@Properties LocalData
IdcService=GET_CRITERIA_WORKFLOWS_FOR_GROUP
dSecurityGroup=Public
@end

6.2.4 GET_DOCUMENT_PROBLEMREPORTS

Service that returns all problem reports for a specific content item. This service is available from the content information page and is only available when documents are being staged by Content Publisher.

Service Class: Doc Service

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

Additional Required Service Parameters

dDocName: The Content ID for the content item.
dProjectID: The Content Publisher project ID generated by the Content Server.

Example

IdcService=GET_DOCUMENT_PROBLEMREPORTS
dProjectID=servG0SGXDW5YD55T80NHPR57MWW40
dDocName=security_000015

6.2.5 GET_PROBLEMREPORTS_SEARCH_FORM

Service that returns the problem report search form.

Service Class: Doc Service

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

6.2.6 GET_PROBLEMREPORTS_SEARCH_RESULTS

Service that returns a list of problem reports that match search criteria as specified on the Problem Reports search page. The search criteria can be any of the columns as specified in the Problem Reports table.

Search criteria that are used can take any of the columns specified in the Problem Reports table. The service is passed in name/value pairs, which are then turned into a database query's WHERE clause.

The Problem Reports data source (as specified in the resource.htm file) is used with the WHERE clause generated by the name/value pair to construct the query. The results of this query are then passed back for presentation.

Service Class: Doc Service

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

Optional Service Parameters

dPrSeverity: The problem report severity level such as Critical, Moderate, Minor. This option has no bearing on how a problem report is handled within the workflow process.
dPrAuthor: The problem report author.
dPrCaption: The caption for the problem report.
dPrState: The problem report state such as Open, Closed, Fixed.
dDocTitle: The content item title.
dDocName: The Content ID for the content item.
dPrjDescription: The project description.

6.2.7 GET_UPDATE_PROBLEMREPORT_FORM

Service that returns the update form for a problem report.

Service Class: Doc Service

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

Additional Required Service Parameters

dPrID: The problem report ID.

Example

IdcService=GET_UPDATE_PROBLEMREPORT_FORM
dPrID=1

6.2.8 GET_WORKFLOWDOCUMENTS

Service that returns a list of content item revisions that are in a specific workflow.

The service provides a list of all content items in workflows and is updated by the system server to keep track of the status of content items (state and step) that are in workflows.

The most likely error is a workflow name that does not exist.

Service class: Service (general service)

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

Additional Required Service Parameters

IdcService: Must be set to GET_WORKFLOWDOCUMENTS.
dWfName: The workflow name.

Example

IdcService=GET_WORKFLOWDOCUMENTS
dWfName=mktg_review

6.2.9 GET_WORKFLOWS_FOR_ALL

Service used by the Workflow applet to return information about all workflows and their steps.

Service Class: Service (general service)

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

6.2.10 LOAD_WORKFLOW_QUEUE

Service that returns the personalization data for the user, which contains a list of content items in a workflow that require action. The data comes from the wf_in_queue.hda file in the DomainHome/ucm/cs/data/users/profiles directories.

This is intended to be a remote applicaiton service because it is a raw data service with no associated display template.

Service Class: User Service

Access Level: Read, Scriptable (33)

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

Results

Results Sets: WorkflowInQueue

Used By

Other: SoapCustom:Wsdl:Workflow:Services

6.2.11 NOTIFY_CONTRIBUTOR

Service that notifies a contributor on the problem report for the specified content item. The most likely error is a content item no longer in the system.

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

Additional Required Service Parameters

dID: The generated content item revision ID.

Example

IdcService=NOTIFY_CONTRIBUTOR
dID=55

6.2.12 PROBLEMREPORT_INFO

Service that returns all information about a problem report. The information for a problem report is in the file system and in the database. This service takes the user (when used in context) to the problem report information page. This allows the user to resend, delete, or update the problem report from the user interface.

Service Class: Doc Service

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

Additional Required Service Parameters

dPrID: The problem report's unique ID.

Example

IdcService=PROBLEMREPORT_INFO
dPrID=1

6.2.13 RESEND_PROBLEMREPORT

Service that resends email to all interested users that are to be notified about an activity. This service is accessible from the Problem Report page.

Service Class: Doc Service

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

Additional Required Service Parameters

dPrID: The problem report ID.

Example

IdcService=RESEND_PROBLEMREPORT
dPrID=1

6.2.14 REVIEW_WORKFLOW_DOC

Service that generates the page allowing a user to review a document in a workflow.

Service Class: Doc Service

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

Additional Required Service Parameters

dID: The generated content item revision ID.

6.2.15 UPDATE_PROBLEMREPORT

Service that updates problem report information.

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

Additional Required Service Parameters

dPrID: The problem report ID.
dPrState: The problem report state, such as Open, Closed, Fixed.

Optional Service Parameters

dPrCaption: The caption for the problem report.
dPrSeverity: The problem report severity level, such as Critical, Moderate, Minor. This option has no effect on how a problem report is handled within the workflow process.
prMessage: The problem report message.

Example

IdcCommand command file format:

IdcService=UPDATE_PROBLEMREPORT
dPrID=1
dPrState=OPEN

HDA file format with optional parameters:

@Properties LocalData
IdcService=UPDATE_PROBLEMREPORT
dPrID=1
dPrState=OPEN
prMessage=Description is stored in hda file.
dPrCaption=change this caption
dPrSeverity=SERIOUS
@end

6.2.16 WORKFLOW_CHECKIN_SUB

Subservice that checks in a content item if the item already exists and is in a workflow.

Service Class: Doc Service

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

6.2.17 WORKFLOW_EDIT_REV

Subservice used by the WORKFLOW_CHECKIN_SUB subservice to determine what kind of workflow check is being performed. This service edits the workflow revision in place. When the workflow design is evaluated, a decision is made whether to use WORKFLOW_EDIT_REV or WORKFLOW_NEW_REV.

Service Class: Doc Service

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

6.2.18 WORKFLOW_NEW_REV

Subservice used by the WORKFLOW_CHECKIN service to determine the type of workflow checkin being performed. This service creates a new revision for the workflow document.

Service Class: Doc Service

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

6.2.19 WORKFLOW_REJECT_FORM

Service that returns the reject form for a rejected workflow revision. This service is executed when a reviewer rejects content in a workflow step (when the reviewer clicks Reject).

This service is normally performed in the browser environment, which uses JavaScript to assign values. Parameters that are passed in the browser environment are listed in the following subsection.

Service Class: Doc Service

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

Additional Required Service Parameters

dID: The generated content item revision ID.
dWfName: The workflow name.

Example

IdcService=WORKFLOW_REJECT_FORM
dWfName=mktg_review
dID=44