Creating a Customized Release Workflow

This functionality is currently available only on browser.

Administrators of enterprises can create customized release and obsoletion workflows specific to the enterprise needs. Onshape provides a JSON file of our release and obsoletion workflows as a starting place for customizing the workflow to suit your company's needs. You can also use our JSON as a starting point for creating your own JSON file.

Bear in mind that the currently selected release and obsoletion workflow (chosen by the administrator) governs newly created release candidates through the selected process. If you change the worfklow while a release is in-process, that release follows the workflow under which it was created. The newly selected workflow will govern only release candidates created after it was selected.

One more thing: Onshape customized workflows currently do not allow cyclical processes.

At this time, you are not able to delete a workflow, but you are able to add as many as you want to your workflow repertoire to select from. You are also able to replace an existing customized workflow, if necessary.

We recommend keeping all of your workflow definition files in one Onshape document for ease of access.

The customization process has these major steps, each explained in detail below:

  1. Download the Onshape default workflows to your hard drive or other easily accessible location.
  2. Create a new Onshape document and import the workflow files.
  3. Edit and publish the workflows.

Automatic transition for two-tiered workflows

When you set up a custom release workflow that includes two tiers, and the second tier is not required (that is, the second tier is optional) Onshape will automatically transition from Pending to Released if there is no approver specified in the release package. No setup is required for this, the only requirements are that you have a two-tier workflow, the second tier is optional and there are no approvers specified in the Approver field in the release candidate.

Download the Onshape default workflows

To download the Onshape default workflow files:

  1. Navigate to your Company settings and select Release management.
  2. Confirm that Enable managed workflows is checked, then click View in document.

    The workflow file opens in a public document in another tab.

  3. Click Download, enter a new name for the file.

    You can close that tab once the tab is downloaded.

Create a new Onshape document and import the workflow files

  1. In your enterprise, navigate to the Documents page, select Create > Document, then select Blue OK button. (In this example, the document name is Company Customized Workflows)
  2. In the new document, click the Plus icon Plus sign icon at the bottom and select Import:

Import highlighted in menu

  1. Select the workflow file you just downloaded and click Open.
  2. Another tab appears in your document, with the name of the file you imported. Select that tab to open it:

Example of a custom workflow

Edit and publish the workflows

Edit the custom workflow according to the guidelines below:

  • As you edit, the diagram on the right will reflect the changes made in your JSON.
  • The diagram is dynamic and draggable, so if the structure does not reflect your intended workflow, use your cursor to adjust it.
  • Cyclical workflows are not allowed.
  • Once you are satisfied with your edits and want to make your workflow available for use in the enterprise, click to open the Publish custom workflow dialog:

Publish button icon

Publish custom workflow dialog

This dialog will alert you of any errors that may have to be fixed before publishing.(After you click Publish, if there are errors in your workflow code they will be displayed at the top of this dialog. Cancel the dialog, fix the errors and click Publish again to open this dialog). Once your workflow is error-free: provide a name, description, and workflow type. If this is a brand new workflow, not replacing another workflow, select None in the Replace workflow dropdown. If you wish to replace an already-existing workflow, select the one you wish to replace.

Click Publish icon.

Enabling multiple active workflows

Once you have published a custom workflow, you can enable multiple active workflows in your enterprise if you wish. When multiple active workflows are available to your users, they can select which workflow to follow when creating a release candidate.

It is the responsibility of the administrator to educate users on which workflows should be used and under what conditions.

To enable multiple workflows:

  1. Follow the instructions above to create more than one custom workflow and publish them in Onshape.
  2. In the Release management page of Company settings, select one of the custom workflows from the Managed workflows drop down:

  3. Once a custom workflow is selected, a check box for enabling multiple workflows appears below the workflow diagram:

  4. Check the box to access the additional workflows and select as many as you want to make available to users:

    Since 01Review workflow is already selected (above) as the enabled workflow, its checkbox cannot be unchecked.

  5. Make sure to click Save release settings to save the changes you've made to the Release management settings for the enterprise.

When your users create a release candidate, they are presented with an opportunity to select a workflow at that time (from the dropdown):

Syntax

The syntax for customizing the release or obsoletion workflow is presented below. Note that capitalization is important.

Keep in mind the following rules.

 


Was this article helpful?

Last Updated: January 07, 2021