OpenAir Source

Overview

OpenAir Source Component is SSIS Data Flow Component for consuming data from OpenAir Service. The configuration options are provided in the standard data flow source component dialog.

Setup

Use the options below to setup the component.

Options

OPENAIR

Select an existing OpenAir connection manager.

Related Topics: OpenAir Connection Manager

Attributes (1.6 SR-3)

Specify read attributes. Multiple attributes are separated with newline, using syntax: [name]=[value]. Use attributes listed in the following table.

Attribute Value Description
deleted 1 Returns deleted records.
include_flags 1 Returns account or user switches, by default those are not
populated.
include_nondeleted 1 Returns all records, deleted and nondeleted.

Note: This attribute only works in conjunction with the
deleted attribute.
with_project_only 1 Used only with type: Customer. Will only return customers
which have associated project records.
base_currency 3 Letter currency code. Works with type: Currencyrate.
Converts values on the fly to currency specified.
generic 1 Returns generic resources (users) only, where by default, the
API returns regular users only.
BatchSize

Specify the number of rows to be retrieved as a batch. Default is 1000.

Filter

Specify records filter. Multiple filters are separated with newline. Use filters listed in the following table.

Value Description
open-envelopes Returns only records associated with an open envelope.
approved-envelopes Returns only records associated with an approved envelope.
rejected-envelopes Returns only records associated with a rejected envelope.
submitted-envelopes Returns only records associated with a submitted envelope.
nonreimbursed-envelopes Returns envelopes that have a non-zero balance attribute.
reimbursable-envelope Returns only records associated with a reimbursable
envelope.
open-slips Returns only records associated with an open slip.
approved-slips Returns only records associated with an approved slip.
open-timesheets Returns only records associated with an open timesheet.
approved-timesheets Returns only records associated with an approved
timesheet.
rejected-timesheets Returns only records associated with a rejected timesheet.
submitted-timesheets Returns only records associated with a submitted timesheet.
not-exported Returns only records that have not been marked as
exported.
approved-revenue-recognition-transactions Returns only revenue recognition transactions belonging to
approved revenue_container records.

  • newer-than
  • older-than
  • date-equal-to
  • date-not-equal-to

Date filters. Date filter parameters and multiple date filters are separated with comma. Not supported in importexport type.

  • Example: to retrieve all records where updated field is equal or greater than Jan 1, 2011, set for filter:
    date-equal-to,newer-than,updated,updated,01-01-2011,01-01-2011
  • Example: to retrieve all records for the whole day and times use:
    newer-than,older-than,updated,updated,2011-08-31 23:59:59,2011-09-02
IncludeCustom

Specify to include custom fields in result. This property has the options listed in the following table.

Value Description
True The custom fields are included in the result.
False The custom fields are not included in the result (default).
IncludeDeleted

Specify to include all records in result, including the deleted. This property has the options listed in the following table.

Value Description
True All records are included in the result, including the deleted.
False The deleted records are not included in the result (default).

Note: Deprecated in SSIS+ 1.6 SR-3. Use Attributes parameter instead.

InputType

Select input OpenAir type.

Note: After input type change, you have to use Refresh command in the 'Column Mappings' tab to reload type metadata.

Method

Select OpenAir retrieve method. This property has the options listed in the following table.

Value Description
All Returns all available records (default).
EqualTo Returns records that have fields that are equal to the field value(s) passed in MethodCriteria. Selecting this value displays the dynamic option MethodCriteria.
EqualTo Returns records that have fields that are not equal to the field value(s) passed in MethodCriteria. Selecting this value displays the dynamic option MethodCriteria.
Method Criteria

Select variable containing recordset object with method criteria(s) or specify method criteria. To match match multiple values, set field criteria to comma delimited list. To match empty value, set field criteria to empty.

How to modify input type dynamically at runtime?

The input type, filter and method criteria are available in the data flow properties list. Follow these steps to setup expression:

  • Right-click on data flow canvas and select Properties menu.
  • Scroll-down and find property named like [OpenAir Source].[InputType]. This is the property containing the record.
  • Scroll-down and find Expressions property. Setup expression to modify the input type dynamically.