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