Include custom fields within the items in your packaged solution to enable the user who deploys the package to customize branding. For example, if an asset contains a logo that varies across environments, you can create a custom field where the correct logo is inserted during deployment.
Custom fields are supported in objects such as Journey Builder activities, Content Builder entities, CloudPages, and Automation Studio Send Email activities. Some fields, such as email names and journey names, aren’t supported because they don’t allow special characters. Also, some objects, such as email and SMS activities, have custom fields that are preset and can’t be edited.
Before you begin, identify the items that you want to add custom fields to.
-
In the item, insert a placeholder for each a custom string or URL.
Format your placeholders like this: {{mcpm:fieldName}}. fieldName represents a prompt to your users about what information to enter. For example, {{mcpm:logo}} prompts the user to input a URL to their logo image. Or enter {{mcpm:companyName}} and {{mcpm:companyWebsite}} to prompt the user to input the business unit’s name and website.
You can reuse a placeholder repeatedly and use as many placeholders as you want.
- Create a packaged solution that contains the item with the placeholders.
-
Use Custom Fields Configuration to add more information for the user who deploys the
package.
Each custom field must have a label. For example, if you use the {{mcpm:logo}} placeholder, you can enter a label of Logo URL. When a user deploys the package, they see a field labeled Logo URL and can then input the link to the correct logo. You can also add a more detailed description to help the user deploying the package know how to format the placeholder.
Note If you don’t see custom fields, Package Manager didn’t find the correct syntax. Make sure that your syntax is correctly formatted and try again. - Download your package.
- When a user attempts to deploy the package, they must enter values for all custom fields.
- When the package is deployed, Package Manager replaces all instances of each placeholder with the corresponding value.