This chapter describes the services available when using and customizing Oracle WebCenter Content Server workflows, and other services which are stored in the workflow.htm file in the IdcHomeDir/resources/core/templates/ directory.
This chapter covers the following topics:
Information about what is a WebCenter Content service and how services can be used is provided in Section 2, "Using Services." Information about basic services structure, attributes, actions, and a service example is provided in Section 3, "Customizing Services." You should be familiar with this information before customizing current services or creating new services
The locations for specific workflow services are listed within each individual service.
Note:
The most commonly used services have more extensive descriptions.
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.
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:
Service that adds a problem report to a content item.
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.
IdcService=ADD_PROBLEMREPORT dPrCaption=Problem report for this content. dDocName=PublicDoc1_ia3c488971 dID=67 dPrState=OPEN dPrSeverity=MINOR
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.
IdcService=DELETE_PROBLEMREPORT dPrID=1
Service that returns a list of Criteria workflows and workflow steps for a specific security group.
Returns the WorkflowsForGroup and WorkflowStepsForGroup result sets:
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.
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
Service that returns all problem reports for a specific content item..
Service class: Doc Service
Location: IdcHomeDir/resources/core/templates/workflow.htm
Additional Required Service Parameters
dDocName: The Content ID for the content item.
IdcService=GET_DOCUMENT_PROBLEMREPORTS dDocName=security_000015
Service that returns the problem report search form.
Service Class: Doc Service
Location: IdcHomeDir/resources/core/templates/workflow.htm
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
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.
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.
IdcService=GET_UPDATE_PROBLEMREPORT_FORM dPrID=1
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.
IdcService=GET_WORKFLOWDOCUMENTS dWfName=mktg_review
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
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 application 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/tables/std_services.htm
Results Sets: WorkflowInQueue
Other: SoapCustom:Wsdl:Workflow:Services
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.
IdcService=NOTIFY_CONTRIBUTOR dID=55
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.
IdcService=PROBLEMREPORT_INFO dPrID=1
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.
IdcService=RESEND_PROBLEMREPORT dPrID=1
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.
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.
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.
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
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
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
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
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.
IdcService=WORKFLOW_REJECT_FORM dWfName=mktg_review dID=44
Workflow Template Services are used to manage or alter workflow templates. All services listed here have a Service Class of Workflow Template Service. The following services are described in this section:
Service that creates a new workflow template. The most likely error is when the workflow template name is not unique or when the system is unable to retrieve the workflow template list.
Location: IdcHomeDir/resources/core/templates/workflow.htm
Additional Required Service Parameters
dWfTemplateName: The workflow template name.
dWfTemplateDescription: The workflow template description.
IdcService=ADD_WF_TEMPLATE dWfTemplateName=mark_temp dWfTemplateDescription=marketing template
Service that deletes an existing workflow template. The most likely error is when the system is unable to retrieve workflow templates.
Location: IdcHomeDir/resources/core/templates/workflow.htm
Additional Required Service Parameters
dWfTemplateName: The workflow template name.
IdcService=DELETE_WF_TEMPLATE dWfTemplateName=wf_template_10
Service that modifies an existing workflow template. This service is similar to EDIT_WORKFLOWSTEP, as a workflow template has steps in it. However, this service allows the editing of more than one step and other parts of the template.
Location: IdcHomeDir/resources/core/templates/workflow.htm
Additional Required Service Parameters
dAliases: The list of alias users separated by the /n escape sequence.
For example: dAliases=subadmins/nservices
dWfStepDescription: The step description.
dWfStepHasWeight: Enables the limited reviewer option.
Set to 1 (true), and define the number of reviewers with the dWfStepWeight parameter.
Set to 0 (false) if dWfStepIsAll is enabled.
dWfStepIsAll: Enables the all reviewer option.
Set to 1 (true) to require all users assigned to the step to approve the revision before the workflow passes to the next step.
Set to 0 (false) if dWfStepHasWeight is enabled.
dWfStepName: The workflow step name. Typically this is the type of review (such as initial review or copy edit) or the function of the reviewer (such as manager or copy editor).
dWfStepType: The workflow step type:
Reviewer: Approves or rejects the revision.
Reviewer/Contributor: Can edit the revision and approves or rejects it.
dWfStepWeight: Defines the number of reviewers for the limited reviewer option.
Enter a numeric value for the number of reviewers. The workflow passes to the next step as soon as the number of users specified have approved the revision.
You can enter zero (0) in this field to notify reviewers that the revision has reached the step, but reviewers will not be able to approve, reject, or edit the revision at that step. The workflow will pass to the next step automatically.
dWfTemplateDescription: The workflow template description.
dWfTemplateName: The workflow template name.
The following is an example EDIT_WF_TEMPLATE service call:
@Properties LocalData
dUser=fradiche
dWfStepIsAll=0
watchedMonikers=
blFieldTypes=StatusMessage message
monitoredTopics=appcommongui,1060430685890
dAliases=fradiche*09user*09user1*09user
monitoredSubjects=collaborations,1061386025875,config,1061386026266,metadata,
1061386026216,metaoptlists,1061386026236,wftemplates,1061386026267,projects,
1061386026586,users,1061386026216,workflows,1061386026296,aliases,
1061386026266,wfscripts,1061386026266,usermetaoptlists,1061386026256,
doctypes,1061386026216,accounts,1061386026216
refreshSubMonikers=
dWfStepID=
dWfStepHasWeight=1
wfExitScript=
wfUpdateScript=
ClientEncoding=Cp1252
dWfStepDescription=
wfUpdateScriptSummary=
dWfStepType=Reviewer
dWfID=
HasAdditionalExitCondition=0
IsTemplateScript=1
dWfStepName=s1
IsJava=1
wfExitConditionSummary=
dAliasType=user
ConditionKeys=HasAdditionalExitCondition,wfAdditionalExitCondition
dWfTemplateDescription=test
dWfTemplateName=test
blDateFormat=M/d{/yyyy} {h:mm{:ss}{.SSSS} {aa}}!tAmerica/Chicago
IdcService=EDIT_WF_TEMPLATE
dAlias=user1
dWfStepWeight=1
wfEntryScriptSummary=
wfExitScriptSummary=
wfEntryScript=
@end
@ResultSet WorkflowSteps
9
dWfStepName
dWfStepID
dWfID
dWfStepType
dWfStepIsAll
dWfStepWeight
dWfStepDescription
dAliases
dWfStepHasWeight
s1
Reviewer
0
1
fradiche*09user*09user1*09user
1
@end
@ResultSet WorkflowStepEvents
4
dWfStepName
wfEntryScript
wfExitScript
wfUpdateScript
s1
@end
@ResultSet UpdatedUserTopics
3
topicName
topicValue
topicTS
@end
The following is an example of the results that would be returned:
Content-type: text/plain
Content-Length: 2446
<?hda version="6.3 dev (build-date)" jcharset=Cp1252 encoding=iso-8859-1?>
@Properties LocalData
wfUpdateScript=
dUser=sysadmin
refreshSubMonikers=
refreshTopics=appcommongui,1040486396000
dWfTemplateDescription=test
dAlias=user1
wfExitConditionSummary=
monitoredSubjects=collaborations,1061386025875,config,1061386026266,metadata,
1061386026216,metaoptlists,1061386026236,wftemplates,1061386026267,projects,
1061386026586,users,1061386026216,workflows,1061386026296,aliases,
1061386026266,wfscripts,1061386026266,usermetaoptlists,1061386026256,
doctypes,1061386026216,accounts,1061386026216
wfExitScript=
ConditionKeys=HasAdditionalExitCondition,wfAdditionalExitCondition
dWfStepDescription=
dAliases=fradiche*09user*09user1*09user
dWfStepType=Reviewer
watchedMonikers=
HasAdditionalExitCondition=0
changedMonikers=
changedSubjects=
blFieldTypes=StatusMessage message
IdcService=EDIT_WF_TEMPLATE
wfExitScriptSummary=
dWfStepHasWeight=1
wfEntryScript=
wfUpdateScriptSummary=
dAliasType=user
dWfStepName=s1
dWfStepWeight=1
wfEntryScriptSummary=
dWfStepID=
refreshMonikers=
blDateFormat=M/d{/yyyy} {h:mm{:ss}{.SSSS} {aa}}!tAmerica/Chicago
ClientEncoding=Cp1252
IsJava=1
dWfStepIsAll=0
IsTemplateScript=1
refreshSubjects=wftemplates,1061386026272
dWfTemplateName=test
monitoredTopics=appcommongui,1060430685890
dWfID=
@end
@ResultSet WorkflowSteps
9
dWfStepName
dWfStepID
dWfID
dWfStepType
dWfStepIsAll
dWfStepWeight
dWfStepDescription
dAliases
dWfStepHasWeight
s1
Reviewer
0
1
fradiche*09user*09user1*09user
1
@end
@ResultSet WorkflowStepEvents
4
dWfStepName
wfEntryScript
wfExitScript
wfUpdateScript
s1
@end
@ResultSet UpdatedUserTopics
3
topicName
topicValue
topicTS
appcommongui
\@Properties LocalData\nblFieldTypes=\nblDateFormat=M/d{/yy} {h:mm{:ss.SSSS}
{aa}[zzz]}!tAmerica/Chicago\n\@end\n\@ResultSet
UserSelectView:filter\n3\nfilterColumn\nfilterValue\nisEnabled\ndUserAuthType
\nLOCAL\ntrue\n\@end\n\@ResultSet UserView:filter\n3\nfilterColumn
\nfilterValue\nisEnabled\ndUserAuthType\nLOCAL\ntrue\n\@end\n\@ResultSet
DocView:filter\n3\nfilterColumn\nfilterValue\nisEnabled\ndProcessingState
\nM\nfalse\ndIsCheckedOut\n1\nfalse\ndStatus\nGENWWW\ntrue\ndDocTitle
\nCanceled:%\nfalse\ndReleaseState\nN\nfalse\nisLatestRev\n\ntrue
\ndSecurityGroup\ntest\nfalse\ndDocType\ntest\nfalse\n\@end\n\n
1040486396000
@end
@ResultSet WfTemplates
2
dWfTemplateName
dWfTemplateDescription
collaboration_template
Basic Collaboration template
test
test
@end
Service that returns the description of a specific workflow template. The most likely error is a workflow template name that does not exist.
Location: IdcHomeDir/resources/core/templates/workflow.htm
Additional Required Service Parameters
dWfTemplateName: The workflow template name.
IdcService=GET_WF_TEMPLATE dWfTemplateName=servicestemplate
Service that returns a list of all workflow templates and their descriptions. The most likely error is a workflow name that does not exist.
Service Class: Workflow Template Service
Location: IdcHomeDir/resources/core/templates/workflow.htm
Workflow services are those used to manage workflows, including adding a workflow, adding tokens, and enabling or disabling a workflow. Frequently used services are marked with an asterisk (*) in the following list.
All of these services have a Service Class of Workflow Service.
The following services are described in this section:
Service that creates a new workflow. This service is executed by the Workflow Admin applet. Workflows and sub-workflows can be added, edited, enabled, disabled, and deleted from the Workflow Admin administration applet.
The most likely error is when the workflow name is not unique.
Location: IdcHomeDir/resources/core/templates/workflow.htm
Additional Required Service Parameters
dWfName: The workflow name.
dWfDescription: The workflow description.
dWfType: The workflow type such as Basic or Criteria.
dSecurityGroup: The security group such as Public or Secure.
dWfCriteriaName: The workflow criteria field.
dWfCriteriaOperator: The workflow criteria operator matches.
dWfCriteriaValue: The workflow criteria value.
IdcService=ADD_WORKFLOW dWfName=test_workflow dSecurityGroup=Public dWfType=Criteria dWfCriteriaName=dDocAuthor dWfCriteriaOperator=matches dWfCriteriaValue=sysadmin dWfDescription=testing workflow
Service used to add a script template for a workflow.
Location: IdcHomeDir/resources/core/templates/workflow.htm
Additional Required Service Parameters
wfScriptName: Name of the script template to be used.
wfScriptDescription: Description used for the script.
Service used to add tokens for workflows.
Service Class: Workflow Service
Location: IdcHomeDir/resources/core/templates/workflow.htm
Additional Required Service Parameters
wfToken: Default token to use to create the new token.
wfTokenName: Name of the new token to be added.
wfTokenDescription: Description used for the token.
Service that adds a user or an alias to a workflow step. To add a user, set the dAliasType parameter to user. To add an alias, set dAliasType to alias. The most likely error is when the specified workflow does not exist.
Note:
The alias is not defined here. The alias must already exist. It is usually created using the UserAdmin applet.
Service Class: Workflow Service
Location: IdcHomeDir/resources/core/templates/workflow.htm
Additional Required Service Parameters
aliases: The alias name.
dAliasType: The assigned alias type. Values can be alias or user.
dWfID: The workflow ID.
dWfName: The workflow name.
dWfStepID: The workflow contribution stage ID. This auto-generated value can be retrieved from the database table. The Content Server system automatically assigns dWfStepID for that contribution stage.
IdcService=ADD_WORKFLOWALIASES dWfName=mktg_review dWfID=12 dAliasType=user aliases=sammy dWfStepID=26
Service that adds a new content item to a Basic workflow. The content item specified by dDocName does not have to exist in the system.
This service is called from the Workflow Admin applet by creating a Basic workflow and clicking New in the Content section. This service executes the ADD_WORKFLOWDOCUMENT_SUB subservice.
Location: IdcHomeDir/resources/core/templates/workflow.htm
Additional Required Service Parameters
dWfName: The workflow name.
dDocName: The Content ID of the content item.
IdcService=ADD_WORKFLOWDOCUMENT dWfName=mktg_review dDocName=test1234
Subservice called by ADD_WORKFLOWDOCUMENTS and ADD_WORKFLOWDOCUMENT to add a content item to the Basic workflow.
Location: IdcHomeDir/resources/core/templates/workflow.htm
Service that adds the selected content items to a Basic workflow. The list of items to add is specified in the dDocName parameter.
This service is called from the Workflow Admin applet by creating a Basic workflow and clicking Select in the Content section.
This service executes the subservice ADD_WORKFLOWDOCUMENT_SUB.
Location: IdcHomeDir/resources/core/templates/workflow.htm
Additional Required Service Parameters
dWfName: The workflow name.
dDocName: The Content ID of the content items to be added. If multiple items are to be added, use a tab-separated list.
IdcService=ADD_WORKFLOWDOCUMENTS dWfName=mktg_review dDocName=test_000035 dataSource=Documents resultName=DOCUMENTS dWfType=Basic whereClause=dSubscriptionType='test' dWfDirectory=public
Service that creates a new workflow step.
These parameters can be executed in a browser environment using the Workflow Admin applet. For example, the dWfStepName, dWfStepDescription, and dWfStepType entries correspond to the Name entry, the Description field, and the Type drop-down list of the Workflow Admin applet Edit Step Reviewer screen.
Setting dWfStepWeight to a numeric value is the same as entering a value in the field associated with the At least this many reviewers option for Workflow Steps in the Workflow Admin applet. If defined, the workflow passes to the next step as soon as the number of users specified in dWfStepWeight have approved the revision.
Setting dWfStepIsAll to 1 (true) is the same as enabling the All Reviewers option for Workflow Steps in the Workflow Admin applet. If set to true, all users assigned to the step must approve the revision before the workflow passes to the next step.
The most likely error is when the specified workflow does not exist or when the specified step is not unique.
Location: IdcHomeDir/resources/core/templates/workflow.htm
Additional Required Service Parameters
dWfName: The workflow name.
dWfStepName: The workflow step name.
dWfStepDescription: The step description.
dWfStepType: The workflow step type:
Reviewer: Approves or rejects the revision.
Reviewer/Contributor: Can edit the revision and approves or rejects it.
dWfStepIsAll:
1 (true): All users assigned to the step must approve the revision before the workflow passes to the next step.
0 (false): The number of approvals required is specified by the dWfStepWeight parameter.
dWfStepWeight: The number of reviewers that must approve the revision before the workflow passes to the next step.
If dWfStepIsAll is 1 (true), this parameter is ignored. If dWfStepIsAll is 0 (false), this parameter is enabled.
Setting this parameter to 0 (zero) notifies reviewers that the revision has reached the step, but reviewers will not be able to approve, reject, or edit the revision at that step. The workflow will pass to the next step automatically.
wfEntryScript: The step entry script.
wfExitScript: The step exit script.
wfUpdateScript: The step update script.
Note:
Scripts must be placed within <$ and $> delimiters. For example: <$if ConditionExpression$>
Service that disables a Criteria workflow. The most likely error is when the specified workflow does not exist.
Location: IdcHomeDir/resources/core/templates/workflow.htm
Additional Required Service Parameters
dWfName: The workflow name.
IdcService=CRITERIAWORKFLOW_DISABLE dWfName=mktg_review
Service that disables a sub-workflow in a Criteria workflow.
Location: IdcHomeDir/resources/core/templates/workflow.htm
Service that enables a Criteria workflow. The most likely error is when the specified workflow does not exist.
Location: IdcHomeDir/resources/core/templates/workflow.htm
Additional Required Service Parameters
dWfName: The workflow name.
IdcService=CRITERIAWORKFLOW_ENABLE dWfName=mktg_review
Service used to delete the users and aliases from the first step (the contribution step) of a Basic workflow. The most likely errors are mismatched parameters or when the specified workflow or alias does not exist.
Location: IdcHomeDir/resources/core/templates/workflow.htm
Additional Required Service Parameters
aliases: The aliases and users to be deleted from the Basic workflow. If multiple aliases are to be deleted, use a tab-separated list.
dWfName: The workflow name.
dWfStepID: The workflow contribution step ID. This auto-generated value can be retrieved from the database table.
IdcService=DELETE_WFCONTRIBUTORS dWfName=mktg_review dWfStepID=26 aliases=user20
Service that deletes an existing Basic workflow. The most likely error is when the specified workflow does not exist.
Location: IdcHomeDir/resources/core/templates/workflow.htm
Additional Required Service Parameters
dWfName: The workflow name.
IdcService=DELETE_WORKFLOW dWfName=mktg_review
Service that deletes a workflow script.
Location: IdcHomeDir/resources/core/templates/workflow.htm
Additional Required Service Parameters
wfScriptName: Name of the script template to be used.
wfScriptDescription: Description used for the script.
Service that deletes a workflow token.
Location: IdcHomeDir/resources/core/templates/workflow.htm
Additional Required Service Parameters
wfTokenName: Name of the token to be deleted.
Service that deletes an existing Criteria workflow. If the workflow is active the user is prompted that this action will cause all content items in this workflow to exit the workflow. The most likely error is when the specified workflow does not exist.
Location: IdcHomeDir/resources/core/templates/workflow.htm
Additional Required Service Parameters
dWfName: The workflow name.
IdcService=DELETE_WORKFLOWCRITERIA dWfName=mktg_review
Service that deletes content items from a Basic workflow. This service is executed by the Workflow Admin applet.
The most likely error is when the specified workflow does not exist.
Location: IdcHomeDir/resources/core/templates/workflow.htm
Additional Required Service Parameters
dWfName: The Basic workflow name.
docNames: The content item names of the documents to be deleted. If multiple items are to be deleted, use a tab-separated list.
Note:
It is recommended that you include both the docNames parameter and the dDocName parameter, as both parameters are used in the execution of this service.
The following is an example DELETE_WORKFLOWDOCUMENTS service call:
@Properties LocalData IdcService=DELETE_WORKFLOWDOCUMENTS dWfName=w3 docNames=rr dDocName=rr @end
The following is an example of the results that would be returned:
Content-type: text/plain
Content-Length: 931
<?hda version="6.3 dev (build-date)" jcharset=Cp1252 encoding=iso-8859-1?>
@Properties LocalData
dUser=sysadmin
blFieldTypes=xThreadParentDocName bigtext,xCollectionID int,xMailType
text,xZoomLevel int,dCompletionDate date,xTargetCompression int,xTemplateType
text,xEmailFrom bigtext,xEmailCC memo,dMessage message2,xHidden text,
xClbraAliasList memo,xWebsiteID int,StatusMessage message,xComments memo,
xEmailDate date,xWebsiteObjectType text,xCollectionInhibitUpdateMeta text,
xClbraUserList memo,xFileFormat bigtext,dReleaseDate date,xMessageID
text,dInDate date,xDiscussionType text,dCreateDate date,dOutDate
date,xDiscussionCount int,xReadOnly text
docNames=rr
refreshSubMonikers=
blDateFormat=M/d{/yyyy} {h:mm{:ss}{.SSSS} {aa}}!tAmerica/Chicago
dWfName=w3
refreshSubjects=
changedSubjects=workflows,1061386026294
dDocName=rr
refreshMonikers=
changedMonikers=
dWfDocState=INIT
IdcService=DELETE_WORKFLOWDOCUMENTS
IsJava=1
@end
Service that deletes a specified step from a workflow. This service is used from the Workflow applet. The user selects a step and clicks the Delete Step button. If this service is run outside the applet, then the controlling application must specify the workflow step. The step ID and name is stored in the database as part of the workflow design information and can be retrieved from there for use.
The most likely error is when the specified workflow or workflow step does not exist or if the workflow is active.
Location: IdcHomeDir/resources/core/templates/workflow.htm
Additional Required Service Parameters
dWfName: The workflow name.
dWfStepName: The workflow step name.
dWfStepID: The workflow contribution stage ID.
IdcService=DELETE_WORKFLOWSTEP dWfName=c2 dWfStepID=12 dWfStepName=edit
Service that modifies an existing workflow. This service is executed by the Workflow Admin applet. The most likely error is a workflow name that does not exist or a user failing the security check.
Location: IdcHomeDir/resources/core/templates/workflow.htm
Additional Required Service Parameters
dWfName: The workflow name.
dSecurityGroup: The security group such as Public or Secure.
dWfCriteriaName: The workflow criteria name.
dWfCriteriaOperator: The workflow criteria operator such as Matches, Starts, Ends.
dWfCriteriaValue: The workflow criteria value.
dWfDescription: The workflow description.
dWfType: The workflow type such as Basic or Criteria.
IdcCommand command file format:
IdcService=EDIT_WORKFLOW dWfName=c2 dSecurityGroup=Public
HDA format with optional parameters:
@Properties LocalData IdcService=EDIT_WORKFLOW dWfName=test_workflow dSecurityGroup=Public dWfType=Criteria dWfCriteriaName=dDocAuthor dWfCriteriaOperator=matches dWfCriteriaValue=sysadmin dWfDescription=testing workflow @end
Service used to edit a workflow script.
Location: IdcHomeDir/resources/core/templates/workflow.htm
Additional Required Service Parameters
wfScriptName: Name of the script template to be used.
wfScriptDescription: Description used for the script.
Service used to edit a workflow token.
Location: IdcHomeDir/resources/core/templates/workflow.htm
Additional Required Service Parameters
wfTokenName: Name of the token to be edited.
Service that modifies the criteria for an existing Criteria workflow. Editing the criteria may include changing the workflow to a project or collaboration workflow, or changing the metadata conditions that a content item must meet to enter the workflow.
Two types of Criteria workflows exist: criteria, which is a workflow that requires a metadata condition and subworkflow, which does not have a metadata condition. Because of the two types of workflows, dWfType is a required parameter to designate which type of Criteria workflow is to be used.
This service is executed by the Workflow Admin applet. The most likely error is a workflow name that does not exist or a user failing the security check.
Service Class: Workflow Service
Location: IdcHomeDir/resources/core/templates/workflow.htm
Additional Required Service Parameters
dWfName: The workflow name.
dSecurityGroup: The security group such as Public or Secure.
dWfType: The workflow type.
dWfCriteriaName: The workflow criteria name.
dWfCriteriaOperator: The workflow criteria operator such as Matches, Starts, Ends.
dWfCriteriaValue: The workflow criteria value.
dWfDescription: The workflow description.
IdcService=EDIT_WORKFLOWCRITERIA dWfName=c2 dSecurityGroup=Public dWfType=Criteria dWfCriteriaName=dDocType dWfCriteriaOperator=matches dWfCriteriaValue=ADACCT
Service that modifies an existing workflow step.
These parameters can be executed in a browser environment using the Workflow Admin applet. For example, the dWfStepName, dWfStepDescription, and dWfStepType entries correspond to the Name entry, the Description field, and the Type drop-down list of the Workflow Admin applet Edit Step Reviewer screen.
Setting dWfStepWeight to a numeric value is the same as entering a value in the field associated with the At least this many reviewers option for Workflow Steps in the Workflow Admin applet. If defined, the workflow passes to the next step as soon as the number of users specified in dWfStepWeight have approved the revision.
Setting dWfStepIsAll to 1 (true) is the same as enabling the All Reviewers option for Workflow Steps in the Workflow Admin applet. If set to true, all users assigned to the step must approve the revision before the workflow passes to the next step.
Location: IdcHomeDir/resources/core/templates/workflow.htm
Additional Required Service Parameters
dWfName: The workflow name.
dWfStepName: The workflow step name.
dAliases: A tab-delimited list of aliases and users to be used for the step. The format for this parameter is (alias/user)\t(alias/user type)\t(alias/user)\t(alias/user type).
dWfStepDescription: The step description.
dWfStepType: The workflow step type:
Reviewer: Approves or rejects the revision.
Reviewer/Contributor: Can edit the revision and approves or rejects it.
dWfStepIsAll:
1 (true): All users assigned to the step must approve the revision before the workflow passes to the next step.
0 (false): The number of approvals required is specified by the dWfStepWeight parameter.
dWfStepWeight: The number of reviewers that must approve the revision before the workflow passes to the next step.
If dWfStepIsAll is 1 (true), this parameter is ignored. If dWfStepIsAll is 0 (false), this parameter is enabled.
Setting this parameter to 0 (zero) notifies reviewers that the revision has reached the step, but reviewers will not be able to approve, reject, or edit the revision at that step. The workflow will pass to the next step automatically.
wfEntryScript: The step entry script.
wfExitScript: The step exit script.
wfUpdateScript: The step update script.
Note:
Scripts must be placed within <$ and $> delimiters. For example, <$if ConditionExpression$>.
Note in the following example, the convention \t denotes a tab separator.
IdcService=EDIT_WORKFLOWSTEP dWfName=test_workflow dWfStepName=edit dWfStepType=Reviewer/Contributor dWfStepDescription=copy edit step dAliases=AllUsers\taliases\tsysadmin\tuser dWfStepIsAll=0 dWfStepWeight=2 wfEntryScript= wfExitScript= wfUpdateScript=
Service that returns the Active Workflows page where a user can select a workflow and view all documents in a workflow.
Access Level: Read, Global, Scriptable (49)
Location: IdcHomeDir/resources/core/templates/workflow.htm
Result Sets:
StdWorkflows (dWfName, dWfID, dWfDescription, dCompletionDate, dSecurityGroup, dWfStatus, dWfType, dIsCollaboration)
ClbraWorkflows (same fields as StdWorkflows)
ClbraAccessList (dClbraName, userList, aliasList)
Response Template: WORKFLOW_LIST (workflow_list.htm)
Resource Includes:
pne_nav_management_links
std_doc_man_pages
Templates:
WORKFLOW_REJECT_FORM (reject_doc.htm)
ALL_WORKFLOW_DOCS (workflow_all_docs_list.htm)
WORKFLOW_DOCS (workflow_docs_list.htm)
WORKFLOW_INFO (workflow_info.htm)
WF_INQUEUE_LIST (workflow_queue.htm)
WORKFLOW_REVIEW_FORM (workflow_review_form.htm)
Standard Navigation: commonNav.js
Service that returns a result set of documents in a workflow and their revision information.
Location: IdcHomeDir/resources/core/templates/workflow.htm
Service used by the Workflow applet that returns workflows for a specified security group. It returns the step information for the returned workflows. The most likely error is a security group that does not exist or a user failing the security check.
Returns the WorkflowsForGroup and WorkflowStepsForGroup result sets:
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).
Location: IdcHomeDir/resources/core/templates/workflow.htm
Additional Required Service Parameters
dSecurityGroup: The security group such as Public or Secure.
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
Returns the companion information file for a document in a workflow.
Location: IdcHomeDir/resources/core/templates/workflow.htm
Additional Required Service Parameters
dDocName: The name of the document in the workflow.
dWfName: The workflow name.
Service that returns information about a specific workflow. The most likely error is a workflow name that does not exist.
Location: IdcHomeDir/resources/core/templates/workflow.htm
Additional Required Service Parameters
dWfName: The workflow name.
IdcService=GET_WORKFLOW dWfName=mktg_review
Service that returns workflow step information for a content item. This service is executed in a browser interface by selecting Active Workflows from PNE links, clicking on the workflow name, and then clicking the link for step name.
The most likely error is a content item or workflow name that does not exist.
Access Level: Read, Global, Scriptable (49)
Queries Executed: QdocInfo, QworkflowDocument, QworkflowForID, QwfDocState, QworkflowSteps
Location: IdcHomeDir/resources/core/templates/workflow.htm
Additional Required Service Parameters
dID: The generated content item revision ID.
dWfStepID: The workflow contribution stage ID. This auto-generated value can be retrieved from the database table.
Result Sets:
WorkflowSteps (All fields from all rows of WorkflowSteps DB table for specified workflow)
WorkflowStep (All WorkflowSteps fields for current step plus dUsers and dHasTokens fields)
DOC_INFO (All fields from Revisions and DocMeta for the specified revision)
WorkflowInfo (All fields from Workflows DB table for specified workflow)
WorkflowState (dUserName field only from WorkflowState DB table for specified content item)
WorkflowActionHistory (Result set from corresponding HDA file in data\workflow\states directory)
Local Data:
AuthorAddress
dID
dUser
dWfCurrentStepID
dWfName
dWfStepID
RemainingStepUsers
Response Template: WORKFLOW_INFO (workflow_info.htm)
Resource Includes: clbra_wf_doc_list
IdcService=GET_WORKFLOW_INFO dID=61 dWfStepID=19
Service used to retrieve information about a workflow based on the name of a document in the workflow. It returns the Workflow Information page for a content item, which lists the history of the document, what steps remain in the workflow, and who is currently reviewing the workflow.
Access Level: Read, Global, Scriptable (49)
Queries Executed:
QdocNameMeta
QworkflowDocument
QworkflowForID
QwfDocState
QworkflowSteps
Location: IdcHomeDir/resources/core/templates/workflow.htm
Additional Required Service Parameters
dDocName: The name of a document in an active workflow.
Result Sets:
WorkflowSteps (All fields from all rows of WorkflowSteps DB table for specified workflow)
WorkflowStep (All WorkflowSteps fields for current step plus dUsers and dHasTokens fields)
DOC_INFO (All fields from Revisions and DocMeta for the specified content item)
WorkflowInfo (All fields from Workflows DB table for specified workflow)
WorkflowState (dUserName field only from WorkflowState DB table for specified content item)
WorkflowActionHistory (Result set from corresponding HDA file in data\workflow\states directory)
Local Data:
AuthorAddress
dUser
dWfName
dWfStepID
RemainingStepUsers
Response Template: WORKFLOW_INFO (workflow_info.htm)
Resource Includes:
setup_workflow_action_popups
wf_in_queue_display
workflow_action_popup
Templates:
WORKFLOW_REVIEW_FORM (workflow_review_form.htm)
WORKFLOW_REVIEW_FRAMES (workflow_review_frames.htm)
Other: SoapCustom:Wsdl:Workflow:Services
Service used to retrieve a workflow script.
Location: IdcHomeDir/resources/core/templates/workflow.htm
Additional Required Service Parameters
wfScriptName: Name of the script template to be used.
wfScriptDescription: Description used for the script.
Service that returns a list of content item revisions that are in a specific workflow. This service is run in the browser environment by selecting Active Workflows in PNE links and clicking on the workflow name.
The most likely error is a workflow name that does not exist.
Access Level: Read, Global, Scriptable (49)
Queries Executed:
Qworkflow
QwfStates
QworkflowDocuments
QworkflowSteps
Location: IdcHomeDir/resources/core/templates/workflow.htm
Additional Required Service Parameters
dWfName: The workflow name.
Result Sets:
WorkflowSteps (All fields from all rows of WorkflowSteps DB table for specified workflow plus the additional fields, dUsers and dHasTokens)
WfDocuments (Rows correspond to each content item belonging to the specified workflow; each row contains all fields from WorkflowDocuments, Revisions, and DocMeta DB tables)
WorkflowStates (All fields from the WorkflowStates DB table for the specified workflow)
WF_INFO (All fields from the Workflows DB table for the specified workflow)
Local Data:
dUser
dWfName
isCollaboration
Response Template:
WORKFLOW_DOCS (workflow_docs_list.htm)
Resource Includes:
checkin_multiuploadapplet_processing_functions
setup_active_standard_workflows_table_row
legacy_active_collaboration_workflows_table
legacy_active_standard_workflows_table
wf_in_queue_display
workflow_action_popup
workflow_revisions_href
Templates:
CONTRIBUTOR_MAIL (contributor_mail.htm)
PROJECT_INFO (project_info.htm)
WF_REJECT_MAIL (reject_mail.htm)
WORKFLOW_INFO (workflow_info.htm)
WORKFLOW_REJECT_FORM (reject_doc.htm)
WORKFLOW_REVIEW_FORM (workflow_review_form.htm)
Other: SoapCustom:Wsdl:Workflow:Services
Redirect service for: WORKFLOW_APPROVE, WORKFLOW_EDIT_APPROVE, WORKFLOW_REJECT, WORKFLOW_CHECKIN
IdcService=GET_WORKFLOW dWfName=mktg_review
Service that retrieves a list of all workflows including their description, security group, status, and type.
Location: IdcHomeDir/resources/core/templates/workflow.htm
Service used to check the validity of a workflow script.
Location: IdcHomeDir/resources/core/templates/workflow.htm
Additional Required Service Parameters
wfScriptName: Name of the script template to be used.
wfScriptDescription: Description used for the script.
dDocName: Content item to be used in the test scenario.
Service that approves a content item revision in a workflow.
Location: IdcHomeDir/resources/core/templates/workflow.htm
Additional Required Service Parameters
dID: The generated content item revision ID.
IdcService=WORKFLOW_APPROVE dID=81
Service that cancels a Basic workflow.
Location: IdcHomeDir/resources/core/templates/workflow.htm
Additional Required Service Parameters
dWfName: The workflow name.
IdcService=WORKFLOW_CANCEL dWfName=mktg_review
Service that checks in a new revision of a content item that is in a workflow. The most likely error is when the specified content item or workflow does not exist.
This service executes the subservice WORKFLOW_CHECKIN_SUB. This subservice checks a content item revision into a workflow.
Access Level: Read (1)
Queries Executed: QdociInfo, Qrevisions
Calls Subservice: WORKFLOW_CHECKIN_SUB
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.
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 Content Server instance. 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.
If a primary file is not specified, you can use a metafile in its place. Only one metafile can exist though for each content item (a primary AND alternate meta file cannot coexist).
If both a primary and alternate file is specified, their extensions must be different.
isFinished: Indicates that the editing is finished for a rejected content item.
1 (true): The revision will be checked in and approved. |
0 (false): The revision will be checked in but will still need to be approved.
doFileCopy:
1 (true): The file will not be deleted from the hard drive after checkin.
0 (false): The file will be removed from your hard drive after checkin.
alternateFile
RedirectUrl
Local Data:
Content Server:
alternateFile
changedSubjects
CurRevID
dAction
dActionDate
dCheckoutUser
dClbraName
dConversion
dCreateDate
dDocAccount
dDocAuthor
dDocID
dDocName
dDocTitle
dDocType
dExtension
dFileSize
dFormat
dID
dInDate
dIsPrimary
dIsWebFormat
dlsCheckedOut
doFileCopy
dLocation
dOriginalName
dOutDate
dpAction
dpEvent
dProcessingState
dPublishState
dPublishType
dRawDocID
dReleaseState
dRevClassID
dRevisionID
dRevLabel
dRevRank
dSecurityGroup
dStatus
dUser
dUserName
isCheckin
isCurRevEmpty
isDocProfileUsed
isEditMode
isInfoOnly
isNew
IsNotLatestRev
isStatusChanged
IsUpdate
IsWorkflow
latestID
oldName
prevID
prevReleaseState
primaryFile
VaultfilePath
WebfilePath
Workflow:
dWfComputed
dWfCurrentStepID
dWfDirectory
dWfDocState
dWfEntry
dWfID
dWfName
dWfStatus
dWfStepID
dWfStepDescription
dWfStepIsAll
dWfStepName
dWfStepType
dWfStepWeight
dWfType
dWorkflowState
entryCount
wfAction
wfCurrentStepPrefix
WfEditFinished
wfMessage
wfStepCheckinType
Response Template:
REDIRECT_TEMPLATE (redirect_template.htm)
Default redirect service (branched): GET_WORKFLOWDOCREVISIONS or GET_PORTAL_PAGE (Page=WF_INQUEUE_LIST)
IdcService=WORKFLOW_CHECKIN dID=92 dDocName=test_00063 dWfID=4 dSecurityGroup=Public dDocAccount=mainaccount dWfType=Criteria dWfName=mktg_review primaryFile=c:/hello_hello.txt dRevLabel=2 doFileCopy=1 isFinished=1
Service used for client applications (that is, not used by the core Content Server software) which need the ability to approve a document without passing through a checkin/checkout process.
Location: IdcHomeDir/resources/core/templates/workflow.htm
Service that rejects a content item revision in a workflow.
The system administrator cannot approve or reject a content item in a workflow unless they are defined as a reviewer for the current step. Therefore, if you run this service in IdcCommand as the user sysadmin, you cannot reject the content item unless sysadmin is defined as a reviewer.
Access Level: Read (1)
Queries Executed:
QdocInfo
IworkflowDocHistory
UrevisionStatus
UworkflowDocStep
UrevisionStatus
DworkflowDocState
QwfDocInformation
Location: IdcHomeDir/resources/core/templates/workflow.htm
Additional Required Service Parameters
dID: The generated content item revision ID.
wfRejectMessage: The rejection message.
RedirectUrl
Local Data:
Content Server:
changedSubjects
dActionDate
dClbraName
dDocAuthor
dDocName
dDocTitle
dExtension
dID
dPublishState
dReleaseState
dRevClassID
dStatus
dUser
isCurRevEmpty
IsWorkflow
prevReleaseState
Workflow:
dAction
dOriginalName
dWfCompute
dWfCurrentStepID
dWfDirectory
dWfDocState
dWfID
dWfName
dWfStatus
dWfStepDescription
dWfStepID
dWfStepIsAll
dWfStepName
dWfStepType
dWfStepWeight
dWfType
dWorkflowState
entryCount
wfAction
wfCurrentStepPrefix
WfEditFinished
wfMailSubject
wfMailTemplate
wfMessage
wfRejectMessage
wfStepCheckinType
wfUsers
Response Template:
REDIRECT_TEMPLATE (redirect_template.htm)
Default redirect service (branched): GET_WORKFLOWDOCREVISIONS or GET_PORTAL_PAGE (Page=WF_INQUEUE_LIST)
Applets: Repostory Manager
Templates: WORKFLOW_REJECT_FORM (reject_doc.htm)
Other: SoapCustomer:Wsdl:Workflow:Services
IdcService=WORKFLOW_REJECT dID=95 wfRejectMessage=Please Revise
Service Class: Workflow Service
Location: IdcHomeDir/resources/core/templates/workflow.htm
Additional Required Service Parameters
dWfName: The workflow name.
dSecurityGroup: The security group, such as Public or Secure.
wfMessage: The message that will be included in the Workflow Started notification e-mail.
IdcService=WORKFLOW_START dWfName=mktg_review dSecurityGroup=Public wfMessage=Please check in this content item