Skip to main content

Use Alteryx One Macros in Designer Workflows

Insert cloud-hosted macros from your Alteryx One Library into Designer workflows. Designer references the selected macro in Alteryx One instead of relying on its local file path. This reference helps the workflow use the same macro across supported environments.

Before You Start

  • Make sure you’re online and Designer can access the internet.

  • Sign in to the Alteryx One workspace that contains the macro.

  • Confirm that you have access to the macro.

Your active workspace determines which Alteryx One Library Designer uses.

Insert a Macro from Alteryx One

If you have Designer macros in your Alteryx One Library, you can insert them into a Designer workflow from the canvas.

  1. In Designer, right-click an empty area of the workflow canvas.

  2. Select Insert > Macro > Browse in Alteryx One. Any Alteryx One macros already open in Designer are identified by a cloud icon.

  3. In the macro browser, locate and select a macro. You can use the available filter options to narrow the list:

    • Select from All, Owned by Me, and Shared with Me.

    • Use the filter (funnel) icon to show macros based on these categories:

      • Owner: Show macros created by specific users.

      • Shared With: Show macros shared with specific users.

      • Tag: Show macros with specific tags applied.

      • Created By: Show macros created by specific users.

  4. Use the dropdown in the Version column to select the version to use:

    • Select a numbered version to keep the workflow linked to that version.

    • (Default) Select Always Use Latest Version to always use the latest available version. At runtime, the workflow uses the latest version available in the Alteryx One library. The version is selected when workflow execution first reaches the macro and remains fixed for the rest of that workflow execution. This option does not limit selection to published versions.

  5. Select Insert.

Designer adds the macro to the canvas and stores its Alteryx One asset reference and version selection in the workflow.

A cloud icon indicates open macros in Designer that were opened from Alteryx One. You can also insert one of these open macros from Insert > Macro.

重要

Alteryx One macros are currently not available in the Designer tool palette. To use Alteryx One macros in Designer, add them to your workflow with the right-click Insert option.

Change Macro Version

  1. Right-click the macro on the canvas.

  2. Select Choose Macro Version.

  3. Select a numbered version or Always Use Latest Version (if you always want to use the latest available version).

If you select Always Use Latest Version, the workflow can use a newer macro version when one becomes available. Review the workflow after the macro owner publishes an update.

Open a Referenced Macro

Double-click a cloud-hosted macro on the canvas to open it in a new Designer tab. You can also right-click the macro and select Open Macro.

Designer retrieves the selected macro version from Alteryx One. If Designer is offline, it can open the macro only when that version remains available in the local cache.

Work Offline

When Designer is offline, only Insert > Macro > Browse Locally is available and opens the local file browser. You can insert a local YXMC file, but you can’t browse the Alteryx One Library.

A cloud-hosted macro already in the workflow might remain available from the local cache. Designer displays an error if it can’t retrieve the referenced macro.

Save or Package the Workflow

Designer preserves Alteryx One macro references when you save the workflow as a YXZP file to Alteryx One.

When you save a workflow package as a YXZP file in Designer via File > Save As > Alteryx One:

  • Cloud-hosted macros aren’t included as a dependency by default (they aren't selected in the Dependencies section). The package keeps its Alteryx One references. The macro is indicated as a “Cloud Macro” with its location shown as Alteryx One Library\MyMacro, for example.

  • To package the cloud macro with your workflow, select the cloud-hosted macro in Dependencies. This includes an independent copy* of the cloud macro in the package (indicated by "Macro Copy" in the Dependencies list).

  • Make sure users and workspace execution environments can access any macro that remains referenced from Alteryx One.

Macro Copy

*If you select a cloud-hosted macro in Dependencies, a copy of the macro is saved to the cloud and referenced in the workflow. As a result, future updates to the original macro won’t be reflected in your workflow.

When a workflow includes a referenced macro, and you save it to Server, the macro is always included as a copy. Future updates to the original cloud macro won’t be reflected in the workflow.

Go to Workflow Management for information about saving workflows and managing package dependencies.