Versions Compared

Key

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

...

Akamai Read Snap is a READ-type Snap that reads data from upstream.

...

Limitations and Known Issues

None.

Snap Views

Type

Format

Number of Views

...

Input

This Snap has at most one document input view. Each document contains data in the form of JSON.

Output

This Snap has at most one document output view. Each document contains a corresponding response in the form of JSON.

Error

...

Examples of Upstream and Downstream Snaps

Description

Input 

Document

 

  • Min: 1

  • Max: 1

  • Mapper Snap

  • Binary to Document Snap

  • Sort Snap

Each input document contains data that you want to write to AEP.

Output

Document

  • Min: 0

  • Max: 1

  • Mapper Snap

  • Join Snap

  • Union Snap

Each output document lists the status and other details associated with the writing process.

Error

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 when 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 if 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

ield Name

Field Type

Description

Label*

 

Default ValueN/A
ExampleAkamai Snap

String

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.

 

Entity type name*

Default ValueN/A
Example doc_edi

String

Specify the name of the entity type to export user reports from the Akamai portal.

Data attributes

Default ValueN/A
Examplesdjhasfa.json

String

Specify the name of the JSON array of the schema attributes to include in the export. By default, all the attributes are included.

Filter

Default ValueN/A
ExampleDATA>11

String

Specify the filter to include the iterations.

Last run date

Default ValueN/A
Example15

Integer

Enter the sleep time after each iteration.

API interval (ms)

Default ValueN/A
Example1010

Integer

Enter the interval between each iteraton in milliseconds.

Snap Execution

 

Default ValueExecute Only
Example: Validate & Execute

Dropdown list

Select one of the following three modes in which the Snap executes:

  • 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.

Label

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.

Entity type name

required

User can provide the appropriate object/api name to read the data.

Example value: user

Data attributes

 

Last run date

provide the date to get the data from that pirticular time .( lastUpdated > lastRunDate)

API interval (ms)

Sleep time after each iteration

Snap Execution

optional

Specifies the execution type:

Validate & Execute: Performs limited execution of the Snap (up to 2000 records based on Preview doc count, default is  50 records) during Pipeline validation; performs full execution of the Snap (unlimited records) during Pipeline execution
  • .

  • Execute only: Performs full execution of the Snap during Pipeline execution; does not execute the Snap during Pipeline validation.

  • Disabled: Disables the Snap and, by extension, its downstream Snaps.

  • Default value: Execute only