Source Jitterbit Variables

Introduction

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

Informational

Settings

Informational

`jitterbit.source.filename`

Variable	`jitterbit.source.filename`
Data Type	String
Description	The name of the source file. Holds the leaf part of the locator. For example, if the locator is `ftp://ordersrv/orderdrop/po.xml`, the name of the source file is `po.xml`. This variable is available only while a transformation using this particular file is executing.

`jitterbit.source.filenames`

Variable	`jitterbit.source.filenames`
Data Type	Array
Description	Same as `jitterbit.source.locators` but holding only the leaf part of the locators (see `jitterbit.source.locator`). This variable is available unless it has been overwritten by another operation in an operation chain.

`jitterbit.source.http.response`

Variable	`jitterbit.source.http.response`
Data Type	String
Description	The response body returned from an HTTP source when used in an operation or `ReadFile()` script function. This variable is populated only when the operation or function fails. Available as of Jitterbit Harmony version 8.20.

`jitterbit.source.http.status_code`

Variable	`jitterbit.source.http.status_code`
Data Type	Integer
Description	The response status code returned from an HTTP source when used in an operation or `ReadFile()` script function. Available as of Jitterbit Harmony version 8.20.

`jitterbit.source.locator`

Variable	`jitterbit.source.locator`
Data Type	String
Description	The locator used to fetch a file. This can be a URL or a path to a file share, such as `ftp://ordersrv/orderdrop/po.xml`. This variable is available only while a transformation using this particular file is executing.

`jitterbit.source.locators`

Variable	`jitterbit.source.locators`
Data Type	Array
Description	An array containing all the locators that will be processed. This variable is available after the source files have been fetched. It is available as long as it has not been overwritten by another operation in an operation chain.

`jitterbit.source.size`

Variable	`jitterbit.source.size`
Data Type	Integer
Description	Size of the source file in bytes. The size is `0` for database sources.

`jitterbit.source.sizes`

Variable	`jitterbit.source.sizes`
Data Type	Array
Description	An array containing all the sizes of the source files that will be processed. This variable is available after the source files have been fetched. It is available as long as it has not been overwritten by another operation in an operation chain.

Settings

`jitterbit.source.db.character_encoding`

Variable	`jitterbit.source.db.character_encoding`
Data Type	String
Description	Specifies the character encoding for ODBC source database character/text columns. If no encoding is specified, Latin-1 (ISO-8859-1) is assumed. For supported encoding, see Character Encoding.

`jitterbit.source.db.preserve_char_whitespace`

Variable	`jitterbit.source.db.preserve_char_whitespace`
Data Type	Boolean
Default	`false`
Description	Preserves whitespace in `char(n)` database source columns if the length of the data is less than `n`.

`jitterbit.source.db.schema_name_delimiter`

Variable	`jitterbit.source.db.schema_name_delimiter`
Data Type	String
Default	`.`
Description	Character used by the source database to delimit the schema name from the table name, such as `Schema.Tab`. The default is a single period (`.`), as most databases use a period as the delimiter.

`jitterbit.source.db.trim`

Variable	`jitterbit.source.db.trim`
Data Type	Boolean
Default	false
Description	Trim white-space characters from values read from the database.

`jitterbit.source.file_limit`

Variable	`jitterbit.source.file_limit`
Data Type	Integer
Description	Maximum number of files to process for a file share or FTP source. This limit is applied after the files have been listed and filtered.

`jitterbit.source.file_share.file_list_limit`

Variable	`jitterbit.source.file_share.file_list_limit`
Data Type	Integer
Description	This option limits the number of files that are listed for a file share. It is applied before the filter. This option is more efficient than `jitterbit.source.file_limit`, but it can be used only if all the files in a directory are to be processed. In all other cases, use `jitterbit.source.file_limit` for file share sources.

`jitterbit.source.ftp.transfer_timeout`

Variable	`jitterbit.source.ftp.transfer_timeout`
Data Type	Integer
Description	Set the transfer time-out in seconds for FTP source transfers. The default transfer time-out for FTP is four hours (14,400 seconds). Set to zero to disable.

`jitterbit.source.http.max_redirs`

Variable	`jitterbit.source.http.max_redirs`
Data Type	Integer
Default	`0`
Description	Maximum number of redirects to follow when using an HTTP source. Set this variable to a negative number to follow any number of redirects. The default is 0 (zero); no redirects are followed.

`jitterbit.source.http.response.header.HeaderName`

Variable jitterbit.source.http.response.header.HeaderName(shown in the script editor as jitterbit.source.http.response.header.*)

Data Type

String

Description

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

For example, the variable jitterbit.networking.http.response.header.Content-Type would hold the MIME type of the body of the request.

`jitterbit.source.http.ssl_cert_id`

Variable	`jitterbit.source.http.ssl_cert_id`
Data Type	String
Description	An identifier for a configuration entry in the configuration file `jitterbit.conf` for the SSL certificate to use for HTTP sources. Also see Customizations > Client Certificates and Adding Certificates to Keystore for Private Agents.

`jitterbit.source.http.transfer_timeout`

Variable	`jitterbit.source.http.transfer_timeout`
Data Type	Integer
Description	Sets the transfer time-out in seconds for HTTP source transfers. The default transfer time-out for HTTP is one hour (3,600 seconds). Set to zero to disable.

`jitterbit.source.preserve_char_whitespace`

Variable	`jitterbit.source.preserve_char_whitespace`
Data Type	Boolean
Default	`false`
Description	Set this to `true` to preserve whitespace in source data. The default value is `false`, meaning white space will be trimmed from the beginning and end of strings in the source.

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

Variable	`jitterbit.source.sftp.ssh_key_id` and `jitterbit.target.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.source.text.character_encoding`

Variable	`jitterbit.source.text.character_encoding`
Data Type	String
Description	Specify the character encoding for text source documents. If no encoding is specified, Latin-1 (ISO-8859-1) is assumed. For supported encoding, see Character Encoding.

`jitterbit.source.text.csv_nullable`

Variable	`jitterbit.source.text.csv_nullable`
Data Type	Boolean
Description	If set to `true`, CSV files can contain null data elements. Two consecutive commas in a file will be interpreted as a null.

Related Articles

Page:

API Jitterbit Variables
Page:

Global Variable Target
Page:

Hosted Endpoint Jitterbit Variables
Page:

Operation Jitterbit Variables
Page:

Scripting Jitterbit Variables
Page:

SFDC Jitterbit Variables
Page:

Source Jitterbit Variables
Page:

Specifying Source and Target Fields Dynamically
Page:

Target Jitterbit Variables
Page:

Text Jitterbit Variables
Page:

Transformation Jitterbit Variables
Page:

Using Global Variables
Page:

Web Service Jitterbit Variables

Related Topics

Page:

Reference

Last updated: Jun 12, 2019

QUICK LINKS

PAGE TREE

Introduction

Informational

Settings

Informational

`jitterbit.source.filename`

`jitterbit.source.filenames`

`jitterbit.source.http.response`

`jitterbit.source.http.status_code`

`jitterbit.source.locator`

`jitterbit.source.locators`

`jitterbit.source.size`

`jitterbit.source.sizes`

Settings

`jitterbit.source.db.character_encoding`

`jitterbit.source.db.preserve_char_whitespace`

`jitterbit.source.db.schema_name_delimiter`

`jitterbit.source.db.trim`

`jitterbit.source.file_limit`

`jitterbit.source.file_share.file_list_limit`

`jitterbit.source.ftp.transfer_timeout`

`jitterbit.source.http.max_redirs`

`jitterbit.source.http.response.header.HeaderName`

`jitterbit.source.http.ssl_cert_id`

`jitterbit.source.http.transfer_timeout`

`jitterbit.source.preserve_char_whitespace`

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

`jitterbit.source.text.character_encoding`

`jitterbit.source.text.csv_nullable`

QUICK LINKS

PAGE TREE

Source Jitterbit Variables

Introduction

Informational

Settings

Informational

jitterbit.source.filename

jitterbit.source.filenames

jitterbit.source.http.response

jitterbit.source.http.status_code

jitterbit.source.locator

jitterbit.source.locators

jitterbit.source.size

jitterbit.source.sizes

Settings

jitterbit.source.db.character_encoding

jitterbit.source.db.preserve_char_whitespace

jitterbit.source.db.schema_name_delimiter

jitterbit.source.db.trim

jitterbit.source.file_limit

jitterbit.source.file_share.file_list_limit

jitterbit.source.ftp.transfer_timeout

jitterbit.source.http.max_redirs

jitterbit.source.http.response.header.HeaderName

jitterbit.source.http.ssl_cert_id

jitterbit.source.http.transfer_timeout

jitterbit.source.preserve_char_whitespace

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

jitterbit.source.text.character_encoding

jitterbit.source.text.csv_nullable

`jitterbit.source.filename`

`jitterbit.source.filenames`

`jitterbit.source.http.response`

`jitterbit.source.http.status_code`

`jitterbit.source.locator`

`jitterbit.source.locators`

`jitterbit.source.size`

`jitterbit.source.sizes`

`jitterbit.source.db.character_encoding`

`jitterbit.source.db.preserve_char_whitespace`

`jitterbit.source.db.schema_name_delimiter`

`jitterbit.source.db.trim`

`jitterbit.source.file_limit`

`jitterbit.source.file_share.file_list_limit`

`jitterbit.source.ftp.transfer_timeout`

`jitterbit.source.http.max_redirs`

`jitterbit.source.http.response.header.HeaderName`

`jitterbit.source.http.ssl_cert_id`

`jitterbit.source.http.transfer_timeout`

`jitterbit.source.preserve_char_whitespace`

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

`jitterbit.source.text.character_encoding`

`jitterbit.source.text.csv_nullable`