IBM Support

How do I get property values for a Business Automation Workflow process to be displayed in an in-basket after you apply fix for APAR JR64631

How To


Summary

In-basket improvements related to how Business Automation Workflow process work items is displayed and organized in the in-basket were added with APAR JR64631 and pre-req JR64557.
The improvements include the following
- New design architecture implemented for Business Automation Workflow process work items to retrieve and display business (case and activity) properties values in the In-basket columns.
- Fixed filtering and sorting with business(case and activity) properties for Business Automation Workflow process work items in In-baskets.
- Provides a configuration to show only claimed work items in the personal (My Work) in-basket

This document discusses the changes and how to set up the properties correctly so that they are displayed in an in-basket and allow users to be able to filter and sort the work items. This document also discusses the limitations of the implementation.

Steps

Enabling Business Automation Workflow process properties for sorting and filtering in an in-basket
For case properties associated with Business Automation Workflow process work items to be displayed correctly and allow users to filter and sort the results correctly, you must perform the following steps:
  1. Enable "Automatically sync shared business objects" for each activity processes
    image-20220428154707-1
  2. For each case property (case or activity property) on the activity process, which is exposed as a column or filter in any of the In-baskets, enable "Expose in work environments" flag on the property.AddAlias
  3. An alias name must be given to each case property.  The alias name must have the following notations:
    • Prefix “CF_” for case properties to the actual symbolic name of property in the content object reference or unique identifier for the case property
    • Prefix “CT_” for activity properties to the actual symbolic name of property in the content object reference or unique identifier for the case property
    Case Properties created within case solution, having solution prefix
    • CF_<solutionPrefix>_propertyUniqueIdentifier (for example, CF_TST_stringProp1, where TST is the solution prefix)
    Case Properties created that uses a reuse property (property template with no solution prefix)
    • CF_ propertyUniqueIdentifier (for example, CF_stringProp1, where stringProp1 is a reuse property)
    Reused Case Properties from other solutions
    • CF_<originalSolutionPrefix(not current solution)>_propertyUniqueIdentifier (for example, CF_TST2_stringProp1, where TST2_stringProp1 is a property from another solution)
    Activity Properties created within the case solution, having solution prefix
    • CT_<solutionPrefix>_ propertyUniqueIdentifier (for example, CT_TST_stringProp1, where TST is the solution prefix)
    Activity Properties created that uses a reuse property (property template with no solution prefix)
    • CT_ propertyUniqueIdentifier (for example, CT_stringProp1, where stringProp1 is a reuse property)
    Reused Activity Properties from other solutions
    • CT_<originalSolutionPrefix(not current solution)>_propertyUniqueIdentifier (for example, CT_TST2_stringProp1, where TST2_stringProp1 is a property from another solution)
    Repeat steps 1-3 for all the Business Automation Workflow activity processes in a case solution.
     
    Specific to the JR64631 interim fix, the alias has a limitation of 30 characters.  The interim fix supports only 30-character property alias (including the prefix CF_ or CT_ along with solution prefix if any) in order to be able to filter and sort the work items. The property name along with notation mentioned above must be same within the 30-character limit or the sorting and filtering would not be applied. Also, the column values for the exposed case or activity property in the in-baskets would be blank.
  4. Once the aliases are specified for the case or activity properties for the processes, the following one-time action needs to be performed.
    1. Open the following rest api - /rest/bpm/wle/v1/searches/tasks/meta/businessDataFields (Ex: https://ip:port/rest/bpm/wle/v1/searches/tasks/meta/businessDataFields)
    2. For already created aliases the following might be seen, ex:
      image-20220428164041-1
      image-20220428172017-1
    3. The new format of alias result needs to be generated for case or activity content objects, to generate, a touch save needs to be performed for the processes holding the content object aliases
    4. Verify the rest api generated after save.
      image-20220428172025-2
      image-20220428172034-3
    5. Make sure the new format alias result is generated for mapped column case and activity properties. If required, do save again.
    6. This action needs only to be performed one-time.
Note:
  • The alias configured would be applied only for the new process instances. For existing running work items of created instances, the values would be empty.
  • All properties of sort and filter columns defined in the solution In-baskets need to be configured with an alias.
  • For the same case or activity property used across different processes within a solution, the alias names must match.
  • Do not modify alias names post indexing and in subsequent snapshots.
  • Do not define alias names for Case content object properties (case and activity properties) similar to any of the non-case related variables across the processes.
  • The case client plug-in configuration setting of "Maximum number of IBM Business Automation Workflow process Work items retrieved when filter applied in In-basket"  is obsolete
  • The case client plug-in configuration setting of "Number of Work items in In-basket page" remains unchanged and continues to function.
Filter limitations:
  • Float data type, filtering and sorting works only for 2 decimal points
  • Case Identifier, Case Type, Case Stage property columns are not supported for process work items.  If defined, the values for the columns are empty and thus no sorting or filtering can be applied.  Support for these columns is to be added with v22.0.2.
  • The current interim fix does not support properties (case or activity) for Business Automation Workflow processes that is external to a case solution
  • "Is Like" is an expensive content search operator and can have performance impact
Supported operator mappings for data types:
String:

Case Client Filter Operator

Process work item or API support

Is equal

Yes

Is like

Yes

Is not equal

Yes

Is not like

Not supported

Is greater than

Yes

Is greater than or equal

Not supported but works same as Is greater than

Is less than

Yes

Is less than or equal

Not supported but works same as Is less than
Boolean:

Case Client Filter Operator

Process work item or API support

Is equal

Yes

Is not equal

Yes
Integer:

Case Client Filter Operator

Process work item or API support

Is equal

Yes

Is not equal

Yes

Is greater than

Yes

Is greater than or equal

Not supported but works same as Is greater than

Is less than

Yes

Is less than or equal

Not supported but works same as Is less than
Float:

Case Client Filter Operator

Process work item or API support

Is equal

Yes

Is not equal

Yes

Is greater than

Yes

Is greater than or equal

Not supported but works same as Is greater than

Is less than

Yes

Is less than or equal

Not supported but works same as Is less than
Date:

Case Client Filter Operator

Process work item or API support

Is equal

Yes

Is not equal

Yes

Is greater than

Yes

Is greater than or equal

Not supported but works same as Is greater than

Is less than

Yes

Is less than or equal

Not supported but works same as Is less than
Business Automation Workflow process due date column is now correctly mapped to 'timeout'
  • Business Automation Workflow process work items due date column is fixed.
  • The equivalent column to show the due date for Process work items is "Timeout".
Show only Claimed work items in the personal (My work) In-basket
  • A new configuration is added to In-basket widget.  The new configuration is named 'Only include a users assigned tasks in the personal in-basket'.
  • This setting applies specifically to Business Automation Workflow process work items.
  • The default is not checked.  When not enabled, the personal in-basket (My Work) displays unclaimed or unassigned work items from roles or teams that the user belongs to.
  • If the configuration is enabled, the personal in-basket(My Work) shows only claimed or assigned process work items.
Note:
  • Unclaimed External process work items or work items with existing processes might not be displayed
More than 500 process work items in each In-basket
  • To display process work items in an in-basket, a search is issued against the Business Automation Workflow server to get the result set.
  • The default number of work items returned from a process work item search is 500.
  • Refer to Tuning Process Portal searches for more information on how to further tune this value.

Document Location

Worldwide

[{"Type":"MASTER","Line of Business":{"code":"LOB45","label":"Automation"},"Business Unit":{"code":"BU059","label":"IBM Software w\/o TPS"},"Product":{"code":"SS8JB4","label":"IBM Business Automation Workflow"},"ARM Category":[{"code":"a8m0z000000cwFFAAY","label":"Case Management-\u003ECase Client\/App Usage"}],"ARM Case Number":"","Platform":[{"code":"PF025","label":"Platform Independent"}],"Version":"21.0.3"}]

Document Information

Modified date:
10 October 2022

UID

ibm16576761

Page Feedback