Interface Designer Window
Use the Interface Designer window to customize an app or macro interface. Reorder interface questions and actions, add interface elements, test values, and include content.
To access the Interface Designer...
Select Interface Designer from View.
Or use the Ctrl + Alt + D keyboard shortcut.
The Interface Designer window opens independently of the Designer interface. Go to Interface Tools for more information on tools used to create an app or macro interface.
Layout
In the Layout View, add, remove, and reorder the app or macro interface elements.
Add interface design elements. Alteryx Designer creates those elements at the bottom of the tab you've selected.
Group Box
A visual indicator box that contains related elements. Designer moves elements into the group box. It doesn't create elements within it.
Label
Add a line of text to the app. The label has no visual indicator except the additional text.
Link
Link to a web page or file from the app.
Provide a relative path for any file link. You can use a file link to download a file from an Alteryx Server instance:
Enter the file link in Interface Designer. Use
%20for spaces:gallery/My%20File.docCopy the file to the gallery file of your Alteryx Server installation:
C:\Program Files\Alteryx\bin\RuntimeData\gallery
Tab
Add a tab to the top of the app interface. The Analytic App prompts the user to move from one tab to the next to complete the process. Use tabs to organize an Analytic App.
Select an interface element and select Delete to remove it from the interface. Deleted container elements do not delete held elements.
Select an interface element and use the arrows to move the element up or down or nest tools on a tab, or move elements left or right between tabs.
To edit the properties of an interface element, select the element and edit it in the Configuration window, outside of the Interface Designer window. To confirm edits, select out of the Configuration window or select Apply.
Test
In the Test View, test the app or macro. Select or enter values for questions, then open a debug version of the app or macro with those values.
Select the values manually, or use these options:
Reset
Clear all user-entered values and return to default design settings.
Open
Open File Explorer. Locate app values saved as .yxwv files.
Save
Open File Explorer. Save app values as a .yxwv file to use in subsequent runs of the same Analytic App.
View
Show the XML result of all questions with the values you've entered.
Select Open Debug to open a duplicate workflow in a new tab configured with the values you entered for each question. The Debug Workflow displays a Debug Log accessible via a Tool Container. Select the Tool Container to view the debug log in detail.
The interface tools are not included in that workflow.
If workflow tools reference connection names in an expression, the app values won't update in the debug workflow.
Tree
The Tree view displays the hierarchical relationship between questions and actions in the app or macro. A blue box surrounds the selected interface element (question or action). A gray box surrounds its corresponding question or action.
Use the up and down arrows to reorder a selected interface element. You can reorder actions, inputs, and outputs. Go to Macro Input Tool and Macro Output Tool for more information.
Properties
In the Properties view, customize the app or macro controls. Controls differ between apps and macros.
App Controls
Help: Use File or Hyperlink: A relative path or URL to a custom Help topic for an app or macro. The default Help page is either Analytic Apps or Macros. The referenced topic displays when a user presses F1 or selects the tool and selects the Help icon in the Configuration window.
On Success - Run another Analytic App: Select the saved app that should launch after the first app is successfully executed. This chains one Analytic App to another Analytic App. These app chains should be kept to 7 apps or fewer if you plan to publish them to the Server UI in the future. App chains longer than 7 apps don't work on Server.
On Success - Show Results to User: Select the files to output when the app is successfully executed. All output files and Browse tools from an app design workflow are available for selection.
Output Message: Enter a text-only message to display when the app is successfully executed.
No Output Files Message: Enter a message to display when no output files are available.
Graphic (Desktop only): An image that displays when the app is run on a desktop.
Use Graphic: The graphic displayed for Analytic apps run on desktops. The default graphic is the Alteryx Analytic App graphic, a PNG image with 124w x 319h dimensions. To use a custom graphic, click the Browse button and select an image. The default application window is 124w x 319h pixels. Graphics are not resized to fit.
Macro Controls
Standard Icon: A standard icon to represent the macro when it is placed on the canvas.
Custom Icon: Select a custom image. The image is re-sized to 41 x 41 pixels.
Output fields change based on macro's configuration or data input: Select this option to make the macro remember the output fields from the previous run. To reset the output fields to the default values, change the macro configuration. Select this option if the output fields change based on the data passed to the macro. Do not select this option if the output fields only change based on input fields or question answers.
Note
Designer provides additional controls for these macro types: Batch macro, Iterative macro, and Location Optimizer macro.