Jitterbit Success Central

Log In to Jitterbit Harmony

View Jitterbit Developer Portal

Ask the Jitterbit Community

Getting Support

Suggest an Idea

Getting Jitterbit Training

Check Jitterbit System Status

PAGE TREE
Skip to end of metadata
Go to start of metadata

Introduction

This page covers Jitterbit variables that are available for targets, organized by informational variables that you get (read), and settings variables that you set (write):

Informational

Settings

Informational

jitterbit.target.file_count

Variablejitterbit.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

Variablejitterbit.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

Variablejitterbit.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

Variablejitterbit.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

Variablejitterbit.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

Variablejitterbit.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

Variablejitterbit.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

Variablejitterbit.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

Variablejitterbit.target.db.include_null_in_sql_statement

Data Type

Boolean
Defaultfalse
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

Variablejitterbit.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

Variablejitterbit.target.db.pre_target_sql

Data Type

String
Default""
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

Variablejitterbit.target.db.schema_name_delimiter

Data Type

String
Default.
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

Variablejitterbit.target.db.transaction

Data Type

Boolean
Defaulttrue
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.file_share.create_directories

Variablejitterbit.target.file_share.create_directories

Data Type

Boolean
Defaultfalse
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 and jitterbit.source.ftp.encode_url

Variablejitterbit.target.ftp.encode_url and
jitterbit.source.ftp.encode_url

Data Type

Boolean
Defaultfalse
Description

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

jitterbit.target.ftp.transfer_timeout

Variablejitterbit.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

Variablejitterbit.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

Variablejitterbit.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

Variablejitterbit.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

Variablejitterbit.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

Variablejitterbit.target.http.max_redirs

Data Type

Integer
Default0
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

Variablejitterbit.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

Variablejitterbit.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 $jitterbit.networking.http.response.header.Proxy-Authenticate would hold the value of the Proxy-Authenticate response-header.

jitterbit.target.http.ssl_cert_id

Variablejitterbit.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

Variablejitterbit.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.sftp.ssh_key_id and
jitterbit.source.sftp.ssh_key_id

Variablejitterbit.target.sftp.ssh_key_id and
jitterbit.source.sftp.ssh_key_id

Data Type

String
Default""
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

Variablejitterbit.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

Variablejitterbit.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.include_empty_xml

Variablejitterbit.target.xml.include_empty_xml

Data Type

Boolean
Defaultfalse
Description

If a mapping to a target node results in an empty value, include the node. The default is to exclude this node. Setting this option to false removes the node from the target XML. Setting this option to true includes the node in the target XML.

jitterbit.target.xml.include_null_xml

Variablejitterbit.target.xml.include_null_xml

Data Type

Boolean
Defaulttrue
Description

If a mapping to a target node results in null or an empty value, include the node but make it nil. The default is to include this node. Setting this option to false removes the node from the target XML.

jitterbit.target.xml.nsprefix

Variablejitterbit.target.xml.nsprefix

Data Type

String
Default"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

Variablejitterbit.target.xml.num_for_bool

Data Type

Boolean
Defaulttrue
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

Variablejitterbit.target.xml.prettify

Data Type

Boolean
Defaulttrue
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.


Last updated: Mar 03, 2022

Get answers from our community

Getting Support

Suggest an idea