Skip to main content

Table Output

Description

Table Output is a step in the Output Plugin for Process Studio Workflows. The Table output step writes information to a database table. It provides configuration options for a target table.

Configurations

Field NameDescription
Step nameName of the step. Note: The name must be unique in a single workflow.
ConnectionSpecify the database connection to which the data is to be written.
EditClick to edit the database connection.
NewClick to create a new database connection.
WizardClick to create a new database connection using the Wizard.
Target SchemaSpecify the name of the database schema.
BrowseClick to browse and select a database schema.
Target TableSpecify the name of the table to write data.
BrowseClick to browse and select a table from the schema.
Commit sizeSpecify the batch size for commit. Specifying a commit size may change the performance.

Note: Transactions are not supported on all database platforms.
Truncate tableEnable checkbox to truncate the table before inserting the first row into the table.
Ignore insert errorsEnable checkbox to ignore all insert errors A maximum of 20 warnings are logged. This option is not applicable for batch inserts.
Specify database fieldsEnable checkbox to specify the fields in the Database fields tab. Otherwise all fields are inserted by default.

Main options Tab

Field NameDescription
Partition data over tablesEnable checkbox to split the data over multiple tables based on the value of the date field specified in the Partitioning field below. When this option is selected, data is inserted into tables with name format: '<target-table>_<date-format>'. These tables must be created manually before running the transformation for data to be inserted in these tables.
Partitioning fieldSelect the date field to use to determine how to split values across multiple tables. This value is used to generate a dated table name into which data is inserted.
Partition data per monthSpecify the date format used in the table name when partitioning the table: 'yyyyMM' for 'per month'
Partition data per daySpecify the date format used in the table name when partitioning the table: 'yyyyMMdd' for 'per day'.
Use batch update for insertsEnable checkbox for batch inserts. This option is enabled by default.

The batch mode is only used when the following conditions are met:

The Use batch update for inserts check box is selected

The Commit Size option is greater than 0

The Return auto-generated key option is cleared

The workflow is not enabled to use unique connections (Workflow properties > Misc Tab > Make the workflow database transactional)

The database type supports batch updates

There are limiting factors depending on the database type and further step options.
Is the name of the table defined in a field?Enable checkbox to specify the name of the target table in the Field below.

This option allows you to store data from each row in a different table, based on the value of the Field that contains name of table.
Field that contains name of tableSelect a field name from the input stream to use for the name of the table when the option "Is the name of the table defined in a field?" is selected.
Store the table name fieldEnable checkbox to store the table name in the output. When using this option, the table must contain a column with the name you defined in the Field that contains name of table.
Return auto-generated keyEnable checkbox to return the key that was generated by inserting a row into the table in the field ‘Name of auto-generated key field’, below.
Specify Name of the auto-generated keyEnable checkbox to store the key that was generated by inserting a row into the table; in the field below ‘Name of the auto-generated key column’.
Name of the auto-generated key columnSpecify an output field that stores the name of auto-generated key column.
Name of auto-generated key fieldSpecify an output field that stores the auto-generated key.

Database Fields Tab

Field NameDescription
Fields to insert:Tabular List:
Table FieldSpecify the name of the database column to insert data.
Stream FieldSpecify the stream field being read from the source/input steps and inserted into the database.
Plain TextWhen a field receives a secret status in an upstream step, that status automatically travels with the data to the step. Use the Plain text setting to control how the step handles this incoming secret data.

Select Y to write the actual, unmasked value of the incoming secret field to the output target.

Select N (the default setting) to safely remove the secret field from the output entirely. The step never writes secret values to the target, and the step excludes the key from all generated objects.

Important:

· Secret columns are not included in either the lookup keys or the SET clause. Set plain text = Y to use the real value.

· Secret columns are not included in the INSERT — the database's default value or NULL is used for that column. Set plain text = Y to write the real value to the table.

· Select Y only when the target system requires the actual value and no secure alternative exists. Whenever possible, configure downstream tools to read credentials directly from a credential parameters or credential attribute rather than writing sensitive data to an output file or database.

· The system saves the Y selection directly within the workflow file. This ensures security reviewers can easily audit the workflow and identify any field configured to expose plain text data.

· Ensure the secret status remains intact before the data reaches the output step. Modifying the data upstream (for example, using a Calculator step to build "Token: " + secretField), or renaming the column using the Rename Fields step—removes the secret status.
Get fields (button)Click to import the fields from the data source into the Database fields table. The Specify database fields option in the general area must be selected for this to be active.
Enter field mapping (button)Click to open the Enter Mapping window. The Specify database fields option in the general area must be selected for this tool to be active.