Skip to main content
Kinetic Community

Jira Adapter

The Jira Adapter is used to retrieve data from a Jira instance and use it in Kinetic Schedule.

Requirements

  • The Kinetic Schedule web server must be using JDK 6.0 or higher.
  • The following java libraries must be included in the Kinetic Schedule web application classpath:​
    • Http Client 4.1.2 (httpclient-4.1.2.jar)
    • Http Core 4.1.2 (httpcore-4.1.2.jar)
    • Apache Commons Logging (commons-logging-1.1.1.jar)
    • Kinetic Schedule Jira Adapter (kinetic-schedule-jira-adapter.jar)
  • The adapter and required jars can be downloaded using this zip file

Adapter Configuration

The following properties are required for all adapters.

 

Property Description
name

Any alpha-numeric value is acceptable, but should indicate this is a Jira adapter.

Example: "jira"

className

The value of the main adapter class file.  This will be a unique value specific to the adapter.

Value: "com.kineticdata.schedule.adapter.jira.JiraAdapter"

 

Example Adapters Configuration File

{
    "adaptersConfig": {
        "adapters": [
            {
                "name": "jira",
                "className": "com.kineticdata.schedule.adapter.jira.JiraAdapter"
            }
        ]
    }
}

 

Connection Configuration

The following properties are required for all connections, regardless of what type of adapter is used.  If the value for that property is not used by the adapter, the property must still exist in the configuration file.  The value for the property should be set to the blank string ("") if it is not used.

 

Property Description
name

The name of the connection that will be used in data source configuration files that use this connection.  Should be a name that correlates the adapter and server.

Example: "jira"

type

The value that was entered as the "name" property for the JiraAdapter in the adapters configuration file.

Example: in the adapter configuration example above, the value would be "jira"

description

A description of the connection.  This is not seen by the end users, it is simply a way to describe what this connection interacts with.

Example: "Jira connection"

location

The Jira instance that will be used to load data into Kinetic Schedule.

Example: "https://company.atlassian.net"

username

The username used to login to the Jira instance.

Example: "Demo"

password

The password used to login to the Jira instance.  This value can be entered as plain-text or encrypted with the Password Encryption form.

Example: "pass123"

useEncryption

Indicates if the password is stored in plain-text or encrypted form.

"true" if encrypted, "false" if plain-text

 

There are no additional parameters needed for the Jira Adapter.

 

Example Connector Configuration File

{
    "connection": {
        "name": "jira",
        "type": "jira",
        "description": "Jira connection",
        "location": "https://company.atlassian.net",
        "username": "Demo",
        "password": "pass123",
        "useEncryption": "false",
        "additionalParameters": []
    }
}