1"use strict";(self.webpackChunkKatalon_Docs=self.webpackChunkKatalon_Docs||[]).push([[6298],{22443:(t,s,e)=>{e.r(s),e.d(s,{assets:()=>d,contentTitle:()=>r,default:()=>h,frontMatter:()=>l,metadata:()=>i,toc:()=>c});const i=JSON.parse('{"id":"record-and-spy/windows-record-and-spy-utilities/capture-windows-objects-using-the-windows-spy-utility-in-katalon-studio","title":"Capture Windows Objects using the Windows Spy 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/capture-windows-objects-using-the-windows-spy-utility-in-katalon-studio.md","sourceDirName":"record-and-spy/windows-record-and-spy-utilities","slug":"/record-and-spy/windows-record-and-spy-utilities/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","draft":false,"unlisted":false,"tags":[],"version":"current","lastUpdatedAt":1764053770000,"frontMatter":{"title":"Capture Windows Objects using the Windows Spy Utility in Katalon Studio"},"sidebar":"katalon-studio","previous":{"title":"Windows Record Utility in Katalon Studio","permalink":"/katalon-studio/record-and-spy/windows-record-and-spy-utilities/windows-record-utility-in-katalon-studio"},"next":{"title":"Windows Record Tutorials in Katalon Studio","permalink":"/katalon-studio/record-and-spy/windows-record-and-spy-utilities/windows-record-tutorials-in-katalon-studio"}}');var n=e(74848),o=e(28453),a=e(86025);const l={title:"Capture Windows Objects using the Windows Spy Utility in Katalon Studio"},r="Capture Windows Objects using the Windows Spy Utility in Katalon Studio",d={},c=[{value:"Configure the Windows spy utility",id:"configure-the-windows-spy-utility",level:2},{value:'<a class="anchor_top_offset"></a>Capture Windows objects',id:"capture-windows-objects",level:2}];function p(t){const s={a:"a",admonition:"admonition",em:"em",h1:"h1",h2:"h2",header:"header",li:"li",ol:"ol",p:"p",strong:"strong",ul:"ul",...(0,o.R)(),...t.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(s.header,{children:(0,n.jsx)(s.h1,{id:"capture-windows-objects-using-the-windows-spy-utility-in-katalon-studio",children:"Capture Windows Objects using the Windows Spy Utility in Katalon Studio"})}),"\n",(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.jsx)(s.li,{children:"If your projects rely on Windows Desktop app testing, we recommend upgrading to Katalon Studio 10.4.0 and later to access Windows Desktop app testing."}),"\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:"This guide shows you how to capture Windows objects with the Windows spy utility."}),"\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.jsx)("ul",{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.jsxs)("p",{xmlns:"http://www.w3.org/1999/xhtml",className:"p",children:["To use the utility, first you need to open the ",(0,n.jsx)("strong",{className:"ph b",children:"Spy Windows Objects"})," dialog. From the main toolbar, click on the ",(0,n.jsx)("strong",{className:"ph b",children:"Spy Windows Objects"})," icon."]}),"\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-spy-tutorial/KS-Windows-Spy-Objects-button.png"),alt:"Spy Windows Objects dialog"}),(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:"Spy Windows Objects"})," 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-spy-tutorial/KS-Windows-Object-Spy-dialog.png"),alt:"Spy Windows Objects dialog"}),(0,n.jsx)("br",{}),(0,n.jsx)("br",{})]}),"\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:"configure-the-windows-spy-utility",children:"Configure the Windows spy utility"}),"\n",(0,n.jsxs)("p",{xmlns:"http://www.w3.org/1999/xhtml",className:"p",children:["To configure the utility, in the ",(0,n.jsx)("strong",{className:"ph b",children:"Configurations"})," section, specify the following fields:"]}),"\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)("p",{xmlns:"http://www.w3.org/1999/xhtml",className:"p",children:"For example, we provide the IP address to the remote Windows machine and the path to Notepad executable as 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-spy-tutorial/KS-Configure-Spy-Utility.png"),alt:"CONFIGURATIONS section"}),(0,n.jsx)("br",{}),(0,n.jsx)("br",{})]}),"\n",(0,n.jsxs)(s.admonition,{title:"notes",type:"info",children:[(0,n.jsx)(s.p,{children:"For Universal Windows Platform (UWP) applications, the executable file should be:"}),(0,n.jsxs)(s.ul,{children:["\n",(0,n.jsxs)(s.li,{children:[(0,n.jsx)(s.em,{children:"ApplicationID"}),", if the application is published on the Microsoft store."]}),"\n",(0,n.jsxs)(s.li,{children:[(0,n.jsx)(s.em,{children:"PackageFamilyName!Application ID"}),", if the application is still in development."]}),"\n"]})]}),"\n",(0,n.jsxs)(s.h2,{id:"capture-windows-objects",children:[(0,n.jsx)("a",{id:"id_2",class:"anchor_top_offset"}),"Capture Windows objects"]}),"\n",(0,n.jsx)(s.p,{children:"To capture Windows objects, follow these steps:"}),"\n",(0,n.jsxs)(s.ol,{children:["\n",(0,n.jsxs)(s.li,{children:["\n",(0,n.jsxs)(s.p,{children:["Start the connection to the WinAppDriver by clicking on the\xa0",(0,n.jsx)(s.strong,{children:"Start"}),"\xa0button."]}),"\n",(0,n.jsx)("img",{src:"https://github.com/katalon-studio/docs-images/raw/master/katalon-studio/docs/windows-spy-tutorial/KS-Windows-spy-utility-start-button.png",alt:"Start button"}),"\n",(0,n.jsxs)(s.p,{children:["You can see the opened window of the executed AUT in the\xa0",(0,n.jsx)(s.strong,{children:"Screen View"}),"\xa0section:"]}),"\n",(0,n.jsx)("img",{src:"https://github.com/katalon-studio/docs-images/raw/master/katalon-studio/docs/windows-spy-tutorial/KS-Windows-spy-utility-executed-AUT.png",alt:"Screen view Windows spy utulity"}),"\n",(0,n.jsxs)(s.p,{children:["All available objects on the window are displayed in the\xa0",(0,n.jsx)(s.strong,{children:"All Objects"}),"\xa0section. You can verify an object by clicking on it; the utility highlights the object with a green border in\xa0",(0,n.jsx)(s.strong,{children:"Screen View"}),"."]}),"\n",(0,n.jsx)("img",{src:"https://github.com/katalon-studio/docs-images/raw/master/katalon-studio/docs/windows-spy-tutorial/KS-Windows-spy-utility-executed-highlighted-object.png",alt:"Screen view Windows spy utulity"}),"\n"]}),"\n",(0,n.jsxs)(s.li,{children:["\n",(0,n.jsx)(s.p,{children:"Add the captured objects. Select the objects you want to capture by checking on the checkbox on the left."}),"\n",(0,n.jsxs)(s.p,{children:["The selected objects are displayed in the\xa0",(0,n.jsx)(s.strong,{children:"Captured Objects"}),"\xa0section."]}),"\n",(0,n.jsx)("img",{src:"https://github.com/katalon-studio/docs-images/raw/master/katalon-studio/docs/windows-spy-tutorial/KS-Select-Captured-Objects.png",alt:"Spy object window screen"}),"\n"]}),"\n",(0,n.jsxs)(s.li,{children:["\n",(0,n.jsxs)(s.p,{children:["To save the captured objects, click on the\xa0",(0,n.jsx)(s.strong,{children:"Add to Object Repository"}),"\xa0button. In the opened dialog, select your desired folder, then click\xa0",(0,n.jsx)(s.strong,{children:"OK"}),"."]}),"\n",(0,n.jsx)("img",{src:"https://github.com/katalon-studio/docs-images/raw/master/katalon-studio/docs/windows-spy-tutorial/KS-Add-to-Object-Repository.png",alt:"Add to object repo screen"}),"\n",(0,n.jsxs)(s.p,{children:["The captured objects are added to the selected folder in the\xa0",(0,n.jsx)(s.strong,{children:"Object Repository"}),"."]}),"\n",(0,n.jsx)("img",{src:"https://github.com/katalon-studio/docs-images/raw/master/katalon-studio/docs/windows-spy-tutorial/KS-Object-Repository.png",alt:"Object repo result screen"}),"\n"]}),"\n",(0,n.jsxs)(s.li,{children:["\n",(0,n.jsxs)(s.p,{children:["To end the capturing session, click on the\xa0",(0,n.jsx)(s.strong,{children:"OK"}),"\xa0button at the bottom of the dialog."]}),"\n"]}),"\n"]}),"\n",(0,n.jsxs)(s.admonition,{title:"tips",type:"tip",children:[(0,n.jsx)(s.p,{children:"While spying, recording, or executing a test on a desktop application:"}),(0,n.jsxs)(s.ul,{children:["\n",(0,n.jsx)(s.li,{children:"Do not lock the screen of the testing machine"}),"\n",(0,n.jsx)(s.li,{children:"Do not run multiple instances of the AUT simultaneously."}),"\n"]})]})]})}function h(t={}){const{wrapper:s}={...(0,o.R)(),...t.components};return s?(0,n.jsx)(s,{...t,children:(0,n.jsx)(p,{...t})}):p(t)}},28453:(t,s,e)=>{e.d(s,{R:()=>a,x:()=>l});var i=e(96540);const n={},o=i.createContext(n);function a(t){const s=i.useContext(o);return i.useMemo((function(){return"function"==typeof t?t(s):{...s,...t}}),[s,t])}function l(t){let s;return s=t.disableParentContext?"function"==typeof t.components?t.components(n):t.components||n:a(t.components),i.createElement(o.Provider,{value:s},t.children)}}}]);
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.