Skip to Content

Scripting Jitterbit Variables

Introduction

This page covers Jitterbit variables that are available for scripting. Each of these variables is available to set (write):

  • jitterbit.scripting.db.auto_commit
  • jitterbit.scripting.db.max_rows
  • jitterbit.scripting.db.rows_affected
  • jitterbit.scripting.db.transaction
  • jitterbit.scripting.ldap.include_dn_in_results
  • jitterbit.scripting.ldap.max_search_results
  • jitterbit.scripting.ldap.return_null_if_no_results
  • jitterbit.scripting.ldap.scope
  • jitterbit.scripting.ldap.use_paged_search
  • jitterbit.scripting.nesting.max
  • jitterbit.scripting.while.max_iterations

Settings

jitterbit.scripting.db.auto_commit

Variable jitterbit.scripting.db.auto_commit

Data Type

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

jitterbit.scripting.db.max_rows

Variable jitterbit.scripting.db.max_rows

Data Type

Integer
Default 10000
Description Maximum number of rows to fetch in a call to DbExecute.

jitterbit.scripting.db.rows_affected

Variable jitterbit.scripting.db.rows_affected

Data Type

Integer
Description The number of rows affected by a call to DbExecute or DbLookup.

jitterbit.scripting.db.transaction

Variable jitterbit.scripting.db.transaction

Data Type

Boolean
Default false
Description Set to true if you want DbExecute/DbLookup calls to run in a transaction.

jitterbit.scripting.ldap.include_dn_in_results

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

Note

This variable is set and used independently of the LDAP connector.

jitterbit.scripting.ldap.max_search_results

Variable jitterbit.scripting.ldap.max_search_results

Data Type

Integer
Description

The maximum number of entries LdapSearch should return.

Note

This variable is set and used independently of the LDAP connector.

jitterbit.scripting.ldap.return_null_if_no_results

Variable jitterbit.scripting.ldap.return_null_if_no_results

Data Type

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

Note

This variable is set and used independently of the LDAP connector.

jitterbit.scripting.ldap.scope

Variable

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.

Note

This variable is set and used independently of the LDAP connector.

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

Note

This variable is set and used independently of the LDAP connector.

jitterbit.scripting.nesting.max

Variable

jitterbit.scripting.nesting.max

Data Type

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

Variable

jitterbit.scripting.while.max_iterations

Data Type

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

Note

This setting applies to Jitterbit Script only. For JavaScript, see Loop Iterations under JavaScript.