Jitterbit App Builder Connection¶

Introduction¶

A Jitterbit App Builder connection, created using the Jitterbit App Builder connector, establishes access to App Builder. Once a connection is configured, you can create instances of Jitterbit App Builder activities associated with that connection to be used either as sources (to provide data in an operation) or as targets (to consume data in an operation).

Create or Edit a Jitterbit App Builder Connection¶

A new Jitterbit App Builder connection is created using the Jitterbit App Builder connector from one of these locations:

• The design component palette's Connections tab (see Design Component Palette).
• The Global Connections page (see Create a Global Connection in Global Connections).

An existing Jitterbit App Builder connection can be edited from these locations:

• The design component palette's Connections tab (see Design Component Palette).
• The project pane's Components tab (see Component Actions Menu in Project Pane Components Tab).
• The Global Connections page (see Edit a Global Connection in Global Connections).

Configure a Jitterbit App Builder Connection¶

Each user interface element of the Jitterbit App Builder connection configuration screen is described below.

• Connection Name: Enter a name to use to identify the connection. The name must be unique for each Jitterbit App Builder connection and must not contain forward slashes (/) or colons (:). This name is also used to identify the Jitterbit App Builder endpoint, which refers to both a specific connection and its activities.

• Region: Select the region of the App Builder app, one of APAC, EMEA, or NA. Custom is used only for internal purposes.

• Sandbox: Select if the environment in which your App Builder app resides is associated with the Sandbox app runtime. If not selected, the Production app runtime is assumed. For information on associating app runtimes, see Managing Environments in Environments.

• Username: Enter the username that was specified during the app's first release.

• Password: Enter the password that was specified during the app's first release.

• Client ID: Enter the app's client ID, located in the app's Overview section as the Client ID.

• Client Secret: Enter the client secret, located in the app's Overview section as the Client Key.

• Scope: Enter the scope. This field is not required.

• Test: Click to verify the connection using the provided configuration.

• Save Changes: Click to save and close the connection 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.

• Delete: After opening an existing connection configuration, click to permanently delete the connection from the project and close the configuration (see Component Dependencies, Deletion, and Removal). A message asks you to confirm that you want to delete the connection.

Next Steps¶

After a Jitterbit App Builder connection has been created, you place an activity type on the design canvas to create activity instances to be used either as sources (to provide data in an operation) or as targets (to consume data in an operation).

Menu actions for a connection and its activity types are accessible from the project pane and design component palette. For details, see Actions Menus in Connector Basics.

These activity types are available:

• Update: Updates existing objects in a specified module within an App Builder app and is intended to be used as a target in an operation.

• Delete: Deletes objects from a selected module within an App Builder app and is intended to be used as a target in an operation.

• Create: Creates objects in a specified module within an App Builder app and is intended to be used as a target in an operation.

• Query: Retrieves objects from a specified module within an App Builder app and is intended to be used as a source in an operation.