OpenAir Read

On this Page

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:

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 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 AfterDate 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.
OutputThis Snap has at most one document output view.
ErrorThis 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 Execution

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.

Snap Pack History

 Click to view/expand
ReleaseSnap Pack VersionDateTypeUpdates
4.27main12833 StableUpgraded with the latest SnapLogic Platform release.
4.26main11181 StableUpgraded with the latest SnapLogic Platform release.
4.25main9554
 
StableUpgraded with the latest SnapLogic Platform release.
4.24main8556
StableUpgraded with the latest SnapLogic Platform release.
4.23main7430
 
StableUpgraded with the latest SnapLogic Platform release.
4.22main6403
 
StableUpgraded with the latest SnapLogic Platform release.
4.21snapsmrc542

 

StableUpgraded with the latest SnapLogic Platform release.
4.20snapsmrc535
 
StableUpgraded with the latest SnapLogic Platform release.
4.19 Patchopenair8336 Latest

Fixed the broken doc link for the OpenAir Write/Update Snap.

4.19snaprsmrc528
 
StableUpgraded with the latest SnapLogic Platform release.
4.18snapsmrc523
 
StableUpgraded with the latest SnapLogic Platform release.
4.17ALL7402
 
Latest

Pushed automatic rebuild of the latest version of each Snap Pack to SnapLogic UAT and Elastic servers.

4.17snapsmrc515
 
Latest

Added the Snap Execution field to all Standard-mode Snaps. In some Snaps, this field replaces the existing Execute during preview check box.

4.16snapsmrc508
 
StableUpgraded with the latest SnapLogic Platform release.
4.15snapsmrc500
 
StableUpgraded with the latest SnapLogic Platform release.
4.14snapsmrc490
 
StableUpgraded with the latest SnapLogic Platform release.
4.13

snapsmrc486

 
StableUpgraded with the latest SnapLogic Platform release.
4.12

snapsmrc480

 
StableUpgraded with the latest SnapLogic Platform release.
4.11snapsmrc465
 
StableUpgraded with the latest SnapLogic Platform release.
4.10

snapsmrc414

 
StableUpgraded with the latest SnapLogic Platform release.
4.9snapsmrc405
 
StableUpgraded with the latest SnapLogic Platform release.
4.8

snapsmrc398

 
StableUpgraded with the latest SnapLogic Platform release.
4.7

snapsmrc382

 
StableUpgraded with the latest SnapLogic Platform release.
4.6rcmsf233
 
Stable
  • OpenAir Read Snap is updated with a new field to enable retention of null values in date field or replacement of null values with system timestamp/date.
  • Resolved an issue with OpenAir Read Snap that caused unexpected results when working with End_Date column values.
4.5.1

rcmsf231

 
StableUpgraded with the latest SnapLogic Platform release.
4.5

rcmsf231

Stable

OpenAir Read was updated with a new error condition. A data exception error view document is created if more than one document is received by input2.