Supported Component Fields
The Component Exporter supports many fields of a Compass component that can be exported to a CSV file, including custom fields. But there are also fields not supported at the moment. The following list gives you an overview.
Do you miss a field or experience any problems? Just reach out to our support team.
Field Name | Description | Multi-Value? | Example | Supported |
|---|---|---|---|---|
Name | Name of a component. |
| My Component | |
ID | ID of a component. |
| 5d058ef8-037a-4c89-9820-01c7675385e4 | Will be added soon. |
Slug | Slug of a component. |
| my-component-slug | |
Type Id | The (internal) Compass type id. |
| CLOUD_RESOURCE | |
Type Name | The user-facing name of a type. |
| Cloud resource | |
Type Icon Url | The icon url of a type. |
| https://cdn.atlassian.net/icon.png | Can be added if requested. |
Description | The summary/description of a component. Note: This does not include the recently announced More Details section. |
| My example component. | |
Description - More Details | The More Details section of a component description. |
| My example component with additional formatting applied. | Can be added if requested. |
State | Status of a component, e.g. active, archived or pending. |
| ACTIVE | |
Component Link | Link to a Compass component on a Compass site. |
| https://example.atlassian.net/compass/component/7c01c2e9-b3f3-4152-862d-e56a266662e3 | |
Lifecycle | The lifecycle stage of a component as text, e.g. Active, Deprecated, Pre-release. |
| ACTIVE | |
Tier | The tier classification of a component as a number. |
| 1 | |
Labels | The labels applied to a component, separated by the list separator because labels is a multi-value field. | Yes | label-one||label-two||label-three | |
Owner | The id of the owner team of a component. |
|
| |
Chat Channels | The chat channel URLs of a component. | Yes |
| |
Repositories | The repository URLs of a component. | Yes |
| |
Projects | The project URLs of a component. | Yes |
| |
Documentation | The documentation URLs of a component. | Yes |
| |
Dashboards | The dashboard URLs of a component. | Yes |
| |
On Calls | The on call URLs of a component. | Yes |
| |
Other Links | The other link URLs of a component. | Yes |
| |
Boolean Custom Field | Boolean field value as text. |
| true | |
Number Custom Field | Number field value as text. |
| 123 | |
Text Custom Field | Text field value. |
| Hello World. | |
User Custom Field | The account ID of a user that is set for a custom field. |
| abc123def456 | We don’t store user data at the moment. Please reach out if you need this. |
Single Dropdown Custom Field | The value of a selected option from a single dropdown list. |
| Option One | |
Multi Dropdown Custom Field | The value of all selected options from a multi dropdown list. | Yes | option one||option two||option three |