Using the ‘events’ tab in Alteryx to include documentation with a workflow/macro/application package

Recently I have been working on a project which involved running a series of .bat files at particular points in an Alteryx workflow. To do this we were using two Run Command tools, one at the beginning and one at the end of the workflow. This process was to unlock and lock a database so that it could be edited within the workflow.

Randomly, after I bit of exploring around the Alteryx user interface, I came across the ‘Events’ tab available in the workflow configuration pane.

2016-10-23_13-55-32

What the ‘Events’ pane allows us to do is three things.

  1. Run Commands, either ‘Before Run’, ‘After Run’, ‘After Run with Errors’ and ‘After Run without Errors’
  2. Send emails, either ‘Before Run’, ‘After Run’, ‘After Run with Errors’ and ‘After Run without Errors’
  3. Add assets

The ‘Add assets’ is what we are interested in here. Essentially this enables to package files that are not traditional workflow assets (by traditional workflow assets I mean assets that are required for the workflow to run, for example macros or static data-sets).

To me this is a great feature, we can include documentation documents or videos that enable are users to understand how and why they can use the macro.

The proccess of adding files is simple.

  1. Navigate to the ‘Events’ tab on the workflow configuration panel.
  2. Make sure the ‘Enable Events’ box is checked
  3. Go to ‘Add’
  4. Select ‘Run Command’

    2016-10-23_14-03-44

  5. Navigate to the ‘Assets(s)’ tab
  6. Select ‘Add File(s)’ and add your files.

    2016-10-23_14-33-18

  7. Navigate back to the ‘Event’ pane
  8. Press ‘Okay’
  9. Go to ‘Options’ and ‘Export Workflow’, you will now see that any additional files you included can be selected to package within your .yxwz (Alteryx zip) file.

Now as you distributed this around your company via the Alteryx server, when they download the workflow/macro/application, the documentation will be extracted with the other required assets.

2016-10-23_14-11-56

Once they import the file, any attached files will now be placed in the directory as given by the user! Excellent!

Ben

Advertisements

Leave a Reply

Fill in your details below or click an icon to log in:

WordPress.com Logo

You are commenting using your WordPress.com account. Log Out / Change )

Twitter picture

You are commenting using your Twitter account. Log Out / Change )

Facebook photo

You are commenting using your Facebook account. Log Out / Change )

Google+ photo

You are commenting using your Google+ account. Log Out / Change )

Connecting to %s