1"use strict";(self.webpackChunkKatalon_Docs=self.webpackChunkKatalon_Docs||[]).push([[13593],{11470:(e,n,t)=>{t.d(n,{A:()=>k});var i=t(96540),r=t(18215),s=t(17559),a=t(23104),o=t(56347),l=t(205),c=t(57485),d=t(31682),h=t(70679);function u(e){return i.Children.toArray(e).filter((e=>"\n"!==e)).map((e=>{if(!e||(0,i.isValidElement)(e)&&function(e){const{props:n}=e;return!!n&&"object"==typeof n&&"value"in n}(e))return e;throw new Error(`Docusaurus error: Bad <Tabs> child <${"string"==typeof e.type?e.type:e.type.name}>: all children of the <Tabs> component should be <TabItem>, and every <TabItem> should have a unique "value" prop.`)}))?.filter(Boolean)??[]}function p(e){const{values:n,children:t}=e;return(0,i.useMemo)((()=>{const e=n??function(e){return u(e).map((({props:{value:e,label:n,attributes:t,default:i}})=>({value:e,label:n,attributes:t,default:i})))}(t);return function(e){const n=(0,d.XI)(e,((e,n)=>e.value===n.value));if(n.length>0)throw new Error(`Docusaurus error: Duplicate values "${n.map((e=>e.value)).join(", ")}" found in <Tabs>. Every value needs to be unique.`)}(e),e}),[n,t])}function g({value:e,tabValues:n}){return n.some((n=>n.value===e))}function j({queryString:e=!1,groupId:n}){const t=(0,o.W6)(),r=function({queryString:e=!1,groupId:n}){if("string"==typeof e)return e;if(!1===e)return null;if(!0===e&&!n)throw new Error('Docusaurus error: The <Tabs> component groupId prop is required if queryString=true, because this value is used as the search param name. You can also provide an explicit value such as queryString="my-search-param".');return n??null}({queryString:e,groupId:n});return[(0,c.aZ)(r),(0,i.useCallback)((e=>{if(!r)return;const n=new URLSearchParams(t.location.search);n.set(r,e),t.replace({...t.location,search:n.toString()})}),[r,t])]}function x(e){const{defaultValue:n,queryString:t=!1,groupId:r}=e,s=p(e),[a,o]=(0,i.useState)((()=>function({defaultValue:e,tabValues:n}){if(0===n.length)throw new Error("Docusaurus error: the <Tabs> component requires at least one <TabItem> children component");if(e){if(!g({value:e,tabValues:n}))throw new Error(`Docusaurus error: The <Tabs> has a defaultValue "${e}" but none of its children has the corresponding value. Available values are: ${n.map((e=>e.value)).join(", ")}. If you intend to show no default tab, use defaultValue={null} instead.`);return e}const t=n.find((e=>e.default))??n[0];if(!t)throw new Error("Unexpected error: 0 tabValues");return t.value}({defaultValue:n,tabValues:s}))),[c,d]=j({queryString:t,groupId:r}),[u,x]=function({groupId:e}){const n=function(e){return e?`docusaurus.tab.${e}`:null}(e),[t,r]=(0,h.Dv)(n);return[t,(0,i.useCallback)((e=>{n&&r.set(e)}),[n,r])]}({groupId:r}),m=(()=>{const e=c??u;return g({value:e,tabValues:s})?e:null})();(0,l.A)((()=>{m&&o(m)}),[m]);return{selectedValue:a,selectValue:(0,i.useCallback)((e=>{if(!g({value:e,tabValues:s}))throw new Error(`Can't select invalid tab value=${e}`);o(e),d(e),x(e)}),[d,x,s]),tabValues:s}}var m=t(92303);const f={tabList:"tabList__CuJ",tabItem:"tabItem_LNqP"};var v=t(74848);function b({className:e,block:n,selectedValue:t,selectValue:i,tabValues:s}){const o=[],{blockElementScrollPositionUntilNextRender:l}=(0,a.a_)(),c=e=>{const n=e.currentTarget,r=o.indexOf(n),a=s[r].value;a!==t&&(l(n),i(a))},d=e=>{let n=null;switch(e.key){case"Enter":c(e);break;case"ArrowRight":{const t=o.indexOf(e.currentTarget)+1;n=o[t]??o[0];break}case"ArrowLeft":{const t=o.indexOf(e.currentTarget)-1;n=o[t]??o[o.length-1];break}}n?.focus()};return(0,v.jsx)("ul",{role:"tablist","aria-orientation":"horizontal",className:(0,r.A)("tabs",{"tabs--block":n},e),children:s.map((({value:e,label:n,attributes:i})=>(0,v.jsx)("li",{role:"tab",tabIndex:t===e?0:-1,"aria-selected":t===e,ref:e=>{o.push(e)},onKeyDown:d,onClick:c,...i,className:(0,r.A)("tabs__item",f.tabItem,i?.className,{"tabs__item--active":t===e}),children:n??e},e)))})}function y({lazy:e,children:n,selectedValue:t}){const s=(Array.isArray(n)?n:[n]).filter(Boolean);if(e){const e=s.find((e=>e.props.value===t));return e?(0,i.cloneElement)(e,{className:(0,r.A)("margin-top--md",e.props.className)}):null}return(0,v.jsx)("div",{className:"margin-top--md",children:s.map(((e,n)=>(0,i.cloneElement)(e,{key:n,hidden:e.props.value!==t})))})}function w(e){const n=x(e);return(0,v.jsxs)("div",{className:(0,r.A)(s.G.tabs.container,"tabs-container",f.tabList),
1children:[(0,v.jsx)(b,{...n,...e}),(0,v.jsx)(y,{...n,...e})]})}function k(e){const n=(0,m.A)();return(0,v.jsx)(w,{...e,children:u(e.children)},String(n))}},19365:(e,n,t)=>{t.d(n,{A:()=>a});t(96540);var i=t(18215);const r={tabItem:"tabItem_Ymn6"};var s=t(74848);function a({children:e,hidden:n,className:t}){return(0,s.jsx)("div",{role:"tabpanel",className:(0,i.A)(r.tabItem,t),hidden:n,children:e})}},28453:(e,n,t)=>{t.d(n,{R:()=>a,x:()=>o});var i=t(96540);const r={},s=i.createContext(r);function a(e){const n=i.useContext(s);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:a(e.components),i.createElement(s.Provider,{value:n},e.children)}},80712:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>d,contentTitle:()=>c,default:()=>p,frontMatter:()=>l,metadata:()=>i,toc:()=>h});const i=JSON.parse('{"id":"integrations/alm-and-test-management/jira-integration","title":"Jira integration","description":"This document shows you how to set up an integration for Jira within Katalon True Platform.","source":"@site/docs/katalon-platform/integrations/alm-and-test-management/jira-integration.md","sourceDirName":"integrations/alm-and-test-management","slug":"/integrations/alm-and-test-management/jira-integration","permalink":"/katalon-platform/integrations/alm-and-test-management/jira-integration","draft":false,"unlisted":false,"tags":[],"version":"current","lastUpdatedAt":1790051160000,"frontMatter":{"title":"Jira integration"},"sidebar":"katalon-platform","previous":{"title":"Azure DevOps Integration","permalink":"/katalon-platform/integrations/alm-and-test-management/azure-devops-integration"},"next":{"title":"Xray Integration","permalink":"/katalon-platform/integrations/alm-and-test-management/xray-integration"}}');var r=t(74848),s=t(28453),a=t(11470),o=t(19365);const l={title:"Jira integration"},c=void 0,d={},h=[{value:"Connect a Jira account to Katalon True Platform",id:"connect-a-jira-account-to-katalon-true-platform",level:2},{value:"Result",id:"result",level:4},{value:"Configure Jira integration at Project level",id:"configure-jira-integration-at-project-level",level:2},{value:"Step 2: Integration Options",id:"step-2-integration-options",level:4},{value:"Step 3: Release and Sprint Mapping",id:"step-3-release-and-sprint-mapping",level:4},{value:"Step 4: Common Fields and Values Mapping",id:"step-4-common-fields-and-values-mapping",level:4},{value:"Step 5: Requirement Fields and Value Mapping",id:"step-5-requirement-fields-and-value-mapping",level:4},{value:"Step 6: Bug Fields and Values Mapping",id:"step-6-bug-fields-and-values-mapping",level:4},{value:"Result",id:"result-1",level:4},{value:"View release plans synced from linked Jira Integration",id:"view-release-plans-synced-from-linked-jira-integration",level:2},{value:"Manage Jira integration",id:"manage-jira-integration",level:2},{value:"Disconnect a Jira Connection",id:"disconnect-a-jira-connection",level:3},{value:"Archive a Linked Jira integration",id:"archive-a-linked-jira-integration",level:3},{value:"Restore a Linked Jira integration",id:"restore-a-linked-jira-integration",level:3}];function u(e){const n={a:"a",admonition:"admonition",blockquote:"blockquote",br:"br",code:"code",em:"em",h2:"h2",h3:"h3",h4:"h4",hr:"hr",li:"li",ol:"ol",p:"p",strong:"strong",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",ul:"ul",...(0,s.R)(),...e.components},{Details:t}=n;return t||function(e,n){throw new Error("Expected "+(n?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.p,{children:"This document shows you how to set up an integration for Jira within Katalon True Platform."}),"\n",(0,r.jsxs)(n.p,{children:["If your Jira or Git instance is hosted on\u2011premise or behind a corporate firewall, use this guide together with the ",(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.a,{href:"/katalon-platform/troubleshooting/troubleshooting-common-administrative-issues/private-integration-network-troubleshooting",children:"Private Jira/Git integration (Network configuration guide)"})})," to ensure all required firewall rules and tunnels are in place."]}),"\n",(0,r.jsx)(n.h2,{id:"connect-a-jira-account-to-katalon-true-platform",children:"Connect a Jira account to Katalon True Platform"}),"\n",(0,r.jsxs)(n.p,{children:["Before configuring Jira integration at the ",(0,r.jsx)(n.strong,{children:"Project"})," level (selecting board, mapping fields...), you must first set up the connection at the ",(0,r.jsx)(n.strong,{children:"Account"})," level."]}),"\n",(0,r.jsx)(n.admonition,{title:"Requirements",type:"info",children:(0,r.jsxs)(n.p,{children:["You must have the ",(0,r.jsx)(n.strong,{children:"Account Admin"})," or ",(0,r.jsx)(n.strong,{children:"System Admin"})," role to perform this action."]})}),"\n",(0,r.jsx)(n.p,{children:"To set up the connection:"}),"\n",(0,r.jsxs)(n.ol,{children:["\n",(0,r.jsxs)(n.li,{children:["\n",(0,r.jsxs)(n.p,{children:["Go to ",(0,r.jsx)(n.strong,{children:"Account > Integrations"}),"."]}),"\n"]}),"\n",(0,r.jsxs)(n.li,{children:["\n",(0,r.jsxs)(n.p,{children:["Click ",(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"+ Create Integration"})}),". In the ",(0,r.jsx)(n.strong,{children:"Available Integration"})," list, choose ",(0,r.jsx)(n.strong,{children:"Jira"}),"."]}),"\n"]}),"\n",(0,r.jsxs)(n.li,{children:["\n",(0,r.jsxs)(n.p,{children:["Fill in the required fields to establish the connection. Katalon True Platform supports ",(0,r.jsx)(n.strong,{children:"two types"})," of Jira instances:"]}),"\n",(0,r.jsxs)(a.A,{groupId:"jira-instance-type",defaultValue:"cloud",children:[(0,r.jsxs)(o.A,{value:"cloud",label:"Jira Cloud or Atlassian.com (SaaS)",default:!0,children:[(0,r.jsx)("img",{src:"https://tw-cdn.katalon.com/katalon-platform/integration/jira-integration-saas-option.png",alt:"SaaS option",width:"800"}),(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Integration Name"}),": A custom name for the integration (max 50 characters)."]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Organization URL"}),": The Jira Organization URL.","\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:["Example: ",(0,r.jsx)(n.code,{children:"https://katalon-product-demo.atlassian.net"})]}),"\n",(0,r.jsxs)(n.li,{children:["Must start with ",(0,r.jsx)(n.code,{children:"https://"})]}),"\n"]}),"\n"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Personal Access Token (PAT)"}),": Enter your Jira API token. To generate a PAT, refer to this ",(0,r.jsx)(n.a,{href:"https://confluence.atlassian.com/enterprise/using-personal-access-tokens-1026032365.html",children:"documentation"}),". Please make sure the PAT has required permissions.","\n",(0,r.jsxs)(t,{children:[(0,r.jsxs)("summary",{children:[" \u2705 ",(0,r.jsx)(n.strong,{children:"Jira Permissions Required for integration"})," "]}),(0,r.jsxs)(n.table,{children:[(0,r.jsx)(n.thead,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Integration Feature"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Required Permission(s)"})}),(0,r.jsx)(n.th,{children:(0,r.jsx)(n.strong,{children:"Notes"})})]})}),(0,r.jsxs)(n.tbody,{children:[(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:"Manual Sync"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"Browse Projects"})}),(0,r.jsx)(n.td,{children:"Allows Katalon True Platform to retrieve project data from Jira."})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:"Link Defects"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"Browse Projects"})}),(0,r.jsx)(n.td,{children:"Enables linking Jira issues to Katalon True Platform test cases."})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:"Create Defects"})}),(0,r.jsxs)(n.td,{children:[(0,r.jsx)(n.code,{children:"Browse Projects"}),", ",(0,r.jsx)(n.code,{children:"Create Issues"})]}),(0,r.jsx)(n.td,{children:"Additional permissions may be required depending on Jira field configurations (see below)."})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{}),(0,r.jsxs)(n.td,{children:[(0,r.jsx)(n.em,{children:"Optional:"})," ",(0,r.jsx)(n.code,{children:"Assign Issues"}),", ",(0,r.jsx)(n.code,{children:"Modify Reporter"}),", ",(0,r.jsx)(n.code,{children:"Link Issues"}),", ",(0,r.jsx)(n.code,{children:"Resolve Issues"}),", ",(0,r.jsx)(n.code,{children:"Schedule Issues"})]}),(0,r.jsxs)(n.td,{children:["These become ",(0,r.jsx)(n.strong,{children:"required"})," if the corresponding fields (",(0,r.jsx)(n.code,{children:"Assignee"}),", ",(0,r.jsx)(n.code,{children:"Reporter"}),", ",(0,r.jsx)(n.code,{children:"Issue Links"}),", ",(0,r.jsx)(n.code,{children:"Fix Versions"}),", ",(0,r.jsx)(n.code,{children:"Due Date"}),") are marked as ",(0,r.jsx)(n.strong,{children:"required"})," in Jira."]})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:"Handle Webhook Events"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"Browse Projects"})}),(0,r.jsx)(n.td,{children:"Needed to associate Jira events with Katalon True Platform updates."})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.strong,{children:"Webhook Setup"})}),(0,r.jsxs)(n.td,{children:[(0,r.jsx)(n.code,{children:"Administer Jira"})," (global permission)"]}),(0,r.jsx)(n.td,{children:"Required only when configuring webhooks from Jira to Katalon True Platform."})]})]})]})]}),"\n"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Description (Optional)"}),": Brief description of the integration (max 255 characters)."]}),"\n"]}),(0,r.jsx)(n.p,{children:"\ud83d\udd01 Service Hooks will be automatically created at the project level for real-time syncing and automation."})]}),(0,r.jsxs)(o.A,{value:"datacenter",label:"Jira Datacenter Server or Self-Managed (On-Premise)",children:[(0,r.jsx)("img",{src:"https://tw-cdn.katalon.com/katalon-platform/integration/jira-integration-self-managed.png",alt:"Self-managed option",width:"800"}),(0,r.jsx)(n.admonition,{type:"note",children:(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Supported Version"}),": Jira Datacenter Server 10.6.1 and above. Older versions may not be compatible and could cause connection issues."]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Use HTTPS for Jira Data Center"}),": Configure your Jira Data Center instance to use HTTPS and update its base URL accordingly. Browsers may block or upgrade HTTP requests, which can prevent embedded resources such as images, icons, and videos from loading correctly in Katalon True Platform."]}),"\n"]})}),(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Integration Name"}),": Enter a custom name for the integration (max 50 characters)."]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Organization URL"}),": Enter the Jira Organization URL.","\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:["Example: ",(0,r.jsx)(n.code,{children:"https://your-jira-instance.example.com"})]}),"\n",(0,r.jsxs)(n.li,{children:["Must start with ",(0,r.jsx)(n.code,{children:"https://"}),"."]}),"\n"]}),"\n"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Personal Access Token (PAT)"}),": Enter the PAT of an ALM admin account. This is required for webhooks to work and to keep changes in sync with Katalon True Platform. To generate a PAT, refer to this ",(0,r.jsx)(n.a,{href:"https://confluence.atlassian.com/enterprise/using-personal-access-tokens-1026032365.html",children:"documentation"}),"."]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Description (Optional)"}),": Enter a brief description of the integration (max 255 characters)."]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"TestCloud Tunnel (Optional)"}),": Select an active tunnel from the list. If you cannot find an active tunnel, ",(0,r.jsx)(n.a,{href:"/katalon-testcloud/local-testing-with-testcloud/local-testing-with-testcloud-in-testops",children:"set up a new TestCloud Tunnel"}),"."]}
1),"\n",(0,r.jsxs)(n.li,{children:["For private, firewall-restricted environments, make sure the network paths between Jira and Katalon True Platform are configured as described in this ",(0,r.jsx)(n.a,{href:"/katalon-platform/troubleshooting/troubleshooting-common-administrative-issues/private-integration-network-troubleshooting",children:(0,r.jsx)(n.strong,{children:"Private Jira/Git integration \u2013 network configuration guide"})})," document."]}),"\n"]})]})]}),"\n"]}),"\n",(0,r.jsxs)(n.li,{children:["\n",(0,r.jsxs)(n.p,{children:["Click ",(0,r.jsx)(n.strong,{children:"Test Connection"})," to validate the integration."]}),"\n"]}),"\n",(0,r.jsxs)(n.li,{children:["\n",(0,r.jsxs)(n.p,{children:["Once validated, click ",(0,r.jsx)(n.strong,{children:"Save"}),", or click ",(0,r.jsx)(n.strong,{children:"Cancel"})," to exit without saving any changes."]}),"\n"]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"result",children:"Result"}),"\n",(0,r.jsxs)(n.p,{children:["To verify if the connection is active, navigate to ",(0,r.jsx)(n.strong,{children:"Admin > System > Integrations"}),". Your Jira integration will be listed under the ",(0,r.jsx)(n.strong,{children:"Integration list"}),"."]}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:["If the status initially shows as ",(0,r.jsx)(n.strong,{children:"Inactive"}),", reload the page to update the status to ",(0,r.jsx)(n.strong,{children:"Active"}),"."]}),"\n",(0,r.jsxs)(n.li,{children:["If the status shows ",(0,r.jsx)(n.strong,{children:"Error"}),", verify all required configuration fields, especially the Personal Access Token (PAT), and confirm it is valid and configured correctly in the account-level integration."]}),"\n"]}),"\n",(0,r.jsx)(n.h2,{id:"configure-jira-integration-at-project-level",children:"Configure Jira integration at Project level"}),"\n",(0,r.jsx)(n.admonition,{title:"Requirements",type:"info",children:(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:["You must have the ",(0,r.jsx)(n.strong,{children:"Project Admin"})," role to perform this action."]}),"\n",(0,r.jsxs)(n.li,{children:["You have connected a ",(0,r.jsx)(n.a,{href:"/katalon-platform/integrations/alm-and-test-management/jira-integration",children:"Jira account at the Account-level"})]}),"\n"]})}),"\n",(0,r.jsx)(n.p,{children:"Once the connection is established, you can now configure the integration and perform these actions:"}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsx)(n.li,{children:"Select Projects and Boards"}),"\n",(0,r.jsx)(n.li,{children:"Pull requirements"}),"\n",(0,r.jsx)(n.li,{children:"Map fields"}),"\n"]}),"\n",(0,r.jsxs)(n.ol,{children:["\n",(0,r.jsxs)(n.li,{children:["Navigate to your project > ",(0,r.jsx)(n.strong,{children:"Settings > Integrations"}),"."]}),"\n",(0,r.jsxs)(n.li,{children:["Click the right edge of your ",(0,r.jsx)(n.strong,{children:"linked connection"})," and select the Settings (\u2699\ufe0f) icon."]}),"\n"]}),"\n",(0,r.jsx)("img",{alt:"Jira clicks on Settings",src:"https://tw-cdn.katalon.com/katalon-platform/integration/click-settings-icon-in-project-settings.png",width:"700"}),"\n",(0,r.jsx)("br",{}),"\n",(0,r.jsxs)(n.ol,{start:"3",children:["\n",(0,r.jsxs)(n.li,{children:["Select the ",(0,r.jsx)(n.strong,{children:"Project"})," and ",(0,r.jsx)(n.strong,{children:"Board"}),":"]}),"\n"]}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Project"}),": Select the Jira Project to link from the dropdown list. This defines which work items will be synced to Katalon True Platform."]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Board"})," (Optional): Select a board to link to enhance collaboration."]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Description"})," (Optional): Brief description of the linked project (max 255 characters)."]}),"\n"]}),"\n",(0,r.jsx)("img",{src:"https://tw-cdn.katalon.com/katalon-platform/integration/jira-integration-project-level.png",alt:"Jira integration settings field at project level",width:"800"}),"\n",(0,r.jsx)("br",{}),"\n",(0,r.jsxs)(n.p,{children:["After selecting a Jira project and optional board, Katalon True Platform retrieves the fields and values available for that project. The configuration sections shown below depend on the options selected under ",(0,r.jsx)(n.strong,{children:"Integration Options with Jira"}),"."]}),"\n",(0,r.jsx)(n.h4,{id:"step-2-integration-options",children:"Step 2: Integration Options"}),"\n",(0,r.jsxs)(n.p,{children:["Select ",(0,r.jsx)(n.strong,{children:"Pull Requirements"})," to enable:"]}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsx)(n.li,{children:"Requirement synchronization and configure release and sprint mapping"}),"\n",(0,r.jsx)(n.li,{children:"Common field mapping"}),"\n",(0,r.jsx)(n.li,{children:"Requirement fields, work item types, release dates, and requirement statuses"}),"\n"]}),"\n",(0,r.jsxs)(n.p,{children:["Select ",(0,r.jsx)(n.strong,{children:"Bug Mapping"})," to enable ",(0,r.jsx)(n.strong,{children:"Bug Fields and Values Mapping"}),", where you can map Jira bug severity and status or resolution to Katalon True Platform values."]}),"\n",(0,r.jsx)(n.p,{children:"Select both options to configure both requirement and bug synchronization."}),"\n",(0,r.jsxs)(n.p,{children:["If a board is selected, sprint-related data is also retrieved from Jira. Review the available fields and mappings, adjust them to match your Jira workflow, and click ",(0,r.jsx)(n.strong,{children:"Proceed"})," to save the configuration and begin synchronization."]}),"\n",(0,r.jsx)(n.h4,{id:"step-3-release-and-sprint-mapping",children:"Step 3: Release and Sprint Mapping"}),"\n",(0,r.jsx)(n.p,{children:"Define how Release and Sprint data will be mapped from your Jira project."}),"\n",(0,r.jsx)(n.h4,{id:"step-4-common-fields-and-values-mapping",children:"Step 4: Common Fields and Values Mapping"}),"\n",(0,r.jsx)(n.p,{children:"This section allows you to map priority for effective issue prioritization and resource allocation, ensuring clear prioritization based on urgency (e.g., High, Medium, Low). Consistent mapping helps maintain workflow efficie
1ncy and prevents misalignment that could lead to inefficiencies."}),"\n",(0,r.jsxs)(n.p,{children:["Map ",(0,r.jsx)(n.strong,{children:"Jira Priority"})," levels your chosen ",(0,r.jsx)(n.strong,{children:"Katalon True Platform Priority"})," levels based on your workflow."]}),"\n",(0,r.jsx)(n.h4,{id:"step-5-requirement-fields-and-value-mapping",children:"Step 5: Requirement Fields and Value Mapping"}),"\n",(0,r.jsx)(n.p,{children:"Use this section to define how Jira requirement data appears in Katalon True Platform."}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Release Date for Requirement"})," (Optional): Select up to three Jira date fields. The fields are evaluated from left to right, and the first available value is used as the requirement\u2019s release date."]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Status mapping"}),": Map Jira Status or Resolution to the corresponding Katalon True Platform State."]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Work Item Types"}),": Select the Jira work item types that should be synchronized as requirements."]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Requirement fields mapping"})," (Optional): Select additional Jira fields to display in the True Platform requirement details. By default, only the Jira issue description is synchronized."]}),"\n"]}),"\n",(0,r.jsxs)(n.p,{children:["For each mapped field, you can customize the True Platform label, change the display order, or remove the field.",(0,r.jsx)(n.br,{}),"\n","Mapped fields appear as follows:"]}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsx)(n.li,{children:"Rich-text fields appear in the General tab below the description."}),"\n",(0,r.jsx)(n.li,{children:"Other field types appear in the collapsible Additional Information panel."}),"\n",(0,r.jsxs)(n.li,{children:["Empty Jira fields are displayed with a ",(0,r.jsx)(n.code,{children:"-"})," placeholder."]}),"\n"]}),"\n",(0,r.jsx)("div",{style:{display:"flex",justifyContent:"center"},children:(0,r.jsx)("iframe",{src:"https://demo.arcade.software/nvsG7UP3Z6pFP7eKZpeN?embed&embed_mobile=tab&embed_desktop=inline&show_copy_link=true",title:"Map Jira requirement fields into Katalon True Platform",frameborder:"0",loading:"lazy",webkitallowfullscreen:!0,mozallowfullscreen:!0,allowfullscreen:"true",allow:"clipboard-write",style:{width:"90%",height:"400px",border:"none"}})}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsx)(n.p,{children:"Fields provided by Jira Marketplace apps that are stored outside the standard Jira issue payload are not supported."}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:"For an existing Jira configuration, select Edit, configure the requirement fields, and click Proceed to re-sync. Then go to Plans and click Sync to refresh the requirements."}),"\n",(0,r.jsx)(n.h4,{id:"step-6-bug-fields-and-values-mapping",children:"Step 6: Bug Fields and Values Mapping"}),"\n",(0,r.jsx)(n.p,{children:"This section allows you to map the fields and values of bugs to the corresponding fields and values in Katalon True Platform."}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:["Map ",(0,r.jsx)(n.strong,{children:"Jira Severity"})," levels to your chosen ",(0,r.jsx)(n.strong,{children:"Katalon True Platform Severity"})," levels based on your workflow."]}),"\n",(0,r.jsxs)(n.li,{children:["Map ",(0,r.jsx)(n.strong,{children:"Jira Status"})," levels to your chosen ",(0,r.jsx)(n.strong,{children:"Katalon True Platform Status"}),"."]}),"\n",(0,r.jsxs)(n.li,{children:["Select either ",(0,r.jsx)(n.strong,{children:"Jira Resolution"})," or ",(0,r.jsx)(n.strong,{children:"Jira Status"})," to your chosen Katalon True Platform Status."]}),"\n"]}),"\n",(0,r.jsx)("img",{src:"https://tw-cdn.katalon.com/katalon-platform/integration/alm/jira-step6.png",alt:"Filling in required fields in System Integration UI",width:"900"}),"\n",(0,r.jsx)("br",{}),"\n",(0,r.jsxs)(n.ol,{start:"4",children:["\n",(0,r.jsxs)(n.li,{children:["Click ",(0,r.jsx)(n.strong,{children:"Proceed"})," to sync data and finalize the connection.","\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:["If the status initially shows as ",(0,r.jsx)(n.strong,{children:"Inactive"}),", reload the page to update the status to ",(0,r.jsx)(n.strong,{children:"Active"}),"."]}),"\n",(0,r.jsxs)(n.li,{children:["If you modify the connection details and click ",(0,r.jsx)(n.strong,{children:"Save"}),", your changes will be saved, but the status may remain ",(0,r.jsx)(n.strong,{children:"Inactive"}),". To sync data and finalize the connection, click ",(0,r.jsx)(n.strong,{children:"Proceed"}),"."]}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsxs)(n.p,{children:["To edit an existing linked Jira integration, click the ",(0,r.jsx)(n.strong,{children:"Edit (pen)"})," icon, make the necessary changes, and click ",(0,r.jsx)(n.strong,{children:"Proceed"}),". After editing, reload the page to ensure data is refreshed."]}),"\n"]}),"\n",(0,r.jsx)(n.h4,{id:"result-1",children:"Result"}),"\n",(0,r.jsx)(n.p,{children:"Your Jira integration is now active within your project."}),"\n",(0,r.jsx)(n.h2,{id:"view-release-plans-synced-from-linked-jira-integration",children:"View release plans synced from linked Jira Integration"}),"\n",(0,r.jsx)(n.p,{children:"To view release plans synced from linked Jira integration:"}),"\n",(0,r.jsxs)(n.ol,{children:["\n",(0,r.jsxs)(n.li,{children:["Navigate to your ",(0,r.jsx)(n.strong,{children:"specific project's UI > Plans"}),"."]}),"\n",(0,r.jsxs)(n.li,{children:["In the left-right ",(0,r.jsx)(n.strong,{children:"dropdown menu"}),", select the linked Jira integration."]}),"\n",(0,r.jsxs)(n.li,{children:["Click the ",(0,r.jsx)(n.strong,{children:"Sync"})," button to fetch the latest data."]}),"\n"]}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h2,{id:"manage-jira-integration",children:"Manage Jira integration"}),"\n",(0,r.jsx)(n.p,{children:"Katalon True Platform provides multiple ways to manage Jira integrations without losing historical data. This section covers how to disconnect, archive, and restore an integration when needed."}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:["Use ",(0,r.jsx)(n.strong,{children:"Disconnect"})," to disable Jira integration ",(0,r.jsx)(n.strong,{children:"across all projects"})," (Account-level)."]}),"\n",(0,r.jsxs)(n.li,{children:["Use ",(0,r.jsx)(n.strong,{children:"Archive"})," to disable Jira connection for ",(0,r.jsx)(n.strong,{children:"a single project"})," (Project-level)."]}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:"Katalon does not support permanently deleting integrations. This ensures audit history is preserved and enhances security and traceability."}),"\n",(0,r.jsx)(n.h3,{id:"disconnect-a-jira-connection",children:"Disconnect a Jira Connection"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsx)(n.p,{children:"Required role: Account Admin or System Admin to perform this action."}),"\n"]}),"\n",(0,r.jsxs)(n.p,{children:["Disconnecting makes the integration inactive across ",(0,r.jsx)(n.strong,{children:"all projects"}),". Katalon True Platform does not support fully deleting integrations, in order to preserve audit history."]}),"\n",(0,r.jsxs)(n.ol,{children:["\n",(0,r.jsxs)(n.li,{children:["\n",(0,r.jsxs)(n.p,{children:["Go to ",(0,r.jsx)(n.strong,{children:"Account > Integrations"}),"."]}),"\n"]}),"\n",(0,r.jsxs)(n.li,{children:["\n",(0,r.jsxs)(n.p,{children:["Click the ",(0,r.jsx)(n.strong,{children:"Disconnect"})," icon next to the connection."]}),"\n"]}),"\n",(0,r.jsxs)(n.li,{children:["\n",(0,r.jsxs)(n.p,{children:["Confirm b
1y clicking ",(0,r.jsx)(n.strong,{children:"Disconnect"})," in the dialog."]}),"\n",(0,r.jsxs)(n.p,{children:["=> The status changes to ",(0,r.jsx)(n.strong,{children:"Inactive"}),". All projects using this integration lose the ability to sync with Jira."]}),"\n"]}),"\n",(0,r.jsxs)(n.li,{children:["\n",(0,r.jsxs)(n.p,{children:["To reconnect, click the ",(0,r.jsx)(n.strong,{children:"Reconnect"})," icon next to the integration and confirm. All projects will resume syncing once reconnected."]}),"\n"]}),"\n"]}),"\n",(0,r.jsx)(n.h3,{id:"archive-a-linked-jira-integration",children:"Archive a Linked Jira integration"}),"\n",(0,r.jsxs)(n.blockquote,{children:["\n",(0,r.jsx)(n.p,{children:"Required role: Account Admin or System Admin to perform this action"}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:"Archiving disables the connection for that project only \u2014 other projects using the same Jira integration are unaffected. Archived configurations no longer appear in Project Settings, and any scheduled test runs will be canceled at runtime."}),"\n",(0,r.jsxs)(n.ol,{children:["\n",(0,r.jsxs)(n.li,{children:["Go to your project > ",(0,r.jsx)(n.strong,{children:"Settings > Integrations"}),"."]}),"\n",(0,r.jsxs)(n.li,{children:["Click the right edge of your linked connection and select ",(0,r.jsx)(n.strong,{children:"Archive"}),"."]}),"\n",(0,r.jsxs)(n.li,{children:["Confirm by clicking ",(0,r.jsx)(n.strong,{children:"Archive"})," in the dialog."]}),"\n"]}),"\n",(0,r.jsxs)(n.p,{children:["Result: The integration no longer appears in the ",(0,r.jsx)(n.strong,{children:"Plans module"}),"."]}),"\n",(0,r.jsx)(n.h3,{id:"restore-a-linked-jira-integration",children:"Restore a Linked Jira integration"}),"\n",(0,r.jsxs)(n.ol,{children:["\n",(0,r.jsxs)(n.li,{children:["Go to your project > ",(0,r.jsx)(n.strong,{children:"Settings > Integrations"}),"."]}),"\n",(0,r.jsxs)(n.li,{children:["Click ",(0,r.jsx)(n.strong,{children:"New configuration"})," (settings icon) on the Jira connection."]}),"\n",(0,r.jsxs)(n.li,{children:["Enter the same repository URL as the archived configuration and click ",(0,r.jsx)(n.strong,{children:"Proceed"}),"."]}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:"Katalon True Platform will restore the archived configuration rather than creating a duplicate."})]})}function p(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(u,{...e})}):u(e)}}}]);
Line numbers count LF bytes from the start of the resource, as the search results do. Vendor segments are library code the classifier recognised; they are stored but not indexed. Bytes are shown as Latin1 characters, one per byte.