https://docs-production-katalon.netlify.app/assets/js/0b1faf23.1f1b3e41.js

1"use strict";(self.webpackChunkKatalon_Docs=self.webpackChunkKatalon_Docs||[]).push([[976],{28453:(e,n,t)=>{t.d(n,{R:()=>l,x:()=>a});var i=t(96540);const s={},r=i.createContext(s);function l(e){const n=i.useContext(r);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function a(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:l(e.components),i.createElement(r.Provider,{value:n},e.children)}},74286:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>o,contentTitle:()=>a,default:()=>h,frontMatter:()=>l,metadata:()=>i,toc:()=>d});const i=JSON.parse('{"id":"administer/administration-and-licensing-alternate/manage-systems/configurations/customizable-fields","title":"Customizable Fields","description":"This document explains how to configure and manage customizable fields in Katalon True Platform to organize, categorize, and report on your testing data effectively.","source":"@site/docs/katalon-platform/administer/administration-and-licensing-alternate/manage-systems/configurations/customizable-fields.md","sourceDirName":"administer/administration-and-licensing-alternate/manage-systems/configurations","slug":"/administer/administration-and-licensing-alternate/manage-systems/configurations/customizable-fields","permalink":"/katalon-platform/administer/administration-and-licensing-alternate/manage-systems/configurations/customizable-fields","draft":false,"unlisted":false,"tags":[],"version":"current","lastUpdatedAt":1776759360000,"frontMatter":{"title":"Customizable Fields","description":"This document explains how to configure and manage customizable fields in Katalon True Platform to organize, categorize, and report on your testing data effectively."},"sidebar":"katalon-platform","previous":{"title":"Configure Katalon Studio (KS) on Katalon True Platform","permalink":"/katalon-platform/administer/administration-and-licensing-alternate/manage-systems/configurations/configure-ks"},"next":{"title":"Configure Katalon Tunnel","permalink":"/katalon-platform/administer/administration-and-licensing-alternate/manage-systems/configurations/configure-katalon-tunnel"}}');var s=t(74848),r=t(28453);const l={title:"Customizable Fields",description:"This document explains how to configure and manage customizable fields in Katalon True Platform to organize, categorize, and report on your testing data effectively."},a=void 0,o={},d=[{value:"Overview",id:"overview",level:2},{value:"Field Types and Descriptions",id:"field-types-and-descriptions",level:2},{value:"Important Notes",id:"important-notes",level:2},{value:"Adding a Custom Field",id:"adding-a-custom-field",level:2}];function c(e){const n={admonition:"admonition",em:"em",h2:"h2",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,r.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsxs)(n.admonition,{title:"requirements",type:"info",children:[(0,s.jsx)(n.p,{children:"To configure customizable fields:"}),(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:["You must have a ",(0,s.jsx)(n.strong,{children:"True Enterprise"})," subscription."]}),"\n",(0,s.jsxs)(n.li,{children:["You must have the ",(0,s.jsx)(n.strong,{children:"Account Admin"})," or ",(0,s.jsx)(n.strong,{children:"System Admin"})," role."]}),"\n"]})]}),"\n",(0,s.jsx)(n.p,{children:"This document explains how to configure and manage customizable fields in Katalon True Platform to organize, categorize, and report on your testing data effectively."}),"\n",(0,s.jsx)(n.h2,{id:"overview",children:"Overview"}),"\n",(0,s.jsxs)(n.p,{children:["Customizable Fields allow teams to ",(0,s.jsx)(n.strong,{children:"add metadata attributes"})," to testing entities such as ",(0,s.jsx)(n.strong,{children:"Test Case"}),", ",(0,s.jsx)(n.strong,{children:"Test Run"}),", and ",(0,s.jsx)(n.strong,{children:"Test Result, configurable by users"}),"."]}),"\n",(0,s.jsx)(n.p,{children:"By configuring these fields, you can categorize, filter, and organize your testing data effectively across the entire test management lifecycle."}),"\n",(0,s.jsxs)(n.ol,{children:["\n",(0,s.jsxs)(n.li,{children:["\n",(0,s.jsxs)(n.p,{children:["Go to the ",(0,s.jsx)(n.strong,{children:"Account Settings"})," in Katalon True Platform."]}),"\n"]}),"\n",(0,s.jsxs)(n.li,{children:["\n",(0,s.jsxs)(n.p,{children:["Navigate to ",(0,s.jsx)(n.strong,{children:"System \u2192 Configurations \u2192 Customizable Fields tab"}),"."]}),"\n",(0,s.jsx)("img",{alt:"Custom Fields Overview UI",src:"https://tw-cdn.katalon.com/katalon-platform/admin/custom-fields-feb5.png"}),"\n"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:"Benefits"})}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"Align testing with business context"}),": Capture key information like project phase, release cycle, or environment directly in your test entities for easier collaboration and reporting."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"Boost productivity in reporting and filtering"}),": Quickly filter, sort, and group test data using meaningful labels, making it easier to find relevant results or patterns."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"Improve visibility across teams"}),": Enable QA, Dev, and PM stakeholders to track progress and coverage based on shared attributes such as priority, feature area, or owner."]}

1),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"Simplify audits and compliance tracking"}),": Maintain consistent metadata that supports traceability for audits, version control, and regulatory requirements."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"Scale effectively with governance"}),": Manage metadata growth through predefined limits and standardized field configurations, ensuring performance and consistency across large teams."]}),"\n"]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h2,{id:"field-types-and-descriptions",children:"Field Types and Descriptions"}),"\n",(0,s.jsxs)(n.table,{children:[(0,s.jsx)(n.thead,{children:(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Field Type"})}),(0,s.jsx)(n.th,{children:(0,s.jsx)(n.strong,{children:"Description"})})]})}),(0,s.jsxs)(n.tbody,{children:[(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:"Dropdown (Single Select)"}),(0,s.jsx)(n.td,{children:"User can only select one value from a dropdown"})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:"Dropdown (Multiple Select)"}),(0,s.jsx)(n.td,{children:"User can only select one or more values from a dropdown"})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:"Text"}),(0,s.jsx)(n.td,{children:"Text input"})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:"Number"}),(0,s.jsx)(n.td,{children:"Number only input"})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:"Date"}),(0,s.jsx)(n.td,{children:"Date only input"})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:"Checkbox"}),(0,s.jsx)(n.td,{children:"Boolean (true/false) input"})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:"URL"}),(0,s.jsx)(n.td,{children:"URL/link input"})]})]})]}),"\n",(0,s.jsx)(n.h2,{id:"important-notes",children:"Important Notes"}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsx)(n.li,{children:"Changes to field configuration apply globally to all users in the workspace."}),"\n",(0,s.jsx)(n.li,{children:"Modifying or repurposing a field affects existing data associated with that field."}),"\n"]}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h2,{id:"adding-a-custom-field",children:"Adding a Custom Field"}),"\n",(0,s.jsxs)(n.ol,{children:["\n",(0,s.jsxs)(n.li,{children:["To add a new field, click ",(0,s.jsx)(n.strong,{children:"Add Field"}),".\nTo edit existing field, on the ",(0,s.jsx)(n.strong,{children:"Customizable Fields"})," page, click the \u270f\ufe0f ",(0,s.jsx)(n.strong,{children:"Edit"})," icon next to the field you want to modify."]}),"\n",(0,s.jsxs)(n.li,{children:["The ",(0,s.jsx)(n.strong,{children:"Edit Custom Field"})," dialog appears."]}),"\n",(0,s.jsx)(n.li,{children:"Configure the following settings:"}),"\n"]}),"\n",(0,s.jsxs)(n.table,{children:[(0,s.jsx)(n.thead,{children:(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.th,{children:"Setting"}),(0,s.jsx)(n.th,{children:"Description"})]})}),(0,s.jsxs)(n.tbody,{children:[(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.strong,{children:"Visible"})}

1),(0,s.jsx)(n.td,{children:"Toggle ON to make the field appear in the UI."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.strong,{children:"Applied To Objects"})}),(0,s.jsx)(n.td,{children:"Choose one or more entities (Test Case, Test Run, Test Result) where this field will appear."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.strong,{children:"Label"})}),(0,s.jsx)(n.td,{children:"The display name that appears in your workspace."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsxs)(n.td,{children:[(0,s.jsx)(n.strong,{children:"Key"})," ",(0,s.jsx)(n.em,{children:"(Cannot be edited)"})]}),(0,s.jsx)(n.td,{children:"The internal identifier that uniquely distinguishes each customizable field within the system."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.strong,{children:"Tooltip/Description"})}),(0,s.jsx)(n.td,{children:"Optional text that describes the field\u2019s purpose."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsxs)(n.td,{children:[(0,s.jsx)(n.strong,{children:"Menu Options"})," ",(0,s.jsx)(n.em,{children:"(for Dropdown fields only)"})]}),(0,s.jsx)(n.td,{children:"Add or modify the selectable values (up to 30)."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.strong,{children:"Default Value"})}),(0,s.jsx)(n.td,{children:"Specify a value that appears by default."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.strong,{children:"Exportable"})}),(0,s.jsx)(n.td,{children:"Enable this to include the field data in exports and reports."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsxs)(n.td,{children:[(0,s.jsx)(n.strong,{children:"Unique"})," ",(0,s.jsx)(n.em,{children:"(for Text and Number fields only)"})]}),(0,s.jsx)(n.td,{children:"Enable to require unique values across all objects using this field."})]})]})]}),"\n",(0,s.jsxs)(n.ol,{start:"4",children:["\n",(0,s.jsxs)(n.li,{children:["Click ",(0,s.jsx)(n.strong,{children:"Save"})," to apply your changes."]}),"\n",(0,s.jsx)(n.li,{children:"The updated field will immediately reflect across the selected entities."}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:"Result"})}),"\n",(0,s.jsx)(n.p,{children:"Your customizable field will be visible on all test cases (or whichever object you chose)."}),"\n",(0,s.jsx)("img",{alt:"Custom Fields showing on UI - TC",src:"https://tw-cdn.katalon.com/katalon-platform/configuration/custom-fields/custom-fields-result-tc-1.png",width:"700"})]})}function h(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(c,{...e})}):c(e)}}}]);