CSV Export¶
Clarity Transform populates a third-party CSV template from its own data: upload the template, map Clarity fields to its headers, and download a completed file ready for an external tool. The card describes it as: "Upload a 3rd-party CSV template, map Clarity fields to the template headers, and download a populated CSV ready for external tools."
Where to find it¶
Go to Discover → Integrations, then select the CSV Export card. The card opens its own page of export jobs, not the endpoint page that most integrations use. The card's history icon opens the standard integration page instead, so open the card itself to reach the jobs.
Why we do this¶
Clarity is rarely the only tool in a migration. A cloud vendor's sizing tool, a partner's costing model or a customer's own programme tracker all want data in their own format, and retyping it is both slow and a source of error.
Mapping to the template rather than exporting a fixed format means the receiving tool does not have to change, which is usually the constraint. The template is whatever the other side already accepts.
What we collect¶
Nothing. This integration is an output rather than a source. It reads Clarity's own data and writes a file.
- A third-party CSV template, uploaded, whose headers define the output
- A mapping from Clarity fields to those headers
- A populated CSV, downloaded
What it adds¶
A route out of Clarity that does not need a developer. A new template is a configuration exercise rather than a change request, so a tool nobody anticipated can be fed the same week it is asked for.
What is deliberately not inferred¶
- Nothing is sent anywhere. The file is downloaded by the user; Clarity does not transmit it.
- No system is connected to and no credential is used.
- Nothing in Clarity is changed by an export, except the job's own Last Run, Last Run By and Last Result.
What we require¶
No credential is used. This integration needs no account on any system, so there is nothing for a customer to provision and nothing to revoke afterwards.
Verification before handover¶
Run this check before the populated file is handed over, so a rejected file is never the first time anyone finds out.
- Confirm the receiving tool accepts the template you have. Get the template from the tool itself rather than from a previous engagement.
The export jobs page¶
The page lists export jobs in a grid:
- Name: select a job's name to open its export wizard.
- Ci Class: values seen in this build are Application and Device.
- Last Run
- Last Run By
- Last Result: empty until the job has been run.
The grid has the standard toolbar: the add icon (tooltip Create New Integrations Csv Export), the edit icon, Remove selected, Clear selection, Reload table data, Enable spreadsheet editing, Export CSV and Import CSV. Each row has a View Details row action (the eye icon). Each column has a filter row, and the grid has a Search: box.
The grid remembers its Search: text, column filters, sort order and page size between visits. If the grid shows fewer rows than you expect, clear the Search: box and the filter row.
The export wizard¶
Selecting a job's name opens a page with three steps, in this order. The step descriptions are quoted as the product shows them.
- Step 1 - Upload CSV Template: "Upload the blank 3rd-party CSV template that defines the export column headers." Button: Upload Template, which opens the page "Upload CSV Template" with a file input for a .csv file.
- Step 2 - Column Mapping: "Map each 3rd-party template column to its corresponding Clarity database field." Button: Column Mapping, which opens the page "Map Export Columns", with Back and Save.
- Step 3 - Run Export: "Generate and download the populated CSV in your 3rd-party tool's format." Button: Run Export.
Configuring the export job¶
The create form (Create new entry) has two fields. The edit form has the same fields, filled in.
| Field | Value |
|---|---|
| Name | A name for the export job (text) |
| Ci Class | The class of records to export: Application, Cluster, Database, Device or Relationship. It starts as Application |
There is no endpoint, credential or schedule field: the template is uploaded and the populated CSV downloaded through the wizard.
- Go to Discover → Integrations, then select the CSV Export card.
- Select the add icon (Create New Integrations Csv Export). The Create new entry form opens.
- Enter a Name and choose the Ci Class.
- Select Save.
- Select the new job's Name to open its wizard, then work through Step 1 - Upload CSV Template to Step 3 - Run Export.
If a wizard step returns you to the job list, read the error message shown on the job list: it appears as a red toast when the list opens and gives the reason the step could not continue.
The toolbar's Import CSV loads rows into this list of export jobs ("Rows with an existing ID will be updated; rows without an ID will be inserted as new records."). It does not upload a template; use Upload Template in the job's wizard for that.
Removing the access¶
There is nothing to remove.
Troubleshooting¶
| Symptom | Cause |
|---|---|
| The receiving tool rejects the file | The template is from a different version of that tool. Obtain the current template from the tool itself. |
| Columns are populated with the wrong values | A mapping error. Check one row field by field against its source record. |
| Empty columns in the output | The mapped Clarity field holds no value for those records, which is a data completeness question rather than an export fault. |
Related pages¶
- Integrations: the Discover → Integrations screen and its cards.
- CSV Import: import jobs, reached from the CSV Import card.