Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
This page describes how to create and configure a

Introduction

global variable as a  can be configured as an in-memory source in Jitterbit Studio.

Create

. This lets the global variable be used anywhere that a source can be.

Creating a Global Variable Source

You can choose to create a new global variable Global Variable source on its own, or within an existing operation. For more information on how sources and targets work within operations, see Creating an Operation. For more information details on global variables, see Using Global Variables.

Create

Creating a New Global Variable Source as a Standalone Source

Within your project within in Jitterbit Design Studio, there are several ways to you create a new global variable sourceGlobal Variable source by any of:

  • Go to File > New > New Source. In the popup, select Global Variable as the type.; or

  • In the tree on the left, right-click on Sources and select New Source. In the popup, select Global Variable as the type.; or
  • In the top toolbar, click the green source icon 

    Image Removed

     Image Added .

In the popup,

select

select Global Variable

as

 as the type:

Image Added

Your new source appears in its own New Source tab in the right pane of the window.

Info

NOTE: If you create a standalone source

via one of the above

using any of these methods, note that it is not connected to

any

an operation.

To use the source you have just created in an operation, follow Use Existing

See Using an Existing Global Variable Source in an Existing Operation below to use the new source.

Create

Creating a New Global Variable Source in an Existing Operation

A source is usually created by default when you create a new operation. If you have already created an operation(The exception is an operation that consists only of a script.) With an existing operation, you can specify the type of the its source as followsby:

  • Within an operation, double-click Double-clicking on the source icon. In ; in the popup, select Create New Source. In the configuration screen, use the Type dropdown to select Global Variable.

    Within an operation, right-click

    ; or

  • Right-clicking on the source icon and select selecting Create New New Source . 

In the configuration screen that appears, use the Type dropdown to select Global Variable, as shown above.

Use

Using an Existing Global Variable Source in an Existing Operation

A source is created by default when you create a new operation. If you already have an existing global variable source you want to use, you can use it in the operation as follows:

Within an

To use an existing Global Variable source in an existing operation with a source, you can set it by any of:

  • Within the operation, double-click clicking on the source icon. In the source icon, and in the resulting popup, select the existing source from selecting the desired Global Variable source from the list.; or

  • Within an the operation, right-click clicking on the source icon and choose source icon, choosing Select Existing Source. In , and in the resulting popup, select the existing source from selecting the desired Global Variable source from the list.; or

  • Drag the existing source from Dragging the desired Global Variable source from the tree on the left and drop dropping it onto the source icon on existing source icon of the operation.
Configure

Configuring a Global

Variable Source

Variable Source

After you have created a new global variable sourceGlobal Variable source, the configuration screen will open in the main view of Design Studio. You can get back return to the configuration screen at any time by double-clicking on the source icon in the operation, or by double-clicking on the source in the tree on the left.

The basic configuration screen should look will appear similar to the example below. Each configurable option is explained as follows.

Image Removed

Variable: Enter an existing global variable name, or enter the name you want to use

this example:

Image Added

  • Name: Enter an appropriate, unique name for the source.
  • Type: Use the dropdown to select Global Variable, if it is not already specified.
  • Global Variable:
    • Variable: Enter the name of the global variable you want to use; either a name for a new global variable
  • . You can also
    • or the name of an existing global variable. If a new name is entered, the global variable will automatically be created.
      • To see a list of existing global variables, either double-click in
  • this box or begin typing an open square bracket '[' to bring up a list of existing global variables to choose from.
      • the field entry area or type a single open square bracket ([). You can then choose one of the existing global variables.
      • Global variable names can be specified in this field with or without square brackets as
  • of
  • TipNOTETest Connection: Clicking the Image Added button will test the Global Variable source; it will fail if the variable cannot be created in memory on the Agent. This can happen if the Agent is not reachable or the variable name is missing.
  • Click the Save button in either the main toolbar or the source's toolbar to save the configuration.

Tip

TIP: When creating new global variables,

it can be a good idea to prefix your global variables so that they are

prefix the global variable name so that it is easy to look up later. For example

,

: for a global variable such as org.api.response, as it is prefixed with org

will be

, it is easier to find

if you have

with other related global variables that also use the org prefix.

InfoNOTE: When using global variables inScripts or Transformations, you can reference the variable by beginning with a $, for example $org.api.response. For more information, see Using Global Variables.
  • Test Connection: Click the Image Removed button to test creating the variable in memory on the Agent.
  • Panel
    borderColor#65379B
    titleColor#FFFFFF
    titleBGColor#65379B
    titleOn This Page
    Table of Content Zone

    Table of Contents
    maxLevel3
    minLevel2
    indent20px

    Panel
    borderColor#00B886#FF7C4C
    titleColor#FFFFFF
    titleBGColor#00B886#FF7C4C
    titleRelated TopicsArticles
    contentbylabelshowLabels
    falsemax1000showSpacefalsesort
    Panel
    borderColor
    #00B886
    titleColor
    #FFFFFF
    titleBGColor
    #00B886
    title
    cqllabel in ("source-overview","script-overview") and space = "DOC"
    Related Topics

    HideElements
    metastrue

    Last updated: 

    Lastmodifieddate