Subscribe

UiPath StudioX

The UiPath StudioX Guide

Project Templates

Project templates can speed up automation design when used as a starting point for new automation projects. StudioX comes with a number of built-in templates and enables you to use custom templates from other sources, such as the organization-wide and Getting Started template feeds. In addition, you can create and publish your own custom templates.

Templates Feeds can be enabled or disabled for your organization through Governance policies. This works in both the Classic and Modern policies.

Using Templates

You can view all available project templates in the Templates tab in StudioX Backstage View by selecting All in the drop-down menu under Search for Templates.

1506

Recently used templates are listed at the top. You can search for templates by name and description, select whether to include prerelease versions, or filter templates by location.

The following template locations are available:

  • All - All locations.
  • Getting started - Templates created to help users get started with StudioX. Templates under this category have customizable fields which allow you to configure the newly created task and adapt it to your data.
  • Built-in - Templates that come installed with Studio.
  • Official - Templates from the official UiPath feed.
  • Orchestrator - Organization-wide templates feed, available when connected to Orchestrator.
  • Local - The local user feed, by default: C:\Users\User\Documents\UiPath\.templates. The location can be defined by selecting Settings > Locations in StudioX Backstage view.

Getting Started Templates

This category contains a collection of reusable tasks that are meant to help you get started with StudioX. Annotations added to the activities in each template contain additional information about the purpose of the activities and how you can configure them.

Hovering over a template displays a short description that explains what the template is meant to do.

1498

Built-in Templates

A number of templates are included by default in StudioX. Each template is a fully functional project that automates a set of common tasks and can be used as is to learn more about how to design automation projects, or as a starting point for your own automations. Annotations added to the activities in each template contain additional information about the purpose of the activities and how you can configure them.

To create a new project based on a built-in template, in StudioX Backstage View, select the Start tab, and then select one of the entries on the right side of the screen. Alternatively, you can search for a template or click View all Templates to view all of the available templates.

1500

Creating a Project Based on a Template

  1. Click the template. A window with details about the template opens.
  2. Select the version to use from the lower-left corner of the window (by default, the latest version), and then click Use Template.
  3. Configure the Process Name and Location.
  4. Click Create.
  5. A pop-up is displayed with information about customizable fields. Click Continue and optionally, select Don't show again.
  6. Use the customizable fields in the task to add your own data. Once the task is fully configured, you can run it or further customize it by adding new activities.

Customizable fields are marked with an icon at the beginning of the field.

472

Creating a Template

You can create custom templates and publish them for personal use or for sharing within your organization.

To create a new project template:

  1. In StudioX Backstage View, select the Start tab, and then, under New, select Template. The New Template window is displayed.
  2. Provide the following information:
    • Name - Enter a name for the template.
    • Location - Browse to a location on your hard drive where to create the template. The default location is C:\Users\User\Documents\UiPath\.templates.
    • Description - Optionally, enter a brief description to provide more details about the template.
563
  1. Click Create.
  2. A pop-up is displayed with information about customizable fields. Click Continue and optionally, check the Don't show again checkbox.
  3. Add and configure the desired activities.
  4. For input fields that you want to become configurable, click Plus plus button on the right side of the field, then, from the menu select Mark as Customizable.
  5. Test your project by running it, and then save it.

Customizable Fields

Customizable fields allow you to create a template with sample data that is cleared when the template is published. This makes it easier to then create tasks with your own data from that template.

When creating a template, you may have fields that should become configurable once the template is published. As an example, this can be useful when creating a template using Excel activities where the file used and the range selected can change according to what is being automated.

For those instances, you can mark fields as customizable by clicking Plus plus button on the right side of the field, then selecting Mark as Customizable.

288

This marks the field with an icon. You can still use fields marked as customizable as any other field, so you can run and test the project with your own values.

474

Once the template is published, the value in this field is cleared. If you reopen the template after saving it, your test values are kept and you can continue editing.

If you decide you’d like this field not to be configurable and maintain the values, select Plus plus button > Unmark as customizable.

289

Publishing a Template

Publishing templates is similar to publishing projects, with the exception that the wizard contains an additional step where to enter template information. To publish a template, select Publish in the StudioX Design tab ribbon and then fill in the required information.

650

For more detailed instructions, see About Publishing Automation Projects in the Studio Guide.

Updated 3 months ago


Project Templates


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.