Distribution Metadata

Content Configuration supports metadata tags that provide distribution-specific information for Email, SMS, and Storage channels. Metadata can be configured using the <comms-meta> and <comms-email> tags. The values may be specified as static text or dynamically populated using the <comms-data> tag.

Email Metadata

Email metadata defines recipient information and additional email properties such as the subject, attachment name, email headers, and scheduling information.

See Understanding Email Distribution

Email Address

The <comms-email> tag is used to define email recipients.

Syntax:

<comms-email>$Email{
    "Type":"",
    "Display":"",
    "Address":""
}</comms-email>
Attributes:
Attribute Description
Type Specifies the email metadata property. For the Email recipient type, the supported values are From, To, Cc, Bcc, and ReplyTo.
Display Display name of the email recipient. Can be a static value or a <comms-data> tag.
Address Email address. Can be a static value or a <comms-data> tag.

Email Subject

The <comms-meta> tag is used to define the subject of an email.

Syntax:

<comms-meta>$Meta{
    "Name":"Subject",
    "Type":"String",
    "Value":""
}</comms-meta>
Attributes:
Attribute Description
Name Specifies the email metadata property. For the email subject, the value must be Subject.
Type Specifies the data type of the metadata value. For the email subject, the value must be String.
Value Specifies the email subject. The value can be a static string or dynamically populated using the <comms-data> tag.

Additional metadata

The <comms-meta> tag is used to specify additional metadata for email distribution, such as the scheduled send time, PDF name for email attachment, and custom email headers.

Syntax for SendAt: Specifies the date time at which the email should be sent. 

<comms-meta>$Meta{
    "Name":"SendAt",
    "Type":"DateTime",
    "Value":""
}</comms-meta>

Syntax for EmailAttachmentName: Specifies the name of the email attachment. Currently, Communication Cloud supports specifying the name for only one attachment. 

<comms-meta>$Meta{
    "Name":"EmailAttachmentName",
    "Type":"String",
    "Value":""
}</comms-meta>

Syntax for EmailHeaders: Specifies custom email headers that are used for traceability purposes. Currently, Communication Cloud supports specifying only one email header. 

<comms-meta>$Meta{
    "Name":"EmailHeaders",
    "Type":"String",
    "Value":""
}</comms-meta>
Attributes:
Attribute Description
Name Specifies the email metadata property. Supported values are SendAt, EmailAttachmentName, and EmailHeaders.
Type Specifies the data type of the metadata value. Use DateTime for SendAt and String for EmailAttachmentName and EmailHeaders.
Value Specifies the metadata value. The value can be a static value or dynamically populated using the <comms-data> tag.

SMS Metadata

SMS distribution uses metadata tags to define recipient information and SMS message properties.

See Understanding Message Distribution

SMS Body

The <comms-meta> tag is used to specify the content of an SMS message. 

<comms-meta>$Meta{
    "Name":"SMS Body",
    "Type":"String",
    "Value":""
}</comms-meta>
Attributes:
Attribute Description
Name Specifies the SMS metadata property. For the SMS, the value must be SMS Body.
Type Specifies the data type of the metadata value. For the SMS, the value must be String.
Value Specifies the SMS content. The value can be a static value or dynamically populated using the <comms-data> tag.

SMS Phone Number

The <comms-meta> tag is used to specify the recipient phone number including the country code for SMS delivery.

Syntax:

<comms-meta>$Meta{
    "Name":"PhoneNumber",
    "Type":"String",
    "Value":""
}</comms-meta>
Attributes:
Attribute Description
Name Specifies the SMS metadata property. For the recipient phone number, the value must be PhoneNumber.
Type Specifies the data type of the metadata value. For the phone number, the value must be String.
Value Specifies the recipient phone number. The value can be a static value or dynamically populated using the <comms-data> tag.

Additional metadata

The <comms-meta> tag is used to specify additional metadata for SMS distribution, such as the sender information, messaging service identifier, callback URL, and scheduled send time.

Syntax for From: Specifies the sender phone number or sender identifier used to send the SMS. 

<comms-meta>$Meta{
    "Name":"From",
    "Type":"String",
    "Value":""
}</comms-meta>

Syntax for MessagingServiceSId: Specifies the messaging service identifier used for SMS delivery. This metadata is mutually exclusive with From. 

<comms-meta>$Meta{
    "Name":"MessagingServiceSId",
    "Type":"String",
    "Value":""
}</comms-meta>

Syntax for StatusCallback: Specifies the callback URL used to receive SMS delivery status notifications. This metadata is primarily used for traceability purposes. 

<comms-meta>$Meta{
    "Name":"StatusCallback",
    "Type":"String",
    "Value":""
}</comms-meta>

Syntax for SendAt: Specifies the date and time at which the SMS should be sent. 

<comms-meta>$Meta{
    "Name":"SendAt",
    "Type":"DateTime",
    "Value":""
}</comms-meta>
Attributes:
Attribute Description
Name Specifies the SMS metadata property. Supported values are From, MessagingServiceSId, StatusCallback, and SendAt.
Type Specifies the data type of the metadata value. Use String for From, MessagingServiceSId, and StatusCallback, and DateTime for SendAt.
Value Specifies the metadata value. The value can be a static value or dynamically populated using the <comms-data> tag.

Storage Metadata

Storage distribution uses metadata tags to define the properties of the generated storage asset, such as the file name, file type, and destination path.

See Understanding Storage Distribution

The <comms-meta> tag is used to specify metadata for storage distribution.

File Name: Specifies the name of the generated storage asset.

Syntax:

<comms-meta>$Meta{
    "Name":"File Name",
    "Type":"String",
    "Value":""
}</comms-meta>

Type: Specifies the file extension or document type of the generated storage asset.

Syntax:

<comms-meta>$Meta{
    "Name":"Type",
    "Type":"String",
    "Value":""
}</comms-meta>

FilePath: Specifies the destination path where the generated storage asset is stored, such as an SFTP location.

Syntax:

<comms-meta>$Meta{
    "Name":"FilePath",
    "Type":"String",
    "Value":""
}</comms-meta>
Attributes:
Attribute Description
Name Specifies the storage metadata property. Supported values are File Name, Type, and FilePath.
Type Specifies the data type of the metadata value. For all supported storage metadata properties, the value must be String.
Value Specifies the metadata value. The value can be a static value or dynamically populated using the <comms-data> tag.

Conditional Support

The <comms-cond> tag can be used with <comms-email> and <comms-meta> tags to conditionally include metadata for Email, SMS, Storage, and other supported distribution channels.

Syntax:

<comms-cond>$Cond{
    "Condition":"Field == 'ABC'"
}
    <comms-meta>$Meta{
        "Name":"File Name",
        "Type":"String",
        "Value":"PremiumStatement"
    }</comms-meta>
</comms-cond>
Attributes:
Attribute Description
Condition Specifies the expression to be evaluated. The enclosed <comms-meta> tags are processed only if the condition evaluates to true.