Workitem Linking

Imixs-Office-Workflow provides a way to link workitems together. This means a workitem can point to another workitem which may have a different workflow. The link is defined by the linked $uniqueId and is stored in the item $workitemref. The list of linked workitems is defined by the following Lucene Query:

  (type:"workitem") AND ($workitemref: "<$UNIQUEID>")

To set a new linked workitem in a form you can use the custom formpart ‘workitemlink’. See the following example:

<item name="project.ref"
      type="custom"
      path="workitemlink"
      readonly="false"
      options="$workflowgroup:Projekt"
      label="Project:" />

The user can enter a search phrase to search for a workitem within the index. With the attribute options an optional search filter can be specified. The tag name is used to hold a list of linked workitems of this type.

If you set readonly="true" the formpart shows only a list of linked workitems.

The workitems linked directyl for the current workitem are also called ‘outbound workitmes’

Display Inbound Workitem Links

It is also possible to display a list of inbound linked workitems. These are workitems holding a reference to the current workitem instance.

<item name="project.ref"
      type="custom"
      path="workitemlink_inbound"
      readonly="false"
      options="$workflowgroup:Projekt"
      label="Project:" />

Note: The inbound linked workitems can only be refered by the item $workitemref. The attribute ‘name’ is in this case not relevant and will be ignored.

Table Layout

The linked workitems can also be displayed in a table layout:

Use the part workitemreftable :

<item name="payment.ref"
      type="custom"
      path="workitemlink_outbound_table"
      options="($workflowgroup:Payment) "
      label="Payments" />

Or to display inbound linked workitems use:

<item name="payment.ref"
      type="custom"
      path="workitemlink_inbound_table"
      options="($workflowgroup:Payment) "
      label="Payments" />

Copy Data

Optional you can copy a list of items from the linked workitem into the current workitem. Therefore use the plugin

org.imixs.workflow.office.plugins.WorkitemLinkPlugin

The plugin can be configured by the following workflow result definition:

<workitemlink name="copydata">
	<ref>payment.ref</event>
	<items>customer.name, customer.number</items>
      <debug>false</debug>
</workitemlink>

This definition copies the items ‘customer.name’ and ‘customer.number’ from the workitem referred by ‘payment.ref’ into the current workitem.

To avoid name conflicts, the item name can be mapped to a different name by separating the new name with the ‘|’ char.

   <items>customer.name|contact.name</items>

In this example the item customer.name will be copied into the target workitem with the new item name contact.name . Copy Items by Regex

The items tag also supports regular expression. See the following example with will copy all items starting with ‘customer.’:

<workitemlink name="copydata">
	<ref>payment.ref</event>
  <items>(^customer\.)</items>
</workitemlink>

A regular expression must always be included in brackets.

Note: In case of a regular expression you can not use item name mapping with the ‘|’ character.

The option <debug>true</debug> prints details of the copy process into the server log

Layout and CSS

There are different CSS classes defined wthin the imixs-marty.css file. You can overwrite the layout of the workitemlink widget.

marty-workitemlink - defines the main widget container
marty-workitemlink-referencebox - containing the reference workitem entries
marty-workitemlink-referencebox-entry - a single workitem entry
marty-workitemlink-inputbox - container with the input field
marty-workitemlink-resultlist - the container where the suggest result is presented
marty-workitemlink-resultlist-entry - a single workitem entry