Scripting Jitterbit variables in Integration Studio

Introduction

This page covers Jitterbit variables that are available for scripting. Each of these are settings variables that you write (Settings).

Settings

jitterbit.scripting.db.auto_commit

Data type

Boolean

Default value

true

Description

Set to false to run DbExecute and DbLookup statements in a transaction. Auto-commit is turned on by default.

jitterbit.scripting.db.character_encoding

Data type

String

Description

Specifies the character encoding used by database functions CallStoredProcedure and DBLookup when connected via ODBC.

If no encoding is specified, Latin-1 (ISO-8859-1) is assumed. For supported encoding, see Supported character encodings.

jitterbit.scripting.db.max_rows

Data type

Integer

Default value

10000

Description

Maximum number of rows to fetch with the DBExecute function.

jitterbit.scripting.db.rows_affected

Data type

Integer

Description

The number of rows affected by the DBExecute or DBLookup functions.

jitterbit.scripting.db.search.rowset

Data type

Boolean

Default value

false

Description

If using a JDBC driver to connect to a database, set to true upstream of the DBExecute function to make any calls to a stored procedure that returns multiple results to return the first non-empty record set instead of returning an empty set.

jitterbit.scripting.db.transaction

Data type

Boolean

Default value

false

Description

Set to true if you want the DBExecute and DBLookup functions to run in a transaction.

jitterbit.scripting.hex.enable_unicode_support

Data type

Boolean

Description

Set to true upstream of the HexToString or StringToHex functions to convert between string values and their UTF-16 hexadecimal representations. This variable is supported when using agent versions 10.71 / 11.9 or later.

jitterbit.scripting.ldap.include_dn_in_results

Data type

Boolean

Description

When set, XML-formatted LdapSearch results will include the DN attribute for each entry.

jitterbit.scripting.ldap.max_search_results

Data type

Integer

Description

The maximum number of entries LdapSearch should return.

jitterbit.scripting.ldap.return_null_if_no_results

Data type

Boolean

Default value

false

Description

If an LDAP query returns no results, a NULL data element is returned. The default is to return an empty array data element. This is for backward-compatibility only.

jitterbit.scripting.ldap.scope

Data type

Integer

Description

The scope LdapSearch should use. These options are valid:

• 0 – Search the base entry only.
• 1 – Search all entries in the first level below the base entry, excluding the base entry.
• 2 – Search the base entry and all entries in the tree below the base.

jitterbit.scripting.ldap.use_paged_search

Data type

Integer

Description

Use paged search when searching LDAP directories. This option is useful for retrieving large result sets.

This variable is supported only on Windows-based private agents and is not supported on Linux-based private agents or the cloud agent groups. To work around this limitation, we suggest one of these alternatives:

• Use an LDAP user that is not restricted by the search size limit imposed by the LDAP server, such as an admin user.
• Adjust the search size limit setting on the LDAP server itself.
• Instead of this variable, use the LDAP connector, whose Search entry activity supports paging on both Windows and Linux agents.

jitterbit.scripting.nesting.max

Data type

Integer

Default value

10

Description

Maximum nesting level for RunScript/RunOperation calls. If the nesting level is exceeded, the operation will fail. If your application needs deeper nesting, increase this number.

jitterbit.scripting.while.max_iterations

Data type

Integer

Default value

50000

Description

The maximum number of times that the body of a while loop will execute. Setting this number to less than 1 reverts to the default of 50,000 iterations.