Jitterbit App Builder Query Activity¶

Introduction¶

A Jitterbit App Builder Query activity, using its Jitterbit App Builder connection, retrieves objects from a specified module within an App Builder app and is intended to be used as a source to provide data in an operation.

Create a Jitterbit App Builder Query Activity¶

An instance of a Jitterbit App Builder Query activity is created from a Jitterbit App Builder connection using its Query activity type.

To create an instance of an activity, drag the activity type to the design canvas or copy the activity type and paste it on the design canvas. For details, see Creating an Activity Instance in Component Reuse.

An existing Jitterbit App Builder Query activity 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 Jitterbit App Builder Query Activity¶

Follow these steps to configure a Jitterbit App Builder Query activity:

Step 1: Enter a Name and Select an Object
Provide a name for the activity and select an object.
Step 2: Select an Operation
Select the operation to be performed on the selected object.
Step 3: Select a Module
Select the module containing the object to be queried.
Step 4: Review the Data Schemas
Any request or response schemas generated from the endpoint are displayed.

Step 1: Enter a Name and Select an Object¶

In this step, provide a name for the activity and select an object. Each user interface element of this step is described below.

Jitterbit App Builder Query Activity Configuration Step 1

Tip

Fields with a variable icon support using global variables, project variables, and Jitterbit variables. Begin either by typing an open square bracket [ into the field or by clicking the variable icon to display a list of the existing variables to choose from.

Name: Enter a name to identify the activity. The name must be unique for each Jitterbit App Builder Query activity and must not contain forward slashes (/) or colons (:).
Select an Object: This section displays objects available in the Jitterbit App Builder endpoint. When reopening an existing activity configuration, only the selected object is displayed instead of reloading the entire object list.
- Selected Jitterbit App Builder Object: After an object is selected, it is listed here.
- Search: Enter any part of the object name into the search box to filter the list of objects. The search is not case-sensitive. If objects are already displayed within the table, the table results are filtered in real time with each keystroke. To reload objects from the endpoint when searching, enter search criteria and then refresh, as described below.
- Refresh: Click the refresh icon or the word Refresh to reload objects from the Jitterbit App Builder endpoint. This may be useful if objects have been added to App Builder. This action refreshes all metadata used to build the table of objects displayed in the configuration.
- Selecting an Object: Within the table, click anywhere on a row to select an object. Only one object can be selected. The information available for each object is fetched from the App Builder endpoint:
  - Name: The object name from App Builder.
  - Description: The object description from App Builder.
Tip

If the table does not populate with available objects, the Jitterbit App Builder connection may not be successful. Ensure you are connected by reopening the connection and retesting the credentials.
Advanced HTTP Properties: Click the add icon to add a row to the table below and enter a key-value pair for each request parameter.

To save the row, click the submit icon in the rightmost column.

To edit or delete a single row, hover over the rightmost column and use the edit icon or delete icon .

To delete all rows, click Clear All.

Save & Exit: If enabled, click to save the configuration for this step and close the activity configuration.
Next: Click to temporarily store the configuration for this step and continue to the next step. The configuration will not be saved until you click the Finished button on the last step.
Discard Changes: After making changes, click to close the configuration without saving changes made to any step. A message asks you to confirm that you want to discard changes.

Step 2: Select an Operation¶

In this step, select the operation to be performed on the selected object. Each user interface element of this step is described below.

Jitterbit App Builder Query Activity Configuration Step 2

Select an Operation: This section displays operations available in the Jitterbit App Builder endpoint. When reopening an existing activity configuration, only the selected operation is displayed instead of reloading the entire operation list.
- Selected Jitterbit App Builder Object: The object selected in the previous step is listed here.
- Select Jitterbit App Builder Operation: After an operation is selected, it is listed here.
- Search: Enter any part of the operation name into the search box to filter the list of operations. The search is not case-sensitive. If operations are already displayed within the table, the table results are filtered in real time with each keystroke. To reload operations from the endpoint when searching, enter search criteria and then refresh, as described below.
- Refresh: Click the refresh icon or the word Refresh to reload operations from the Jitterbit App Builder endpoint. This may be useful if operations have been added to App Builder. This action refreshes all metadata used to build the table of operations displayed in the configuration.
- Selecting an Operation: Within the table, click anywhere on a row to select an operation. Only one operation can be selected. The information available for each operation is fetched from the App Builder endpoint:
  - Name: The operation name from App Builder.
  - Description: The operation description from App Builder.
Tip

If the table does not populate with available operations, the Jitterbit App Builder connection may not be successful. Ensure you are connected by reopening the connection and retesting the credentials.
Back: Click to temporarily store the configuration for this step and return to the previous step.
Next: Click to temporarily store the configuration for this step and continue to the next step. The configuration will not be saved until you click the Finished button on the last step.
Discard Changes: After making changes, click to close the configuration without saving changes made to any step. A message asks you to confirm that you want to discard changes.

Step 3: Select a Module¶

In this step, select the module containing the object to be queried. Each user interface element of this step is described below.

Jitterbit App Builder Query Activity Configuration Step 3

Select Module: This section displays modules available in the Jitterbit App Builder endpoint. When reopening an existing activity configuration, only the selected module is displayed instead of reloading the entire module list.
- Selected Object: The object selected in the previous step is listed here.
- Select Module: After a module is selected, it is listed here.
- Search: Enter any part of the module name into the search box to filter the list of modules. The search is not case-sensitive. If modules are already displayed within the table, the table results are filtered in real time with each keystroke. To reload modules from the endpoint when searching, enter search criteria and then refresh, as described below.
- Refresh: Click the refresh icon or the word Refresh to reload modules from the Jitterbit App Builder endpoint. This may be useful if modules have been added to App Builder. This action refreshes all metadata used to build the table of modules displayed in the configuration.
- Selecting a Module: Within the table, click anywhere on a row to select a module. Only one module can be selected. The information available for each module is fetched from the App Builder endpoint:
  - Name: The module name from App Builder.
  - Description: The module description from App Builder.
Tip

If the table does not populate with available modules, the Jitterbit App Builder connection may not be successful. Ensure you are connected by reopening the connection and retesting the credentials.
Back: Click to temporarily store the configuration for this step and return to the previous step.
Next: Click to temporarily store the configuration for this step and continue to the next step. The configuration will not be saved until you click the Finished button on the last step.
Discard Changes: After making changes, click to close the configuration without saving changes made to any step. A message asks you to confirm that you want to discard changes.

Step 4: Review the Data Schemas¶

Any request or response schemas generated from the endpoint are displayed. Each user interface element of this step is described below.

Jitterbit App Builder Query Activity Configuration Step 4

Data Schemas: These data schemas are inherited by adjacent transformations and are displayed again during transformation mapping.

Note

Data supplied in a transformation takes precedence over the activity configuration. For a description of each schema node and field, see Query Activity in Jitterbit App Builder Data Schemas.
Refresh: Click the refresh icon or the word Refresh to regenerate schemas from the Jitterbit App Builder endpoint. This action also regenerates a schema in other locations throughout the project where the same schema is referenced, such as in an adjacent transformation.
Back: Click to temporarily store the configuration for this step and return to the previous step.
Finished: Click to save the configuration for all steps and close the activity configuration.
Discard Changes: After making changes, click to close the configuration without saving changes made to any step. A message asks you to confirm that you want to discard changes.

Next Steps¶

After configuring a Jitterbit App Builder Query activity, complete the configuration of the operation by adding and configuring other activities, transformations, or scripts as operation steps. You can also configure the operation settings, which include the ability to chain operations together that are in the same or different workflows.

Menu actions for an activity are accessible from the project pane and the design canvas. For details, see Activity Actions Menu in Connector Basics.

Jitterbit App Builder Query activities can be used as a source with these operation patterns:

Transformation Pattern
Two-target Archive Pattern (as the first source only)
Two-target HTTP Archive Pattern (as the first source only)
Two-transformation Pattern (as the first or second source)

A typical use case is to use a Jitterbit App Builder Query activity in the Two-transformation Pattern. In this example, the first transformation (Query Request) creates a request structure that is passed to the Jitterbit App Builder Query activity. The second transformation (Query Response) receives the response structure, which is then written to a variable by a Variable Write activity (Write Query Response) and a message is then logged by the Write to Operation Log script:

Jitterbit App Builder Query operation

To use the activity with scripting functions, write the data to a temporary location and then use that temporary location in the scripting function.

When ready, deploy and run the operation and validate behavior by checking the operation logs.