Session Properties Reference
Session Properties Reference
By PenchalaRaju.Yanamala
This appendix contains a listing of settings in the session properties. These settings are
grouped by the following tabs:
General Tab
Properties Tab
Mapping Tab (Transformations View)
Mapping Tab (Partitions View)
Components Tab
Metadata Extensions Tab
Properties Tab
General Options. General Options settings allow you to configure session log
file name, session log file directory, parameter file name and other general
session settings. For more information, see General Options Settings.
Performance. The Performance settings allow you to increase memory size,
collect performance details, and set configuration parameters. For more
information, see Performance Settings.
You can configure General Options settings on the Properties tab. You can enter
session log file name, session log file directory, and other general session
settings.
*Tip: When you bulk load to Microsoft SQL Server or Oracle targets, define a large
commit interval. Microsoft SQL Server and Oracle start a new bulk load
transaction after each commit. Increasing the commit interval reduces the number
of bulk load transactions and increases performance.
Performance Settings
Table A-3. Properties Tab - Performance Settings
Performance Description
Settings
DTM Buffer Size Amount of memory allocated to the session from the DTM
process.
By default, the Integration Service determines the DTM buffer
size at run time. The Workflow Manager allocates a minimum of
12 MB for DTM buffer memory.
You can specify auto or a numeric value. If you enter 2000, the
Integration Service interprets the number as 2000 bytes.
Append KB, MB, or GB to the value to specify other units. For
example, you can specify 512MB.
Increase the DTM buffer size in the following circumstances:
A session contains large amounts of character data and you
configure it to run in Unicode mode. Increase the DTM buffer
-size to 24MB.
A session contains n partitions. Increase the DTM buffer size
-to at least n times the value for the session with one partition.
A source contains a large binary object with a precision larger
than the allocated DTM buffer size. Increase the DTM buffer
-size so that the session does not fail.
Collect Collects performance details when the session runs. Use the
Performance Data Workflow Monitor to view performance details while the session
runs.
Write Writes performance details for the session to the PowerCenter
Performance Data repository. Write performance details to the repository to view
to Repository performance details for previous session runs. Use the
Workflow Monitor to view performance details for previous
session runs.
Incremental Select Incremental Aggregation option if you want the
Aggregation Integration Service to perform incremental aggregation.
Reinitialize Select Reinitialize Aggregate Cache option if the session is an
Aggregate Cache incremental aggregation session and you want to overwrite
existing aggregate files.
After a single session run, to return to a normal incremental
aggregation session run, you must clear this option.
Enable High When selected, the Integration Service processes the Decimal
Precision datatype to a precision of 28. If a session does not use the
Decimal datatype, leave this setting clear.
Session Retry On Select this option if you want the Integration Service to retry
Deadlock target writes on deadlock. You can only use Session Retry on
Deadlock for sessions configured for normal load. This option is
disabled for bulk mode. You can configure the Integration
Service to set the number of deadlock retries and the deadlock
sleep time period.
Pushdown Use pushdown optimization to push transformation logic to the
Optimization source or target database. The Integration Service analyzes
the transformation logic, mapping, and session configuration to
determine the transformation logic it can push to the database.
At run time, the Integration Service executes any SQL
statement generated against the source or target tables, and it
processes any transformation logic that it cannot push to the
database.
Select one of the following values:
None. The Integration Service does not push any
-transformation logic to the database.
To Source. The Integration Service pushes as much
-transformation logic as possible to the source database.
To Target. The Integration Service pushes as much
-transformation logic as possible to the target database.
Full. The Integration Service pushes as much transformation
logic as possible to both the source database and target
-database.
$$PushdownConfig. The $$PushdownConfig mapping
parameter allows you to run the same session with different
-pushdown optimization configurations at different times.
Default is None.
Allow Temporary Select to allow the Integration Service to create temporary
View for views in the database when it pushes the session to the
Pushdown database. The Integration Service must create a view in the
database if the session contains an SQL override, a filtered
lookup, or an unconnected lookup.
Allow Temporary Select to allow the Integration Service to create temporary
Sequence for sequence objects in the database. The Integration Service
Pushdown must create a sequence object in the database if the session
contains a Sequence Generator transformation.
Session Sort Specify a sort order for the session. The session properties
Order display all sort orders associated with the Integration Service
code page. When the Integration Service runs in Unicode
mode, it sorts character data in the session using the selected
sort order. When the Integration Service runs in ASCII mode, it
ignores this setting and uses a binary sort order to sort
character data.
In the Transformations view of the Mapping tab, you can configure settings for
connections, sources, targets, and transformations.
Connections
Sources
Targets
Transformations
Connections Node
The Connections node displays the source, target, lookup, stored procedure,
FTP, external loader, and queue connections. You can choose connection types
and connection values. You can also edit connection object values.
Sources Node
The Sources node lists the sources used in the session and displays their
settings. If you want to view and configure the settings of a specific source, select
the source from the list.
Readers. The Readers settings displays the reader the Integration Service uses
with each source instance. For more information, see Readers Settings.
Connections. The Connections settings lets you configure connections for the
sources. For more information, see Connections Settings.
Properties. The Properties settings lets you configure the source properties.
For more information, see Properties Settings.
Readers Settings
You can view the reader the Integration Service uses with each source instance.
The Workflow Manager specifies the necessary reader for each source instance.
For relations sources the reader is Relational Reader and for file sources it is File
Reader.
Table A-6. Mapping Tab - Sources Node - Properties Settings (Relational
Sources)
Relational Description
Source
Options
Owner Name Specifies the table owner name.
Source Table Specifies the source table name. Enter a table name, or enter a
Name parameter or variable to define the source table name in a
parameter file. You can use mapping parameters, mapping
variables, session parameters, workflow variables, or worklet
variables.
If you override the source table name here, and you override the
source table name using an SQL query, the Integration Service
uses the source table name defined in the SQL query.
User Defined Specifies the condition used to join data from multiple sources
Join represented in the same Source Qualifier transformation.
Tracing Level Specifies the amount of detail included in the session log when you
run a session containing this transformation. You can view the
value of this attribute when you click Show all properties.
Select Distinct Selects unique rows.
Pre SQL Pre-session SQL commands to run against the source database
before the Integration Service reads the source.
Post SQL Post-session SQL commands to run against the source database
after the Integration Service writes to the target.
Sql Query Defines a custom query that replaces the default query the
Integration Service uses to read data from sources represented in
this Source Qualifier. A custom query overrides entries for a
custom join or a source filter.
Source Filter Specifies the filter condition the Integration Service applies when
querying records.
Table A-7 describes the Properties settings on the Mapping tab for file sources:
Table A-7. Mapping Tab - Sources Node - Properties Settings (File Sources)
File Source Description
Options
Source File Enter the directory name in this field. By default, the Integration
Directory Service looks in the service process variable directory,
$PMSourceFileDir, for file sources.
If you specify both the directory and file name in the Source Filename
field, clear this field. The Integration Service concatenates this field
with the Source Filename field when it runs the session.
You can also use the $InputFileName session parameter to specify
the file directory.
Source Enter the file name, or file name and path. Optionally use the
Filename $InputFileName session parameter for the file name.
The Integration Service concatenates this field with the Source File
Directory field when it runs the session. For example, if you have
“C:\data\” in the Source File Directory field, then enter “filename.dat”
in the Source Filename field. When the Integration Service begins the
session, it looks for “C:\data\filename.dat”.
By default, the Workflow Manager enters the file name configured in
the source definition.
Source You can configure multiple file sources using a file list.
Filetype Indicates whether the source file contains the source data, or a list of
files with the same file properties. Select Direct if the source file
contains the source data. Select Indirect if the source file contains a
list of files.
When you select Indirect, the Integration Service finds the file list
then reads each listed file when it executes the session.
Set File You can configure the file properties.
Properties
Datetime Displays the datetime format for datetime fields.
Format*
Thousand Displays the thousand separator for numeric fields.
Separator*
Decimal Displays the decimal separator for numeric fields.
Separator*
*You can view the value of this attribute when you click Show all properties. This
attribute is read-only. For more information, see the PowerCenter Designer Guide.
Configure flat file properties by clicking the Set File Properties link in the Sources
node. You can define properties for both fixed-width and delimited flat file
sources.
You can configure flat file properties for non-reusable sessions in the Workflow
Designer and for reusable sessions in the Task Developer.
To edit the delimited properties, select Delimited in the Flat Files dialog box and
click the Advanced button. The Delimited File Properties dialog box appears.
Table A-9. Delimited Properties for File Sources
Delimited File Description
Properties
Options
Delimiters Character used to separate columns of data in the source file.
Delimiters can be either printable or single-byte unprintable
characters, and must be different from the escape character and
the quote character (if selected). To enter a single-byte
unprintable character, click the Browse button to the right of this
field. In the Delimiters dialog box, select an unprintable character
from the Insert Delimiter list and click Add. You cannot select
unprintable multibyte characters as delimiters. The delimiter must
be in the same code page as the flat file code page.
Optional Quotes Select None, Single, or Double. If you select a quote character,
the Integration Service ignores delimiter characters within the
quote characters. Therefore, the Integration Service uses quote
characters to escape the delimiter.
For example, a source file uses a comma as a delimiter and
contains the following row: 342-3849, ‘Smith, Jenna’, ‘Rockville,
MD’, 6.
If you select the optional single quote character, the Integration
Service ignores the commas within the quotes and reads the row
as four fields.
If you do not select the optional single quote, the Integration
Service reads six separate fields.
When the Integration Service reads two optional quote
characters within a quoted string, it treats them as one quote
character. For example, the Integration Service reads the
following quoted string as I’m going tomorrow:
2353, ‘I’’m going tomorrow.’, MD
Additionally, if you select an optional quote character, the
Integration Service only reads a string as a quoted string if the
quote character is the first character of the field.
Note: You can improve session performance if the source file
does not contain quotes or escape characters.
Code Page Select the code page of the delimited file. The default setting is
the client code page.
Row Delimiter Specify a line break character. Select from the list or enter a
character. Preface an octal code with a backslash (\). To use a
single character, enter the character.
The Integration Service uses only the first character when the
entry is not preceded by a backslash. The character must be a
single-byte character, and no other character in the code page
can contain that byte. Default is line-feed, \012 LF (\n).
Escape Character immediately preceding a delimiter character
Character embedded in an unquoted string, or immediately preceding the
quote character in a quoted string. When you specify an escape
character, the Integration Service reads the delimiter character
as a regular character (called escaping the delimiter or quote
character).
Note: You can improve session performance for mappings
containing Sequence Generator transformations if the source file
does not contain quotes or escape characters.
Remove Escape This option is selected by default. Clear this option to include the
Character From escape character in the output string.
Data
Treat By default, the Integration Service reads pairs of delimiters as a
Consecutive null value. If selected, the Integration Service reads any number
Delimiters as of consecutive delimiter characters as one.
One For example, a source file uses a comma as the delimiter
character and contains the following record: 56, , , Jane Doe. By
default, the Integration Service reads that record as four columns
separated by three delimiters: 56, NULL, NULL, Jane Doe. If you
select this option, the Integration Service reads the record as two
columns separated by one delimiter: 56, Jane Doe.
Number of Initial Integration Service skips the specified number of rows before
Rows to Skip reading the file. Use this to skip title or header rows in the file.
Targets Node
The Targets node lists the used in the session and displays their settings. If you
want to view and configure the settings of a specific target, select the target from
the list.
Writers. The Writers settings displays the writer the Integration Service uses
with each target instance. For more information, see Writers Settings.
Connections. The Connections settings lets you configure connections for the
targets. For more information, see Connections Settings.
Properties. The Properties settings lets you configure the target properties. For
more information, see Properties Settings.
Writers Settings
You can view and configure the writer the Integration Service uses with each
target instance. The Workflow Manager specifies the necessary writer for each
target instance. For relational targets the writer is Relational Writer and for file
targets it is File Writer.
Table A-12. Mapping Tab - Targets Node - Properties Settings (Relational)
Target Property Description
Target Load Type You can choose Normal or Bulk.
If you select Normal, the Integration Service loads targets
normally.
If you select Normal and the Microsoft SQL Server target
name includes spaces, configure the following connection
environment SQL in the connection object:
SET QUOTED_IDENTIFIER ON
You can select Bulk when you load to IBM DB2, Sybase,
Oracle, or Microsoft SQL Server. If you select Bulk for an
IBM DB2, Sybase, Oracle, or Microsoft SQL Server
target, the Integration Service invokes the bulk API with
default settings, bypassing database logging.
If you select Bulk for other database types, the Integration
Service reverts to a normal load.
Loading in bulk mode can improve session performance,
but limits the ability to recover because no database
logging occurs.
Insert If selected, the Integration Service inserts all rows flagged
for insert.
By default, this option is selected.
Update (as Update) If selected, the Integration Service updates all rows
flagged for update.
By default, this option is selected.
Update (as Insert) If selected, the Integration Service inserts all rows flagged
for update.
By default, this option is not selected.
Update (else Insert) If selected, the Integration Service updates rows flagged
for update if it they exist in the target, then inserts any
remaining rows marked for insert.
Delete If selected, the Integration Service deletes all rows
flagged for delete.
Truncate Table If selected, the Integration Service truncates the target
before loading.
Reject File Directory Enter the directory name in this field. By default, the
Integration Service writes all reject files to the service
process variable directory, $PMBadFileDir.
If you specify both the directory and file name in the
Reject Filename field, clear this field. The Integration
Service concatenates this field with the Reject Filename
field when it runs the session.
You can also use the $BadFileName session parameter
to specify the file directory.
Reject Filename Enter the file name, or file name and path. By default, the
Integration Service names the reject file after the target
instance name: target_name.bad. Optionally use the
$BadFileName session parameter for the file name.
The Integration Service concatenates this field with the
Reject File Directory field when it runs the session. For
example, if you have “C:\reject_file\” in the Reject File
Directory field, and enter “filename.bad” in the Reject
Filename field, the Integration Service writes rejected
rows to C:\reject_file\filename.bad.
Rejected Instructs the Integration Service to write the truncated
Truncated/Overflowed and overflowed rows to the reject file.
Rows*
Update Override* Override the default UPDATE statement.
Table Name Prefix Specify the owner of the target tables.
Pre SQL You can enter pre-session SQL commands for a target
instance in a mapping to execute commands against the
target database before the Integration Service reads the
source.
Post SQL Enter post-session SQL commands to execute
commands against the target database after the
Integration Service writes to the target.
Target Table Name Specifies the target table name. Enter a table name, or
enter a parameter or variable to define the target table
name in a parameter file. You can use mapping
parameters, mapping variables, session parameters,
workflow variables, or worklet variables.
*You can view the value of this attribute when you click Show all properties. This
attribute is read-only. For more information, see the PowerCenter Designer Guide.
Properties Settings for Flat File Targets
*You can view the value of this attribute when you click Show all properties. This
attribute is read-only. For more information, see the PowerCenter Designer Guide.
Click the Set File Properties button on the Mapping tab to configure flat file
properties. You can define flat file properties for both fixed-width and delimited
flat file targets.
You can configure flat file properties for non-reusable sessions in the Workflow
Designer and for reusable sessions in the Task Developer.
Table A-14. Fixed-Width Properties for File Targets
Fixed-Width Description
Properties
Options
Null Character Enter the character you want the Integration Service to use to
represent null values. You can enter any valid character in the
file code page.
Repeat Null Select this option to indicate a null value by repeating the null
Character character to fill the field. If you do not select this option, the
Integration Service enters a single null character at the beginning
of the field to represent a null value.
Code Page Select the code page of the fixed-width file. The default setting is
the client code page.
To edit the delimited properties, select Delimited in the Flat Files dialog box and
click the Advanced button. The Delimited File Properties dialog box appears.
Mapping Tab (Partitions View)
In the Partitions view of the Mapping tab, you can configure partitions. You can
configure partitions for non-reusable sessions in the Workflow Designer and for
reusable sessions in the Task Developer.
The following nodes are available in the Partitions view:
Select Reusable in the Type field if you want to select an existing Command task
as the pre- or post-session shell command. The Command Object Browser
appears when you click the Open button in the Value field.
Table A-25 describes the configuration options for the Metadata Extensions tab: