Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  • Expected input: The typical input for this Snap would be documents containing Eloqua contact IDs, such as the output of the Eloqua Read Snap for the Contacts type.

  • Expected output: One output document per contact ID, containing the contact ID and a list of zero or more activities for that contact.

    Image Added

Snap Type

The Eloqua Query Activities Snap is a Read-type Snap.

...

Support for Ultra Pipelines

Works in Ultra Task Pipelines.

Limitations and Known Issues

...

Type

Format

Number of Views

Examples of Upstream and Downstream Snaps

Description

Input 

Document

  • Min: 1

  • Max: 1

JSON Generator

The Snap invokes the Eloqua endpoint for the given object type once for each input document, using the document as the content sent to the endpoint. Check the Eloqua API documentation to understand the required and supported fields specific to the object type. Note that the Eloqua documentation is not very complete/accurate in this respect.This Snap has one document input view.

Output

Document

 

  • Min: 1

  • Max: 1

Mapper

 

The Snap produces one document in the view for each successful call to the Eloqua endpoint.

Error

This Snap has exactly one document output view.

Error

This Snap has at most one document error view and produces zero or more documents in the view.

Error handling is a generic way to handle errors without losing data or failing the Snap execution. You can handle the errors that the Snap might encounter while running the Pipeline by choosing one of the following options from the When errors occur list under the Views tab:

  • Stop Pipeline Execution: Stops the current pipeline execution when the Snap encounters an error.

  • Discard Error Data and Continue: Ignores the error, discards that record, and continues with the remaining records.

  • Route Error Data to Error View: Routes the error data to an error view without stopping the Snap execution.

Learn more about Error handling in Pipelines.

Snap Settings

Snap type:

Read

Field Name

Field Type

Field Dependency

Description

:

This Snap is used to retrieve the activities associated with one or more Eloqua contact asset.  It invokes the Eloqua REST API 1.0 "Read (list)" endpoint for Activities.

  • Expected input: The typical input for this Snap would be documents containing Eloqua contact IDs, such as the output of the Eloqua Read Snap for the Contacts type.

  • Expected output: One output document per contact ID, containing the contact ID and a list of zero or more activities for that contact.

Prerequisites:

[None]

Support and limitations:

Works in Ultra Task Pipelines.

Account: 

This Snap uses account references created on the Accounts page of SnapLogic Manager to handle access to this endpoint. See Eloqua Account for more information.

Views:

InputThis Snap has at most one document input view.
OutputThis Snap has exactly one document output view.
ErrorThis Snap has at most one document error view and produces zero or more documents in the view.

Settings

Label

Activity Type

Label

Default Value: Eloqua Query Activities

Example: Create Accounts

String

N/A

Required. The name for the Snap. You can modify this to be more specific, especially if you have more than one of the same Snap in your pipeline.

Contact ID

Example:
Default value:

String

N/A

Required. ID of the Eloqua contact associated with the activities of interest, or an expression which evaluates to a contact ID.

Example:
Default value:

Activity Type

Dropdown List

N/A

Required. The type of activity you wish to retrieve for the specified contact.  One of:

  • emailOpen

  • emailSend

  • emailClickThrough

  • emailSubscribe

  • emailUnsubscribe

  • formSubmit

  • webVisit

  • campaignMembership

Start Date/Time

String

N/A

Required. Start of the time range for activities to retrieve.  This should be a 10-digit Unix timestamp, or an expression that evaluates to a timestamp or a DateTime. See http://www.unixtimestamp.com/ .

Examples:

  • 1341343693

  • Date.now().minusDays(30)

  • Date.parse("2015-12-25T12:00:00+00:00")

End Date/Time

String

N/A

Required. End of the time range for activities to retrieve.

Count

String

N/A

Maximum number of activities to retrieve for each contact.  This is not a limit on the number of documents to output, which is always equal to the number of input documents (or 1 if there are no input documents).

Multiexcerpt include macroname

Pass through

Default Value: Deselected

Checkbox

N/A

Select this checkbox to enable the Snap to pass the input document to the output view under the key original.

 

Snap Execution

pageAnaplan Read Multiexcerpt include macronameSnap_Execution_IntroducedpageAnaplan Read

Dropdown list

N/A

Select one of the three modes in which the Snap executes. Available options are:

  • Validate & Execute: Performs limited execution of the Snap, and generates a data preview during Pipeline validation. Subsequently, performs full execution of the Snap (unlimited records) during Pipeline runtime.

  • Execute only: Performs full execution of the Snap during Pipeline execution without generating preview data.

  • Disabled: Disables the Snap and all Snaps that are downstream from it.

Examples

...

Sample input:

Code Block
[
  {
    "id": "4156"
  },
  {
    "id": "4157"
  },
  {
    "id": "4158"
  }
]

...