Component

Template

Overview

Template Component is SSIS Data Flow Component providing ability to setup data flow output text columns, based on other input columns and package variables and a template. The template definition is based on Apache Velocity engine.

Setup

The component setup dialog consists of three parts:

  • Grid to define result columns.
  • Variables and column reference tree.
  • Template definition editor.

Options

Column

Select result column type. This property has the options listed in the following table.

Value Description
<add as new column> A new output column is setup for result.
Replace '...' Selected existing input column is replaced with the template result.
Result Column

Specify result column name.

Variables and Columns

Build a template that uses a variable or an input column by dragging the variable or column from the list of available variables and columns to the template edit window.

Template

Specify result column template. The value of this property can be specified by using a property expression.

What is the difference between Template Task and Template Component?

Template Task have to be used when you would like to generate complex document, with input from multiple data flows. The Template component is recommended when you would like to generate result document, based only on one data flow input columns.

NetSuite Destination

Overview

NetSuite Destination Component is SSIS Data Flow Component for loading data into NetSuite record. The configuration options are provided in the standard data flow destination component dialog. A separate input is setup for the main record and each related composite record.

Setup

Use the options below to setup the component.

Options

NETSUITE

Select an existing NetSuite connection manager.

Related Topics: NetSuite Connection Manager

Action

Select destination record action. This property has the options listed in the following table.

Action Description
Create Create new instance in the destination NetSuite record.
Update Update existing instance in the destination NetSuite record. You have to specify internalId for the update to work.
Delete Delete existing instance from the destination NetSuite record.
Upsert Update and insert record in the destination NetSuite record. You have to specify externalId for action to work.

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

DestinationRecord

Specify the destination NetSuite record where the data is loaded.

BatchSize

Specify the number of rows to be sent as a batch.

ErrorRowDisposition (NetSuite Destination Input)

Specify how to handle rows with errors.

Id (NetSuite Destination Error Output)

Contains the unique identifier of the added, updated or deleted record.

Composite record data

The composite record input accepts sets of rows, one set for each parent record. Each set of rows must be separated with blank row (all NULLs). The parent record will not finish processing its record, until all composite record children have received blank row to indicate completion.

NetSuite Source

Overview

NetSuite Source Component is SSIS Data Flow Component for consuming data from NetSuite Service. The configuration options are provided in the standard data flow source component dialog. A separate output is setup for the main record and each related composite record.

Setup

Use the options below to setup the component.

Options

NETSUITE

Select an existing NetSuite connection manager.

Related Topics: NetSuite Connection Manager

BatchSize

Specify the number of rows to be retrieved as a batch. Default is 0. If set to 0, the page size defined in NetSuite search preferences will be used.

InputType

Specify input type. This property has the options listed in the following table.

Value Description
Record Input type is NetSuite record or composite object. Selecting this value displays the dynamic options Record, RecordId, RecordVariable.
SearchXML Input type is search statement. Selecting this value display the dynamic options SearchXML.

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

Record

Select NetSuite record or composite object.

SearchXML

Specify NetSuite search record statement. The statement should be the same XML format used in NetSuite search method. For example to retrieve all account records containing the keyword "Drawing" in account's name, use the following statement:

<AccountSearchBasic>
  <name operator="contains">
    <searchValue>Drawing</searchValue>
  </name>
</AccountSearchBasic>

Composite record data

The composite record output contains not only fields from the composite record, but also the parent records. The output will be populated with sets of rows, one set for each parent record. Each set of rows is separated with blank row (all NULLs).

How to modify source statement dynamically at runtime?

The source record or statement 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 [NetSuite Source].[SearchXML]. This is the property containing the record statement.
  • Scroll-down and find Expressions property. Setup expression to modify the record statement dynamically.

SugarCRM Destination

Overview

The SugarCRM Destination Component is an SSIS Data Flow Component for loading data into a SugarCRM module. The configuration parameters are provided in the standard data flow destination component dialog.

Setup

Use the parameters below to set up the component.

Parameters

SUGARCRM

Select an existing SugarCRM connection manager.

Related Topics: SugarCRM Connection Manager

DestinationModule

Specify the destination SugarCRM module where the data is loaded.

BatchSize

Specify the number of rows to be sent as a batch.

ErrorRowDisposition (SugarCRM Destination Input)

Specify how to handle rows with errors.

Id (SugarCRM Destination Error Output)

Contains the unique identifier of the updated record.

How to modify a destination module dynamically at runtime

The destination module is available in the data flow properties list. Follow these steps to set up an expression:

  • Right-click on the data flow canvas and select the Properties menu.
  • Scroll down and find the property named like [SugarCRM Destination].[DestinationModule]. This is the property containing the destination module.
  • Scroll down and find the Expressions property. Set up an expression to modify the destination module dynamically.

How to update an existing module record

To update an existing module record follow these steps:

  • Map the columns you want updated.
  • Map the module Id column to the updated record identifier.

How to delete a module record

The component cannot delete module records. However you can mark specific records as deleted. Follow these steps:

  • Map the module Id column to the deleted record identifier.
  • Set the module deleted column to True.

SugarCRM Source

Overview

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

Setup

Use the parameters below to set up the component.

Parameters

SUGARCRM

Select an existing SugarCRM connection manager.

Related Topics: SugarCRM Connection Manager

BatchSize

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

Module

Select the SugarCRM module.

Query

Specify the WHERE clause. Optional.

OrderBy

Specify the ORDER BY clause. Optional.

IncludeDeleted

Indicate whether or not to include deleted records in the result. This parameter has the options listed in the following table.

Value Description
True Include the deleted records in the result.
False Do not include the deleted records in the result (default).
IncludeLink

Indicate whether or not the module relationship fields should be included. This parameter has the options listed in the following table.

Value Description
True The relationship fields are included. Keep in mind this may cause the retrieve process to run more slowly.
False The relationship fields are not included (default).

How to modify the source dynamically at runtime

The source “module”, “query” and “order by” parameters are available in the data flow properties list. Follow these steps to set up an expression:

  • Right-click on the data flow canvas and select the Properties menu.
  • Scroll down and find the property named like [SugarCRM Source].[Module]. This is the property containing the module.
  • Scroll down and find the Expressions property. Set up an expression to modify the module dynamically.

Dynamics NAV Source

Overview

The Dynamics NAV Source Component is an SSIS Data Flow Component for consuming data from the Dynamics NAV Service. The configuration parameters are provided in the standard data flow source component dialog.

Setup

Use the parameters below to set up the component.

Parameters

DYNAMICS-NAV

Select an existing Dynamics NAV connection manager.

Related Topics: Dynamics NAV Connection Manager

BatchSize

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

Page

Select the Dynamics NAV page.

PageFilter

Specify page filter. The filter is specified as a field name, followed by a colon (:) and ends with the filter specification. Multiple filters are separated with a newline character. For example to get all records where the Location_Code field is GREEN, specify: Location_Code:=GREEN

For more information about filter specification check here.

How to modify the source dynamically at runtime

The source page or filter is available in the data flow properties list. Follow these steps to set up an expression:

  • Right-click on the data flow canvas and select the Properties menu.
  • Scroll down and find the property named like [Dynamics NAV Source].[PageFilter]. This is the property containing the page filter.
  • Scroll down and find the Expressions property. Set up an expression to modify the page filter dynamically.

SAS Data Destination

Premium component

Overview

The SAS Data Destination Component is an SSIS Data Flow Component for loading data into SAS's sas7bdat file. The configuration parameters are provided in the standard data flow destination component dialog.

Setup

Use the parameters below to set up the component.

Parameters

FILE

Select an existing File connection manager.

Related Topics: File Connection Manager

Input Column Format

Specify result SAS variable format. This property is optional.

Related Topics: Formats Syntax

Input Column Informat

Specify result SAS variable informat. This property is optional.

Related Topics: Informats Syntax

SAS Data Source

Premium component

Overview

SAS Data Source Component is SSIS Data Flow Component for consuming data from SAS's sas7bdat files. The configuration options are provided in the standard data flow source component dialog.

Setup

Use the options below to setup the component.

Options

FILE

Select an existing File connection manager.

Related Topics: File Connection Manager

Dynamics AX Destination

Overview

The Dynamics AX Destination Component is an SSIS Data Flow Component for loading data into a Microsoft Dynamics AX table. The configuration parameters are provided in the standard data flow destination component dialog.

Setup

Use the parameters below to set up the component.

Parameters

DYNAMICS-AX

Select an existing Dynamics AX connection manager.

Related Topics: Dynamics AX Connection Manager

Action

Select the destination table action. This parameter has the options listed in the following table.

Action Description
Create Create a new record in the destination table.
Update Update an existing record in the destination table. The appropriate table record identifier must be specified for the update to work.
Delete Delete an existing record from the destination table. The appropriate table record identifier must be specified for the delete to work.

Note: After changing the action, you must use the Refresh command in the 'Column Mappings' tab to reload the destination list metadata.

DestinationTable

Specify the destination Dynamics AX table where the data is to be loaded.

ErrorRowDisposition (Dynamics AX Destination Input)

Specify how to handle rows with errors.

How to modify the destination table dynamically at runtime

The destination table is available in the data flow properties list. Follow these steps to set up an expression:

  • Right-click on the data flow canvas and select the Properties menu.
  • Scroll down and find the property named like [Dynamics AX Destination].[DestinationTable]. This is the property containing the destination table.
  • Scroll down and find the Expressions property. Set up an expression to modify the destination table dynamically.

Dynamics AX Source

Overview

The Dynamics AX Source Component is an SSIS Data Flow Component for consuming data from a Dynamics AX server. The configuration parameters are provided in the standard data flow source component dialog.

Setup

Use the parameters below to set up the component.

Parameters

DYNAMICS-AX

Select an existing Dynamics AX connection manager.

Related Topics: Dynamics AX Connection Manager

InputTables

Select one or more Dynamics AX tables from which data will be extracted.

Statement

Use SELECT statements to specify the data to be processed from the tables selected with the InputTables parameter above. To indicate which table the data should be extracted from, use %1 for the first table in InputTables, %2 for the second table in InputTables and so on.

How to modify input tables and statements dynamically at runtime

The input tables or query are available in the data flow properties list. Follow these steps to set up an expression:

  • Right-click on the data flow canvas and select the Properties menu.
  • Scroll down and find the property named like [Dynamics AX Source].[InputTables]. This is the property containing the input tables. Every table is separated with a comma and line feed (,\n)
  • Scroll down and find the Expressions property. Set up an expression to modify the input tables dynamically.
Syndicate content