OpenAir Read

Snap type:

Read

Description:

This Snap reads the data from OpenAir for a specific read type. The data can be filtered by using like date filters, deleted records and so on.

Expected upstream Snaps: File Reader followed by any file parser.
Expected downstream Snaps: Any file formatter, followed by File Writer.
Expected input: OpenAir Read Type should be given.
Expected output: OpenAir data for the given read type.

Prerequisites:

[None]

Support and limitations:

Ultra pipelines: May work in Ultra Pipelines.
Spark mode (Deprecated): Not supported in Spark - Deprecated mode.

Account:

This Snap uses account references created on the Accounts page of SnapLogic Manager to handle access to this endpoint. See OpenAir Account for information on setting up this type of account.

Views:

Input

This Snap has exactly two document input views.

Input1: To provide the values for OpenAir read types, Search field name, Search field Value, Read type for Custom field in order to filter the data based on field names and values.
Input2: To provide the values for Date filter field name, Date filter from value, Date filter to value in order to filter the data based on date values. Only the first document is processed; a data exception error view document is created if more than one document is received.

Note: If you use the Date filter type (that is, when it is not set to [None]), it is mandatory to provide the Date filter field name value. Allowed values for Date filter field name are Created, Deleted, Updated etc. For more information, refer to OpenAir API documentation.

If you use Before filter, you must specify the Date filter to value. If you use After, Date equal to, or Date not equal to filter, you must specify the Date filter from value. If you use Between filter, you must specify the Date filter from value and Date filter to value.

Output

This Snap has at most one document output view.

Error

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

Settings

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.

OpenAir read types

Required. The supported (read operation) types of the OpenAir. The types can be suggested. If a new read type is exposed in the OpenAir XML API, that can also be given.

Default value: [None]

Date filter types

The supported date filter types. Options available are:

[None]
Before
Between
After
Date equal to
Date not equal to

Default value: [None]

Include filter

The supported filter types. Options available are:

[None]
Deleted records only
Existing and deleted records.

This is used to indicate whether or not to use include filters to get deleted records.
By default (NONE) will used to fetch the existing records.
Default value: [None]

API Call Delay

The delay between subsequent OpenAir API calls (in milliseconds).

It is not recommended to set this property over 60000 milliseconds (1 minute).

If not specified , default behavior will be executed.

Default value: [None]

Retain null values for date

When selected, retains null values in the date field. This options is selected by default. When not selected, null values in date field are replaced with current system timestamp/date.

Example of a date with null value: <Date><hour/><minute/><timezone/><second/><month>00</month><day>00</day><year>0000</year></Date>

Default value: [None]

Do not execute if inputview1 is empty

Select this option if the Snap execution needs to be stopped when inputview1 has no records.

Default value: Not selected

Do not execute if inputview2 is empty

Select this option if the Snap execution needs to be stopped when inputview2 has no records.

Default value: Not selected

Snap History

4.6

Updated to allow OpenAir Read to retain null values for date field or replace null values with system timestamp/date. The newly added field is Retain null values for date.