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.
Field Support Overview
| Field Name | Description | Multi-Value? | Example | Supported |
|---|---|---|---|---|
| Name | Name of a component. | No | My Component | ✓ |
| ID | ID of a component. | No | 5d058ef8-037a-4c89-9820-01c7675385e4 | ✗ Will be added soon. |
| Slug | Slug of a component. | No | my-component-slug | ✗ |
| Type Id | The (internal) Compass type id. | No | CLOUD_RESOURCE | ✓ |
| Type Name | The user-facing name of a type. | No | Cloud resource | ✓ |
| Type Icon Url | The icon url of a type. | No | 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. | No | My example component. | ✓ |
| Description - More Details | The More Details section of a component description. | No | My example component with additional formatting applied. | ✗ Can be added if requested. |
| State | Status of a component, e.g. active, archived or pending. | No | ACTIVE | ✓ |
| Component Link | Link to a Compass component on a Compass site. | No | 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. | No | ACTIVE | ✓ |
| Tier | The tier classification of a component as a number. | No | 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. | No | ✓ | |
| 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 links URLs of a component. | Yes | ✓ |
Custom Fields
The Component Exporter also supports various custom field types:
| Field Type | Description | Multi-Value? | Example | Supported |
|---|---|---|---|---|
| Boolean | Boolean field value as text. | No | true | ✓ |
| Number | Number field value as text. | No | 123 | ✓ |
| Text | Text field value. | No | Hello World. | ✓ |
| User | The account ID of a user that is set for a custom field. | No | abc123def456 | ✓ |
| Single Dropdown | The value of a selected option from a single dropdown list. | No | option one | ✓ |
| Multi Dropdown | The value of all selected options from a multi dropdown list. | Yes | option one||option two||option three | ✓ |
