Home
Administrator Guides
Transactional Message Administrator Guide
Integration with the Deliver transactional message service
The Deliver Transactional messaging System (TMS) is a web service hosted as part of HCL Unica hosted services. Application developers must work with digital marketers in your organization to create the client applications required to integrate your corporate transactional systems with the Deliver TMS. These client applications initiate each transactional message by making a SOAP request to the Deliver TMS over an HTTPS connection.
Construction of the transactional email request
To access the Deliver TMS, the transactional email client must be able to provide credentials to connect to the TMS. It must also provide mailing and message information as part of the web service request. Unica provides two versions of a WSDL as a guide to structuring a SOAP request that includes all information required to send a transactional email.
attachments
Use this parameter to specify files that are attached to the transactional email message. The web service request includes the content of the attached file in the format that you specify.

Administrator Guides
- Startup and Administrator Guide
- Transactional Message Administrator Guide
  - About Deliver and transactional message
    A transactional message is a single message sent in response to a specific, predetermined transaction detected in your business systems. Unica provides the Deliver Transactional messaging Service (TMS) as a hosted web service to process transactional messages. Digital marketers work with application developers to integrate corporate transaction management systems with the Deliver TMS.
  - Integration with the Deliver transactional message service
    The Deliver Transactional messaging System (TMS) is a web service hosted as part of HCL Unica hosted services. Application developers must work with digital marketers in your organization to create the client applications required to integrate your corporate transactional systems with the Deliver TMS. These client applications initiate each transactional message by making a SOAP request to the Deliver TMS over an HTTPS connection.
    - Identification of transaction events
      Application developers must design the local transactional message client to interact with transaction monitoring systems used by your organization. The client must take transaction notifications as input and distinguish the type of transaction event that the transaction management system is reporting.
    - Access to recipient data
      To personalize transactional messages, the local transactional message client must access business systems and databases that can provide recipient-specific data used in transactional message.
    - Connection to the Deliver TMS
      You must design the local transactional message client to automatically connect to the Unica data center assigned to your hosted message account. The client must be able to provide the appropriate authentication credentials as part of the web service request.
    - Attachments in transactional email requests
      The Deliver TMS supports attaching one or more files to a transactional email message. The web services request must contain the file contents and information that describes each file.
    - Construction of the transactional email request
      To access the Deliver TMS, the transactional email client must be able to provide credentials to connect to the TMS. It must also provide mailing and message information as part of the web service request. Unica provides two versions of a WSDL as a guide to structuring a SOAP request that includes all information required to send a transactional email.
      - mailingCode
        The mailingCode parameter specifies the unique mailing code defined in the configuration of the Deliver mailing that you have enabled for transactional email. The mailingCode specifies the unique mailing code that is defined in the transactional mailing in Marketing Center. Marketing Center assigns the code to the mailing after the mailing is deployed. The code is displayed on the Deploy tab of the mailing.
      - audienceID
        You define the audienceID parameter to correlate transactional email messages with email recipients when you perform additional reporting and processing.
      - Fields
        Use the fields parameter to provide recipient-specific information to populate personalization fields defined in the transactional email message.
      - Cell codes
        The cellCodes parameter is optional. By default, the Deliver TMS expects to receive a null value for this parameter. If you provide a value for cellCodes, you can pass only one cell code in each web service request.
      - additionalOptions
        This parameter is reserved for future use.
      - attachments
        Use this parameter to specify files that are attached to the transactional email message. The web service request includes the content of the attached file in the format that you specify.
      - Tracking fields
        Use this parameter to specify personalized fields used for additional contact tracking.
      - locale
        This parameter specifies the locale, including the associated language, which is used for messages that are sent back from the Deliver Transactional Mailing Service.
      - userName
        This parameter specifies the user name that is associated with your hosted email account. Specifying the user name is part of the authentication that is required to establish a connection with the Deliver TMS. You must also specify the password that is assigned to the hosted email account.
      - password
        This parameter specifies the password that is associated with your hosted email account. Specifying the password is part of the authentication that is required to establish a connection with the Deliver TMS. You must also specify the user name that is assigned to the hosted email account.
  - The Deliver Transactional Mailing Service API
    The Deliver Transactional Mailing Service is a web service hosted in HCL Unica. It provides an API that contains one method calledsendMailing.
  - Sample client
    Unica provides sample transactional message clients to guide application developers that create client applications that make web service calls to the Deliver Transactional Messaging Service (TMS). This sample client is based on the second-generation WSDL.
  - About Dynamic Transactional Images
    Dynamic transactional images are images specific to a particular individual that you can include with transactional email messages. Dynamic transactional images are sent as attachments to transactional email but they display as images embedded in the body of the message.

attachments

Use this parameter to specify files that are attached to the transactional email message. The web service request includes the content of the attached file in the format that you specify.

You can provide values for multiple elements in this parameter. If the email message includes a dynamic transactional image, you specify the image label as an element in this parameter.

Parameter name: attachments
Data Type: fileName: Name of the attached file. Pass the name as a string.; label: Used to identify dynamic transactional images. If the email includes dynamic transactional images, pass the label as a string. Otherwise, pass this value as null.; label: Used to identify personalized images. If the email includes a personalized image, pass the label as a string. You can omit the label if you are not using personalized images.; fileContent: the MIME content type of the attached file. The type is always base64Binary.

For more information about using the label attribute to identify dynamic transactional images, see About Dynamic Transactional Images.

Rate this topic

5 stars 4 stars 3 stars 2 stars 1 star

Comment on this topic.

By clicking this box, you acknowledge that you are NOT a U.S. Federal Government employee or agency, nor are you submitting information with respect to or on behalf of one. HCL provides software and services to U.S. Federal Government customers through its partners immixGroup, Inc. Contact this team at https://hcltechsw.com/resources/us-government-contact. Do not include any personal data in this Comment box.