JavaScript Jitterbit and Common Functions¶

Jitterbit JavaScripts can access—in addition to the standard JavaScript functions that are part of ECMA-262 v5.1—these Jitterbit-specific functions. As ECMA-262 v5.1 is an older version of JavaScript than what is commonly available in browsers and other JavaScript engines, we've included tables of the common and standard JavaScript functions that are available in Jitterbit JavaScripts.

Jitterbit Functions¶

Jitterbit.DbExecute¶

Declaration¶

array Jitterbit.DbExecute(string databaseId, string sql)

int Jitterbit.DbExecute(string databaseId, string sql, string outputVariable,...)

Syntax¶

Jitterbit.DbExecute(<databaseId>, <sql>)

Jitterbit.DbExecute(<databaseId>, <sql>, <outputVariable>,...])

Required Parameters¶

• databaseId: A string Database source in the current project
• sql: The SQL command to be executed against the database
• outputVariable: (Second form) An output parameter that is matched to fields returned in the SQL command. Additional arguments can be specified as required.

Description¶

Executes a SQL statement on a database and returns the results. See the Jitterbit Script DBExecute function for details.

Jitterbit.DbLookup¶

Declaration¶

string Jitterbit.DbLookup(string databaseId, string sql)

Syntax¶

Jitterbit.DbLookup(<databaseId>, <sql>)

Required Parameters¶

• databaseId: A string Database source in the current project
• sql: The SQL command to be executed against the database

Description¶

Executes a SQL statement on a database and returns the first field of the first result matching the specified criteria. See the Jitterbit Script DBLookup function for details.

Jitterbit.GetVar¶

Declaration¶

string Jitterbit.GetVar(string jitterbitVariableName)

Syntax¶

Jitterbit.GetVar(<jitterbitVariableName>)

Required Parameters¶

• jitterbitVariableName: The name of a Jitterbit Variable

Description¶

Returns the value of either a Jitterbit variable (the predefined global variables that are built into Jitterbit and begin with "$jitterbit."). The dollar symbol is optional and can be omitted.

The available variables can be seen in the Jitterbit Studio and are documented under Jitterbit Variables.

Examples¶

// Retrieves the value of the Jitterbit variable "jitterbit.api.request"
var request = Jitterbit.GetVar("$jitterbit.api.request");

Jitterbit.ReadFile¶

Declaration¶

string Jitterbit.ReadFile(string sourceId[, string fileFilter])

Syntax¶

Jitterbit.ReadFile(<sourceId>[, <fileFilter>])

Required Parameters¶

• sourceId: File-type source in the current project

Optional Parameters¶

• fileFilter: File filter or filename to override the source definition

Description¶

Reads the contents of a file from a source.

The file-type source used in this function call must be defined as a source in the current project.

See the instructions on inserting project items.

The method returns the contents of the file pointed to by the source. If the source filter selects more than one file, the first one will be used. It is recommended to specify a source that uniquely identifies a single file.

The parameter fileFilter is optional and can be used to override the file filter used in the source definition. A filename can be used. Alternatively, a global variable can be used to override the file filter in the source definition. Global variables are referenced as [de_name] in the source definition.

As of Harmony version 8.20, if the ReadFile function fails, the operation does not fail. A script will abort, a warning added to the operation log, and the operation will continue.

This method can be used to read data from an HTTP source. In that case, all Jitterbit $jitterbit.source.http.* variables will be populated.

Examples¶

// Reads the first file retrieved from a source
var fileContents = Jitterbit.ReadFile("<TAG>Sources/Customer CSV FTP</TAG>");

// Use the filename "test.txt" instead of what is defined in the source
var fileContents = Jitterbit.ReadFile("<TAG>Sources/Customer CSV FTP</TAG>", "test.txt");

Jitterbit.SetVar¶

Declaration¶

Jitterbit.SetVar(string jitterbitVariableName, string value)

Syntax¶

Jitterbit.SetVar(<jitterbitVariableName>, <value>)

Required Parameters¶

• jitterbitVariableName: The name of a Jitterbit Variable
• value: A value to be assigned to the variable

Description¶

Sets the value of a Jitterbit variable (the predefined global variables that are built into Jitterbit and begin with "$jitterbit."). The dollar symbol is optional and can be omitted.

The available variables can be seen in the Jitterbit Studio and are documented under Jitterbit Variables.

Examples¶

// Sets a Jitterbit variable
Jitterbit.SetVar("$jitterbit.scripting.db.max_rows", 1000);

Jitterbit.WriteFile¶

Declaration¶

void Jitterbit.WriteFile(string targetId, type fileContents[, string filename])

Syntax¶

Jitterbit.WriteFile(<targetId>, <fileContents>[, <filename>])

Required Parameters¶

• targetId: File-type target in the current project

Optional Parameters¶

• fileContents: Data to be written to the file
• filename: Filename to override the target definition

Description¶

Writes the fileContents to the file-type target specified by targetId. If fileContents is of type binary, the binary data is written to the file. In all other cases, a string representation of the data is written. The file is automatically flushed and closed by the function.

The file-type target used in this function call must be defined as a target in the current project.

The available variables can be seen in the Jitterbit Studio and are documented under Jitterbit Variables.

The third parameter, filename, is optional and can be used to override the filename used in the target. Alternatively, a global variable can be used to override the filename in the target definition. Global variables are referenced as [de_name] in the target definition.

This method can also be used to write/post data to an HTTP target. In that case, $jitterbit.target.http.* variables will be populated.

As of Harmony version 8.20, if the WriteFile function fails, the operation does not fail. A script will abort, a warning added to the operation log, and the operation will continue.

Examples¶

//  Writes the value of $contents to the file defined by a target
Jitterbit.WriteFile("<TAG>Targets/FTP Target</TAG>", $contents);

// Use the filename "test.txt" instead of what is defined in the target
Jitterbit.WriteFile("<TAG>Targets/FTP Target</TAG>", $contents, "test.txt");

SetScriptOutput¶

Declaration¶

void SetScriptOutput(string data)

Syntax¶

SetScriptOutput(<data>)

Required Parameters¶

• data: Data to be returned by the script

Description¶

Sets the value returned by a script.

The return value of a script can be accessed as the return value of the RunScript function.

Examples¶

// In the calling Jitterbit Script script:
$result = RunScript("<TAG>Scripts/CalculateSomething</TAG>", value_to_be_calculated);

// In the Jitterbit JavaScript script "CalculateSomething":
var calculated_value = ...;
...
SetScriptOutput(calculated_value);

SetScriptResult¶

Declaration¶

void SetScriptResult(string data)

Syntax¶

SetScriptResult(<data>)

Required Parameters¶

• data: Data to be returned by the script

Description¶

An alias for the SetScriptOutput function. See SetScriptOutput for details.

WriteToOperationLog¶

Declaration¶

string WriteToOperationLog(string message)

Syntax¶

WriteToOperationLog(<message>)

Required Parameters¶

• message: A string message

Description¶

Writes a message to the Operation Log.

Examples¶

// Writes a message to the Operation Log
WriteToOperationLog("The source field 'Price' has an invalid value.");

JavaScript Common Functions¶

These common JavaScript functions—part of ECMA-262 v5.1—are supported in Jitterbit JavaScripts.