Chapter 3. Workflow cleanup log
When you start the application server or process server for the first time after you install IBM TRIRIGA Application Platform, a workflow validation process is initiated. This process identifies and reports any issues that might keep the workflows from running as expected. The log report is named
WorkflowCleanup.log
.
The workflow validation process runs for only one time, when you start the server for the first time after installation. The process reports any issues with published workflows that require a user action to resolve, and any issues that are repaired automatically. After the process is completed, you can review the log report to understand which workflows were updated and which workflows might need your attention.
The log report is written to the log directory of the IBM TRIRIGA installation. For example, on Windows, C:\Tririga\log\WorkflowCleanup.log is the typical location.
Log format
The format of the log report can contain as many as three main sections. The first section indicates that the process ran and completed. The second section lists any issues and related workflows that cannot be repaired automatically. The third section lists any issues and related workflows that were repaired automatically.
Similar issues are listed together. Within an issue, the workflows are ordered by module, business object, and workflow name. Many of the issues provide more information to help you locate the specific step that needs review or repair. A workflow might be listed more than one time, depending on what issues were found and what repairs were made. It is also possible for a workflow that was retired by the process (because of an irreparable issue) to contain more issues than what was reported.
Log example
The following sample comes from a WorkflowCleanup.log report, and highlights the three main sections:
Workflow cleanup and repair processing pass 1.
Workflow cleanup and repair processing pass 2.
Workflow cleanup and repair completed in 2 passes.
The following problems could not be completely repaired.
Review the identified workflow(s) and the action taken (if any) and resolve any remaining problems to assure correct workflow execution.
Condition expression is invalid. Review and correct the expression.
Workflow:19124805.14 Module=exModule1 BO=-Any- Name=’exModule1 - condition’
Invalid Expression[p0 == == 1] Step:0 Start(1) ’Start’
Retired the workflow because of missing step definitions that could not be repaired.
Workflow:10485177.0 Module=exModule1 BO=exBO
Name=’exModule1 - PRE-CREATE - initialize’
Information about missing definition: Step:100033 Switch(14)
Parent Step:100030 Modify Records(28) ’Update Examples’
© Copyright IBM Corp. 2011, 2015
83
The following problems were repaired.
Review the identified workflow(s) and the resolution to assure correct workflow execution.
Removed the entry from WF_LOOKUP because the workflow is not in a published state.
Workflow:19122518.0 Module=exModule1 BO=-Any- Name=’A New Workflow’
Retired the workflow because there isn’t a corresponding entry in WF_LOOKUP.
Workflow:19122236.2 Module=exModule1 BO=-Any- Name=’Copy of A New Workflow’
Flow control value was invalid. Set step to normal flow (non-swapped).
Review flow and verify this is correct.
Workflow:19139030.0 Module=exModule1 BO=-Any- Name=’exModule1 - Workflow 2’
Invalid flow value was ’REPORT’ Step:206635 Break(21)
Retired the workflow because its Module could not be found.
Workflow:19122928.1 Module=<23549> BO=-Any- Name=’Example Map Source to Section’
Step definition added for End step.
Workflow:10179388.0 Module=exModule1 BO=exBO2
Name=’Delete associated BO Values’
Added the required End step structure and definition information.
Workflow:18412.1 Module=exModule2 BO=exBO3
Name=’exBO3 - Add Values’
Changed step with missing definition to a No-Op.
Workflow:12034842.1 Module=exModule1 BO=-Any-
Name=’exModule1 - exUpdate - Record Update’
Information about missing definition: Step:1000112 Call Workflow(38)
Parent Step:1000100 Fork(13)
Workflow:19111379.6 Module=exModule2 BO=exBO3
Name=’exModule2 – exBO3 - Populate File’
Information about missing definition: Step:205341 Populate File(36)
Parent Step:0 Start(1) ’Start’
Reported issues
The log report might identify issues that the process cannot repair automatically.
When the process cannot repair a workflow automatically, it typically retires the workflow. You can review this log report to repair any issues in the workflows that your business processes require, and publish the revised workflows.
Suggested actions
The following issues cannot be repaired automatically. The table shows the issue that is written to the WorkflowCleanup.log file and the corresponding description and suggested actions.
Issue
Condition expression is invalid. Review and correct the expression.
Retired the workflow because of a block structure error that cannot be repaired.
Description
A workflow condition expression is invalid and the expression cannot be processed. At run time, these conditions are treated as though they are blank. For Start conditions, the workflow is started. For Switch conditions, the expression is always true.
For Break conditions, the Loop or Iteration is stopped. The information for the workflow lists the expression and the task step in which it is contained. The process leaves the workflow in the published state. The workflow must be revised, the expression must be corrected, and the workflow must be republished.
A block structure within the workflow has a problem that makes it invalid and cannot be repaired by the process. The following task types define block structures: Switch, Loop,
Iterator, Fork, and DataConnect. The process retires the workflow. Review the retired workflow and correct any problems. It is possible that a workflow that is listed might not open in the Workflow Builder. If the listed workflow version cannot be opened, then open older versions for review.
84
© Copyright IBM Corp. 2011, 2015
Issue
Retired the workflow because of a missing Start step that cannot be repaired.
Retired the workflow because of missing Start and End steps that cannot be repaired.
Retired the workflow because of a structure error that cannot be repaired.
Retired the workflow because of an unknown task type <type-number>.
Retired the workflow because of missing step definitions that cannot be repaired.
Unexpected problem in trying to load the workflow.
Description
The workflow is missing the Start task step and cannot be repaired by the process. The process retires the workflow.
Review the retired workflow and correct any problems. It is possible that a workflow that is listed might not open in the
Workflow Builder. If the listed workflow version cannot be opened, then open older versions for review.
The workflow is missing the Start and End task steps and cannot be repaired by the process. The process retires the workflow. Review the retired workflow and correct any problems. It is possible that a workflow that is listed might not open in the Workflow Builder. If the listed workflow version cannot be opened, then open older versions for review.
The step-to-step structure of the workflow has a problem that makes it invalid and the structure cannot be repaired by the process. The process retires the workflow. Review the retired workflow and correct any problems. It is possible that a workflow that is listed might not open in the Workflow
Builder. If the listed workflow version cannot be opened, then open older versions for review.
The workflow contains a step with a task type that cannot be understood by the workflow processor. Since the step uses an unknown task type, this condition cannot be repaired by the process. The process retires the workflow. Review the retired workflow and correct any problems. It is possible that a workflow that is listed might not open in the Workflow
Builder. If the listed workflow version cannot be opened, then open older versions for review.
The properties for one or more steps within the workflow cannot be loaded. Since the properties for the step are specific to the logic of the workflow, this condition cannot be repaired by the process. The process retires the workflow. Review the retired workflow and correct any problems. It is possible that a workflow that is listed might not open in the Workflow
Builder. If the listed workflow version cannot be opened, then open older versions for review.
This issue covers any problems that do not fit into any of the other categories. The process retires the workflow. Review the retired workflow and correct any problems. It is possible that a workflow that is listed might not open in the Workflow
Builder. If the listed workflow version cannot be opened, then open older versions for review.
Automatic repairs
The following issues can be repaired automatically. The table shows the issue that is written to the WorkflowCleanup.log file and the corresponding description and automatic repairs.
Issue
Added the required End step structure and definition information.
Description
Valid workflows require an End task step and one cannot be found. The process adds an End task step to the workflow.
Review the workflow to verify that the step was added correctly.
Chapter 3. Workflow cleanup log
85
Issue Description
Changed step with missing definition to a
No-Op.
Converted obsolete task type step to a No-Op.
Flow control value was invalid. Set step to normal flow (non-swapped).
Removed the entry from
WF_LOOKUP because the workflow is not in a published state.
The properties for a task step cannot be loaded. According to past behavior, when the properties for a step cannot be loaded, the step was skipped and processing was continued with the next step. Because the properties for steps other than an End or Stop task are specific to the workflow, the process cannot create them. However, because the step was skipped in the past, the process replaces the task step with a No-Op task step. A No-Op (or No Operation) task step is a task step that does nothing. The log entry provides information about what was replaced so the workflow can be reviewed. Review previous versions of the workflow to determine the purpose of the step and replace the step if necessary. The task types
Switch, Fork, Loop, Iterator, and DataConnect cannot be converted to a No-Op step. Missing properties for these task types results in retiring the workflow. (This condition is covered by the table of issues that cannot be automatically repaired by the process.)
Older workflows might contain task steps that were not supported since the Workflow Builder was released in 2005.
These obsolete types are most likely to exist in workflows that were originally created with the older non-graphical workflow editor. According to past behavior, the process skipped these task steps and continued to the next step. The process converts these task steps to No-Op steps.
Switch and Break task steps contain an internal value that indicates whether the condition must be used as-is or swapped. If the internal value is not valid for either a normal or swapped step, the process replaces it with the value for a normal step. This value is an internally used value and not the condition expression for the step. Review the listed Switch or
Break and verify that the step is correct. Swap the step if necessary.
An entry for the workflow existed in the WF_LOOKUP table, but the workflow is not currently published. Only published workflows must have an entry in the WF_LOOKUP table, so the entry was removed. The workflow can be published if it is necessary for current business processes.
Retired the workflow because its Business Object could not be found.
The business object for which the workflow is defined does not exist. If the business object does not exist, then this workflow cannot run. The process retires the workflow.
Retired the workflow because its Module could not be found.
Retired the workflow because there isn't a corresponding entry in
WF_LOOKUP.
Step definition added for
Block-End step.
The module for which the workflow is defined does not exist.
If the module does not exist, then this workflow cannot run.
The process retires the workflow.
The workflow entry in the WF_TEMPLATE table has a status of Published, but there is no entry in the WF_LOOKUP table.
Since the WF_LOOKUP table locates workflows at run time, this workflow cannot run. The process changes the status from
Published to Retired. The workflow can be published if it is necessary for current business processes.
The properties for a Block-End task step cannot be loaded. A
Block-End task step is the bottom of a Switch or Loop task step. All task steps require valid properties to be run.
However, the properties for this task type do not contain any values that are specific to the workflow. The process creates valid properties for them.
86
© Copyright IBM Corp. 2011, 2015
Issue
Step definition added for
End step.
Step definition added for
No-Op step.
Step definition added for
Stop step.
Updated the workflow name in WF_LOOKUP.
Description
The properties for an End task step cannot be loaded. All task steps require valid properties to be run. However, the properties for this task type do not contain any values that are specific to the workflow. The process creates valid properties for them.
The properties for a No-Op task step cannot be loaded. A
No-Op task step is a task step that does nothing, but sometimes it is added to a workflow by the Workflow Builder.
All task steps require valid properties to be run. However, the properties for this task type do not contain any values that are specific to the workflow. The process creates valid properties for them.
The properties for a Stop task step cannot be loaded. All task steps require valid properties to be run. However, the properties for this task type do not contain any values that are specific to the workflow. The process creates valid properties for them.
The name of the workflow in the WF_LOOKUP table does not match the name in the WF_TEMPLATE table. The process repaired this condition by updating the name in the
WF_LOOKUP table. Review the name and verify that this name is expected.
Chapter 3. Workflow cleanup log
87
88
© Copyright IBM Corp. 2011, 2015
