Templates
Use Templates to save a template version of a workflow, macro, or app as a starting point for new Designer Desktop projects in the future. You can create or save templates with common configurations, runtime settings, and formatted comment boxes (to name a few). This lets you spend less time formatting workflows and more time delivering solutions.
You can use templates for any of these scenarios (and more):
Create basic workflow templates, macro templates, or app templates to have a starting point for different project types.
Create templates with different formatted versions for different audiences, like customers or internal teams.
Create templates with...
Company-specific colors for title bars and metadata comment boxes.
Standardized structure for inputs in a container on the left and outputs in a container on the right.
Pre-selected Workflow Configuration settings, for example, Runtime settings.
Notes and Considerations
When you save a template, Alteryx saves it to this directory by default:
C:\Users\[USER]\AppData\Local\Alteryx\Templates
Alternatively, if you have a large number of templates and want to avoid saving each one by one, you can add them directly to the above directory. If you do this, make sure your templates have the appropriate file extensions. If you place an item that doesn't have one of the valid template file extensions into this directory, the project won't be available via File > Templates.
Change Workflow Template Directory
If you prefer to save your template to a different directory than the default, you can specify a new directory in User Settings (this can be a shared network drive or a local directory). Follow these steps:
In Designer, go to Options > User Settings > Edit User Settings.
On the General tab of User Settings, select Override System Settings.
Locate the Default Workflow Template Directory field. Use the 3-dot menu to browse to your desired location or paste/enter the path to the directory. The default location is
C:\Users\[USER]\AppData\Local\Alteryx\Templates.Save your User Settings when you're done with the changes.
Save a New Template
You can save an existing workflow, macro, or app as a template. Follow these steps to do so:
With a workflow, macro, or app open in Designer, select File > Save As.
Select Template to open the Save As Template dialog.
Use the Save as Template dialog to provide some template metadata. The metadata becomes part of the template's XML and you can edit it at a later time if you need to.
Owner: Enter the name of the template owner. This can help template users find the right person should they have questions about the template.
Name: Enter a name for your template. Note that Designer uses your project name by default and preconfigures the file type based on the project that you started with (workflow, macro, app). Refer to Template File Types for more information.
Description: Enter a description for the template, for example, its intended use case. This helps template users determine whether this template is appropriate for their project.
Image: Upload an icon or screenshot of the key part of your workflow, macro, or app. Accepts JPEG and PNG file formats.
Select Save to save your template or Close to go back to your project.
Designer saves your template to the Template folder at this location (unless you specify a different location via the Change Workflow Template Directory steps):
C:\Users\[USER]\AppData\Local\Alteryx\Templates
You can access, edit, and use your template from Designer's main menu via File > Templates.
Use a Template
You can access all of your Designer templates via the main menu. To use a template as a starting point for your next project, follow these steps:
Access the Templates window via File > Templates. The default view is the grid view that displays your template image. You can switch to a list view via the grid and list view icons in the upper-right portion of the Template window.
Locate the template that you want to use. If you have many templates, there are several options available to help you locate the correct template.
Use the project type tabs to switch between All, Workflows, Macros, and Apps. This lets you view only the templates that match the tab you select.
Use the Search box to search for a template by name.
Via the list view, use the Name, Last Updated, and Description column headers to sort your list of templates.
If you need to view template details like the owner or description, use the template's 3-dot menu to select Details (in grid view, hover on the template image to display the 3-dot menu). Once you locate the template that you want to use, select Use Template. Your project opens in Designer, and you can start making any necessary updates.
Important
When you select Use Template, Alteryx creates a copy of the original template and opens it in Designer as a new unsaved workflow, macro, or app. Once you make any necessary updates, you need to save your project as you would with any typical workflow, macro, and app.
Edit a Template
You can make updates to an existing template if needed. Follow these steps to do so:
Go to the Templates window via File > Templates. The default view is the grid view that displays your template image. You can switch to a list view via the grid and list view icons in the upper-right portion of the Template window.
Locate the template that you want to edit or update. If you have many templates, there are several options available to help you locate the correct template.
Use the project type tabs to switch between All, Workflows, Macros, and Apps. This lets you view only the templates that match the tab you select.
Use the Search box to search for a template by name.
Via the list view, use the Name, Last Updated, and Description column headers to sort your list of templates.
Once you locate the template that you want to edit, select its 3-dot menu and select Edit Template (in grid view, hover on the template image to display the 3-dot menu). Your template file opens in Designer, where you can make any necessary changes.
When you finish updating your template, make sure to save the template.
Add or Update Template Details
You can add or update template metadata at any point. Follow these steps to do so:
Go to the Templates window via File > Templates. The default view is the grid view that displays your template image. You can switch to a list view via the grid and list view icons in the upper-right portion of the Template window.
Locate the template that you want to update, select the associated 3-dot menu, and select Details (in grid view, hover on the template image to display the 3-dot menu).
Update the metadata as needed. Note that this is the same information that you can provide when you first save a template (owner, name, description, and image).
Save your updates or Close to return to the main Templates window.
Delete a Template
If you no longer need one of your templates, you can delete it. Follow these steps to delete a template:
Go to the Templates window via File > Templates.
Locate the template that you want to delete. If you have many templates, there are several options available to help you locate the correct template.
Use the project type tabs to switch between All, Workflows, Macros, and Apps. This lets you view only the templates that match the tab you select.
Use the Search box to search for a template by name.
Use the Name, Last Updated, and Description column headers to sort your list of templates.
Once you locate the template that you want to delete, select its 3-dot menu and select Delete. This triggers the Delete Template dialog, where you can select Delete to confirm or select Close to go back to the Templates window.
Warning
Deletion is permanent. Once you confirm to delete a template, you can't recover it!
Template File Types
Each type of Designer template has its own unique file type that maps to the source project file type. The template file types are listed here:
YXTD (Workflow Template): Created from Workflow (YXMD).
YXTC (Macro Template): Created from a Macro (YXMC).
YXTZ (Analytic App Template): Created from an Analytic App (YXWZ).