Skip to end of metadata
Go to start of metadata

Document Type Guide

This document will provide a detailed explanation and introduction of fields in Document Types XML definition, and examples of different Document Types in Kuali Enterprise Workflow that the users may use will be illustrated. In addition, users can find a detailed field-by-field introduction of the funcionality of each illustrated Document Type. There are some common attributes in every Document Type, but each Document Type can be customized to provide different required functionalities.

Common Fields in Document Type

  • name: the name of the Document Type.
  • parent: the parent Document Type of this Document Type. Child Document Type inherits attributes of its parent Document Type.
  • description: the description of the Document Type, what it is mainly responsible to.
  • label: the label of the Document Type, what it is recognized as.
  • postProcessorName: the name of the postProcess which takes charge of the routing of this Document Type.
  • superUserWorkgroupName: the name of the workgroup members of which are the superUsers of this Document Type. By defining superUsers, the members in the workgroup can execute a superuser document search on the Document Type.
  • blanketApproveWorkgroupName: the name of the workgroup members of which have the blanketapprove right over this Document Type.
  • defaultExceptionWorkgroupName: the name of the workgroup members of which get a Exception notice when a document of this Document Type encounter an exception in its routing.
  • docHandler: the DocHandler which handles the routing of this Document Type.
  • active: A true or false indicator of the active status of the document.
  • policies: the policies that apply to this Document Type.
  • policy: the policy that applies to this Document Type. There is just one policy applying to this Document Type.
    • value: A true or false indicator of whether the action for the policy will be taken.
  • routingVersion: This field exists only for purposes of backward compatibility with older versions of KEW. Originally, KEW only supported sequential routing paths (as opposed to those with splits and joins). The KEW getDocRouteLevel() API will return an integer which represents what the numerical "step" in the routing process is. This number only has any meaning in the case of documents that define sequential routing. A document with routingVersion of "1" will keep track of the route level number. A document with routingVersion of "2" (the default unless explicitly defined in the document type configuration) will not keep track of the route level number and (I believe) an exception will be thrown if code attempts to access that value. New document type definitions do not need and should not have this flag defined.
  • routePaths: the routing paths for this Document type
  • routePath: the routing path for this Document type. There is just one routing path for this Document Type.
  • routeNode: the point/node on the routing path of this Document Type.
  • start: the start node of this Document Type during the routing.
  • requests: the requested next node in the routing of this Document type.
  • activationType: the activation type of the next node that is requested by this Document Type. There are two types of activation:
    • P: Parallel. Multiple nodes in the routing process get activated at the same time.
    • S: Serial or Sequential. Only one of the nodes in the routing process gets activated at a time.
  • ruleTemplate: the ruleTemplate that applies to this routing node for this Document Type.
  • split: the routing path splits into branches and can continue on any of them.
  • branch: one of the branches in the routing path.
  • join: the point in the routing path where the split branches join together.
  • process: there is a sub process in the routing path, namely some nodes in the routing will activate a sub process.
  • simple: a new node in the routing path.
    • type: the type of the routing node created.
    • value: the value of the routing node created.
    • message: the message associated with the routing node created.
    • level: the routing level of the node created.
    • log: the log name of the routing node created.
  • dynamic: the node is activate dynamic for the next node in the routing path; therefore, the routing path is dynamic rather than static.

Document Types

Document Type Examples:

KULRICE092:Back To Top

BlanketApproveTest
  • name: this is the Document Type for Blanket Approve Test.
  • description: this Document Type is used to test the Blanket Approve function.
  • label: this document type is recognized as blanketApproveTest type.
  • postProcessorName: the postProcessor for this document type is edu.iu.uis.eden.postprocessor.DefaultPostProcessor.
  • superUserWorkgroupName: the superUsers for this Document Type are members of the TestWorkgroup.
  • blanketApproveWorkgroupName: the members of the TestWorkgroup have blanketApprove right on this type of document.
  • defaultExceptionWorkgroupName: the members of the TestWorkgroup will get Exception notice on exceptions of documents of this Document Type.
  • docHandler: the Doc Handler for this type of document is "_blank".
  • active: this Document Type is currently active, namely, it is in use.
  • Policies for this Document Type contain two policies:
    • The PRE_APPROVE policy is set false by default. Namely, the defualt pre-approve action on this type of document is not to approve it.
    • The DEFAULT_APPROVE policy is set false by default. Namely, the defualt approve action on this type of document is not to approve it.

KULRICE092:Back To Document Types

BlanketApproveSequentialTest
  • name: this is the Document Type for Blanket Approve Sequential Test. There is a sequence of routing nodes, and no routing node can be skipped.
  • parent: the parent Document Type is BlanketApproveTest. This Document Type inherits the policies that blanketApproveTest has.
  • description: this Document Type is used to test the Blanket Approve Sequential function.
  • label: this document type is recognized as blanketApproveSequentialTest type.
  • postProcessorName: the postProcessor for this document type is edu.iu.uis.eden.postprocessor.DefaultPostProcessor.
  • superUserWorkgroupName: the superUsers for this Document Type are members of the TestWorkgroup.
  • blanketApproveWorkgroupName: the members of the TestWorkgroup have blanketApprove right on this type of document.
  • defaultExceptionWorkgroupName: the members of the TestWorkgroup will get Exception notice on exceptions of documents for this Document Type.
  • docHandler: the Doc Handler for this type of document is "_blank".
  • active: this Document Type is currently active, namely, it is in use.
  • routePath: the routing path for this Document Type is: AdHoc -> WorkflowDocument -> WorkflowDocument2 -> Acknowledge1 -> Acknowledge2.
  • routeNode: based on the routePath, there are five nodes in the routing of this Document Type:
    • the starting node for this Document Type is AdHoc, on the initiation of a document of this type, the postProcessor in Kuali Enterprise Workflow activate the node AdHoc.
    • the next node in the routing for this Document Type is WorkflowDocument, on the request, the node is activated and applies rules in rule template WorkflowDocumentTemplate.
    • the next node in the routing for this Document Type is WorkflowDocument2, on the request, the node is activated and applies rules in rule template WorkflowDocument2Template.
    • the next node in the routing for this Document Type is Acknowledge1, on the request, the node is activated and applies rules in rule template Ack1Template.
    • the next node in the routing for this Document Type is Acknowledge2, on the request, the node is activated and applies rules in rule template Ack2Template.

      KULRICE092:Back To Document Types

BlanketApproveParallelTest
  • name: this is the Document Type for Blanket Approve Parallel Test. At some point in the routing, the route path may get split, and some node can get skipped if another parallel node take action on the document.
  • Parent: the parent Document Type is BlanketApproveTest. This Document Type inherits the routing that blanketApproveTest has.
  • description: this Document Type is used to test the Blanket Approve Parallel function.
  • label: this document type is recognized as blanketApproveParallelTest type.
  • postProcessorName: the postProcessor for this document type is edu.iu.uis.eden.postprocessor.DefaultPostProcessor.
  • superUserWorkgroupName: the superUsers for this Document Type are members of the TestWorkgroup.
  • blanketApproveWorkgroupName: the members of the TestWorkgroup have blanketApprove right on this type of document.
  • defaultExceptionWorkgroupName: the members of the TestWorkgroup will get Exception notice on exceptions of documents of this Document Type.
  • docHandler: the Doc Handler for this type of document is "_blank".
  • active: this Document Type is currently active, namely, it is in use.
  • routePath: the routing path for this Document Type is: AdHoc -> WorkflowDocument -> split -> B1\B2\B3 -> Join -> WorkflowDocumentFinal -> Acknowledge1 -> Acknowledge2.
  • routeNode: based on the routePath, there are six nodes in the routing of this Document Type:
    • the starting node for this Document Type is AdHoc, on the initiation of a document of this type, the postProcessor in Kuali Enterprise Workflow activate the node AdHoc.
    • the next node in the routing for this Document Type is WorkflowDocument, on the request, the node is activated and applies rules in rule template WorkflowDocumentTemplate. Then the routing path splits into three branches for next node.
      • One branch is B1, on request, the node WorkflowDocument2-B1 is activated and applies the WorkflowDocument2Template. The next node in this branch is WorkflowDocument3-B1, on request, the node is activated and applies the WorkflowDocument3Template.
      • One branch is B2, on request, the node WorkflowDocument3-B2 is activated and applies the WorkflowDocument3Template. The next node in this branch is WorkflowDocument2-B2, on request, the node is activated and applies the WorkflowDocument2Template.
      • One branch is B3, on request, the node WorkflowDocument4-B3 is activated and applies the WorkflowDocument4Template.
    • then the routing path joins.
    • the next node in the routing for this Document Type is WorkflowDocumentFinal, on the request, the node is activated and applies rules in rule template WorkflowDocumentFinalTemplate.
    • the next node in the routing for this Document Type is Acknowledge1, on the request, the node is activated and applies rules in rule template Ack1Template.
    • the next node in the routing for this Document Type is Acknowledge2, on the request, the node is activated and applies rules in rule template Ack2Template.

      KULRICE092:Back To Document Types

NotificationTest
  • name: this is the Document Type for Notification Test. At some point in the routing, the route path may get split, and some node can get skipped if the other notification node take action on the document.
  • description: this Document Type is used to test the notification function.
  • label: this document type is recognized as NotificationTest type.
  • postProcessorName: the postProcessor for this document type is edu.iu.uis.eden.postprocessor.DefaultPostProcessor.
  • superUserWorkgroupName: the superUsers for this Document Type are members of the TestWorkgroup.
  • blanketApproveWorkgroupName: the members of the TestWorkgroup have blanketApprove right on this type of document.
  • defaultExceptionWorkgroupName: the members of the TestWorkgroup will get Exception notice on exceptions of documents of this Document Type.
  • docHandler: the Doc Handler for this type of document is "_blank".
  • active: this Document Type is currently active, namely, it is in use.
  • routePath: the routing path for this Document Type is: AdHoc -> NotifyFirst -> split -> LeftBranch\RightBranch -> Join -> NotifyFinal.
  • routeNode: based on the routePath, there are four nodes in the routing of this Document Type:
    • the starting node for this Document Type is AdHoc, on the initiation of a document of this type, the postProcessor in Kuali Enterprise Workflow activate the node AdHoc.
    • the next node in the routing for this Document Type is NotifyFirst, on the request, the node is activated and applies rules in rule template NotifyFirstTemplate. Then the routing path splits into two branches for next node.
      • One branch is LeftBranch, on request, the node is activated and applies the NotifyLeftBranchTemplate.
      • One branch is RightBranch, on request, the node is activated and applies the NotifyRightBranchTemplate.
    • then the routing path joins.
    • the next node in the routing for this Document Type is NotifyFinal, on the request, the node is activated and applies rules in rule template NotifyFinalTemplate.

      KULRICE092:Back To Document Types

NotificationTestChild
  • name: this is the Document Type for Notification Test Child.
  • Parent: the parent Document Type is NotificationTest. This Document Type inherits the routing that NotificationTest has.
  • description: this Document Type is used to test the Notification function.
  • label: this document type is recognized as NotificationTest type.
  • postProcessorName: the postProcessor for this document type is edu.iu.uis.eden.postprocessor.DefaultPostProcessor.
  • superUserWorkgroupName: the superUsers for this Document Type are members of the workgroup TestWorkgroup.
  • blanketApproveWorkgroupName: the members of the TestWorkgroup have blanketApprove right on this type of document.
  • defaultExceptionWorkgroupName: the members of the TestWorkgroup will get Exception notice on exceptions of documents of this Document Type.
  • docHandler: the Doc Handler for this type of document is "_blank".
  • active: this Document Type is currently active, namely, it is in use.
  • Policy: there is only one policy that applies to this Document Type: SEND_NOTIFICATION_ON_SU_APPROVE, and this policy is currently applying to this Document Type. Namely, a notification will be sent to the designated two users when a superuser approves a document of this type.

KULRICE092:Back To Document Types

BlanketApproveMandatoryNodeTest
  • name: this is the Document Type for Blanket Approve Mandatory Node Test.
  • Parent: the parent Document Type is BlanketApproveTest. This Document Type inherits the policies that NotificationTest has.
  • description: this Document Type is used to test the Blanket Approve Mandatory Node.
  • label: this document type is recognized as BlanketApproveMandatoryNodeTest type.
  • postProcessorName: the postProcessor for this document type is edu.iu.uis.eden.postprocessor.DefaultPostProcessor.
  • superUserWorkgroupName: the superUsers for this Document Type are members of the TestWorkgroup.
  • blanketApproveWorkgroupName: the members of the TestWorkgroup have blanketApprove right on this type of document.
  • defaultExceptionWorkgroupName: the members of the TestWorkgroup will get Exception notice on exceptions of documents of this Document Type.
  • docHandler: the Doc Handler for this type of document is "_blank".
  • active: this Document Type is currently active, namely, it is in use.
  • routePath: the routing path for this Document Type is: AdHoc -> WorkflowDocument -> WorkflowDocument2 -> Acknowledge1 -> Acknowledge2.
  • routeNode: based on the routePath, there are five nodes in the routing of this Document Type:
    • the starting node for this Document Type is AdHoc, on the initiation of a document of this type, the postProcessor in Kuali Enterprise Workflow activate the node AdHoc.
    • the next node in the routing for this Document Type is WorkflowDocument, on the request, the node is activated, applies rules in rule template WorkflowDocumentTemplate, and sets the mandatory route as true, namely the document must route through this node.
    • the next node in the routing for this Document Type is WorkflowDocument2, on the request, the node is activated, applies rules in rule template WorkflowDocument2Template, and sets the mandatory route as true, namely the document must route through this node.
    • the next node in the routing for this Document Type is Acknowledge1, on the request, the node is activated and applies rules in rule template Ack1Template.
    • the next node in the routing for this Document Type is Acknowledge2, on the request, the node is activated and applies rules in rule template Ack2Template.

      KULRICE092:Back To Document Types

SaveActionEventTest
  • name: this is the Document Type for Save Action Event Test.
  • description: this Document Type is used to test the Blanket Approve Mandatory Node.
  • label: this document type is recognized as SaveActionEventTest type.
  • postProcessorName: the postProcessor for this document type is edu.iu.uis.eden.postprocessor.DefaultPostProcessor.
  • superUserWorkgroupName: the superUsers for this Document Type are members of the TestWorkgroup.
  • blanketApproveWorkgroupName: the members of the TestWorkgroup have blanketApprove right on this type of document.
  • defaultExceptionWorkgroupName: the members of the TestWorkgroup will get Exception notice on exceptions of documents of this Document Type.
  • docHandler: the Doc Handler for this type of document is "_blank".
  • active: this Document Type is currently active, namely, it is in use.
  • Policies for this Document Type contain two policies:
    • The PRE_APPROVE policy is set false by default. Namely, the defualt pre-approve action on this type of document is not to approve it.
    • The DEFAULT_APPROVE policy is set false by default. Namely, the defualt approve action on this type of document is not to approve it.
  • routePath: the routing path for this Document Type is: AdHoc -> WorkflowDocument.
  • routeNode: based on the routePath, there are two nodes in the routing of this Document Type:
    • the starting node for this Document Type is AdHoc, on the initiation of a document of this type, the postProcessor in Kuali Enterprise Workflow activate the node AdHoc.
    • the next node in the routing for this Document Type is WorkflowDocument, on the request, the node is activated and applies rules in rule template WorkflowDocumentTemplate.

      KULRICE092:Back To Document Types

SaveActionEventTestNonInitiator
  • name: this is the Document Type for Save Action Event Test Non Initiator.
  • description: this Document Type is used to test the saving of action event by non-initiator.
  • label: this document type is recognized as SaveActionEventTestNonInitiator type.
  • postProcessorName: the postProcessor for this document type is edu.iu.uis.eden.postprocessor.DefaultPostProcessor.
  • superUserWorkgroupName: the superUsers for this Document Type are members of the TestWorkgroup.
  • blanketApproveWorkgroupName: the members of the TestWorkgroup have blanketApprove right on this type of document.
  • defaultExceptionWorkgroupName: the members of the TestWorkgroup will get Exception notice on exceptions of documents of this Document Type.
  • docHandler: the Doc Handler for this type of document is "_blank".
  • active: this Document Type is currently active, namely, it is in use.
  • Policies for this Document Type contain three policies:
    • The PRE_APPROVE policy is set false by default. Namely, the defualt pre-approve action on this type of document is not to approve it.
    • The DEFAULT_APPROVE policy is set false by default. Namely, the defualt approve action on this type of document is not to approve it.
    • The INITIATOR_MUST_SAVE policy is set false by default. Namely, the initiator does not have to save the document for the non-initiator to save the actions on it.
  • routePath: the routing path for this Document Type is: AdHoc -> WorkflowDocument.
  • routeNode: based on the routePath, there are two nodes in the routing of this Document Type:
    • the starting node for this Document Type is AdHoc, on the initiation of a document of this type, the postProcessor in Kuali Enterprise Workflow activate the node AdHoc.
    • the next node in the routing for this Document Type is WorkflowDocument, on the request, the node is activated and applies rules in rule template WorkflowDocumentTemplate.

      KULRICE092:Back To Document Types

TakeWorkgroupAuthorityDoc
  • name: this is the Document Type for Take Workgroup Authority Doc.
  • description: this Document Type is used to decide authorized workgroup by Document Type.
  • label: this document type is recognized as TakeWorkgroupAuthorityDoc type.
  • postProcessorName: the postProcessor for this document type is edu.iu.uis.eden.postprocessor.DefaultPostProcessor.
  • superUserWorkgroupName: the superUsers for this Document Type are members of the TestWorkgroup.
  • blanketApproveWorkgroupName: the members of the TestWorkgroup have blanketApprove right on this type of document.
  • defaultExceptionWorkgroupName: the members of the TestWorkgroup will get Exception notice on exceptions of documents of this Document Type.
  • docHandler: the Doc Handler for this type of document is "_blank".
  • active: this Document Type is currently active, namely, it is in use.
  • Policies for this Document Type contain two policies:
    • The PRE_APPROVE policy is set false by default. Namely, the defualt pre-approve action on this type of document is not to approve it.
    • The DEFAULT_APPROVE policy is set false by default. Namely, the defualt approve action on this type of document is not to approve it.
  • routePath: the routing path for this Document Type is: AdHoc -> WorkflowDocument.
  • routeNode: based on the routePath, there are two nodes in the routing of this Document Type:
    • the starting node for this Document Type is AdHoc, on the initiation of a document of this type, the postProcessor in Kuali Enterprise Workflow activate the node AdHoc.
    • the next node in the routing for this Document Type is WorkflowDocument, on the request, the node is activated and applies rules in rule template WorkflowDocumentTemplate.

      KULRICE092:Back To Document Types

MoveSequentialTest
  • name: this is the Document Type for Move Sequential Test.
  • Parent: the parent Document Type is BlanketApproveTest. This Document Type inherits the policies that NotificationTest has.
  • description: this Document Type is used to test Move Sequence.
  • label: this document type is recognized as MoveSequentialTest type.
  • postProcessorName: the postProcessor for this document type is edu.iu.uis.eden.postprocessor.DefaultPostProcessor.
  • superUserWorkgroupName: the superUsers for this Document Type are members of the TestWorkgroup.
  • blanketApproveWorkgroupName: the members of the TestWorkgroup have blanketApprove right on this type of document.
  • defaultExceptionWorkgroupName: the members of the TestWorkgroup will get Exception notice on exceptions of documents of this Document Type.
  • docHandler: the Doc Handler for this type of document is "_blank".
  • active: this Document Type is currently active, namely, it is in use.
  • routePath: the routing path for this Document Type is: AdHoc -> WorkflowDocument -> WorkflowDocument2 -> Acknowledge1 -> Acknowledge2.
  • routeNode: based on the routePath, there are five nodes in the routing of this Document Type:
    • the starting node for this Document Type is AdHoc, on the initiation of a document of this type, the postProcessor in Kuali Enterprise Workflow activate the node AdHoc.
    • the next node in the routing for this Document Type is WorkflowDocument, on the request, the node is activated, applies rules in rule template WorkflowDocumentTemplate, and sets the mandatory route as true, namely the document must route through this node.
    • the next node in the routing for this Document Type is WorkflowDocument2, on the request, the node is activated, applies rules in rule template WorkflowDocument2Template, and sets the mandatory route as true, namely the document must route through this node.
    • the next node in the routing for this Document Type is Acknowledge1, on the request, the node is activated and applies rules in rule template Ack1Template.
    • the next node in the routing for this Document Type is Acknowledge2, on the request, the node is activated and applies rules in rule template Ack2Template.

      KULRICE092:Back To Document Types

MoveInProcessTest
  • name: this is the Document Type for Move In Process Test.
  • Parent: the parent Document Type for this Document Type is BlanketApproveTest. This Document Type inherits the policies that NotificationTest has.
  • description: this Document Type is used to test Move In Pprocess.
  • label: this document type is recognized as MoveInProcessTest type.
  • postProcessorName: the postProcessor for this document type is edu.iu.uis.eden.postprocessor.DefaultPostProcessor.
  • superUserWorkgroupName: the superUsers for this Document Type are members of the workgroup TestWorkgroup.
  • blanketApproveWorkgroupName: the members of the workgroup TestWorkgroup have blanketApprove right on this type of document.
  • defaultExceptionWorkgroupName: the members of the workgroup TestWorkgroup will get Exception notice on exceptions of documents of this Document Type.
  • docHandler: the Doc Handler for this type of document is _blank.
  • active: this Document Type is currently active, namely, it is in use.
  • routePath: the routing path for this Document Type is: AdHoc -> WorkflowDocument -> MyRadSub Process -> WorkflowDocument2 -> WorkflowDocument3 -> WorkflowDocumentFinal. There is a sub-process MyRadSubProcess in this path.
  • routeNode: as can be seen from the routePath, there are five nodes in the routing of this Document Type:
    • the starting node for this Document Type is AdHoc, on the initiation of a document of this type, the postProcessor in Kuali Enterprise Workflow activate the node AdHoc.
    • the next node in the routing for this Document Type is WorkflowDocument, on the request, the node is activated, applies rules in rule template WorkflowDocumentTemplate, and initiates a subprocess MyRadSubProcess.
    • the next node in MyRadSubProcess for this Document Type is WorkflowDocument2, on the request, the node is activated and applies rules in rule template WorkflowDocument2Template.
    • the next node in MyRadSubProcess for this Document Type is WorkflowDocument3, on the request, the node is activated and applies rules in rule template WorkflowDocument3Template.
    • the next node in the routing for this Document Type is WorkflowDocumentFinal, on the request, the node is activated and applies rules in rule template WorkflowDocumentFinalTemplate.

      KULRICE092:Back To Document Types

AdhocRouteTest
  • name: this is the Document Type for Adhoc Route Test.
  • description: this Document Type is used to test Ad Hoc Route.
  • label: this document type is recognized as AdhocRouteTest type.
  • postProcessorName: the postProcessor for this document type is edu.iu.uis.eden.postprocessor.DefaultPostProcessor.
  • superUserWorkgroupName: the superUsers for this Document Type are members of the TestWorkgroup.
  • blanketApproveWorkgroupName: the members of the TestWorkgroup have blanketApprove right on this type of document.
  • defaultExceptionWorkgroupName: the members of the TestWorkgroup will get Exception notice on exceptions of documents of this Document Type.
  • docHandler: the Doc Handler for this type of document is "_blank".
  • active: this Document Type is currently active, namely, it is in use.
  • routePath: the routing path for this Document Type is: AdHoc -> One.
  • routeNode: based on the routePath, there are two nodes in the routing of this Document Type:
    • the starting node for this Document Type is AdHoc, on the initiation of a document of this type, the postProcessor in Kuali Enterprise Workflow activate the node AdHoc.
    • the next node in the routing for this Document Type is One, on the request, the node is activated by the type S and applies rules in rule template WorkflowDocumentTemplate.

      KULRICE092:Back To Document Types

PreApprovalTest
  • name: this is the Document Type for PreApprovalTest.
  • description: this Document Type is used to test Pre-Approval.
  • label: this document type is recognized as PreApprovalTest type.
  • postProcessorName: the postProcessor for this document type is edu.iu.uis.eden.postprocessor.DefaultPostProcessor.
  • superUserWorkgroupName: the superUsers for this Document Type are members of the TestWorkgroup.
  • blanketApproveWorkgroupName: the members of the TestWorkgroup have blanketApprove right on this type of document.
  • defaultExceptionWorkgroupName: the members of the TestWorkgroup will get Exception notice on exceptions of documents of this Document Type.
  • docHandler: the Doc Handler for this type of document is "_blank".
  • active: this Document Type is currently active, namely, it is in use.
  • routePath: the routing path for this Document Type is: AdHoc -> PreApprovalTestOne.
  • routeNode: based on the routePath, there are two nodes in the routing of this Document Type:
    • the starting node for this Document Type is AdHoc, on the initiation of a document of this type, the postProcessor in Kuali Enterprise Workflow activate the node AdHoc.
    • the next node in the routing for this Document Type is PreApprovalTestOne, on the request, the node is activated by the type S and applies rules in rule template WorkflowDocumentTemplate.

      KULRICE092:Back To Document Types

VariablesTest
  • name: this is the Document Type for VariablesTest.
  • description: this Document Type is used to test Variables.
  • label: this document type is recognized as VariablesTest type.
  • postProcessorName: the postProcessor for this document type is edu.iu.uis.eden.postprocessor.DefaultPostProcessor.
  • superUserWorkgroupName: the superUsers for this Document Type are members of the TestWorkgroup.
  • blanketApproveWorkgroupName: the members of the TestWorkgroup have blanketApprove right on this type of document.
  • defaultExceptionWorkgroupName: the members of the TestWorkgroup will get Exception notice on exceptions of documents of this Document Type.
  • docHandler: the Doc Handler for this type of document is "_blank".
  • active: this Document Type is currently active, namely, it is in use.
  • routePath: the routing path for this Document Type is: AdHoc -> setStartedVar -> setCopiedVar -> preApprovalTestOne -> setEndedVar -> setGoogleVar -> setXPathVar -> resetStartedVar -> logNode -> logNode2.
  • routeNode: based on the routePath, there are ten nodes in the routing of this Document Type:
    • the starting node for this Document Type is AdHoc, on the initiation of a document of this type, the postProcessor in Kuali Enterprise Workflow activate the node AdHoc.
    • the next node in the routing for this Document Type is setStartedVar, its type is "edu.iu.uis.eden.engine.node.var.SetVarNode", its name is "started", and its value is "startedVariableValue".
    • the next node in the routing for this Document Type is setCopiedVar, its type is "edu.iu.uis.eden.engine.node.var.SetVarNode", its name is "copiedVar", and the value it is copying is "var:started".
    • the next node in the routing for this Document Type is preApprovalTestOne, on the request, the node is activated by the type S and applies rules in rule template WorkflowDocumentTemplate.
    • the next node in the routing for this Document Type is setEndedVar, its type is "edu.iu.uis.eden.engine.node.var.SetVarNode", its name is "ended", and its value is "endedVariableValue".
    • the next node in the routing for this Document Type is setGoogleVar, its type is "edu.iu.uis.eden.engine.node.var.SetVarNode", its name is "google", and it links to "http://google.com".
    • the next node in the routing for this Document Type is setXpathVar, its type is "edu.iu.uis.eden.engine.node.var.SetVarNode", its name is "xpath", and it adds "//documentContent" to the current path.
    • the next node in the routing for this Document Type is resetStartedVar, its type is "edu.iu.uis.eden.engine.node.var.SetVarNode", its name is "started", and it resets the started node at a new node "aNewStartedVariableValue".
    • the next node in the routing for this Document Type is logNode, its type is "edu.iu.uis.eden.engine.node.LogNode", and it sends a message about the xpath of the variables at "var:xpath".
    • the next node in the routing for this Document Type is logNode2, its type is "edu.iu.uis.eden.engine.node.LogNode", its level is "ErRoR", and it opens the log "Custom.Logger.Name" and returns a message "THAT'S ALL FOLKS".

      KULRICE092:Back To Document Types

SUApproveDocumentNotifications
  • name: this is the Document Type for SuperUser Approve Document Notifications.
  • description: this Document Type is used to test the SuperUser Approve Document Notifications.
  • label: this document type is recognized as SUApproveDocumentNotifications type.
  • postProcessorName: the postProcessor for this document type is edu.iu.uis.eden.postprocessor.DefaultPostProcessor.
  • superUserWorkgroupName: the superUsers for this Document Type are members of the TestWorkgroup.
  • blanketApproveWorkgroupName: the members of the TestWorkgroup have blanketApprove right on this type of document.
  • defaultExceptionWorkgroupName: the members of the TestWorkgroup will get Exception notice on exceptions of documents of this Document Type.
  • docHandler: the Doc Handler for this type of document is "_blank".
  • active: this Document Type is currently active, namely, it is in use.
  • There is just one policy for this Document Type:
    • The SEND_NOTIFICATION_ON_SU_APPROVE policy is set true by default. Namely, notifications will be automatically sent on SuperUser's approval.

KULRICE092:Back To Document Types

DynSeqDocType
  • name: this is the Document Type for DynSeqDocType.
  • parent: the parent Document Type is DynDocType.
  • description: this Document Type is used for dynamic routing Document Type.
  • label: this document type is recognized as DynSeqDocType.
  • postProcessorName: the postProcessor for this document type is edu.iu.uis.eden.postprocessor.DefaultPostProcessor.
  • superUserWorkgroupName: the superUsers for this Document Type are members of the TestWorkgroup.
  • blanketApproveWorkgroupName: the members of the TestWorkgroup have blanketApprove right on this type of document.
  • defaultExceptionWorkgroupName: the members of the TestWorkgroup will get Exception notice on exceptions of documents of this Document Type.
  • docHandler: the Doc Handler for this type of document is "_blank".
  • active: this Document Type is currently active, namely, it is in use.
  • routePath: the routing path for this Document Type is:
    Initial->First>DynSeq->Last.
    In the DynSeq node there is SubRequests for dynamic routing nodes.
  • routeNode: based on the routePath, there are at least four nodes in the routing of this Document Type because of the dynamic routing feature:
    • the starting node for this Document Type is Initial, on the initiation of a document of this type, the postProcessor in Kuali Enterprise Workflow activate the node Initial.
    • the next node in the routing for this Document Type is First, on the request, the node is activated and applies rules in rule template First.
    • the next node in the routing for this Document Type is DynSeq, its type is edu.iu.uis.eden.engine.DynamicRoutingTest$MockSequentialDynamicNode, and it will dynamically route the document.
    • the next node in the routing for this Document Type is SubRequests, on the request, the node is activated and applies rules in rule template SubRequests.
    • the next node in the routing for this Document Type is Last, on the request, the node is activated and applies rules in rule template Last.

      KULRICE092:Back To Document Types

Document Type Policies

A list of current document type polices is shown below:

  1. DISAPPROVE
  2. DEFAULT_APPROVE
  3. PRE_APPROVE
  4. INITIATOR_MUST_ROUTE
  5. INITIATOR_MUST_SAVE
  6. INITIATOR_MUST_CANCEL
  7. INITIATOR_MUST_BLANKET_APPROVE
  8. LOOK_FUTURE
  9. SEND_NOTIFICATION_ON_SU_APPROVE
  10. SUPPORTS_QUICK_INITIATE
  11. NOTIFY_ON_SAVE
  12. blanketApprovePolicy

The majority of Document Type Policies are defined in the Document Type XML in the following manner:

KULRICE092:Back To Top

DISAPPROVE

The disapprove policy determines whether a document will stop for further routing transaction. When a document has been disapproved, the document initiator and previous approvers will received acknowledge of this disapproval action.

DEFAULT_APPROVE

The default-approve policy determines whether a document will processed with or without any approval requests. If a document is set for without any approval requests, it will be put into the exception routing. The document will route to the exception workgroup associated with the last route node or the workgroup defined in the 'defaultExceptionWorkgroupname'.

PRE_APPROVE

The pre-approve policy indicates the approval status before the routing process begins. The default setting for the pre-approve policy is false for any document routings.

INITIATOR_MUST_ROUTE

The initiator-must-route policy determines if the user initiated a document must 'route' the document when it is in the initiated state.

INITIATOR_MUST_SAVE

The initiator-must-save policy determines if the user initiated a document would be the only one authorized to 'save' the document.

INITIATOR_MUST_CANCEL

The initiator-must-cancel policy determines if the user initiated a document would be the only one authorized to 'cancel' the document.

INITIATOR_MUST_BLANKET_APPROVE

The initiator-must-blanket-approve policy determines if the user initiated a document would be the only one authorized to 'blanket approve' the document.

LOOK_FUTURE

The look-future policy determines whether the document can be brought into a simulated route from the route log. A simulation of where the document would end up if it completed the route.

SEND_NOTIFICATION_ON_SU_APPROVE

The send-notification-on-su-approve policy indicates whether to send a notification on super user approve.

SUPPORTS_QUICK_INITIATE

The supports-quick-initiate policy indicates whether the document type should be displayed on the Quick Links so that users can quickly initiate instances of the document.

NOTIFY_ON_SAVE

The notify-on-save policy indicates whether a notification should happen in the case of a request generated as the result of a SAVE action on this document type.

blanketApprovePolicy

The blanket approve policy indicates who can blanket approve a workflow document. It indicates either ANY or NONE. ANY means that anybody can blanket approve the document. On the other hand, NONE means that nobody can blanket approve the document. Alternatively, they can specify a blanketApproveWorkgroupName which indicates that members of that workgroup can blanket approve the document. Only one of blanketApprovePolicy and blanketApproveWorkgroupName can be specified.

Since the blanket approve policy is not a true/false policy (like the others) it is simply specified as an element in the Document Type XML:

KULRICE092:Back To Top

Inheritance

Document Types can specify a "parent" document type. This allows them to be included in a document type hierarchy from which certain behavior can be in inherited from their parent document type.

Inheritable Fields

Here are the fields that are inherited:

  • blanketApproveWorkgroupName: Indicates members of the workgroup can blanket approve the document.
  • blanketApprovePolicy: Indicates who can blanket approve a workflow document. "Any" means anybody can, "None" means nobody can.
  • notificationFromAddress: Sends a notification notice to the sender when the transfer of the document is completed.
  • messageEntity: A head and body of the message.
  • policies: Indicates a set of rule(s) applied in the document. For each policy, "True" means policy does apply, "False" means policy does not apply.
  • searchable attributes: Assigned constraint(s) to be the searchable criteria for a document.
  • route paths/route nodes: Designated traveling points before the document reaches its destination in a routing process.

Special notes about inheritance:

  1. Policies – in the policies section there are multiple document type policies (INITAITOR_MUST_ROUTE, DEFAULT_APPROVE, etc), each policy can be overridden on an individual basis. In contrast to the route path, there is no need to override the entire policies section for that document type. For more detail information about document type polices, please refers to KULRICE092:Document Type Policies.
  2. Route paths/ route nodes – If it is desired to override the rote path and route nodes definitions of a parent document type, the entire route nodes and route paths definitions will be overridden. It is prohibited to inherit and use just a portion of a route path; it's all or nothing.

Document Type hierarchy and the rule engine

When the rules engine determines its rule evaluation set at a particular node, a step-by-step process is executed for a particular Document Type:

  1. Look at the Rule Template name of the current node and select all rules with the template and the document's Document Type and add those rules to the rule evaluation set.
  2. If the Document Type has a parent Document Type, select all rules with the template and the parent Document Type and add those to the rule evaluation set.
  3. Repeat step 2 until the root of the document type hierarchy is reached.
  4. Final rule evaluation set will include all of these rules.

KULRICE092:Back To Top

  • No labels