Workflow subaction to submit Content Analytics event

[john-thomas-dotcms]

Parent Issue

No response

User Story

As a developer, I want to collect custom analytics events when users perform specific workflow actions.

Acceptance Criteria

1. Users can add a Workflow subaction to any Workflow action to record an analytics event.
2. The subaction allows the user to specify the following information at a minimum:
   • Event type
     • This can be any value EXCEPT the pre-defined event types we record automatically (e.g. PAGE_REQUEST).
   • Object type (e.g. WhatAmI)
     • If the user leaves this blank, the type is set to CONTENT.
   • Object ID
     • If the user leaves this blank, the id is set to the content identifier.
3. Each time the workflow action is executed, an event is logged to the analytics data store.
4. The events submitted via workflows may be retrieved the same as all other analytics events (e.g. via API and viewtool).
5. No information about the event is displayed anywhere (e.g. no growl, no popups, no log messages).
   • If the user wants any messages or notificaions, they can add other subactions for those.

Proposed Objective

Technical User Experience

Proposed Priority

Priority 2 - Important

External Links... Slack Conversations, Support Tickets, Figma Designs, etc.

No response

Assumptions & Initiation Needs

No response

Quality Assurance Notes & Workarounds

No response

Sub-Tasks & Estimates

No response

[jcastro-dotcms]

INTERNAL QA: FAILED

• Docker Image: trunk_f2fab7c

The event is not making it to the Clickhouse DB. I'm seeing this message in the log:

dotcms-1      | 17:32:53.184  WARN  actionlet.AnalyticsFireUserEventActionlet - The request or response is null, can't send the event for the contentlet: 60f0234c-8b47-457b-b585-9040cd9fb17e

[jdotcms]

taking a look, thx

[jcastro-dotcms]

NOTE TO INTERNAL QA:

The PR that included the Integration Tests for the Content Analytics classes overwrote one of the required changes for this ticket: https://github.com/dotCMS/core/pull/30465/files#diff-b3262e0c55b89f8f7ebd482593a2c45249e4146e261fd613f72f2ae12a97c0bbL67

This is why the event was not being created in the ClickHouse DB. The Failed Internal label is invalid.

Jonathan will send a new PR with the overwritten change so that this ticket can be tested once more.

[github-actions]

PRs:

• #30381 adding a change that was removed by mistake in another PR #30500

[jcastro-dotcms]

INTERNAL QA: FAILED

• Docker Image: trunk_70b861a

The event is still not making it to the Clickhouse DB.

[jcastro-dotcms]

INTERNAL QA: PASSED

• Docker Image: trunk_7a5f044

The event is making it to the Clickhouse DB when the Workflow Action is called on a test Contentlet, as expected.

[josemejias11]

Approved: Tested on trunk_a5bde22, Docker, macOS 14.5, FF v126.0.1