Custom CSV Reports

Overview

This guide covers adding custom fields to the CSV report downloaded from the case management applications tab.

Prerequisites

• GitHub permissions on HV Central Config.
• Case management access to the App ID for which the custom report is being enabled.
• Storing inputs enabled (if inputs fields are required).
• Storing journey outputs enabled (if dashboardData fields are required).

Purpose & use case

Who is this for?

• SA/IE teams
• Support teams

When should this be used? When the client requests custom columns on the case management applications table or in the downloaded report.

Deep dive

Description

• By default, the Download as CSV option on the applications list page does not include dashboardData or inputs fields.
• Add a config to enable a custom CSV report for the client.

Step-by-step guide

1. Ensure storing inputs or dashboardData is enabled per your custom report requirement.

2. Clone the HV Central Config GitHub repository (if not already done).

3. Navigate to buckets/hv-central-config/client-configurations/${appId}.json.

4. Add a new key applicationListDownloadColumns to the JSON config:

   The value is an array of objects, each with this structure:

   Key	Description / Expected value	Example
   key	The key of the field. Could be a default field, a dashboard data field, or an input field.	Default: transactionId, status Dashboard data: dashboardData.panNo Inputs: inputs.leadId
   label	The label used as the column header in the CSV.	Transaction ID, Fetched PAN Number, Lead ID

Sample configuration

{
  // ...existingConfiguration
  "applicationListDownloadColumns": [
    {
      "key": "transactionId",
      "label": "Transaction ID"
    },
    {
      "key": "status",
      "label": "Application status"
    },
    {
      "key": "workflowId",
      "label": "Workflow Id"
    },
    {
      "key": "dashboardData.name",
      "label": "Tester Name"
    },
    {
      "key": "dashboardData.testCase",
      "label": "Test Case"
    },
    {
      "key": "inputs.leadId",
      "label": "Lead ID"
    }
  ]
}

• Add dashboardData fields with dashboardData.<fieldName>.
• Add inputs fields with inputs.<fieldName>.
• Add default transaction fields with just <fieldname>.

Default fields stored for each transaction

transactionId
status
eventTime
workflowId
updatedAt
appVersion
browser
country
device
sdkVersion
dob
ipAddress
platform
platformVersion
os
reviewerEmail

warning

We store some default fields for each application in addition to dashboardData and inputs. If this config is present, only the fields configured will be sent in the CSV file. Without the config, only a subset of default fields will be sent.

FAQs

Q: Will we store raw PII? A: No. PII is stored in two formats:

• Encrypted — for displaying in case management and the downloaded report.
• Hashed — for enabling search.

Q: Will this store all PII? A: No, we only store:

• Inputs — all inputs sent to the SDK (when enabled).
• Dashboard Data — configured fields.
• This does not enable storing PII in API calls.