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.

Note

To provide feedback on this beta feature, contact the Jitterbit Product Team.

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 (:).

• Enter a value for one or more of the fields Log entry prefix text, Variable, or Log entry suffix text:

  • Log entry prefix text: Enter a string to precede the optional variable selected in the Variable field.

  • Variable: Select a variable whose value will be logged. The menu includes global, project, and Jitterbit variables.

    To create a new project variable, click Add at the bottom right of the menu.

    To edit an existing project variable, hover over the variable in the menu and click the Edit icon. Global and Jitterbit variables cannot be edited from this menu.

    Within the 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).

  • Log entry suffix text: Enter a string to follow the optional variable selected in the Variable field.

• Preview: As values are entered or selected, a preview of the log message is automatically populated in this 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:

Icon	Description
	Edit opens the configuration screen.
	Cut places a copy of the component on your clipboard and deletes the original component from the project (see Component reuse).
	Copy places a copy of the component on your clipboard (see Component reuse).
	Rename positions the cursor on the activity or tool name for you to make any edits as necessary.
	Remove removes the component as an operation step from the operation.