Installing Umbraco Workflow

In this article, we will cover the steps required to install Umbraco Workflow on your website.

Prerequisites

• Microsoft Visual Studio

Umbraco Workflow Installation

There are different ways to install Umbraco Workflow:

• .Net CLI Installation

• Visual Studio Installation

.Net CLI Installation

To install the Umbraco Workflow package (Umbraco.Workflow), follow these steps:

1. Run the following command to add a package reference to your Umbraco project:

   dotnet add package Umbraco.Workflow --version 10.*

2. Add AddWorkflowEmailTemplateProvider() in the ConfigureServices method in the Startup.cs file:

   public void ConfigureServices(IServiceCollection services) => 
   services.AddUmbraco(_env, _config)
   	.AddBackOffice()
   	.AddWorkflowEmailTemplateProvider()
       	.AddWebsite()
   	.AddComposers()
       	.Build();

   AddWorkflowEmailTemplateProvider() must be added before AddWebsite().

3. Restart the web application using the following command:

   dotnet run

Visual Studio Installation

To install via Visual Studio, follow these steps:

1. Open your project in Visual Studio.

2. Go to Tools -> NuGet Package Manager -> Manage NuGet Packages for Solution....

3. Browse for Umbraco.Workflow.

4. Select the appropriate version from the Version drop-down depending on the Umbraco version you are using.

5. Click Install.

   
6. Once the package is installed, open the .csproj file to make sure the package reference is added:

   <ItemGroup>
   <PackageReference Include="Umbraco.Workflow" Version="10.0.0" />
   </ItemGroup>

7. Add AddWorkflowEmailTemplateProvider() in the ConfigureServices method in the Startup.cs file:

   public void ConfigureServices(IServiceCollection services) => 
   services.AddUmbraco(_env, _config)
   	.AddBackOffice()
   	.AddWorkflowEmailTemplateProvider()
       	.AddWebsite()
   	.AddComposers()
       	.Build();

`AddWorkflowEmailTemplateProvider()` must be added before `AddWebsite()`.

Using Umbraco Workflow

Once the installation is completed, you will see the following in the Umbraco Backoffice:

A Workflow Dashboard

Workflow dashboard

A Workflow section

Workflow section