JIRA REST Connector 24.4
IDOL JIRA REST Connector Help

# Retrieve Data from JIRA

To automatically retrieve information from JIRA, create a new fetch task by following these steps. The connector runs each fetch task automatically, based on the schedule that is configured in the configuration file.

To create a new Fetch Task

1. Stop the connector.
2. Open the configuration file in a text editor.

3. In the `[FetchTasks]` section of the configuration file, specify the number of fetch tasks using the `Number` parameter. If you are configuring the first fetch task, type `Number=1`. If one or more fetch tasks have already been configured, increase the value of the `Number` parameter by one (1). Below the `Number` parameter, specify the names of the fetch tasks, starting from zero (0). For example:

       [FetchTasks]
       Number=1
       0=MyTask

4. Below the `[FetchTasks]` section, create a new TaskName section. The name of the section must match the name of the new fetch task. For example:

       [FetchTasks]
       Number=1
       0=MyTask

       [MyTask]

1. In the new section, set the parameters necessary for authentication.

   - To retrieve data from an instance of JIRA that is hosted in the cloud, using OAuth authentication, first follow the steps described in Configure OAuth. The OAuth configuration tool creates a file named `oauth.cfg`, which contains the parameters needed to authenticate. You can import these parameters into the task as follows:

         [MyTask] < "oauth.cfg" [OAUTH]

     For more information about including parameters from another file, see Include an External Configuration File.

   - To use HTTP basic authentication, set the following parameters:

     `BasicUsername` | The user name to use. The user must be able to view everything that you want to ingest.
     `BasicPassword` | The password or API token to use. If you are connecting to an instance of JIRA that is hosted in the cloud, you must use an API token. For information about how to obtain an API token, see Authentication (JIRA in the Cloud). Otherwise, specify a password.

     TIP: OpenText recommends that you encrypt the user name and password (or API token) before entering them into the configuration file. For information about how to encrypt the values of configuration parameters, see Encrypt Passwords.

2. In the new section, set the following configuration parameters:

   `JiraUrl` | The base URL of the JIRA instance. The connector expects the REST APIs to be accessible relative to this URL, at `<JiraUrl>/rest`. For example, the following URL should return a list of the available projects: `<JiraUrl>/rest/api/2/project`.
   `ProjectKey` | (Optional) A list of the JIRA projects that you want to ingest data from. If you do not set this parameter, the connector processes all accessible projects.
   `SSLMethod` | The SSL protocol to use. To use the highest protocol supported by both client and server, use the value `negotiate`.

   For example:

       JiraURL=https://example.com/jira
       ProjectKey0=PROJ1
       ProjectKey1=PROJ2
       SSLMethod=Negotiate

3. (Optional) If you need to use a proxy server when connecting to JIRA, set the following parameters so that the connector can access the JIRA instance.

   `ProxyHost` | The host name or IP address of the proxy server to use.
   `ProxyPort` | The port of the proxy server to use.

4. Save and close the configuration file.

Copyright 2024 Open Text
Version 24.4 | Last updated September 2024

Send documentation feedback

Close

Send documentation feedback

To send feedback using your default email client, open an email window.

Otherwise, send your feedback and the information below to MFI-swpdl.idoldocsfeedback@opentext.com.

We appreciate your feedback!

Product: IDOL JIRA REST Connector 24.4

Topic Title: Retrieve Data from JIRA