Creating or editing an endpoint for JIRA activity

Endpoints provide the configuration information that the Studio and the Integration Appliance use to connect to JIRA platform. JIRA connector supports only Basic authentication mechanism so as to authorize users to perform operations. JIRA connector also supports HTTPS connection.

Selecting or editing an JIRA endpoint

  1. In the Create Endpoint or Edit Endpoint pane, configure the JIRA endpoint as described in the following table.
    Note: Changing the configuration properties of an endpoint affects all orchestrations that use that endpoint in the project. The edits are global, not local.
  2. Click Test Connection to confirm that the connection details are valid and you are able to connect to the JIRA successfully.
  3. Click OK.
Table 1. Connection properties
Field Name Description
Host Name Host Name for JIRA instance (on-premise or cloud).
Port Number Port for JIRA instance
User Name Authentication user name for accessing JIRA instance.
Password Authentication password for accessing JIRA instance.
Following parameters are required in endpoint test connection screen to make connection via Proxy:
Host Name Host Name of Proxy Network
Port Port Number of the Proxy Network.
User Name User Name for accessing service via proxy network.
Password Password for accessing service via proxy network.
Following parameters are required in endpoint test connection screen to make HTTPS connection:
HTTPS Checkbox to indicate weather HTTPS to be used
In addition with the above parameters, there is also a provision for Secure Connector configuration to connect the Endpoint with JIRA on-premise instance.
Note: In the Map Input section of each activity, relevant fields of endpoint panel are available to override at runtime. You can provide data to various groups of parameters like Proxy Details, Connection Details or Authentication Details to override. Providing only partial field data in a selected group is not allowed to override.

Objects Supported by the JIRA Connector

JIRA connector supports the JIRA objects as detailed in the table below:

Table 2. Operations supported by the JIRA objects
JIRA Objects Create Update Delete Retrieve All Retrieve Search
Attachment Yes Yes Yes
Component Yes Yes
Filter Yes Yes Yes Yes
Issue Yes Yes Yes Yes Yes
IssueComment Yes Yes Yes Yes Yes
IssueLink Yes Yes Yes
IssueLinkType Yes Yes Yes Yes Yes
IssueWorkLog Yes Yes Yes Yes Yes
IssueVote Yes Yes
Version Yes Yes Yes Yes
ProjectRole Yes Yes
Votes Yes
Watchers Yes Yes Yes
Group Yes
IssueType Yes Yes
Priority Yes Yes
Project Yes
Resolution Yes Yes
Status Yes Yes
User Yes Yes
UserOverMultiProject Yes
AssignableUser Yes
UsersWithPermissions Yes

Custom Objects support

JIRA does not support custom objects.

Custom Fields support

The JIRA UI allows user to add custom fields. These fields are associated only with JIRA ‘Issue’ object. Support for custom fields is provided in the connector activities - Create, Update, Search and Retrieve for the Issue object.

In the MapInputs for Create and Update activities, the Issue object will have additional nodes for custom fields so that user can provide values for them.

For Search and Retrieve activities, the MapOutputs will have additional nodes to identify the custom fields.

The format of custom fields for these activities is as shown below:
<customFields>
<customFieldId>dept-id</customFieldId>
 <customFieldName>deptName</customFieldName>
<customFieldType>FreeTextField</customFieldType>
 <customFieldValue>HR</customFieldValue>
 </customField>
Table 3. Operations supported by the JIRA objects
Custom field parameter Description
customFieldId The ID of the custom field created in JIRA UI. Between the custom field Name and ID, the precedence is given to ‘customFieldId’. If there are multiple custom fields with same name, the customFieldId should be provided to differentiate the fields, else appropriate error gets displayed.
customFieldName The name of the custom field which is provided in JIRA UI while creating it.
customFieldType

The type of custom field, displayed only for Create/Update activities. Allowed values are:

  • DatePickerField
  • DateTimeField
  • FreeTextField
  • Checkboxes
  • Labels
  • MultiSelect
  • RadioButtons
  • SelectList
  • TextField
  • URLField
  • UserPicker
  • GroupPicker
  • MultiGroupPicker
  • MultiUserPicker
  • ProjectPicker
  • SingleVersionPicker
  • VersionPicker

The type of JIRA custom field types not yet supported are:

  • CascadingSelectField
  • NumberField
customFieldValue The value of the custom field. This parameter is recurring to support multiple user input values. If multiple values are provided for a single input field, only the first value gets added.
Note:
  1. The custom field is optional.
  2. If the value is not provided for customFieldName/customFieldId, the other 2 parameter values will be ignored and issue will get created/updated successfully without modification in any custom field.
  3. If customFieldName, customFieldId and customFieldType is provided, an appropriate error message gets displayed for the missing value for customFieldValue.



Feedback | Notices


Timestamp icon Last updated: Tuesday, 27 September 2016


https://www.ibm.com/support/knowledgecenter/en/SS3LC4_7.5.3/com.ibm.wci.doc/JIRA_creating_an_endpoint_activity.html