Documentation Center

Creating an Embeddable Schema

Embeddable Schemas define a series of fields that you can use in other Schemas.

Before you begin

You must have Schema Management rights and Write permissions for the Folder in which you create the Schema to create a Schema.

You also need Workflow Management rights if you intend to associate this Schema with a Workflow Process by adding a Workflow Association.

Procedure

  1. Open Content Manager Explorer.
  2. Navigate to the Publication and Folder in which you want to create the Schema.
  3. Open the Ribbon toolbar Create tab and click New Schema.
    The New Schema window opens.
  4. On the General tab, fill in the following fields:
    FieldDescription
    NameThe name of the Embeddable Schema. Users see this name in their list of Embeddable Schemas to select when they create a Component based on a Schema to which you added this Embeddable Schema. Ensure that the name of the Embeddable Schema easily identifies its intended use. For example, "Address".
    DescriptionA description of this Schema.
    Schema TypeSelect the value Embeddable Schema.
    Root element nameThe name of the root element of the Schema.
  5. Select the Design tab to define fields for this Schema.
  6. Select Add to add fields. In the area on the right, fill in the following fields:
    FieldDescription
    XML NameThe XML name of the field. This name can only contain letters without accents (A-Z, a-z), digits (0-9), underscores '_' and/or hyphens '-'. The first character of the XML name must be a letter or an underscore character.
    DescriptionA description of the field. Users see this description when they create a Component. It appears as the label for the input control for this field in the Component form.
    TypeSelect a field type for this field. Depending on the field type you select, you may need to specify further settings.
    Publish this field when you publish an item that uses this SchemaWhen selected, this field is included in the data published through templateless, data-only publishing. This option does not affect template-based publishing.

    Typically, you will want to keep this option selected, but if the Schema field is used internally only, say for workflow, or if it contains sensitive information, you may want to clear this option. With this option not selected, contents of the field are not included in any publish action.

    This option is selected by default.

    Make this field searchable for website visitorsWhen selected, this field is indexed when data published through templateless, data-only publishing, and will therefore be searchable. This option does not affect template-based publishing.

    Typically, you will want to keep this option selected, but if you do not want this content to be indexed and included in search results, clear this option. With this option not selected, contents of the field still get published (because publish option is selected), but the contents will not be queryable or searchable.

    You can select this option only if you also select the option to publish the field. Both options are selected by default.

  7. Click Save and Close.

Results

You have created an Embeddable Schema. You can now add the Embeddable Schema to another Schema field.