Metadata API Developer’s Guide

Clouds with binary code floating aboveCloud with binary code floating above

No Results

Search Tips:

  • Please consider misspellings
  • Try different search keywords
PDF

Newer Version Available

This content describes an older version of this product. View Latest

ArticleType Layout

Represents the metadata associated with an article type page layout. Article type layouts determine which fields users can view and edit when entering data for an article, they also determine which sections appear when users view articles. The format of the article, for example whether layout sections display as subtabs or as a single page with links, is defined by the article-type template. Each article type has only one layout, but you can choose a different template for each of the article type's four channels. For more information, see “Managing Article Types” in the Salesforce online help and “Articles” in the SOAP API Developer's Guide

File Suffix and Directory Location

ArticleType layouts are stored in the layouts directory of the corresponding package directory. The prefix must match with the article type API name. The extension is .layout.

Version

ArticleType layouts are available in API version 19.0 and later.

Fields

Field Name Field Type Description
layoutSections LayoutSection[] The main sections of the layout containing the article fields. The order here determines the layout order.

LayoutSection

LayoutSection represents a section of an ArticleType layout.

Field Name Field Type Description
customLabel boolean Indicates if this section's label is custom or standard (built-in). Custom labels can be any text, but must be translated. Standard labels have a predefined set of valid values, for example 'System Information', which are automatically translated.
label string The label; either standard or custom, based on the customLabel flag.
layoutColumns LayoutColumn[] The columns of the layout, depending on the style. Salesforce Knowledge only supports one column in article type layouts.
style LayoutSectionStyle (enumeration of type string) The style of the layout. Salesforce Knowledge only supports the value OneColumn which displays a one column page.

LayoutColumn

LayoutColumn represents the items in a column within a layout section.

Field Name Field Type Description
layoutItems LayoutItem[] The individual items within a column (ordered from top to bottom).

LayoutItem

LayoutItem represents the valid values that define a layout item.

Field Name Field Type Description
field string The field name reference, for example MyField__c.

Declarative Metadata Sample Definition

The following is the definition of an ArticleType page layout:
1<?xml version="1.0" encoding="UTF-8"?>
2<Layout xmlns="http://soap.sforce.com/2006/04/metadata">
3    <layoutSections>
4        <customLabel>true</customLabel>
5        <label>Description</label>
6        <layoutColumns>
7            <layoutItems>
8                <field>description__c</field>
9            </layoutItems>
10            <layoutItems>
11                <field>dateTime__c</field>
12            </layoutItems>
13        </layoutColumns>
14        <style>OneColumn</style>
15    </layoutSections>
16    <layoutSections>
17        <label>Data Sheet</label>
18        <layoutColumns>
19            <layoutItems>
20                <field>file__c</field>
21            </layoutItems>
22        </layoutColumns>
23        <style>OneColumn</style>
24    </layoutSections>
25</Layout>