Log (Beta) tool in Jitterbit Integration Studio

Introduction

The Log (Beta) tool is a project component used as an operation step to write text and variable values to the operation log. It can be used in place of a script (as an operation step) dedicated to the WriteToOperationLog function.

Create a Log tool instance

A new instance of a Log (Beta) tool can be created from these locations:

• The project pane's Components tab using the Create New menu (see Components tab actions menu in Project pane Components tab).

• The design component palette's Tools tab (see Tools in Design component palette).

An existing Log (Beta) tool can be edited from these locations:

• The design canvas (see Component actions menu in Design canvas).

• The project pane's Components tab (see Component actions menu in Project pane Components tab).

Configure a Log tool

The Log (Beta) configuration screen includes these fields and actions:

• Name: Enter a name to use to identify the instance. The name must be unique for each Log (Beta) tool and must not contain forward slashes (/) or colons (:).

• Log content: Enter a combination of text and variables to form the log message written to the operation log.

  This field supports global variables, project variables, and Jitterbit variables. Enter a variable either by typing an open square bracket [ into the field or by clicking the variable icon to display a menu listing existing variables to add to the field.

  Within the variable selection menu, the variable type is indicated by the icon next to its name:

  Icon	Variable type
  	Global variable
  	Project variable
  	Jitterbit variable

  • Include variable name in the log: When enabled, the variable's name is included in the log message (disabled by default). The output is a formatted string that prefixes the value with the variable's name and a separator. Every variable added to the Log content field has this option shown on hover:

    

  • Add variable: Click to open a dialog to create a new project variable.

• Preview: As the Log content field is updated, a preview of the log message is automatically populated in this field. The preview is also responsive to the state of the Include variable name in the log option for every variable added to the Log content field.

• Save Changes: After making changes to a new or existing configuration, click to save and close the configuration.

• Discard Changes: After making changes to a new or existing configuration, click to close the configuration without saving. A message asks you to confirm that you want to discard changes.

Actions

The actions bar for a Log (Beta) tool has these actions: