Target Jitterbit variables in Design Studio

Introduction

This page covers Jitterbit variables that are available for activities used as targets, organized by informational variables that you read (Informational), and settings variables that you write (Settings).

Informational

`jitterbit.target.file_count`

Data type

Integer

Description

After all the input files have been transformed, this variable is set to the number of target files that will be transferred.

`jitterbit.target.ftp.return_code`

Data type

Integer

Description

The response status code returned from an FTP target when used in an operation or WriteFile() script function. If no status code is returned, the reported value is -1.

`jitterbit.target.http.status_code`

Data type

Integer

Description

The response status code returned from a HTTP target when used in an operation or WriteFile() script function. If no status code is returned, the reported value is -1.

Settings

`jitterbit.target.chunk_node_name`

Data type

String

Description

If chunking (splitting a file apart) is enabled, a node is the repeating record (or loop node) at which it is possible to split the file.

For example, in an XML file, the named levels (repeating records) could be root, organization, department, and employee. You could choose to chunk (split) the file on department or on employee.

It is also possible to set the node in Operation options.

`jitterbit.target.chunk_size`

Data type

Integer

Description

Two possible cases where jitterbit.target.chunk_size = 2000:

Case 1: Source chunking is turned off, perform target chunking with size = 2000.
Case 2: Source chunking is turned on, it will combine the target first and then chunk the combined target to size = 2000.

`jitterbit.target.chunking_uncombined`

Data type

Boolean

Description

If set to true, and source chunking is turned on, target chunk files are not combined. This allows for 1 target file per record.

`jitterbit.target.db.character_encoding`

Data type

String

Description

Specify the character encoding for ODBC target database character/text columns. If no encoding is specified, Latin-1 (ISO-8859-1) is assumed. For supported encoding, see Supported character encodings.

`jitterbit.target.db.commit_chunks`

Data type

Boolean

Description

If set to true and chunking is enabled for an operation with a database source, each chunk is committed to the database as it is created. This setting can make the transformation run faster as chunks can be committed in parallel.

`jitterbit.target.db.include_null_in_sql_statement`

Data type

Boolean

Default value

false

Description

If set to true, INCLUDE and UPDATE statements generated by Jitterbit for database targets will contain explicit null values for columns that are nullable and have a mapping with a null result.

`jitterbit.target.db.no_data_action`

Data type

String

Description

Option for what to do if an empty database target is created. These values are valid:

OK
Warning
Error

The default (for when this variable is not set) can be changed in jitterbit.conf with the option in the [ErrorHandling] section called NoTargetDataGenerated. If nothing is specified there either, the default is to issue a warning.

`jitterbit.target.db.pre_target_sql`

Data type

String

Default value

""

Description

Run this SQL statement before starting to populate the target database table(s). The default is an empty string.

`jitterbit.target.db.schema_name_delimiter`

Data type

String

Default value

.

Description

The default is a single period (.). Character used by the target database to delimit the schema name from the table name, e.g. Schema.Tab. Almost all databases use a period for the delimiter.

`jitterbit.target.db.transaction`

Data type

Boolean

Default value

true

Description

Set to false if you don't want database changes to be made in a transaction. The default is to commit all of the database changes in a transaction.

`jitterbit.target.db.use_new_postgress_sequence`

Data type

Boolean

Description

Set to true upstream of a Database activity to support sequences when interacting with a PostgreSQL database via JDBC. This variable is supported when using agent versions 11.28 or later.

`jitterbit.target.file_share.create_directories`

Data type

Boolean

Default value

false

Description

Set to true if you want file share target directories to be checked and created. If the directory is known to exist then don't use this option.

`jitterbit.target.ftp.encode_url`

Data type

Boolean

Default value

false

Description

Set to true in a transformation script to use URL encoding where a target file or folder name contains special characters such as #, %, or @. For example, sftp://reposit.mysite.com/storage/file#1.xml.

See jitterbit.source.ftp.encode_url for the source version of this variable.

`jitterbit.target.ftp.transfer_timeout`

Data type

Integer

Description

Set the transfer time-out in seconds for FTP target transfers. The default transfer time-out for FTP is one hour (3,600 seconds). Set to zero to disable.

`jitterbit.target.http.form_data`

Data type

Boolean

Description

If set to true, each target file is uploaded using RFC 1687 form upload.

`jitterbit.target.http.form_data.ContentType`

Data type

String

Description

If RFC 1687 form upload is used, this sets the Content-Type of the file.

`jitterbit.target.http.form_data.filename`

Data type

String

Description

If RFC 1687 form upload is used, this sets the name of the uploaded file.

`jitterbit.target.http.form_data.name`

Data type

String

Description

If RFC 1687 form upload is used, this sets the name of the form.

`jitterbit.target.http.max_redirs`

Data type

Integer

Default value

0

Description

Maximum number of redirects to follow when using an HTTP target. Set this variable to a negative number to follow any number of redirects. The default is 0 (zero); no redirects are followed.

`jitterbit.target.http.remove_trailing_linebreaks`

Data type

Boolean

Description

If set to true, trailing line breaks will be removed before the target data is posted.

`jitterbit.target.http.response.header.<HeaderName>`

(shown in the script editor as jitterbit.target.http.response.header.*)

Data type

String

Description

Set when handling a hosted web service post or an HTTP endpoint. HTTP response headers are not exposed, just the payload. When substituted by the name of an HTTP header for <HeaderName>, this variable holds the corresponding value.

For example, the variable Get("jitterbit.target.http.response.header.Proxy-Authenticate") would hold the value of the Proxy-Authenticate response-header.

Note

If the header name includes a hyphen, you must reference the variable by using either the Set or Get functions.

`jitterbit.target.http.ssl_cert_id`

Data type

String

Description

An identifier for a configuration entry in jitterbit.conf for the SSL certificate to use for HTTP targets. See also Customizations > Client Certificates and Adding certificates to keystore for private agents.

`jitterbit.target.http.transfer_timeout`

Data type

Integer

Description

Set the transfer time-out in seconds for HTTP target transfers. The default transfer time-out for HTTP is one hour (3,600 seconds). Set to zero to disable.

`jitterbit.target.json.array_to_object`

Data type

Boolean

Description

If set to true upstream of a transformation with a JSON target data structure in an operation with chunking enabled, the target file will be in JSON format instead of XML.

`jitterbit.target.sftp.ssh_key_id` and `jitterbit.source.sftp.ssh_key_id`

Data type

String

Default value

""

Description

For configuring multiple SSH keys. By default, these are both empty, meaning the configuration in the [SSH] section of the jitterbit.conf configuration is used for all SFTP sources and targets with no password defined:

[SSH]
PublicKeyFile='Z:/ssh/rsa2048.pub'
PrivateKeyFile='Z:/ssh/rsa2048'
PrivateKeyPassphrase=secret

Note

When editing the configuration file, note that a line that is commented out with a leading # must not be left blank, or the next line will be read as a comment even if it does not begin with #.

If either of these variables is set to a string (such as "RSA"), then these configuration options will be used for a source or target (depending on which variable is defined):

PublicKeyFileRSA='Z:/ssh/id_rsa.pub'
PrivateKeyFileRSA='Z:/ssh/id_rsa'
PrivateKeyPassphraseRSA=verysecret

This allows the picking of different key sets when using public/private SSH key authentication for different SFTP sources and targets.

`jitterbit.target.text.character_encoding`

Data type

String

Description

Specify the character encoding for target text documents. If no encoding is specified, Latin-1 (ISO-8859-1) is assumed. For supported encoding, see Supported character encodings.

`jitterbit.target.wave.json`

Data type

String

Description

Used to override the JSON in a Salesforce Einstein (Wave) JSON metafile. See Overriding JSON metadata in Salesforce Einstein Analytics.

`jitterbit.target.xml.exclude_empty_data`

Data type

Boolean

Default value

false

Description

If a mapping to a target node results in an empty value, set this variable to true to exclude the node in the target XML. The default (false) is to include the node with an empty value from the target XML. This variable is recommended over jitterbit.target.xml.include_empty_xml when the target node has a boolean value.

For a true value of jitterbit.target.xml.exclude_empty_data to take effect, jitterbit.target.xml.include_null_xml must be set to false and jitterbit.target.xml.include_empty_xml must also be false (its default).

`jitterbit.target.xml.include_empty_xml`

Data type

Boolean

Default value

false

Description

If a mapping to a target node results in an empty value, set this variable to true to include the node in the target XML. The default (false) is to exclude the node with an empty value from the target XML. This variable does not affect target nodes that have a boolean value (see jitterbit.target.xml.exclude_empty_data instead).

`jitterbit.target.xml.include_null_xml`

Data type

Boolean

Default value

true

Description

If a mapping to a target node results in a null value or an empty value, the default of this variable (true) is to include the node in the target XML but make it nil. Set this variable to false to remove the node with a null value from the target XML.

`jitterbit.target.xml.nsprefix`

Data type

String

Default value

"NS"

Description

The default XML namespace prefix is "NS". If your XML requires a different namespace prefix, this variable can be used to override the default namespace prefix with your existing namespace prefix name.

For example, with the default XML namespace, your XML target output may look like this:

<ns:Body xmlns:ns="http://www.marketo.com/mktows/">
<ns:successGetMultipleLeads>
<result>

When you set this global variable equal to a different prefix, for example $jitterbit.target.xml.nsprefix="tp", then the output in this example would change to this:

<tp:Body xmlns:tp="http://www.marketo.com/mktows/">
<tp:successGetMultipleLeads>
<result>

`jitterbit.target.xml.num_for_bool`

Data type

Boolean

Default value

true

Description

If set to true, XML boolean target values will be represented with "0" or "1" for false and true values respectively. This is the default so to get the string values "true"/"false" instead you need to set this parameter to false.

`jitterbit.target.xml.prettify`

Data type

Boolean

Default value

true

Description

If set to true, XML targets are written with line breaks and tab indention. This is easier to read but the resulting file will be larger.