Kuali Rice eDocLite

UC Davis, Information & Educational Technology

Agenda

1. Overview

2. Step through an sample eDocLite

3. Look through some of the code behind the sample eDocLite

Overview1. eDocLite allows quick document building and integration with

workflow using only XML

2. Is a component of Kuali Enterprise Workflow

3. Runs on the central Rice servers.

4. Providing access to eDocLite forms is as easy as URL

5. Development team will work on a style/skin to match the UC Davis web template

6. All Documents are searchable on the Rice servers.

eDocLite in Action

Requester searches for the relevant Document and initiates a request.

Requester fills out the form and clicks “route”.

This initiates the workflow.

Based on some rules, the workflow routes the Document to the next appropriate responsible party.

The Document lands in the Action List of someone who is a member of a group who has approval responsibility.

The current status of the Document is ENROUTE.

This Approver opens Document 2220.

The Approver inspects the Document.

After finding that the information in the form is acceptable, the Approver clicks “approve”.

This Document moves forward in the workflow.

The Document lands back in the Action List of the Requester.

The current status of the Document is PROCESSED.

At this stage, we’re asking the Requester to acknowledge that the request has been fulfilled.

The Requester clicks “acknowledge”.

The workflow is thus finished.

The status of the Document is now FINAL.

We can view the routing log of each Document.

eDocLite Behind the Scenes

Parent Document<documentTypes xmlns="ns:workflow/DocumentType"

xsi:schemaLocation="ns:workflow/DocumentType resource:DocumentType"><documentType>

<name>RequestFirewallChange.eDoc.ParentDocType</name><description>eDocLite Parent Document Type</description><label>Request Firewall Change eDocLite Parent Document Type</label><blanketApprovePolicy>NONE</blanketApprovePolicy><docHandler>${workflow.url}/EDocLite</docHandler><active>true</active><routingVersion>2</routingVersion>

</documentType></documentTypes>

A Document Type that has attributes that are to be inherited by all associated Child Document Types.

Child Document<documentTypes xmlns="ns:workflow/DocumentType"

xsi:schemaLocation="ns:workflow/DocumentType resource:DocumentType"><documentType>

<name>RequestFirewallChange.eDoc.ChildDocType</name><parent>RequestFirewallChange.eDoc.ParentDocType</parent><routePaths>

<routePath> </routePath>

</routePaths> <routeNodes>

<start name="Request"> <activationType>P</activationType></start><requests name="FinalApproval"></requests><requests name="AcknowledgeConfiguration"></requests>

</routeNodes></documentType>

</documentTypes>

A Document Type defines the nodes of the workflow and the actions being requested in each node.

eDocLite Form<edoclite xmlns="ns:workflow/EDocLite" xsi:schemaLocation="ns:workflow/EDocLite

resource:EDocLite">

<edl name="RequestFirewallChange.eDoc.Form" title="Request Firewall Change"> ... ...</edl>

<style name="RequestFirewallChange.eDoc.Style">...

...</style>

<association><docType>RequestFirewallChange.eDoc.ChildDocType</docType><definition>RequestFirewallChange.eDoc.Form</definition><style>RequestFirewallChange.eDoc.Style</style>

<active>true</active> </association>

</edoclite>

<edl> defines the fields on the form.

<style> defines the layout using HTML tags

<association> binds the form to a Document Type

Rule Attributes<ruleAttributes xmlns="ns:workflow/RuleAttribute" xsi:schemaLocation="ns:workflow/RuleAttribute

resource:RuleAttribute"><ruleAttribute>

<name>RequestFirewallChange.eDoc.isUrgent.RuleAttribute</name> <className>edu.iu.uis.eden.routetemplate.xmlrouting.StandardGenericXMLRuleAttribute</className>

<label>Request Firewall Change Is Urgent Rule Attribute</label> <description>Request Firewall Change Is Urgent Rule Attribute</description>

<type>RuleXmlAttribute</type> <routingConfig> <fieldDef name="isUrgent" title="URGENT" workflowType="ALL">

<display> <type>select</type> <values title="NO">NO</values> <values title="YES">YES</values> </display> <validation required="true" /> <fieldEvaluation> <xpathexpression>//isUrgent =

wf:ruledata('isUrgent')</xpathexpression> </fieldEvaluation> </fieldDef> <xmlDocumentContent> <isUrgent>%isUrgent%</isUrgent> </xmlDocumentContent> </routingConfig> </ruleAttribute></ruleAttributes>

Rule Attributes define items (typically values in a field), that are to be evaluated by the workflow.

They are associated with Rule Templates and Forms.

Rule Templates<ruleTemplates xmlns="ns:workflow/RuleTemplate" xsi:schemaLocation="ns:workflow/RuleTemplate

resource:RuleTemplate"><ruleTemplate>

<name>RequestFirewallChange.eDoc.InitialApproval.RuleTemplate</name> <description>Initial Approval RuleTemplate</description> <attributes> <attribute>

<name>RequestFirewallChange.eDoc.isUrgent.RuleAttribute</name> <required>true</required> </attribute> </attributes>

</ruleTemplate><ruleTemplate>

<name>RequestFirewallChange.eDoc.FinalApproval.RuleTemplate</name> <description>Final Approval RuleTemplate</description> <attributes> <attribute> <name>RequestFirewallChange.eDoc.isUrgent.RuleAttribute</name> <required>true</required> </attribute> </attributes>

</ruleTemplate></ruleTemplates>

Rule Templates are associated with Route Nodes.

Rule Attributes bind Rule Attributes to nodes in the workflow.

Routing Rules<rules xmlns="ns:workflow/Rule" xsi:schemaLocation="ns:workflow/Rule resource:Rule">

<rule> <documentType>RequestFirewallChange.eDoc.ChildDocType</documentType> <ruleTemplate>RequestFirewallChange.eDoc.InitialApproval.RuleTemplate</ruleTemplate> <description>Initial Approval By Firewall SysAdmin Rule</description> <ignorePrevious>false</ignorePrevious> <ruleExtensions> <ruleExtension> <attribute>RequestFirewallChange.eDoc.isUrgent.RuleAttribute</attribute> <ruleTemplate>RequestFirewallChange.eDoc.InitialApproval.RuleTemplate</ruleTemplate> <ruleExtensionValues> <ruleExtensionValue> <key>isUrgent</key> <value>YES</value> </ruleExtensionValue> </ruleExtensionValues> </ruleExtension>

</ruleExtensions> <responsibilities> <responsibility> <workgroup>ucd.IET.DCCS.FirewallSysAdmin.Workgroup</workgroup> <actionRequested>A</actionRequested> <priority>1</priority> </responsibility> </responsibilities> </rule><rules>

Routing Rules determine the direction of the workflow.

The meat of a rule is comprised of Action Requested, Responsible Group, and one or more Rule Attributes.

eDocLite Dependency Hierarchy

Information Sources• Kuali Foundation: (http://www.kuali.org)

• Kuali Rice• Hampton Sublett (hbsublett@ucdavis.edu)• Curtis Bray (clbray@ucdavis.edu)

• UCD Kuali Rice Wiki: (https://confluence.ucdavis.edu/confluence/x/O4C3)