Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Warning

Looking for the documentation on the newest versions of SIL Engine and the Simple Issue Language for Jira 8 for Server/Data Center? Click here !

Info
titleAvailability
  • This routine is available starting with
katl-commons
  • SIL Engine™ 1.1.2.
  • This routine is available for Jira server and cloud deployment options.

Syntax for server version

linkIssue(issueKey1, issueKey2_or_url, issueLinkTypeName_or_linkText)


Syntax for cloud version

linkissue(inwardIssueKey, outwardIssueKey, issueLinkTypeName [, comment, securityLevel])

Description

Excerpt

Links two issues by a specified link type name. First issue will have the outward description of the link type, the second issue will have the inward description of the link type.

Starting with katl-commons SIL Engine™ 4.0.14 you can also link the issue to a web link.

Parameters

Parameter name

Type

Required

Description

issueKey1

string

Yes

The key

Key of the first issue to be linked.

issueKey2_or_url

string

Yes

The key

Key of the second issue to be linked or the URL.

issueLinkTypeName_or_linkText

string

Yes

The issue

Issue link type name or the link text.

commentstringNoComment that will be posted on the selected issue.
securityLevelstringNoSecurity level of comment.

Return type

None. The  The returned value has no meaning.

Examples for server version

Example 1

Code Block
linkIssue(key, "TST-123", "Relates");
//key represents the key of current issue, "TST-123" the key of the issue it will be linked to.

Result: current issue is linked to issue "TST-123" by Relates link type, such that "TST-123" relates to current issue and vice versa.

...

Result: "TST-123" issue is linked to issue "TST-234" by Blocks link type, such that "TST-123" blocks "TST-234" and "TST-234" is blocked by "TST-123".

Example 3

Code Block
linkIssue("TST-123", "https://confluence.cprimeexample.iocom", "Confluence Documentation");

Result: "As a result, the TST-123 " issue is will be linked to URL "https://confluence.cprimeexample.io" com with link text the "Confluence Documentation" link text..

Examples for cloud version

Example 

Code Block
/*same as server*/
linkIssue(key, "TEST-5", "Duplicate");
Code Block
/*or like this, and the added comment will be public*/
linkIssue(key, "TEST-5", "Duplicate", "some text here")
Code Block
//*or like this, and the added comment will be visible just for users with project role "Developers"*/
linkIssue(key, "TEST-5", "Duplicate", "some text here", "Developers")


See also

Filter by label (Content by label)
showLabelsfalse
showSpacefalse
cqllabel = "jira_links_routine"
labelsjira_links_routine

...