Skip to main content

ClusterFieldName

Column identifiers recognised by the cluster CSV importer.

Each value identifies a cluster attribute that can be mapped to a column in the source spreadsheet so the import understands how to populate the catalogue.

enum ClusterFieldName {
  LANGUAGE
  NAMES
  DESCRIPTIONS
  SHORT_DESCRIPTIONS
  CODE
  CLUSTER_CONFIG_ID
  CLUSTER_ID
  SOURCE_NAME
  SOURCE_ID
  CATEGORY_ID
  CATEGORY_SOURCE_NAME
  CATEGORY_SOURCE_ID
  METADATA_TITLE
  METADATA_DESCRIPTION
  METADATA_KEYWORDS
  METADATA_CANONICAL_URL
  HIDDEN
}

Values

`ClusterFieldName.LANGUAGE`

[Required][String] Cluster default language

`ClusterFieldName.NAMES`

[Required][String] Cluster name

`ClusterFieldName.DESCRIPTIONS`

[Optional][String] Cluster description

`ClusterFieldName.SHORT_DESCRIPTIONS`

[Optional][String] Cluster short description

`ClusterFieldName.CODE`

[Optional][String] Cluster code

`ClusterFieldName.CLUSTER_CONFIG_ID`

[Required][String] Cluster config id

`ClusterFieldName.CLUSTER_ID`

[Optional][String] Cluster id

Use either the internal cluster identifier column or the combination of source name and source identifier columns; do not combine both.

`ClusterFieldName.SOURCE_NAME`

[Optional][String] Cluster source name

Supply together with the source identifier column. Cannot be combined with the internal cluster identifier column.

`ClusterFieldName.SOURCE_ID`

[Optional][String] Cluster source id

Supply together with the source name column. Cannot be combined with the internal cluster identifier column.

`ClusterFieldName.CATEGORY_ID`

[Optional][String] The id of the category the cluster should be created in

`ClusterFieldName.CATEGORY_SOURCE_NAME`

[Optional][String] Name of the parent category source

Supply together with the category source identifier column. Required only when matching the parent category by external source.

`ClusterFieldName.CATEGORY_SOURCE_ID`

[Optional][String] Parent category source id

Supply together with the category source name column. Required only when matching the parent category by external source.

`ClusterFieldName.METADATA_TITLE`

[Optional][String] [SEO] Localized metadata title

`ClusterFieldName.METADATA_DESCRIPTION`

[Optional][String] [SEO] Localized metadata description

`ClusterFieldName.METADATA_KEYWORDS`

[Optional][String] [SEO] Localized metadata keywords

`ClusterFieldName.METADATA_CANONICAL_URL`

[Optional][String] [SEO] Localized metadata canonical URL

`ClusterFieldName.HIDDEN`

[Optional][Enum] The hidden status of the cluster

Must be one of: Y, N. When omitted the catalogue applies the default value of N.

Member Of

ClusterCsvMapping input

Values
Member Of