Monitor Workflow Process Management - BloomReach Experience - Open Source CMS

Monitor Workflow Process Management

This BloomReach Experience Manager feature requires a standard or premium license. Please contact BloomReach for more information.

Introduction

Goal

Monitor processes and data related to workflow process management.

Background

As a developer, you may need to monitor processes and data related to workflow process management in order to troubleshoot any issues that may occur. This page describes how to track a project, its related HST configuration branches, and its related external review process.

Logging

To monitor log messages related to workflow process management, change the log level from WARN to INFO for the following loggers:

  • com.onehippo.cms7.hst.configuration.branch

  • com.onehippo.cms7.services.wpm.project

Project CRUD

When a new project is created, it is stored as a subnode of /hippowpm:hippowpm/hippowpm:projects. The node name is a random string of 5 characters, for example vGVVI (/hippowpm:hippowpm/hippowpm:projects/vGVVI).

HST Configuration

Branch Creation

If a channel “Foo” is added to the project, a new branche is created under /hst:hst/hst:configurations with the name of the channel and the random string making up the name of the project, in this case Foo-vGVVI and Foo-vGVVI-preview.

The branch contains a copy of the HST configuration for the specific channel. The nodes have some additional properties with the form dxphst:*hash. These properties are used to determine the difference between the master (the original configuration) and the branch.

INFO  Branch ‘Foo-v1fYd' created.

Branch Update / Reintegrate

The process of updating and reintegrating can both be monitored through the server side logs:

INFO  Successfully reintegrated 'Foo'. Merges : [MergeItem{relativePath='hst:workspace/hst:sitemenus/main/Bar', mergeType=NODE_ADD, overriddenConflict=false, target=PREVIEW}, MergeItem{relativePath='hst:workspace/hst:sitemenus/main/Bar', mergeType=NODE_ADD, overriddenConflict=false, target=LIVE}]

Alternatively, the process can be monitored using the network tab of the developer tools of the browser. For example, inspect the reponse for a reintegrate call :

http://localhost:8080/cms/ws/projects/vobMU/reintegrate/c6861074-ac6a-447e-bb09-ad1401aff130?dryRun=false&override=false
{
  "success": false,
  "message": "Cannot reintegrate 'Alternative Channel' due to conflicts.",
  "conflicts": [
     {
        "relativePath": "hst:workspace/hst:sitemenus/main/q",
        "target": "PREVIEW"
     },
     {
        "relativePath": "hst:workspace/hst:sitemenus/main/q",
        "target": "LIVE"
     }
  ],
  "merges": null
}

Camunda

If a review is requested for a project, a property hippowpm:externalid is added to the project node. This contains the id of the review process running in BPM.

Go to /bpm/app/cockpit/default/#/processes, select Hippo DX Project workflow and select your project from the list and inspect the process. In this UI, the process can be killed and the current status is graphically visible (the blue dots in the image below).

Did you find this page helpful?
How could this documentation serve you better?
On this page
    Did you find this page helpful?
    How could this documentation serve you better?