Versioned recipes

How to use and create versioned recipes

A versioned recipe in Documotor is essentially a collection of different versions of the same recipe that allows the user to keep the current version of a recipe in production while working on a new version.

Create versioned recipes

  1. From the Navigation Pane (accessible from anywhere by selecting the Documotor logo in the top-left), select Recipes.
  2. Navigate to your desired folder and select New Template > Versioned Recipe.
  3. Enter the name for your new versioned recipe.
  4. Select Create.

Create new versions

  1. Navigate to an existing versioned recipe and open it.
  2. Select New Recipe.
  3. Enter the name for the new version.
  4. Define the file format of your new document.
  5. Select Create.

Stages

Stages are unit-wide. You can read about creating and administering stages in the Unit Management guide.

Existing stages are shown for each version within the collection, and templates that have stages assigned to them have that stage highlighted purple instead of the gray indicators.

How to assign a stage to a template

  1. Select the stage name next to the template.
  2. Select Confirm in the dialog box that opened.

Note that newly created stages must be manually assigned to a version. Once a stage has been assigned to a version, it cannot be deleted from the management dashboard. There can only be one template in each stage, so assigning a new template to a stage will automatically unassign the old one.

Assigning different versions to different stages.

Assigning different versions to different stages.

Generating documents

Documotor supports document generation of versions within a versioned recipe. Postman and Curl code snippets can be accessed by clicking the Code Snippet icon next to the name of the versioned recipe.

Generating versioned documents uses the same endpoint as regular documents with two differences:

  • ID provided is that of the versioned recipe (parent of the version)
  • stageId must be added in the header of the call

If both stageId and stageName are provided in the header, only stageId is considered.

With versioned recipes, there is no need for the ID of the version when calling Documotor's Generate API, as the version ID is found using the ID of the versioned recipes and the ID or Tag of the stage.

Existing stages related to the current unit are shown and can be toggled between, to update the calls with new data.

Note that, if a stage that is not assigned to any version is selected, the constructed code snippet will not work if used. Make sure to only use code snippets from stages that are assigned to versions.