How to setup Macro to be used a reference for multiple workflows on Alteryx Server

Question

Hi all,

I have a few workflows setup in Alteryx Server that contain a macro. I want multiple workflows to reference the same macro so that when I make changes to that macro, I only need to make the change once.

The problem I'm having now when editing the workflow on Alteryx Server is that when I'm editing the workflow in Alteryx Designer, the macro is located in a temporary "_externals\1\" location on my local PC, instead of the actual location of the macro (on a shared drive) .

Any help with how I should be using macros on Alteryx server would be appreciated.

rfoster7 · Accepted Answer

step 1: save the macro in a network shared location that both the people using designer AND the Gallery machine can access.

step 2: add the network share as a macro path under User Settings > Macro tab on each individual's local designer.

step 3: do the same thing through designer on the Gallery. You will need someone with remote desktop access to the gallery to do this step.

now, everyone should be able to access that same macro through designer and the gallery.

step 4: make sure when you save a workflow to the gallery with that macro you UNCHECK the macro under "manage workflow assets" on the save screen. That will keep it from saving an embedded copy into the workflow. That's the "_externals\1\" location  you are seeing. You may have to UNCHECK this each time you save it, so you have to be careful about it.

Now it should try to use the Macro version on the Network share when it runs the workflow on the Gallery.

step 5: make changes to the version of the Macro on the Network share. these should automatically propagate to each run after you make the changes on both designer and the gallery because both places will be using the macro as exists on the network share.

As you can tell, this depends on a lot of self-maintenance on the behalf of the artisans and it's easy to forget to uncheck the Macro. YOu may find that it works better to just create a yxi install file of the macro and distribute it to the userbase like you would a tool from the Alteryx Marketplace. Have the Gallery admins install it "for all users" on the Gallery, while letting the users install it themselves locally on their laptops. Then every time you make a change, distribute the update via a new version of the yxi file. That's what we ended up going with when it turned out to be overly troublesome to get everyone on the same Macro save file location consistently.

KGT · Accepted Answer

Adding to this, that if you go the Macro Repository path, those macro repositories are in an XML file near the User Settings. So, if you decide on everyone having the same macro repository, then that can be packaged into your companies install to also drop that XML with new installs.