community
cancel
Showing results for 
Search instead for 
Did you mean: 

Alteryx Designer Knowledge Base

Definitive answers from Designer experts.

Interface Designer Part 1 - Macros

Alteryx
Alteryx
Created on

The Interface Designer is an often missed piece of setting up custom Macros.  To enable the Interface Designer go to View - Interface Designer. Note that nothing will show in this window unless your process is saved as a .yxmc or .yxwz (Macro or Analtyic App). 

 

First the basics:

The Interface Designer has 4 main views, designated by icons running down the left side of the window:

4 Views.png 

 

From the top down the views are:

Layout View - shows you the interface the end user will see when setting up the tool in their workflow

Test View - Allows you to enter values for your "Questions" to debug potential errors in the macro/app

Tree View - If you created macros or apps prior to version 9.0, this will be familiar to you as it is the old way of setting up your questions and actions.

Properties - Allows you to set specific characteristics about your macro/app

 

For this article we are going to focus on the Layout View, Test View, and Properties.

 

Layout:

The layout view is pretty simple. It shows you what the user will see when configuring your macro. From this view, you can also reorder your questions, or create nested groups depending on the interface tools you are using. You can also add tabs and label boxes for a more custom feel. 

 

Use the "Add" drop down to add a label, group box, link, and/or tab to your interface.You can edit the text seen by the user in the standard configuration window.

Add_Layout.png

 

Group Box - Adds a box so you can nest questions together

Label - Adds custom text to the Interface

Link - Add a URL to a website or a file with a relative path. Webpage must be a full URL

Tab - Adds a tab to the interface. Can split up questions based on section of macro.

 

Use the arrows on the right hand side to move questions up or down, or between tabs (left and right).

 

Test:

The Test view allows you to enter sample values to test the configuration of your macro. You can enter responses to your questions and then enter the  Debug mode to ensure  your Actions are handling the responses correctly.

OpenDebug.png

 

When you click Open Debug you'll notice that a new workflow opens with a text comment box at the top. If you scroll down you will see you macro tools but will notice the Interface tools are not there. Click on any tool that an Action is connected to to ensure the value entered in the Test view window has come through properly. If there are any errors, you will see the standard error icon.

 

Properties:

The first option in the Properties view for macros is to change the icon. Each tool in Alteryx has it's own Icon, and the base color/shape correspond to the category the tool fits in. All of these base icons are available in when selecting the Standard Icon option. Use the drop down arrow to expand the window and scroll through available standard options.

 

ChangeIcons.png

 

You can also set up a custom icon by selecting that radio button. Using the Custom Icon allows you to either create an image outside of Alteryx, or perhaps use a company logo, to represent your macro.

 

Another common setting used in Macros is how the output records will be formatted. The default setting is expecting every iteration of output having the exact same schema, and Alteryx will throw an error if they are different. 

 

If your schema may change based on the data being fed into the macro, select the check box indicating that, and then choose a method to align the fields:

OutputOptions.png

Similar to the Union tool, you can have macro Auto configure the fields by name or position allowing for greater flexibility with your data. These options can be particularly helpful when using the Dynamic Input tool within your macro to open multiple files. These settings should allow the macro to continue opening files regardless of if the schema changes or if field names are slightly different.

 

The final option in the Properties view is not used nearly as often but allows the user to create a custom Help file or link to be included with the macro.

 

Note: Screen shots taken from version 10.5.

 

 

Comments
Meteor

Thanks - super helpful!

Can we find some nice icons to be used as custom icons somewhere ?