https://docs-production-katalon.netlify.app/assets/js/e9a78ab2.de3258ee.js

1"use strict";(self.webpackChunkKatalon_Docs=self.webpackChunkKatalon_Docs||[]).push([[9372],{28453:(e,s,t)=>{t.d(s,{R:()=>a,x:()=>r});var i=t(96540);const n={},o=i.createContext(n);function a(e){const s=i.useContext(o);return i.useMemo((function(){return"function"==typeof e?e(s):{...s,...e}}),[s,e])}function r(e){let s;return s=e.disableParentContext?"function"==typeof e.components?e.components(n):e.components||n:a(e.components),i.createElement(o.Provider,{value:s},e.children)}},52390:(e,s,t)=>{t.r(s),t.d(s,{assets:()=>c,contentTitle:()=>l,default:()=>p,frontMatter:()=>r,metadata:()=>i,toc:()=>d});const i=JSON.parse('{"id":"record-and-spy/windows-record-and-spy-utilities/windows-record-utility-in-katalon-studio","title":"Windows Record Utility in Katalon Studio","description":"- Starting from Katalon Studio 10.4.0, Windows Desktop app testing is officially available. We are using a new custom driver based on the FlaUI library, which supports spy, record, and execution of test cases\u2014no separate installation required.","source":"@site/docs/katalon-studio/record-and-spy/windows-record-and-spy-utilities/windows-record-utility-in-katalon-studio.md","sourceDirName":"record-and-spy/windows-record-and-spy-utilities","slug":"/record-and-spy/windows-record-and-spy-utilities/windows-record-utility-in-katalon-studio","permalink":"/katalon-studio/record-and-spy/windows-record-and-spy-utilities/windows-record-utility-in-katalon-studio","draft":false,"unlisted":false,"tags":[],"version":"current","lastUpdatedAt":1776667030000,"frontMatter":{"title":"Windows Record Utility in Katalon Studio"},"sidebar":"katalon-studio","previous":{"title":"Windows Spy Utility in Katalon Studio","permalink":"/katalon-studio/record-and-spy/windows-record-and-spy-utilities/windows-spy-utility-in-katalon-studio"},"next":{"title":"Capture Windows Objects using the Windows Spy Utility in Katalon Studio","permalink":"/katalon-studio/record-and-spy/windows-record-and-spy-utilities/capture-windows-objects-using-the-windows-spy-utility-in-katalon-studio"}}');var n=t(74848),o=t(28453),a=t(86025);const r={title:"Windows Record Utility in Katalon Studio"},l=void 0,c={},d=[{value:"Requirements",id:"requirements",level:2},{value:"The Windows record utility",id:"the-windows-record-utility",level:2},{value:"Configurations",id:"configurations",level:3},{value:"Recorded actions",id:"recorded-actions",level:3},{value:"Captured objects",id:"captured-objects",level:3},{value:"Screen View",id:"screen-view",level:3},{value:"Screen Objects",id:"screen-objects",level:3},{value:"Possible Actions",id:"possible-actions",level:3},{value:"Export Option",id:"export-option",level:2}];function h(e){const s={a:"a",admonition:"admonition",code:"code",h2:"h2",h3:"h3",li:"li",p:"p",strong:"strong",ul:"ul",...(0,o.R)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(s.admonition,{type:"important",children:(0,n.jsxs)(s.ul,{children:["\n",(0,n.jsxs)(s.li,{children:["Starting from Katalon Studio 10.4.0, ",(0,n.jsx)(s.strong,{children:"Windows Desktop app testing"})," is officially available. We are using a new custom driver based on the FlaUI library, which supports ",(0,n.jsx)(s.strong,{children:"spy"}),", ",(0,n.jsx)(s.strong,{children:"record"}),", and ",(0,n.jsx)(s.strong,{children:"execution"})," of test cases\u2014",(0,n.jsx)(s.strong,{children:"no separate installation required"}),"."]}),"\n",(0,n.jsxs)(s.li,{children:["For full details on feature availability and version support, see the ",(0,n.jsx)(s.a,{href:"/katalon-studio/release-notes/katalon-studio-release-notes-version-10.x",children:"Katalon Studio Release Notes: Version 10.x"}),"."]}),"\n"]})}),"\n",(0,n.jsx)("p",{xmlns:"http://www.w3.org/1999/xhtml",className:"p",children:"Katalon Studio provides the Windows record utility that allows you to record and playback actions performed in a Windows desktop application. With this utility, you can quickly create a test case, and later manually enhance the test."}),"\n",(0,n.jsx)("p",{xmlns:"http://www.w3.org/1999/xhtml",className:"p",children:"This article introduces you to the components of the Windows record utility in Katalon Studio."}),"\n",(0,n.jsx)(s.h2,{id:"requirements",children:"Requirements"}),"\n",(0,n.jsx)("ul",{xmlns:"http://www.w3.org/1999/xhtml",className:"ul",children:(0,n.jsxs)("li",{className:"li",children:["WinAppDriver is running on the test machine. To learn how to set up and run WinAppDriver, see: ",(0,n.jsx)("a",{className:"xref",href:"/katalon-studio/manage-projects/set-up-projects/windows-desktop-apps-testing/desktop-applications-testing-with-flaui-driver-in-katalon-studio",children:"Set up WinAppDriver"}),"."]})}),"\n",(0,n.jsx)("nav",{xmlns:"http://www.w3.org/1999/xhtml",role:"navigation",className:"related-links",children:(0,n.jsxs)("div",{className:"linklist relinfo relconcepts",children:[(0,n.jsx)("strong",{children:"Related concepts"}),(0,n.jsx)("br",{}),(0,n.jsx)("br",{}),(0,n.jsx)("ul",{className:"linklist",children:(0,n.jsx)("li",{className:"linklist",children:(0,n.jsx)("a",{className:"link",href:"/katalon-studio/manage-projects/set-up-projects/windows-desktop-apps-testing/desktop-applications-testing-with-flaui-driver-in-katalon-studio",children:"Set up WinAppDriver"})})})]})}),"\n",(0,n.jsx)(s.h2,{id:"the-windows-record-utility",children:"The Windows record utility"}),"\n",(0,n.jsx)(s.admonition,{type:"note",children:(0,n.jsxs)(s.p,{children:["In Katalon Studio 11.1.0 and later, if Windows Recorder cannot start be

1cause Katalon Studio fails to check whether the local FlaUI server has started, manually start the FlaUI driver and set ",(0,n.jsx)(s.strong,{children:"Desktop Driver URL"})," as a workaround. See ",(0,n.jsx)(s.a,{href:"/katalon-studio/troubleshooting/troubleshoot-windows-automated-testing/unable-to-start-windows-recorder-due-to-flaui-status-check-failure",children:"Unable to start Windows Recorder due to FlaUI status check failure"}),"."]})}),"\n",(0,n.jsxs)("p",{xmlns:"http://www.w3.org/1999/xhtml",className:"p",children:["To open the utility, from the main toolbar, click on ",(0,n.jsx)("strong",{className:"ph b",children:"Record Windows Action"}),"."]}),"\n",(0,n.jsxs)("p",{xmlns:"http://www.w3.org/1999/xhtml",className:"p",children:[(0,n.jsx)("img",{className:"image",src:(0,a.Ay)("https://github.com/katalon-studio/docs-images/raw/master/katalon-studio/docs/windows-record-utility/KS-Record-Windows-Action-button.png"),alt:"Spy Windows Objects icon"}),(0,n.jsx)("br",{}),(0,n.jsx)("br",{})]}),"\n",(0,n.jsxs)("p",{xmlns:"http://www.w3.org/1999/xhtml",className:"p",children:["The ",(0,n.jsx)("strong",{className:"ph b",children:"Windows Action Recorder"})," dialog is displayed as below:"]}),"\n",(0,n.jsxs)("p",{xmlns:"http://www.w3.org/1999/xhtml",className:"p",children:[(0,n.jsx)("img",{className:"image",src:(0,a.Ay)("https://github.com/katalon-studio/docs-images/raw/master/katalon-studio/docs/windows-record-utility/KS-Windows-Action-Recorder-dialog.png"),alt:"Windows Action Recorder dialog"}),(0,n.jsx)("br",{}),(0,n.jsx)("br",{})]}),"\n",(0,n.jsx)(s.h3,{id:"configurations",children:"Configurations"}),"\n",(0,n.jsxs)("p",{xmlns:"http://www.w3.org/1999/xhtml",className:"p",children:["In the ",(0,n.jsx)("strong",{className:"ph b",children:"CONFIGURATIONS"})," section, you can   specify:"]}),"\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:["       ",(0,n.jsx)("strong",{className:"ph b",children:"Configuration"}),": the WinAppDriver URL and desired       capabilities."]}),"   "]}),"   ",(0,n.jsxs)("li",{className:"li",children:["     ",(0,n.jsxs)("p",{className:"p",children:["       ",(0,n.jsx)("strong",{className:"ph b",children:"Application File"}),": the absolute path to the       Windows executable file (*.exe) of the testing machine. For Windows       users, click on the ",(0,n.jsx)("strong",{className:"ph b",children:"Browse..."})," button to locate the       application file."]}),"   "]})," "]}),"\n",(0,n.jsx)(s.h3,{id:"recorded-actions",children:"Recorded actions"}),"\n",(0,n.jsxs)("p",{xmlns:"http://www.w3.org/1999/xhtml",className:"p",children:["After you interact with the application under test (AUT) using the built-in actions, the recorded actions are displayed in the ",(0,n.jsx)("strong",{className:"ph b",children:"Recorded Actions"})," tab."]}),"\n",(0,n.jsxs)("p",{xmlns:"http://www.w3.org/1999/xhtml",className:"p",children:[(0,n.jsx)("img",{className:"image",src:(0,a.Ay)("https://github.com/katalon-studio/docs-images/raw/master/katalon-studio/docs/windows-record-utility/KS-Recorded-Actions-tab.png"),alt:"Recorded Actions tab"}),(0,n.jsx)("br",{}),(0,n.jsx)("br",{})]}),"\n",(0,n.jsx)(s.h3,{id:"captured-objects",children:"Captured objects"}),"\n",(0,n.jsxs)("p",{xmlns:"http://www.w3.org/1999/xhtml",className:"p",children:["During a recording session, the captured Windows objects are displayed in the ",(0,n.jsx)("strong",{className:"ph b",children:"Captured Objects"})," tab. You can view and edit the object name, locator and properties."]}),"\n",(0,n.jsxs)("p",{xmlns:"http://www.w3.org/1999/xhtml",className:"p",children:[(0,n.jsx)("img",{className:"image",src:(0,a.Ay)("https://github.com/katalon-studio/docs-images/raw/master/katalon-studio/docs/windows-record-utility/KS-Captured-Objects-tab.png"),alt:"Captured Objects tab"}),(0,n.jsx)("br",{}),(0,n.jsx)("br",{})]}),"\n",(0,n.jsxs)("p",{xmlns:"http://www.w3.org/1999/xhtml",className:"p",children:["You can modify the locator of an object in ",(0,n.jsx)("strong",{className:"ph b",children:"Object Properties"})," and click ",(0,n.jsx)("strong",{className:"ph b",children:"Highlight"})," to verify if the new locator correctly identifies the associated object."]}),"\n",(0,n.jsx)(s.admonition,{type:"note",children:(0,n.jsxs)(s.p,{children:["Starting from version ",(0,n.jsx)(s.code,{children:"10.4.3"}),", Katalon Studio supports more locators for Windows objects. View supported locators at ",(0,n.jsx)(s.a,{href:"/katalon-studio/test-objects/windows-test-objects/windows-test-objects-in-katalon-studio#locator-strategy-for-detecting-an-object",children:"Windows Test Objects - Locator Strategies"})]})}),"\n",(0,n.jsx)(s.h3,{id:"screen-view",children:"Screen View"}),"\n",(0,n.jsxs)("p",{xmlns:"http://www.w3.org/1999/xhtml",className:"p",children:["The ",(0,n.jsx)("strong",{className:"ph b",children:"Screen View"})," shows the application screenshots taken when you press the ",(0,n.jsx)("strong",{className:"ph b",children:"Start"})," button to record or the ",(0,n.jsx)("strong",{className:"ph b",children:"Refresh Screen"})," button to recapture the application images. The size of a captured screenshot is the same as the displayed application window on the testing machine."]}),"\n",(0,n.jsxs)("p",{xmlns:"http://www.w3.org/1999/xhtml",className:"p",children:[(0,n.jsx)("img",{className:"image",src:(0,a.Ay)("https://github.com/katalon-studio/docs-images/raw/master/katalon-studio/docs/windows-record-utility/KS-Screen-View-section.png"),alt:"Screen view"}),(0,n.jsx)("br",{}),(0,n.jsx)("br",{})]}),"\n",(0,n.jsx)(s.h3,{id:"screen-objects",children:"Screen Objects"}),"\n",(0,n.jsxs)("p",{xmlns:"http://www.w3.org/1999/xhtml",className:"p",children:["The ",(0,n.jsx)("strong",{className:"ph b",children:"Screen Objects"})," section shows a tree of all Windows objects you can interact with. To update this tree view, you can press the ",(0,n.jsx)("strong",{className:"ph b",children:"Refresh Screen"})," button."]}),"\n",(0,n.jsxs)("p",{xmlns:"http://www.w3.org/1999/xhtml",className:"p",children:["The selected object is highlighted 

1with a green border on the ",(0,n.jsx)("strong",{className:"ph b",children:"Screen View"}),"."]}),"\n",(0,n.jsxs)("p",{xmlns:"http://www.w3.org/1999/xhtml",className:"p",children:[(0,n.jsx)("img",{className:"image",src:(0,a.Ay)("https://github.com/katalon-studio/docs-images/raw/master/katalon-studio/docs/windows-record-utility/KS-Screen-view.png"),alt:"Object highlighted in the Screen View"}),(0,n.jsx)("br",{}),(0,n.jsx)("br",{})]}),"\n",(0,n.jsx)(s.h3,{id:"possible-actions",children:"Possible Actions"}),"\n",(0,n.jsxs)("p",{xmlns:"http://www.w3.org/1999/xhtml",className:"p",children:["The ",(0,n.jsx)("strong",{className:"ph b",children:"Possible Actions"})," provides the built-in Windows actions that you can use to interact with the AUT."]}),"\n",(0,n.jsxs)("p",{xmlns:"http://www.w3.org/1999/xhtml",className:"p",children:[(0,n.jsx)("img",{className:"image",src:(0,a.Ay)("https://github.com/katalon-studio/docs-images/raw/master/katalon-studio/docs/windows-record-utility/KS-Possible-Actions-section.png"),alt:"Possible actions"}),(0,n.jsx)("br",{}),(0,n.jsx)("br",{})]}),"\n",(0,n.jsx)("p",{xmlns:"http://www.w3.org/1999/xhtml",className:"p",children:"There are two types of Windows actions:"}),"\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:["Object action: an action that you can perform on a specific Windows object. This type of action requires you to first select the target object on the ",(0,n.jsx)("strong",{className:"ph b",children:"Screen Objects"}),", e.g., performing the ",(0,n.jsx)("em",{className:"ph i",children:"Click"})," action on a menu item."]}),"   "]}),(0,n.jsxs)("li",{className:"li",children:["     ",(0,n.jsxs)("p",{className:"p",children:["Application action: an action for interacting with the application, e.g., the ",(0,n.jsx)("em",{className:"ph i",children:"Close Application"})," action."]}),"   "]})]}),"\n",(0,n.jsx)(s.h2,{id:"export-option",children:"Export Option"}),"\n",(0,n.jsx)("p",{xmlns:"http://www.w3.org/1999/xhtml",className:"p",children:"When you finish the recording session, there are three options to export the recorded actions to a test case:"}),"\n",(0,n.jsxs)("ul",{xmlns:"http://www.w3.org/1999/xhtml",className:"ul",children:[(0,n.jsx)("li",{className:"li",children:"Export to new test case (selected by default)."}),(0,n.jsx)("li",{className:"li",children:"Append to test case."}),(0,n.jsx)("li",{className:"li",children:"Overwrite test case."})]}),"\n",(0,n.jsxs)("p",{xmlns:"http://www.w3.org/1999/xhtml",className:"p",children:[(0,n.jsx)("img",{className:"image",src:(0,a.Ay)("https://github.com/katalon-studio/docs-images/raw/master/katalon-studio/docs/windows-record-utility/KS-Export-Windows-script.png"),alt:"Export actions dialog"}),(0,n.jsx)("br",{}),(0,n.jsx)("br",{})]})]})}function p(e={}){const{wrapper:s}={...(0,o.R)(),...e.components};return s?(0,n.jsx)(s,{...e,children:(0,n.jsx)(h,{...e})}):h(e)}}}]);