Skip to content

Add or Remove Widgets in a Case Report Template#

manageCaseReportTemplate Platinum

Add and remove widgets in a case report template to customize what information appears in your case reports in TheHive. Widgets are configurable components that display specific case data in different formats.

Add widgets in a case report template#

  1. Go to the Organization view from the sidebar menu.

    Organization view

  2. Select the Templates tab.

    Organization templates

  3. Select the Reports tab.

    Organization templates reports

  4. Select the case report template you want to edit, or select next to the case report template you want to edit and then Edit.

  5. Drag available widgets to position them as needed.

    Drag widgets

  6. Enter the required information for the widget.

    Available variables

    You can insert variables into certain fields and widgets such as the header, footer, and text widget by selecting Add variable.

    Helpers using Mustache syntax

    Data transformation helpers#

    Helper Description Usage Output
    tlpLabel Format the tlp field of the object {{ tlpLabel object.tlp }} Amber
    papLabel Format the pap field of the object {{ papLabel object.pap }} Amber
    severityLabel Format the severity field of the object {{ severityLabel object.severity }} Critical
    dateFormat Format a date field of the object using Java date time patterns {{dateFormat audit._createdAt "EEEEE dd MMMMM yyyy" "fr" }} jeudi 01 septembre 2022

    Standard string helpers can be found in the official Handlebars documentation.

    Conditional helpers#

    Examples:

    • Displays Medium if case.severity equals 2, otherwise displays Other:
    {{#if (eq case.severity 2) }}
        Medium
    {{else}}
        Other 
    {{/if}}
    
    • Displays the threat actor value only if case.customFieldValues.threat-actor is defined:
    {{#if case.customFieldValues.threat-actor}}
        Threat Actor: {{case.customFieldValues.threat-actor}}
    {{/if}}
    

    Find additional supported operators in the official Handlebars documentation.

  7. Select Confirm.

  8. Select to edit sections, to duplicate them, and to delete them.

  9. Select to preview the case report display.

  10. Select to save your case report template.

Remove widgets in a case report template#

  1. Go to the Organization view from the sidebar menu.

    Organization view

  2. Select the Templates tab.

    Organization templates

  3. Select the Reports tab.

    Organization templates reports

  4. Select the case report template you want to edit, or select next to the case report template you want to edit and then Edit.

  5. Select at the top right of the widget you want to remove.

  6. Select OK.

Next steps