Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[HCA DX] Upgrade support request tag, trigger, and variables to GA4 conventions #4188

Closed
10 tasks done
MillenniumFalconMechanic opened this issue Oct 9, 2024 · 8 comments
Closed
10 tasks done
Assignees
Labels
canary Done by the Clever Canary team

Comments

@MillenniumFalconMechanic
Copy link
Contributor

MillenniumFalconMechanic commented Oct 9, 2024

Need

The support request GTM configuration currently has some configuration objects that are in the deprecated UA-4. For example:

  • The tag - support_request_create tag contains a reference to Event Action and Event Label parameters.
image
  • The Support Request Create trigger name should follow GA4 naming conventions.
  • The Source and Catalog variable names should follow GA4 naming conventions.

Approach

Document the changes required to update the support request configuration objects to match GA4 conventions. Once changes are reviewed, proceed with updates and confirm support request events are tracked correctly in staging and prod. (Note that support requests are shared in the HCA community Slack channel; clearly mark any support requests as tests and use dave@clevercanary.com as the submitter email.) Completed; see comment.

Add tracking to "Send" button on support request form by adding a button-support-request test ID to the button, and standard click event configuration in GTM.

Definition of Done

  • Document the changes required to update the support request configuration objects to match GA4 conventions.

  • Merge [Findable PR]

  • Release findable version 13.0.1

  • Update data-browser to new findable version

  • Update data-portal to new findable version (Upgrade Findable-UI to v14.0.0 when available data-portal#2478)

  • Deploy data-browser with new findable version

  • Deploy data-portal with new findable version

  • Create GTM tags

  • Check support request events in query explorer for data.humancellatlas.org - GA4.

  • Check support request events in query explorer for data.humancellatlas.dev.clevercanary.com - GA4.

@github-actions github-actions bot added the canary Done by the Clever Canary team label Oct 9, 2024
@jpaten
Copy link
Contributor

jpaten commented Oct 11, 2024

Currently, this event is not implemented, as the HCA Portal uses the SupportRequest component in Findable, which does not have tracking implemented. Note that on GA4, there are no calls to Support Request in the past month (and very very few over the past year). To resolve this while keeping the tracking functionality, the following would need to be done:

  • Add an event model to findable-ui with the name support_request_create containing source and catalog as parameters
  • Add optional props to SupportRequestProps to pass the relevant data needed to fill the source and catalog parameters
  • Call the event in findable in SupportRequestForm (see the TODO in supportRequestForm.tsx)
  • Pass the relevant props in the Data Portal next site so the event can be called
  • Update the names of the GTM variables and triggers to match other GA4 events, and add consts where relevant.

@jpaten
Copy link
Contributor

jpaten commented Oct 25, 2024

In order to successfully track requests from both the Data Explorer and the HCA Portal, DataBiosphere/data-portal#2478 needs to be merged.

@jpaten
Copy link
Contributor

jpaten commented Oct 25, 2024

Corresponding GTM version is 59

@jpaten
Copy link
Contributor

jpaten commented Nov 13, 2024

@MillenniumFalconMechanic, I confirmed in Preview mode on GTM that this runs and that it showed on Realtime mode on the prod and dev site. I have not yet confirmed that it works on Query Explorer

@jpaten
Copy link
Contributor

jpaten commented Nov 15, 2024

@MillenniumFalconMechanic Confirmed working on staging and prod!

Staging

Image

Prod

Image

@MillenniumFalconMechanic
Copy link
Contributor Author

Would you mind updating the tag and trigger to x - support_request_created?

@jpaten
Copy link
Contributor

jpaten commented Nov 19, 2024

@MillenniumFalconMechanic Updated on version 63

@MillenniumFalconMechanic
Copy link
Contributor Author

LGTM, thanks Jonah!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
canary Done by the Clever Canary team
Projects
None yet
Development

No branches or pull requests

2 participants