https://docs-production-katalon.netlify.app/assets/js/44c4a108.48d74ae5.js

1"use strict";(self.webpackChunkKatalon_Docs=self.webpackChunkKatalon_Docs||[]).push([[5680],{17303:(e,s,t)=>{t.d(s,{Ay:()=>o,RM:()=>a});var i=t(74848),n=t(28453);const a=[];function l(e){const s={admonition:"admonition",p:"p",strong:"strong",...(0,n.R)(),...e.components};return(0,i.jsx)(s.admonition,{title:"Attention",type:"caution",children:(0,i.jsxs)(s.p,{children:["This document covers ",(0,i.jsx)(s.strong,{children:"TestOps Legacy"})," version only."]})})}function o(e={}){const{wrapper:s}={...(0,n.R)(),...e.components};return s?(0,i.jsx)(s,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},28453:(e,s,t)=>{t.d(s,{R:()=>l,x:()=>o});var i=t(96540);const n={},a=i.createContext(n);function l(e){const s=i.useContext(a);return i.useMemo((function(){return"function"==typeof e?e(s):{...s,...e}}),[s,e])}function o(e){let s;return s=e.disableParentContext?"function"==typeof e.components?e.components(n):e.components||n:l(e.components),i.createElement(a.Provider,{value:s},e.children)}},65273:(e,s,t)=>{t.r(s),t.d(s,{assets:()=>d,contentTitle:()=>r,default:()=>p,frontMatter:()=>c,metadata:()=>i,toc:()=>m});const i=JSON.parse('{"id":"administer/administration-tasks/security-settings/configure-idle-timeout","title":"Configure Idle Timeout (Legacy)","description":"Important: An active Katalon Studio Enterprise (KSE) license.You must be an Admin or Owner of your Account.","source":"@site/docs/katalon-platform/administer/administration-tasks/security-settings/configure-idle-timeout.md","sourceDirName":"administer/administration-tasks/security-settings","slug":"/administer/administration-tasks/security-settings/configure-idle-timeout","permalink":"/katalon-platform/administer/administration-tasks/security-settings/configure-idle-timeout","draft":false,"unlisted":false,"tags":[],"version":"current","lastUpdatedAt":1757668806000,"frontMatter":{"title":"Configure Idle Timeout (Legacy)"},"sidebar":"katalon-platform","previous":{"title":"Configure Session Timeout (Legacy)","permalink":"/katalon-platform/administer/administration-tasks/security-settings/configure-session-timeout"},"next":{"title":"Grant permission to access Support Portal (Legacy)","permalink":"/katalon-platform/administer/administration-tasks/manage-support-portal-access/grant-permission-to-access-support-portal"}}');var n=t(74848),a=t(28453),l=t(86025),o=t(17303);const c={title:"Configure Idle Timeout (Legacy)"},r=void 0,d={},m=[...o.RM,{value:'<a class="anchor_top_offset"></a>In Katalon TestOps',id:"in-katalon-testops",level:2},{value:'<a class="anchor_top_offset"></a>In Katalon Studio',id:"in-katalon-studio",level:2}];function h(e){const s={h2:"h2",...(0,a.R)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(o.Ay,{}),"\n",(0,n.jsxs)("div",{xmlns:"http://www.w3.org/1999/xhtml",className:"note important note_important",children:[(0,n.jsx)("span",{className:"note__title",children:"Important:"})," ",(0,n.jsxs)("ul",{className:"ul",children:[(0,n.jsx)("li",{className:"li",children:"An active Katalon Studio Enterprise (KSE) license."}),(0,n.jsx)("li",{className:"li",children:"You must be an Admin or Owner of your Account."})]})]}),"\n",(0,n.jsx)("p",{xmlns:"http://www.w3.org/1999/xhtml",className:"p",children:"You can define how long an open Katalon Studio app with a KSE license can stay inactive before the licensed user is considered idle. Licensed users considered idle will be automatically signed out. This setting impacts all the licensed users in the Organization."}),"\n",(0,n.jsxs)(s.h2,{id:"in-katalon-testops",children:[(0,n.jsx)("a",{id:"task-5981",class:"anchor_top_offset"}),"In Katalon TestOps"]}),"\n",(0,n.jsxs)("section",{xmlns:"http://www.w3.org/1999/xhtml",className:"section context",children:["To enable ",(0,n.jsx)("span",{className:"ph uicontrol",children:"Idle Timeout"}),", do as follows:"]}),"\n",(0,n.jsxs)("ol",{xmlns:"http://www.w3.org/1999/xhtml",className:"ol steps",children:[(0,n.jsx)("li",{className:"li step stepexpand",children:(0,n.jsxs)("span",{className:"ph cmd",children:["Sign in to ",(0,n.jsx)("a",{className:"xref j-external-link",href:"https://my.katalon.com/",target:"_blank",children:"TestOps Admin"}),"."]})}),(0,n.jsxs)("li",{className:"li step stepexpand",children:[(0,n.jsxs)("span",{className:"ph cmd",children:["On the Account admin menu, select the ",(0,n.jsx)("span",{className:"ph uicontrol",children:"Security"})," section on the left bar, navigate to the ",(0,n.jsx)("span",{className:"ph uicontrol",children:"Idle Timeout (Katalon Studio Enterprise)"})," section."]}),(0,n.jsx)("div",{className:"itemgroup info",children:(0,n.jsx)("img",{className:"image",width:850,src:(0,l.Ay)("/3f37c090-46d9-11ee-9fb5-0242c7a41fd4/KT-Aug2023-Idle-Timeout.png"),alt:"Idle Timeout"})})]}),(0,n.jsxs)("li",{className:"li step stepexpand",children:[(0,n.jsxs)("span",{className:"ph cmd",children:["Toggled on ",(0,n.jsx)("span",{className:"ph uicontrol",children:"Automatically log out inactive users from KSE"}),"."]}),(0,n.jsxs)("div",{className:"itemgroup stepresult",children:[(0,n.jsxs)("p",{className:"p",children:["The ",(0,n.jsx)("span",{className:"ph uicontrol",children:"Timeout Limit"})," section appears."]}),(0,n.jsx)("img",{className:"image",width:500,src:(0,l.Ay)("/3fc24d50-46d9-11ee-9fb5-0242c7a41fd4/KT-Aug2023-Enable-Idle-Timeout.png"),alt:"Enable Idle Timeout"})]})]}),(0,n.jsxs)("li",{className:"li step stepexpand",children:[(0,n.jsxs)("span",{className:"ph cmd",children:["In the ",(0,n.jsx)("span",{className:"ph uicontrol",children:"Timeout Limit"})," dropdown list, choose one of the following options:"]}),(0,n.jsxs)("ul",{className:"ul choices",children:[(0,n.jsx)("li",{className:"li choice",children:"1 hour."}),(0,n.jsx)("li",{className:"li choice",children:"3 hours."}),(0,n.jsx)("li",{className:"li choice",children:"6 hours."}),(0,n.jsx)("li",{className:"li choice",children:"12 hours."}),(0,n.jsx)("li",{className:"li choice",children:"24 hours."}),(0,n.jsx)("li",{className:"li choice",children:"Custom (in minutes): specify your desired timeout (in minutes)."})]})]}),(0,n.jsxs)("li",{className:"li step stepexpand",children:[(0,n.jsx)("span",{className:"ph cmd",children:"Set the bypass threshold to limit the number of times that licensed users can resume the session after receiving the idle timeout notification. "}),(0,n.jsx)("ol",{type:"a",className:"ol substeps",children:(0,n.jsx)("li",{className:"li substep",children:(0,n.jsxs)("span",{className:"ph cmd",children:["By default, ",(0,n.jsx)("span",{className:"ph uicontrol",children:"Allow Idle Timeout Bypass Limit"})," option is disabled to allow licensed users to resume the session unlimited times. Turn on this section then input the desired bypass limit."]})})})]}),(0,n.jsx)("li",{className:"li step stepexpand",children:(0,n.jsxs)("span",{className:"ph cmd",children:["Click ",(0,n.jsx)("span",{className:"ph uicontrol",children:"Update"})," once finished."]})})]}),"\n",(0,n.jsxs)(s.h2,{id:"in-katalon-studio",children:[(0,n.jsx)("a",{id:"id_1-tmgfhuil",class:"anchor_top_offset"}),"In Katalon Studio"]}),"\n",(0,n.jsx)("p",{xmlns:"http://www.w3.org/1999/xhtml",className:"p",children:"When this 

1setting is applied, Katalon Studio will notify the user 15 minutes before the end of the timeout period or when only a quarter of the time remains, whichever is shorter."}),"\n",(0,n.jsx)("p",{xmlns:"http://www.w3.org/1999/xhtml",className:"p",children:"If you leave the bypass section empty in TestOps, idle users receive a notification like this:"}),"\n",(0,n.jsx)("p",{xmlns:"http://www.w3.org/1999/xhtml",className:"p",children:(0,n.jsx)("img",{className:"image",width:600,src:(0,l.Ay)("/9cff2776-a906-43ef-b2d6-aebadc94bbf6/KS-2Idle-timeout-dialog-no-bypassed-time.png"),alt:"Katalon Studio's notification for automatically logging out."})}),"\n",(0,n.jsxs)("ul",{xmlns:"http://www.w3.org/1999/xhtml",className:"ul",children:[(0,n.jsxs)("li",{className:"li",children:[(0,n.jsxs)("p",{className:"p",children:["To resume the session, click ",(0,n.jsx)("span",{className:"ph uicontrol",children:"Continue"}),". If you set a bypass limit in TestOps, the notification dialog displays how many times idle users have left to resume the session."]}),(0,n.jsx)("p",{className:"p",children:(0,n.jsx)("img",{className:"image",width:600,src:(0,l.Ay)("/968a2aed-274d-4cff-946b-f4c46fa11c09/KS-2Idle-timeout-dialog-with-bypassed-time.png"),alt:"Katalon Studio's notification for bypassing the automatic log out."})})]}),(0,n.jsx)("li",{className:"li",children:(0,n.jsxs)("p",{className:"p",children:["To log out immediately, the user can click ",(0,n.jsx)("span",{className:"ph uicontrol",children:"Log out"}),"."]})}),(0,n.jsxs)("li",{className:"li",children:[(0,n.jsxs)("p",{className:"p",children:["If the user does nothing or clicks on the ",(0,n.jsx)("em",{className:"ph i",children:"X"})," button to close this notification dialog, the user will be logged out automatically at the end of the timeout period."]}),(0,n.jsxs)("p",{className:"p",children:[(0,n.jsx)("img",{className:"image",width:400,src:(0,l.Ay)("/9a81a3c0-6c18-4558-9729-9d7697a7639c/KS-2Used-up-idle-timeout-dialog.png"),alt:"Katalon Studio's notification informing users that they have used up the allowed number of bypasses."})," "]})]})]})]})}function p(e={}){const{wrapper:s}={...(0,a.R)(),...e.components};return s?(0,n.jsx)(s,{...e,children:(0,n.jsx)(h,{...e})}):h(e)}}}]);