Skip to main content

SDLC Asset Promotion Guide

Use this guide to set up your Software Development Lifecycle (SLDC) process in Alteryx Analytics Cloud (AAC). You can set up these processes through the AAC API or User Interface (UI).

Requirements

  • Dedicated AAC workspaces for separate SDLC environments. For example, Development, Testing, and Production.

  • Workspaces have a dedicated set of users with environment-specific roles and permissions.

  • Users responsible for promoting assets between environments must exist with sufficient permissions on all relevant workspaces.

    • Note that these users require Editor access for write permission.

  • Users must have relevant roles to access Designer Experience and Designer Desktop workflows.

  • Allow asset sharing with users on any of the environment workspaces.

Limitations

  • Workflow versioning is only available for Designer Experience and Designer Desktop workflows at this time.

Useful Terms

  • Asset ID: Unique ID for each of your assets across workspaces.

  • Asset Name: Editable global asset ID. Different assets can have the same Asset Name in the same workspace.

  • Version ID: Within an asset, a unique ID for each version across workspaces.

  • Version Name: Editable name to identify an asset ready for promotion. Note that this value isn't unique, and a workflow can have multiple Version Names that are the same value.

Asset Promotion Guide Using AAC APIs

Create an automated process to handle multiple Designer Experience workflows with the AAC APIs. To learn more about the AAC APIs, go to Get Started with Alteryx Analytics Cloud APIs.

  1. From Designer Experience, create or edit a workflow in a workspace representing the Development environment.

  2. Select Save Version from the File dropdown.

  3. [Optional] Enter a Version Name, for example, Production Ready. Note that you can only view the Version Name that you enter from an API call.

  4. Select Save.

  5. Create a GET API request to retrieve the VersionID that matches with the specific VersionName.

    1. You can use VersionName as a filter to download only the workflows with a specific VersionName. As a result, you will get the relevant WorkflowID and VersionID list.

    2. Here is a sample API call…

      curl\--location 'https://us1.alteryxcloud.com/svc-workflow/api/v1/workflows?versionName[eq]=ProductionReady'\--header 'Authorization: Bearer [API TOKEN]'

  6. Create a Download API request with the WorkflowID and VersionID of the workflows you want to download locally. Note that AAC won’t accept JSON workflow files that have been modified outside of AAC.

    • Here is a sample API call…

      curl\--location 'https://us1.alteryxcloud.com/svc-workflow/api/v1/workflows/[ID]/versions/[VERSION]'\--header 'Accept: application/octet-stream'\--header 'Authorization: Bearer [API Token]'\-o ProductionReady.json

  7. Sign in to the higher environment workspace, for example, the Production environment.

  8. Create a POST API request to upload the previously downloaded workflows into the higher environment workspace.

    1. Here is a sample API call…

      curl\--location 'https://us1.alteryxcloud.com/svc-workflow/api/v1/workflows'\--header 'Authorization: Bearer [API Token]'\--form 'file=@"ProductionReady.json"'

    2. If the same workflow already exists in this workspace, AAC creates a new version of that workflow upon upload.

  9. Open the workflow and reconnect any inputs or outputs to data sources. Note that you must perform this step through the UI.

  10. The workflow is now ready for the next stage of your SDLC process.

Asset Promotion Guide Using the AAC UI

Follow this manual process to handle Designer Experience workflows with the AAC UI.

  1. From Designer Experience, create or edit a workflow in a workspace representing the Development environment.

  2. Select Save Version from the File dropdown.

  3. [Optional] Enter a Version Name, for example, Production Ready. Note that you can only view the Version Name that you enter from an API call.

  4. Select Save.

  5. Go to the Library page.

  6. For relevant workflows that you want to promote to a higher environment, select the 3-dot menu and then select Download. Note that AAC won’t accept JSON workflow files that have been modified outside of AAC.

  7. Sign in to the higher environment workspace, for example, the Production environment.

  8. Go to the Library page.

  9. Select Upload then upload your workflow JSON files. Note that you can only upload 1 workflow at a time.

    • If the same workflow already exists in this workspace, AAC creates a new version of that workflow upon upload.

  10. Open the workflow and reconnect any inputs or outputs to data sources.

  11. The workflow is now ready for the next stage of your SDLC process.

本节内容如下: