Get Repository activity

An activity that retrieves information about a repository from GitHub.


Get Repository activity

Configure the Get Repository activity

Prerequisites

Good to Know

How to Start

  1. Open Process Builder.

    For information about how to open this screen, refer to Process Builder.


    Open Process Builder
  2. In the Process Builder, in the Activity Library, open the GitHub tab.

    Open GitHub tab
  3. On the GitHub tab, drag the Get Repository activity onto your process.

    Drag Get Repository activity

General Configuration

Specifies the basic settings for the Get Repository activity.

Figure: General Configuration screen

General Configuration screen

Good to Know

  • Documentation for this screen is provided for completeness. The fields are mostly self-explanatory.

Fields

Field NameDefinition

Display Name

Function:
Specifies the activity name that shows in your process.
Accepted Values:
One line of text that can have spaces.
Default Value:
None
Accepts Process Data Variables:
No
Example:
This is a common configuration field that is used in many examples. Refer to:
  • Examples - Step-by-step use case examples, information about what types of examples are provided in the AgilePoint NX Product Documentation, and other resources where you can find more examples.

Description

Function:
Specifies an optional text description for your activity.
Accepted Values:
More than one line of text.
Default Value:
None
Accepts Process Data Variables:
No

Get Repository Configuration

Specifies the information about the repository to retrieve from GitHub.

Figure: Get Repository Configuration screen

Get Repository Configuration screen

Fields

Field NameDefinition

GitHub

Function:
Specifies the access token that connects to your GitHub service.
Accepted Values:
A list of access tokens configured for your environment.
Default Value:
None

Create Add Token icon

Opens this Screen:
Access Token for GitHub
Function of this Screen:
Configure an access token to connect to GitHub.

Repository

Function:
Specifies the name of the repository whose information to retrieve.
Accepted Values:
A repository name from the list.

When you select the access token from the GitHub field, this field shows the repository names associated with the access token.

Default Value:
None
Accepts Process Data Variables:
Yes
Limitations:

Some information about third-party integrations is outside the scope of the AgilePoint NX Product Documentation. It is the responsibility of the vendors who create and maintain these technologies to provide this information. This includes specific business use cases and examples; explanations for third-party concepts; details about the data models and input and output data formats for third-party technologies; and various types of IDs, URL patterns, connection string formats, or other technical information that is specific to the third-party technologies. For more information, refer to Where Can I Find Information and Examples for Third-Party Integrations?

Map Response To App Schema / Store Response In This Variable

Function:
Specifies where to store the response from GitHub.
Accepted Values:
  • Map Response To App SchemaSelect this option if you want to map the information from the GitHub data model to your process schema.

    Click the Schema Mapping Schema Mapping icon button to open the Schema Mapper.

    Use this screen to connect the response to the data model for your process.

  • Store Response In This VariableSelect this option if you want to store the information from GitHub to a variable in the AgilePoint NX app.

    In the text field, specify a variable that accepts an alphanumeric string in JSON format.

Default Value:
Map Response To App Schema
Accepts Process Data Variables:
Yes
Limitations:

Some information about third-party integrations is outside the scope of the AgilePoint NX Product Documentation. It is the responsibility of the vendors who create and maintain these technologies to provide this information. This includes specific business use cases and examples; explanations for third-party concepts; details about the data models and input and output data formats for third-party technologies; and various types of IDs, URL patterns, connection string formats, or other technical information that is specific to the third-party technologies. For more information, refer to Where Can I Find Information and Examples for Third-Party Integrations?