Overview
The Jira - Catalog Custom Fields set adds a Jira section to the Validatar catalog at Schema, Table and Column level. Metadata ingestion on a data source built from the Jira Cloud Data Source Template fills it with what Jira knows about each project, issue type, field and issue: which fields an issue type requires, what values a field accepts, and the status, age and owner of each issue Validatar raised.
Marketplace: Jira - Catalog Custom Fields
These fields describe the Jira data source's own catalog. The fields that show open issues on your warehouse tables are a separate, shared set: Issue Tracking Custom Fields.
Import this set before the first ingestion. Validatar ignores an ingested value whose field does not exist, so the ingestion succeeds but the value is not stored.
How the catalog is laid out
| Catalog level | Jira object |
|---|---|
| Schema | A project, named by its key; the _config schema for site-wide lists; or a <KEY> Issues schema for the issues Validatar raised in a project |
| Table | An issue type, a site-wide list such as statuses, or one issue, named by its key |
| Column | A field on an issue type's create screen, an attribute of a list, or an attribute of an issue |
The Jira Table Kind field says which kind of table you are looking at.
Schema fields (7)
| Field | Reference key | Type | Holds |
|---|---|---|---|
| Jira Project Id | jira_project_id |
Short text | The project's numeric id |
| Jira Project Name | jira_project_name |
Short text | The project's display name |
| Jira Project Type | jira_project_type |
Short text | software, business or service_desk; config for _config; issues for an Issues schema |
| Jira Project Style | jira_project_style |
Short text | classic (company-managed) or next-gen (team-managed) |
| Jira Project Lead | jira_project_lead |
Short text | The project lead's name |
| Jira Project URL | jira_project_url |
Short text | A link to the project |
| Jira Ingestion Note | jira_ingestion_note |
Paragraph | Why a project has no issue types in the catalog, usually a missing Create Issues permission |
Table fields (21)
Every table
| Field | Reference key | Type | Holds |
|---|---|---|---|
| Jira Table Kind | jira_table_kind |
Dropdown | Issue Type, Sub-task Type, Reference or Issue |
Issue type tables
| Field | Reference key | Type | Holds |
|---|---|---|---|
| Jira Issue Type Id | jira_issue_type_id |
Short text | The issue type's id |
| Jira Issue Type Description | jira_issue_type_description |
Paragraph | Its description |
| Jira Is Subtask | jira_is_subtask |
Dropdown | Yes for a sub-task type |
| Jira Hierarchy Level | jira_hierarchy_level |
Short text | -1 sub-task, 0 standard, 1 epic |
| Jira Field Count | jira_field_count |
Short text | Fields on the create screen |
| Jira Required Field Count | jira_required_field_count |
Short text | Required fields on the create screen |
| Jira Required Without Default | jira_required_without_default |
Paragraph | Required fields with no default. Each needs a value from the integration, or every create fails |
_config tables
| Field | Reference key | Type | Holds |
|---|---|---|---|
| Jira Row Count | jira_row_count |
Short text | Rows in the list |
Issue tables
| Field | Reference key | Type | Holds |
|---|---|---|---|
| Jira Issue Summary | jira_issue_summary |
Paragraph | The summary |
| Jira Issue Status | jira_issue_status |
Short text | The status name |
| Jira Issue Status Category | jira_issue_status_category |
Short text | To Do, In Progress or Done |
| Jira Issue Priority | jira_issue_priority |
Short text | The priority name |
| Jira Issue Assignee | jira_issue_assignee |
Short text | The assignee's name |
| Jira Issue Created | jira_issue_created |
Short text | Created date, yyyy-mm-dd |
| Jira Issue Resolved | jira_issue_resolved |
Short text | Resolved date, yyyy-mm-dd; blank while open |
| Jira Issue Age (Days) | jira_issue_age_days |
Short text | Days from created to resolved, or to the ingestion for an open issue |
| Jira Issue Occurrences | jira_issue_occurrences |
Short text | How many failing runs the issue has recorded |
| Jira Issue Test URL | jira_issue_test_url |
Short text | The Validatar test that raised it |
| Jira Issue Correlation Key | jira_issue_correlation_key |
Short text | validatar:<instance>:<project id>:<test id>, the link between the test and the issue |
| Jira Issue URL | jira_issue_url |
Short text | A link to the issue |
Dates and counts are short text because Validatar custom fields have no number type, and Jira dates are written as plain dates so they sort as text.
Column fields (11)
These describe the fields on an issue type's create screen.
| Field | Reference key | Type | Holds |
|---|---|---|---|
| Jira Field Id | jira_field_id |
Short text | The field's id, such as customfield_10062 |
| Jira Is Required | jira_is_required |
Dropdown | Whether the create screen requires it |
| Jira Has Default | jira_has_default |
Dropdown | Whether Jira fills it when it is left out |
| Jira Schema Type | jira_schema_type |
Short text | string, number, date, option, array, user and so on |
| Jira Schema Items | jira_schema_items |
Short text | The item type of an array field |
| Jira Schema Custom | jira_schema_custom |
Short text | The field-type key of a custom field |
| Jira Schema System | jira_schema_system |
Short text | The system name of a built-in field |
| Jira Is Custom | jira_is_custom |
Dropdown | Whether it is a custom field |
| Jira Allowed Values | jira_allowed_values |
Paragraph | For choice fields, the values Jira accepts |
| Jira Operations | jira_operations |
Short text | What an update may do: set, add, remove |
| Jira Auto Complete URL | jira_auto_complete_url |
Short text | Jira's lookup address for user and label fields |
A column with Jira Is Required Yes and Jira Has Default No is a field the integration must fill: through Field Defaults (JSON) on the data source, or a test's Issue Field Values.
Import the fields
You need Govern Edition and the Global Custom Metadata Admin role.
- In Validatar, open Marketplace and find Jira - Catalog Custom Fields.
- Choose Get, then Import Directly. Validatar opens Settings > Catalog Custom Fields with an Import Custom Fields panel on the right. The panel lists the Jira section for the Schema, Table and Column levels.
- For each level, open that level on the page, pick the same level in the panel's list, choose Import All once, then Save.
- Check the Schema, Table and Column levels. Each should now have a Jira section with the fields above.
Warning: Choose Import All only once per level. A second Import All adds the same fields again, and Save then refuses with "Please fix the errors on this page". If that happens, leave the page without saving, reload it and import that level again.
To move the set between instances, choose Get, then Download XML, and import it per level from Settings > Catalog Custom Fields with Import.