Kuali Rice Development
  1. Kuali Rice Development
  2. KULRICE-943

Update workgroup documentation to include Workgroup types and configuration

    Details

    • Type: Task Task
    • Status: Closed Closed
    • Priority: Major Major
    • Resolution: Fixed
    • Affects Version/s: None
    • Fix Version/s: Documentation
    • Component/s: Documentation
    • Labels:
      None
    • Similar issues:
      KULRICE-941Update workgroup documentation to include workgroup nesting
      KULRICE-1113Document the Workgroup Type Lookup screen
      KULRICE-6259Document Workgroups - Technical Guide
      KULRICE-2567Update KEN Recipient tables to use Kim Types instead of KEN "USER" and "WORKGROUP"
      KULRICE-6247Document Workgroups - User Guide
      KULRICE-1154add methods to identify all of the workgroups that are associated with a particular document types (or set of document types specified by parent)
      KULRICE-1862Add a reporting workgroup to the Document Type definition
      KULRICE-3417Fix XML syntax in workflow rules and document types where "workgroups" are currently being referred to
      KULRICE-1785Verify that Remove/Replace document bootstrap configuration is correct
      KULRICE-1162Ad Hoc Routing - Clarify Error message when User or Workgroup is not active (vs invalid)

      Description

      We added the ability to define Workgroup Types in the latest version of KEW. This essentially allows for 2 things:

      1) the ability to attach custom data to a workgroup
      2) the ability to specify a custom Document Type definition to use when routing the workgroup

      This allows for decentralization of workgroup routing (i.e. we can route different types of workgroup to different people, even based on the custom data that may be attached to the workgroup)

      Here's what we will want to document regarding Workgroup Types:

      The Functional Perspective:

      In KFS they have defined a Chart Org workgroup type (this is just a workgroup with a Chart Code and Organization Code attached to it, like BL and BUS for the bloomington business school, etc.) we can use this as an example for the functional documentation. Just be sure to note that, out of the box, the only workgroup type which is available is the "Default" type. Any other custom ones have to be built and configured by the KEW admins. This functional documentation should show an example of creating a workgroup with this KFS "Chart Org" type. Also be sure to show how these changes affect the Workgroup Lookup screen. Also document the Workgroup Type lookup (available under the Administration section in the workflow portal now).

      The Technical Perspective:

      From the technical perspective, we'll want to document the process for creating a new workgroup type. This essentially involves the following steps:

      1) If the workgroup is going to include custom fields, an ExtensionAttribute will need to be written and made available to the system (see https://test.kuali.org/fisheye/viewrep/~raw,r=1.2/wsa123/kuali_project/work/src/org/kuali/workflow/attribute/ChartOrgExtensionAttribute.java)
      2) The workgroup type needs to be configured in XML. See the Workgroup TYpe schema (https://test.kuali.org/fisheye/viewrep/~raw,r=1.1.6.2/wsa123/workflow/src/schema/WorkgroupType.xsd). Here's an example of the XML used in KFS for the Chart Org type:

      <workgroupType>
      <name>ChartOrgWorkgroup</name>
      <label>Chart Org</label>
      <description>Workgroups with associated Chart and Org codes</description>
      <documentType>ChartOrgWorkgroup</documentType>
      <attributes>
      <attribute>
      <name>ChartOrgExtensionAttribute</name>
      </attribute>
      </attributes>
      </workgroupType>

      The attribute XML for ChartOrgExtensionAttribute would be:

      <ruleAttribute>
      <name>ChartOrgExtensionAttribute</name>
      <className>org.kuali.workflow.attribute.ChartOrgExtensionAttribute</className>
      <label>Chart Org Extension Attribute</label>
      <description>Chart Org Extension Attribute</description>
      <type>ExtensionAttribute</type>
      </ruleAttribute>

      3) If custom routing is required, than the document type and routing for that document type needs to be built. Be sure to document the format of the XML that is generated so that those implementing custom routing for their workgroup types can do so. Heres an example for one of the KFS Chart Org workgroups:

      <documentContent><applicationContent><workgroups xmlns="ns:workflow/Workgroup" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="ns:workflow/Workgroup resource:Workgroup">
      <workgroup>
      <workgroupName>ChartOrgWorkgroupNumber1</workgroupName>
      <description>This is the Workgroup's description.</description>
      <workgroupType>ChartOrgWorkgroup</workgroupType>
      <extensions>
      <extension attribute="ChartOrgExtensionAttribute">
      <data key="chartOfAccountsCode">BL</data>
      <data key="organizationCode">BUS</data>
      </extension>
      </extensions>
      <members>
      <authenticationId>dfogle</authenticationId>
      <workgroupName>WorkflowAdmin</workgroupName>
      </members>
      </workgroup>
      </workgroups></applicationContent></documentContent>

        Activity

        Hide
        Chiakang Chou (Inactive) added a comment -

        I update the "Workgroup Guide" with WorkgroupType information, and create an additional "WorkgroupType Configuration Guide" on the confluence page.

        Workgroup Guide
        https://test.kuali.org/confluence/display/KEW/Workgroup+Guide

        WorkgroupTyep Configuration Guide
        https://test.kuali.org/confluence/display/KEW/WorkgroupType+Configuration+Guide

        Show
        Chiakang Chou (Inactive) added a comment - I update the "Workgroup Guide" with WorkgroupType information, and create an additional "WorkgroupType Configuration Guide" on the confluence page. Workgroup Guide https://test.kuali.org/confluence/display/KEW/Workgroup+Guide WorkgroupTyep Configuration Guide https://test.kuali.org/confluence/display/KEW/WorkgroupType+Configuration+Guide

          People

          • Assignee:
            Chiakang Chou (Inactive)
            Reporter:
            Eric Westfall
          • Votes:
            0 Vote for this issue
            Watchers:
            0 Start watching this issue

            Dates

            • Created:
              Updated:
              Resolved:

              Structure Helper Panel