This feature is only available to customers on paid plans. To upgrade, contact your Customer Success Manager or sales@heap.io.
Definition verification lets account Admins and Architects establish a trusted and shared set of event definitions for the team to use in analysis. As part of this process, any team member can submit unverified definitions for Admins and Architects to review. Once a definition has been verified, only Admins and Architects will be able to update the definition.
Team members in the Read-Only or Consumer roles cannot create shared definitions or submit existing definitions for verification.
Submit a Definition for Verification
Analysts can submit events to be verified by an Admin or Architect.
New Definitions
After you’ve defined a new shared event, that definition will be submitted for verification by default and will be listed as such on the definition details page.
Existing Definitions
To request verification for an existing definition, navigate to Definitions, select the type of definition you want to verify, click on the definition in the list to bring up the details, then click the Request Verification button.
A pop-up will appear where you can add a note to explain why you are requesting verification.
Once requested, this area will update to show that this definition is now pending verification. Note that it cannot be modified while the request is pending.
If you need to modify the definition after having submitted it for verification, feel free to cancel the verification request by clicking the Cancel Request button, update the definition, then re-submit it for verification.
Review Pending Verifications
Admins and Architects can review all currently pending verifications by navigating to Definitions > Pending Verification.
To review and approve these verification requests, click the View Definition Criteria button to jump to the definition details, including the creator, when it was submitted, how often it occurs, what reports it is used in, any notes, definition criteria, and more.
In the details section, you’ll see buttons to verify the definition or reject the verification request.
If you click Reject… you’ll be prompted to provide a note explaining why definition was rejected.
After you click Reject, the team member who submitted that definition for verification receives an email stating it has been rejected and providing the reason.
Verify & Unverify Definitions
Only Admins and Architects can verify or unverify event definitions. To do so, click the verify button on the top right of the definition details page.
Once verified, a green shield icon will appear next to the definition, symbolizing its trustworthiness. The event details will also be updated to include your name as the person who verified the event.
Only Admins and Architects can modify verified definitions. To unverify an event, simply click the verification icon.
