1. Configuration

Sitecore Content Serialization configuration reference

The Sitecore Content Serialization (SCS) system uses a set of properties to determine what and how content items in a Sitecore instance are influenced by the serialization commands.

Include properties

The include properties:

PropertyRequiredValid valuesDefault value
nameYesStringNone
pathYesStringNone
scopeNoSingleItem, ItemAndChildren, ItemAndDescendants, and DescendantsOnly.ItemAndDescendants
databaseNomastermaster
maxRelativePathLengthNoNumber130
allowedPushOperationsNoCreateOnly, CreateAndUpdate, and CreateUpdateAndDeleteCreateUpdateAndDelete
Note

Duplicate item names on the same level are not supported by the CLI, even if such items are under ignored nodes.

Scope

The scope property configures what content items are influenced:

ScopeContent items influenced
SingleItemOnly the content item.
ItemAndChildrenThe content item and its immediate children.
ItemAndDescendantsThe content item and all its descendants.
DescendantsOnlyOnly the descendants of the content item.
IgnoredAll children and descendants are ignored except those previously matched.ImportantOnly valid in rules. Not valid in includes.

Allowed push operations

The allowedPushOperations property configures how content items can be influenced when pushed to your Sitecore instance:

Content item in file system?Content item in instance?CreateOnlyCreateAndUpdateCreateUpdateAndDelete
YesNoCreate itemCreate itemCreate item
YesYesIgnore itemUpdate itemUpdate item
NoYesIgnore itemIgnore itemDelete item

Rules

The rule properties:

PropertyRequiredAllowed valuesDefault value
pathYesStringNone
scopeYesIgnored, SingleItem, ItemAndChildren, and ItemAndDescendantsNone
aliasNoStringNone
allowedPushOperationsNoCreateOnly, CreateAndUpdate, and CreateUpdateAndDeleteInherited from parent
If you have suggestions for improving this article, let us know!