Attaching Workflow Documentation to Alteryx Server

[barrymoe]

Hi All,

We are currently migrating our workflows to Alteryx Server, and are looing for how to include a high level PDF/Word Document to our server workflows so that users can have some explanation.

Is there an easy way to do this?

Thank you!

[abacon]

@barrymoe You are looking to push the documentation up to the server with the workflow? What are you trying to document? The purpose of the workflow or how it works underneath? So from a user perspective or developer perspective?

For dev perspective, you can annotate and document the workflow in a way that makes it easy to follow when someone new opens it. Additionally, you can add a explorer box to the canvas that is set to the location of the documentation for that workflow, allowing the dev to easily open the docs.

From a user perspective, you can add a description to the meta info section of the workflow configuration that gives a high level overview of the purpose and use.

Bacon

[KGT]

You can also host the documentation on Sharepoint/Confluence or somewhere on the server in HTML format and add that as the Description URL. You are not going to be able to customise the interface that much and so you may want to start with working out the use as @abacon has mentioned.