JiraRecordSink

Description:

Provides a RecordSinkService that can be used to create Jira tasks.

Additional Details...

Tags:

jira, record, sink, send

Properties:

In the list below, the names of required properties appear in bold. Any other properties (not in bold) are considered optional. The table also indicates any default values, and whether a property supports the NiFi Expression Language.

Display NameAPI NameDefault ValueAllowable ValuesDescription
Web Client Service Providerweb-client-service-providerController Service API:
WebClientServiceProvider
Implementation: StandardWebClientServiceProvider
Controller service for HTTP client operations.
URLjira-base-urlBase URL of Jira. Example: https://issues.apache.org/jira
Authentication Methodjira-authentication-methodNone
  • None Access Jira anonymously
  • Access Token Use Personal Access Token to access Jira (supported by Jira Server).
  • API Token Use your e-mail address & API token to access Jira (supported by Jira Cloud).
Method used to authenticate with Jira
Access Tokenjira-personal-access-tokenPersonal access tokens (PATs) are a secure way to use scripts and integrate external applications with your Atlassian application. In Jira, select your profile picture at the top right of the screen, then choose Profile. Once you access your profile, select Personal Access Tokens in the left-hand menu.
Sensitive Property: true

This Property is only considered if the [Authentication Method] Property has a value of "Access Token".
E-mail Addressjira-email-addressYour registered e-mail address at Jira Cloud.

This Property is only considered if the [Authentication Method] Property has a value of "API Token".
API Tokenjira-api-tokenYour API token at Jira Cloud. To create such token, visit your Atlassian ID Account Settings page at: https://id.atlassian.com
Sensitive Property: true

This Property is only considered if the [Authentication Method] Property has a value of "API Token".
Project Keyproject-keyThe Project Key field is used to uniquely identify a project. This property can either be a constant value or a @{Record Path} format, where the RecordPath is evaluated against each incoming Record. Expression language is evaluated first.
Supports Expression Language: true (will be evaluated using flow file attributes and Environment variables)
Issue Summaryissue-summaryThe summary of the issue. This property can either be a constant value or a @{Record Path} format, where the RecordPath is evaluated against each incoming Record. Expression language is evaluated first.
Supports Expression Language: true (will be evaluated using flow file attributes and Environment variables)
Issue Descriptionissue-descriptionThe detailed description of the issue. This property can either be a constant value or a @{Record Path} format, where the RecordPath is evaluated against each incoming Record. Expression language is evaluated first.
Supports Expression Language: true (will be evaluated using flow file attributes and Environment variables)
Issue Typeissue-typeIssue types categorizes issues, eg. Story, Task, Bug. Issue types can be created in Jira. This property can either be a constant value or a @{Record Path} format, where the RecordPath is evaluated against each incoming Record. Expression language is evaluated first.
Supports Expression Language: true (will be evaluated using flow file attributes and Environment variables)
Cache Sizecache-size1000Specifies how many Jira tasks should be cached.
Cache Expirationcache-expiration1 hourSpecifies how long a Jira task that is cached should remain in the cache.

Dynamic Properties:

Supports Sensitive Dynamic Properties: No

Dynamic Properties allow the user to specify both the name and value of a property.

NameValueDescription
An additional attribute to be added to the Jira issue.The attribute valueUser specified Dynamic Properties are added to the Jira issue. The key of the Dynamic Property should be a valid JsonPointer which denotes the JSON path where the extra property is inserted. The value of the property can be plain string, EL or RecordPath and will be inserted as a field value on the given path specified by the property key. In order to provide RecordPath values the @{Record Path Value} notation shall be used. See additional documentation for the Jira issue JSON.
Supports Expression Language: true (will be evaluated using flow file attributes and Environment variables)

State management:

This component does not store state.

Restricted:

This component is not restricted.

System Resource Considerations:

None specified.