PutJiraIssue

Description:

This processor creates issues on a Jira server or cloud service. A JSON with the issues definition must be provided as an incoming FlowFile.

Additional Details...

Tags:

jira, put, issue

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".
Record Readerrecord-readerController Service API:
RecordReaderFactory
Implementations: JASN1Reader
JsonTreeReader
GrokReader
Syslog5424Reader
CiscoEmblemSyslogMessageReader
AvroReader
JsonPathReader
CEFReader
IPFIXReader
WindowsEventLogReader
XMLReader
ScriptedReader
ReaderLookup
YamlTreeReader
ParquetReader
CSVReader
EBCDICRecordReader
ExcelReader
SyslogReader
Specifies the Controller Service to use for parsing incoming data and determining the data's schema.
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)

This Property is only considered if the [Record Reader] Property has a value specified.
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)

This Property is only considered if the [Record Reader] Property has a value specified.
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)

This Property is only considered if the [Record Reader] Property has a value specified.
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)

This Property is only considered if the [Record Reader] Property has a value specified.

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 when a Record Reader is set. 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)

Relationships:

NameDescription
successFor FlowFiles created as a result of a successful execution.
failureFor FlowFiles created as a result of an execution error.

Reads Attributes:

None specified.

Writes Attributes:

NameDescription
mime.typeSets the MIME type to application/json
error.messageThe error message returned by PutJiraIssue.
record.countThe number of records processed.
jira.issue.idThe ID of the Jira issue. In case of multiple records corresponds to the ID of the latest response.
jira.issue.keyThe key of the Jira issue. In case of multiple records corresponds to the key of the latest response.
jira.issue.selfThe link of the canonical location of the issue. In case of multiple records corresponds to the canonical lcation of the latest response.

State management:

This component does not store state.

Restricted:

This component is not restricted.

Input requirement:

This component requires an incoming relationship.

System Resource Considerations:

None specified.

See Also:

GetJiraIssue