UiPath Documentation
studio
2023.4
false
  • Release Notes
    • 2023.4.0
    • 2023.4.1
    • 2023.4.2
    • 2023.4.3
    • 2023.4.4
    • 2023.4.5
    • 2023.4.6
    • 2023.4.7
    • 2023.4.8
    • 2023.4.9
    • 2023.4.10
    • 2023.4.11
    • 2023.4.12
    • 2023.4.13
    • 2023.4.14
  • Getting Started
    • Introduction
    • The User Interface
    • Keyboard Shortcuts
    • Signing in to Your Account
    • Configuring Studio Settings
    • Project Templates
      • Orchestration Process
      • Background Process
      • Robotic Enterprise Framework
      • Attended Automation Framework
    • Creating a Basic Process
    • Creating a Basic Library
    • Tutorials
  • Setup and Configuration
    • Hardware and Software Requirements
    • Install Studio
      • Deployment guidelines
      • Services Studio Connects To
      • Common Installation Errors
      • Modify or Uninstall Studio
    • Activate Studio
      • About Flex Licensing
    • Update Studio
    • Command Line Parameters
    • Supported Applications and Technologies
    • Enabling Gmail for Email Activities
    • Opting Out of Telemetry
    • Studio Executables
  • Automation Projects
    • About Automation Projects
      • About the Windows - Legacy Compatibility
      • About the Project.Json File
    • About Publishing Automation Projects
    • About Libraries
      • Loading Web Services in Libraries
      • Activities Generated from Web Services
    • Designing Automations
    • Managing activity packages
    • Configuring Activity Project Settings
    • Signing Packages
    • Governance
    • Importing Entities
    • Modern Design Experience
    • Linking a Project to an Idea in Automation Hub
    • Using the Data Manager
  • Dependencies
    • About Dependencies
    • Managing Dependencies
    • Project Dependencies Mass Update
      • Mass Update Command Line Parameters
    • Missing or Invalid Activities
  • Types of Workflows
    • Sequences
    • Flowcharts
    • State Machines
    • Global Exception Handler
    • Workflow From a Template
    • Forms
  • File Comparison
    • About File Comparison
    • Comparing Files
  • Automation Best Practices
    • Workflow Design
    • UI Automation
    • Project Organization
    • Automation Lifecycle
    • Methodology for reusing UI components
  • Source Control Integration
    • About Version Control
    • Managing Projects With GIT
    • Managing Projects With TFS
    • Managing Projects With SVN
    • Workflow Diff
  • Debugging
    • About Debugging
      • Test Activities
      • Debugging Actions
      • The Locals Panel
      • The Call Stack Panel
      • The Breakpoints Panel
      • The Watch Panel
      • The Immediate Panel
      • Remote Debugging
      • Profile Execution
  • The Diagnostic Tool
    • About The Diagnostic Tool
  • Workflow Analyzer
    • About Workflow Analyzer
    • Naming Rules
      • ST-NMG-001 - Variables Naming Convention
      • ST-NMG-002 - Arguments Naming Convention
      • ST-NMG-004 - Display Name Duplication
      • ST-NMG-005 - Variable Overrides Variable
      • ST-NMG-006 - Variable Overrides Argument
      • ST-NMG-008 - Variable Length Exceeded
      • ST-NMG-009 - Prefix Datatable Variables
      • ST-NMG-011 - Prefix Datatable Arguments
      • ST-NMG-012 - Argument Default Values
      • ST-NMG-016 - Argument Length Exceeded
    • Design Best Practices
      • ST-DBP-002 - High Arguments Count
      • ST-DBP-003 - Empty Catch Block
      • ST-DBP-007 - Multiple Flowchart Layers
      • ST-DBP-020 - Undefined Output Properties
      • ST-DBP-023 - Empty Workflow
      • ST-DBP-024 - Persistence Activity Check
      • ST-DBP-025 - Variables Serialization Prerequisite
      • ST-DBP-026 - Delay Activity Usage
      • ST-DBP-027 - Persistence Best Practice
      • ST-DBP-028 - Arguments Serialization Prerequisite
    • Project Anatomy Rules
      • ST-ANA-003 - Project Workflow Count
      • ST-ANA-005 - Check Project.json Exists
      • ST-ANA-006 - Main Workflow Exists
      • ST-ANA-009 - File Activities Stats
    • Maintainability and Readability Rules
      • ST-MRD-002 - Activity Name Defaults
      • ST-MRD-004 - Unreachable Activities
      • ST-MRD-005 - Redundant Sequences
      • ST-MRD-007 - Nested If Clauses
      • ST-MRD-008 - Empty Sequence
      • ST-MRD-009 - Deeply Nested Activities
      • ST-MRD-011 - Write Line Usage
      • ST-MRD-017 - Incomplete If
    • Usage Rules
      • ST-USG-005 - Hardcoded Activity Arguments
      • ST-USG-009 - Unused Variables
      • ST-USG-010 - Unused Dependencies
      • ST-USG-014 - Package Restrictions
      • ST-USG-020 - Minimum Log Messages
      • ST-USG-024 - Unused Saved for Later
      • ST-USG-025 - Saved Value Misuse
      • ST-USG-026 - Activity Restrictions
      • ST-USG-027 - Required Packages
      • ST-USG-028 - Restrict Invoke File Templates
      • ST-USG-032 - Required Tags
      • ST-USG-034 - Automation Hub URL
    • Performance and Reusability Rules
      • ST-PRR-004 - Hardcoded Delay Activity
    • Reliability Rules
      • ST-REL-006 - Infinite Loop
    • Security Rules
      • ST-SEC-007 - SecureString Argument Usage
      • ST-SEC-008 - SecureString Variable Usage
      • ST-SEC-009 - SecureString Misusage
  • Variables
    • Managing Variables
    • The Variables Panel
    • Types of Variables
    • UiPath Proprietary Variables
  • Arguments
    • Managing Arguments
    • The Arguments Panel
    • Using Arguments
  • Imported Namespaces
    • About Imported Namespaces
    • Managing Namespaces
  • Trigger-based Attended Automation
    • Trigger-based attended automation
    • Overview
    • Tutorials
      • Contact Centers and Trigger-based Attended Automation
      • Creating a guided product tour
      • Designing validation for existing apps
  • Control Flow
    • About Control Flow
    • Control Flow Activities
      • The Assign Activity
      • The Delay Activity
        • Example of Using the Delay Activity
      • The Do While Activity
        • Example of Using a Do While Activity
      • The If Activity
        • Example of Using an If Activity
      • The Switch Activity
        • Example of Using a Switch Activity
      • The While Activity
        • Example of Using a While Activity
      • The For Each Activity
        • Example of Using a For Each Activity
      • The Break Activity
        • Example of Using a Break Activity
  • Object Repository
    • About Object Repository
    • Creating an Object Repository
    • Reusing objects and UI libraries
  • Logging
    • Studio Logs
    • Setup Logs
    • OCR Diagnostic Logs
    • Logging Levels
    • Types of Logs
    • Protecting Sensitive Information
  • The ScreenScrapeJavaSupport Tool
    • About the ScreenScrapeJavaSupport Tool
    • Argument Descriptions for the ScreenScrapeJavaSupport Tool
  • Studio testing
    • Introduction
    • Application Testing
    • Testing project templates
      • Test Automation Framework
      • SAP Testing Project
    • Test Cases
    • Data-Driven Testing
      • Test Data File
      • Auto-generated Test Data
      • Data Service
      • Test Data Queues
    • RPA Testing
    • Execution Templates
    • Test Case Templates
    • Test Explorer
      • Test Results
      • Activity Coverage
      • Descriptor Coverage
    • Mock Testing
    • API Test Automation
  • Extensions
    • About extensions
    • SetupExtensions tool
    • UiPath Remote Runtime
      • Troubleshooting
        • UiPathRemoteRuntime.exe is not running in the remote session
        • UiPath Remote Runtime blocks Citrix session from being closed
        • UiPath Remote Runtime causes memory leak
    • Extension for Chrome
      • Group Policies
      • Troubleshooting
      • Chrome Extension on Mac
    • Extension for Edge
      • Group Policies
      • Troubleshooting
        • Cannot communicate with the browser
        • Edge extension is removed automatically
        • The extension may have been corrupted
    • Extension for Firefox
      • Troubleshooting
    • Extension for Java
      • Troubleshooting
    • Extension for Silverlight
      • Troubleshooting
    • Extension for Citrix
      • Troubleshooting
    • Extension for Microsoft Remote Desktop and Apps
      • Configure the UiPath Remote Plugin for custom remote applications
      • Troubleshooting
    • Extension for VMware Horizon
    • SAP Solution Manager plugin
    • Excel Add-in
  • Troubleshooting
    • About troubleshooting
    • Microsoft App-V support and limitations
    • Internet Explorer X64 troubleshooting
    • Microsoft Office issues
    • Identifying UI elements in PDF with Accessibility options
    • Repairing Active Accessibility support
    • JxBrowser applications troubleshooting
      • User Events Monitoring
    • Automating Applications Running Under a Different Windows User
    • Validation of large Windows-legacy projects takes longer than expected
UiPath logo, featuring letters U and I in white

Studio User Guide

Last updated Oct 23, 2025

Test Case Templates

Use test case templates as base models for your test cases. For example, you can create a template with data variations to be reused on different tests. You can create test case templates for Test Automation projects, including other file types such as Global Exception Handler. For other projects (e.g., Process), you can create workflow templates.

Conditions

  • The templates are specific to the project type and the language that is used to create it.
  • The templates cannot be converted to workflows, compiled, or published.

  • You can make use of reusable content by creating a library with test case templates. Test data variation is not exported to the library alongside the test case template.

    Important: The resources referenced in the template will not be copied locally to the project where you are trying to import the library. The template should not contain references to other assets, such as workflows within the library.

Template Sources

When you add a new file, you can choose a template on which to base it. The templates that you can choose from vary depending on the type of file you are adding (workflow or test case) and on whether you have previously added templates to your project Templates folder.

Built-in Templates

Empty test case

Choose Empty Test Case when you create a test case if you want to add a Placeholder activity that you want to invoke at a later stage.

BDD test case

BDD stands for Behavioural-Driven Development. Choose BDD Test Case when you create a test case to structure your test around Given-When-Then containers.

Local File Templates

The local templates are created in the Templates folder of the project when you extract a file as template and when you add a template to the Templates folder. Local file templates are available only inside the project where you create, or extract them.

You can create local templates of three types: execution template, workflow template, and test case template. When you extract a file as a template, the template type is applied automatically based on the type of file you extract (workflow or test case). When you manually add a template to the Templates folder, you select the type of template to create.

Package-file Templates

Test with timeout

The Test With Timeout template is available only with the Testing activity package, version 22.10 or higher. Choose Test With Timeout when you create a test case if you want to use a timeout or to take screenshots when a verification fails.

The template is configured to throw a time-based exception, taking a screenshot of the failure that occurred in your workflow.

Note:
  • If you set the takeScreenshotOnException Boolean variable to false make sure to modify the Timeout Message property of the TimeoutScope activity.
  • You can modify the timeout in the duration variable. The default is set to five (5) minutes.
  • You can keep screenshots on your machine by configuring Testing Project Settings.

Adding a Local File Template

You can use the contextual menu in the Project panel to manually add execution, and test case templates based on other templates to your project. After you add a template, you can edit it in the Designer, and then use it as a starting point for creating other files.



  • To add a test case template, right-click the Templates folder, and then select Add > Test Case Template. Follow the test case creation process to configure the template.



  • To add an execution template, right-click the Templates folder, and then select Add > Execution Template.



Extract File as Template

  1. Open your workflow in Studio.

  2. In the Project panel, right-click a test case and select Extract as template.



You test case is now stored in Project > Templates. You can copy and paste or move it back to your testing folder.



Note:
  • You can create templates directly from the Templates folder for your test cases and workflows.
  • You can use the contextual menu within the Templates folder to perform various actions, such as comparing files.

Test Case Templates in Libraries

You can create test case templates in libraries the same way you create them in processes. After you publish the library, the templates marked as public are available as package file templates in projects where the library is installed.

Creating a Test Case From a Template

  1. Create a Testing project.
  2. Build whatever test case you would like to use as a template.

  3. When you finish building the test case, right-click it, and select Extract as Template.

    Name the template, choose the Templates folder as the location to store it in, and select Create. For this example, the name of the template is MyFirstTestCaseTemplate.



  4. Go to the Design tab, in the File group, select New > Test Case. The New Test Case window is displayed.



  5. Give it an appropriate name, and select the template that you previously created from the Template dropdown list. For this example, choose MyFirstTestCaseTemplate.

Removing a Template

To remove a template, expand the Templates folder in the Project panel, right-click the template, and then select Delete.

Was this page helpful?

Connect

Need help? Support

Want to learn? UiPath Academy

Have questions? UiPath Forum

Stay updated