Skip to Content

GitHub Query File Activity

Introduction

A GitHub Query File activity, using its GitHub connection, queries a file in GitHub and is intended to be used as a source to provide data in an operation.

Caution

The Query File activity is deprecated. We recommend using the Search activity instead.

Create a GitHub Query File Activity

An instance of a GitHub Query File activity is created from a GitHub connection using its Query File 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 GitHub Query File activity can be edited from these locations:

Configure a GitHub Query File Activity

Follow these steps to configure a GitHub Query File activity:

Step 1: Enter a Name and Specify Settings

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

GitHub Query File Activity Configuration Step 1

Tip

Fields with a variable icon 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 GitHub Query File activity and must not contain forward slashes / or colons :.

  • GitHub Repository Name: Enter the name of the repository.

  • File Path of File to Be Queried: Enter a valid file path (for example, path/file.txt). The path should point to an existing directory in the GitHub instance.

  • 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: Review the Data Schemas

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

GitHub Query File Activity Configuration Step 2

  • 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.

    The GitHub connector uses the GitHub REST API. Refer to the API documentation for information on the schema nodes and fields.

    The response data schemas consist of these nodes and fields:

    Response Schema Node/Field Description
    deleteFileResponse Node of the delete file response
    isDeleted Boolean value of file deletion (true or false)
    commitMessage Returned commit message
    errorMessage Returned error message

  • Refresh: Click the refresh icon Refresh icon or the word Refresh to regenerate schemas from the GitHub 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 GitHub Query File 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.

GitHub Query File activities can be used as a source with these operation patterns:

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.