The structure of an SCCPL transformation

Last updated Wednesday, November 15, 2017 in Sitecore Azure Toolkit for Administrator, Developer
Keywords: Azure, Cloud

A Sitecore Cargo Payload (SCCPL) package is the extension of a ZIP package with the following structure:

Command

Description

CopyToWebsite/*

Copies files to the Website folder in the target installation. You can use this to deploy new files or overwrite existing files, such as resource files, DLLs, and configuration files.

CopyToRoot/*

Copies files to the root of the Web Deployment Package (WDP). You usually use this to, for example, inject .dacpac or .sql files to perform database changes.

Xdts/*

XDT transformations for XML files are under the Website root. Use XDT transformations to tweak configuration files that the WDP deploys without adding new configuration files. The file name convention is: {original file name}.xdt.

Note

SCCPL transformations use the XDT syntax to transform XML files, not the Sitecore configuration patch syntax.

IOActions/*.ioxml

An XML file that describes the actions that are going to be performed on the files in a WDP package. See the example below.

For example, an SCCPL package can have the following structure:

Package

Description

CopyToWebsite\App_Config\Include\Component.config

Configuration file for a new component, integration into Sitecore.

CopyToWebsite\bin\Component.dll

DLL file for the component.

CopyToWebsite/sitecore/shell/client/Applications/Component/page.cshtml

Resource file - MVC page view.

Xdts\App_Config\ConnectionStrings.config.xdt

XDT transformation: adding connection string for the new component.

IOActions\Component.ioxml

Enable/disable configuration files.

IOActions

The IOActions are described in .ioxml files with path and action attributes; the enable, disable, and delete action values; and the following structure:

<IOActions>
<IOAction path="App_Config\Include\001.Sitecore.Speak.Important.config" action="disable" />
</IOActions>

Attributes

Description

path

The path to the file that you want to change, relative to the Website folder.

Note

The value must be the exact path to a single file, including the expected extension(s). Wildcards are not supported.

action

A file-level action (enable, disable, or delete) that is performed on the file.

IO action values

Description

enable

Enable a configuration file by renaming it from *.config.disabled , or *.config.example, to *.config.

disable

Disable a configuration file by renaming it from *.config to *.config.disabled.

delete

Delete the file from the package.

Send feedback about the documentation to docsite@sitecore.net.