Adobe Campaign Connector Setup Guide for AudienceStream

Adobe Campaign Connector Setup Guide for AudienceStream

by on ‎06-01-2017 08:18 PM (398 Views)

Adobe Campaign enables you to perform marketing automation, increase your campaign productivity, and reduce time to market.

Table of Contents Placeholder

Requirements

  • Adobe Campaign Account
  • SOAP API Credentials (contact your Adobe representative to get your credentials)

Supported Actions

Action Name Trigger on Audience Trigger on Streams
Send Custom SOAP Request

Configure Settings

Go to the Connector Marketplace and add a new Adobe Campaign Connector. Read the Connector Overview article for general instructions on how to add a Connector.

To configure your vendor, follow these steps:

  1. In the Configure tab, provide a title for the Connector instance.

  2. Enter the SOAP API username and password that you received from Adobe for your account.

  3. Enter the SOAP API endpoint that you received from Adobe for your account. Only include the domain. For example, if the server path is http://example.com/nl/jsp/soaprouter.jsp, only enter "example.com" in this field.

  4. Provide additional notes about your implementation.

  5. Click Establish Connection to verify the API connectivity.

This Connector uses Adobe Campaign's SOAP logon method to connect to the SOAP API. Refer to Adobe Campaign's Connectivity documentation for more info.

Action Settings - Parameters and Options

Click Next or go to the Actions tab. It's where you'll set up Actions and trigger them.

This section describes how to set up Parameters and Options for each Action.

Action - Send Custom SOAP Request

Parameters

  1. SOAPAction Header Value (REQUIRED): This is the SOAPAction HTTP header. Select a field from the dropdown or enter a custom value. E.g., xtk:workflow#PostEvent.
  2. SOAP Request Body Template Variables: Required only if you want to define template variables for the SOAP Request Body Template parameter. Map your Attribute values to the field of choice in the To dropdown or enter a custom value. See additional notes below.
  3. SOAP Request Body Template (REQUIRED): Add your SOAP XML template in this field. See additional notes below.
  4. SOAP Response Error Identifier: Select a field from the dropdown or enter a custom identifier. If the response contains any of the error strings (OR condition) specified in this field, the call is marked as a failure. By default, an HTTP response status outside 200-299 range is also marked as a failure.

Refer to Adobe Campaign v6.1 Configuration Guide for additional help.

Additional Notes

  • A SOAP Request Body template is required. To inject a template into the supported fields, simply wrap its name in double curly braces, e.g., {{SomeTemplateName}}. Refer our Templates Guide for common syntax and extensions.
  • A session token is required for Adobe Campaign API calls; be sure to include it in the template where appropriate. Use the reserved template keyword {{sessionToken}} to have this token included in the template. A reserved keyword is predefined and populated automatically for you.
  • Template variables are optional. To name nested template variables, use the dot notation, e.g., items.name. Nested template variables are typically built from data layer list Attributes. Refer our Template Variables Guide for details.

Usage Example

Here's a sample configuration for sending a PostEvent SOAP request.

Parameter - Option Description
SOAPAction Header Value Configure Custom Value of "xtk:workflow#PostEvent"
SOAP Request Body Template Variables Map Custom Value of "workflow1000" To "strWorkflowId"
Map Custom Value of "importTask2000" To "strActivity"
SOAP Request Body Template <SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns0="urn:xtk:workflow"> <SOAP-ENV:Header /> <SOAP-ENV:Body> <ns0:PostEvent> <ns0:sessiontoken>{{sessionToken}}</ns0:sessiontoken> <ns0:strWorkflowId>{{strWorkflowId}}</ns0:strWorkflowId> <ns0:strActivity>{{strActivity}}</ns0:strActivity> </ns0:PostEvent> </SOAP-ENV:Body> </SOAP-ENV:Envelope>
SOAP Response Error Identifier Configure Custom Value of SOAP-ENV:Fault

Example Request

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"
	xmlns:ns0="urn:xtk:workflow">
	<SOAP-ENV:Header />
	<SOAP-ENV:Body>
		<ns0:PostEvent>
			<ns0:sessiontoken>EXAMPLE_TEALIUM_POPULATED_TOKEN</ns0:sessiontoken>
            <ns0:strWorkflowId>workflow1000</ns0:strWorkflowId>
            <ns0:strActivity>importTask2000</ns0:strActivity>
		</ns0:PostEvent>
	</SOAP-ENV:Body>
</SOAP-ENV:Envelope>

Example Response

<?xml version='1.0'?>
	<SOAP-ENV:Envelope xmlns:xsd='http://www.w3.org/2001/XMLSchema'
		xmlns:xsi='http://www.w3.org/2001/XMLSchema-instance' xmlns:ns='urn:xtk:workflow'
		xmlns:SOAP-ENV='http://schemas.xmlsoap.org/soap/envelope/'>
		<SOAP-ENV:Body>
			<PostEventResponse xmlns='urn:xtk:workflow'
				SOAP-ENV:encodingStyle='http://schemas.xmlsoap.org/soap/encoding/'></PostEventResponse>
		</SOAP-ENV:Body>
	</SOAP-ENV:Envelope>

Example Error Response

If the SOAP Call Response's HTTP status is 200-299 or otherwise includes any of the "SOAP Response Error Identifier" values, the Action is deemed as a failure. In this example, the Action will be marked as failure because the response contains the identifier "SOAP-ENV:Server".

<?xml version='1.0'?>
	<SOAP-ENV:Envelope xmlns:xsd='http://www.w3.org/2001/XMLSchema'
		xmlns:xsi='http://www.w3.org/2001/XMLSchema-instance' xmlns:SOAP-ENV='http://schemas.xmlsoap.org/soap/envelope/'>
		<SOAP-ENV:Body>
			<SOAP-ENV:Fault>
				<faultcode>SOAP-ENV:Server</faultcode>
				<faultstring xsi:type='xsd:string'>SOP-330011 Error while executing
					the method 'PostEvent' of service 'xtk:workflow'.</faultstring>
			</SOAP-ENV:Fault>
		</SOAP-ENV:Body>
	</SOAP-ENV:Envelope>

Vendor Documentation