Skip to main content

Advanced setup for Workflows in Portals

How to automatically add Workflows to Portals, and automatically assign External Users as task step owners

Written by Carly Hammond
Updated over 2 weeks ago

Summary

  • Building on our previous article on adding Workflows to Portals, in this article we discuss various options for automating the process

  • You can share a (Company Project) Workflow Template to Portals, meaning that Workflows created from it are also shared to Portals

    • By itself this doesn't mean they are actually added to Portals, but rather that they are available for Portals

    • Individual task steps can be shared to Portals too

  • You can use custom "End User" type fields on the Company model to be dynamic references in task step "Owner" fields within a Workflow Template, to be populated with Portal "External Users"

  • You can include Workflow Templates within Portal Templates, and even set things up so that when you create Portals, External Users are created, Workflows are created, and the relevant External Users are assigned as task step owners

Who is this article for?

  • Planhat users setting up Portals for individual Companies

  • Planhat users configuring Planhat for their organization (e.g. CS Ops)

Series


Article contents


Introduction

Definitions

Portals are collaborative spaces where you share information and work together with your customers and prospects, each Portal belonging to a specific "Company" in Planhat data model terms.

Workflows are processes you configure in Planhat, such as a "Project" type Workflow on the Company model for Enterprise Onboarding, comprising a series of scheduled task steps (e.g. "Hold kick-off call"). Each Workflow record is associated with a particular Company, while Workflow Templates (described next) contain the templated configuration used to create them.

You set up Workflow Templates that each include steps for that process, including rules to define when each step is scheduled (e.g. step 1 should be due 2 days after the Workflow Template is applied to a Company, creating a new Workflow record; and step 2 should be due 5 days after step 1 is marked as completed; and so on).

Recap

In a previous article (here), we talked through how you can manually add a Project-type Workflow record belonging to a Company to that Company's Portal, in two main steps:

  1. Within your Planhat tenant, ensure the Workflow is shared to Portals (shown by a purple "On Portal" badge)

  2. Within the Portal, add a "Workflow 360" Page and select this Workflow

We also discussed how:

  • Individual task steps also need to be shared to Portals (in your Planhat tenant) in order to be visible in the Workflow - which means you can share some task steps with your customers/prospects, but keep other steps in the Workflow "internal"

  • You also configure External Role permissions to determine which parts of the Workflow "External Users" (End Users in a Portal) can see

  • External Users can be task owners

Building on this: more advanced Portal/Workflow functionality

In this article, we'll go through some additional features that enable you to automate the process of including Workflows in Portals:

  • Share Workflow Templates to Portals, meaning you don't need to set this individually for each Workflow created from it

  • Assign a dynamic "End User" type field as a task step owner within a Workflow Template, meaning that when such a Workflow is added to a Portal, this can be populated with the relevant External User

  • Include shared Workflow Templates within Portal Templates, meaning that Workflows are automatically added to Portals

  • Combine all the above 3 features together for even greater value - so you can create a Portal, and have it automatically include a Workflow and assign an External User as a task step owner


Sharing Workflow Templates to Portals

Rather than sharing each individual Workflow record (each belonging to a specific Company) to Portals, you can save time and reduce manual work by sharing a Workflow Template to Portals.

Click the image to view it enlarged

This means that each Workflow (for an individual Company) that's created from that Workflow Template will automatically be shared to Portals too.

Click the image to view it enlarged

It's important to note that this by itself does not add Workflows into Portals; it actually means they are available for selection in Portals. You would then need to either:

  • manually add each individual Workflow to its Company's Portal (as described in our separate article here), or

  • include the Workflow Template in a Portal Template to add it automatically to Portals, as we describe later in this article.

Note also that sharing a Workflow Template to Portals is required for you to be able to dynamically populate its task owners with External Users, which we discuss later in this article.

How to share Workflow Templates to Portals

πŸ“Œ Important to note

You can only share Workflow Templates to Portals that are:

  • Type "Project" (rather than "Sequence")

  • Have the target model "Company"

To share a Workflow Template to Portals:

  1. Go to the "Workflows" Global Tool for admins (in the "System Admin" menu in the top left of your Planhat tenant)

  2. Click on your Workflow Template in the list to open it up

  3. Click on the ellipsis symbol (3 dots) in the top right, and click "Share on Portal"

  4. You'll see the following message; click "Share" to confirm

Once you have done this, the Workflow Template will show the purple badge "On Portal".

It's important to note that each Workflow task step that you want to be present in Portals needs to be shared to Portals too, via the "Shared In Portal" toggle switch. This enables you to share some task steps (external tasks - to be seen/completed by customers/prospects) but not others (internal steps - to be seen/completed by you and your co-workers only). Setting this in a Workflow Template means you don't need to set it for each individual Workflow record.

Click the image to view it enlarged

You also need to share Workflow Template task steps to Portals if you want the option to select an End User type field to dynamically populate task owners with External Users, as we go through next in this article.


Dynamic External User task owners

An "External User" is an End User (a person at one of your prospect/customer Companies) who has been added to a Portal.

When a Workflow is shared to a Portal, you can manually select an External User to be the owner of a specific task.

Click the image to view it enlarged

In this article, we are going to look at how you can automatically assign External Users as task owners, so you don't need to manually do it for each Workflow record.

You set this up via Workflow Templates. To summarize:

  • Within a Workflow Template, in the "Owner" field for your choice of task step, you select a custom "End User" type field (on the Company model), e.g. "CS Ops"

  • You ensure the custom is populated in your Planhat tenant (e.g. for the Company "Microsoft", the "CS Ops" custom field is populated with the End User "Lizzie Barclay")

  • When a Workflow from that Workflow Template is created for a Company, we look for a match between the End User in that field and the existing External Users within the Company's Portal, and populate the task step "Owner" field with that External User

We describe the setup steps in more detail later in this article.

Once set up, your automated process will look like this:

  1. You create a new Workflow for a Company using your Workflow Template

  2. Within your Planhat tenant, you will see that the newly-created Workflow has the External User assigned as the "Owner" of the relevant steps

  3. When you add the Workflow to the Portal (as a Workflow 360 Page), the "Owner" field is automatically populated with the External User here in the Portal too

πŸš€ Tip

You can also automate this process even more, by including the Workflow Template within a Portal Template. We go through this setup later in this article.

How to set up dynamic External User task owners

Let's look at the setup in further detail. There are a few setup stages here to go through.

(1) Create and populate a custom "End User" type field on the Company model for you to use as your task owner (if it doesn't exist yet)

You need to have a field that will be populated in your Planhat tenant for your task step owner. For example, let's say your Workflow Template includes a step that will be carried out by the "Main User" or "CS Ops" person at each Company. You create this "Main User" or "CS Ops" etc. field as a custom field ...

  • ... that you specify as the task step owner in the Workflow Template ...

  • ... and is populated for each Company in your Planhat tenant (e.g. the "Main User" for Company "Apple" is the End User "Betty Jones").

You can do this for each such field/role you want to specify - i.e. you can repeat the setup here if you want to assign different types of End Users to different task steps in Workflow Templates.

How can you create these custom fields? You can read a separate article on creating custom fields generally here, but in short:

  1. Go to the "Data Model" Global Tool for admins (accessed via the "System Admin" menu in the top left of your Planhat tenant)

  2. Ensure "Company" is select in the data models list on the left-hand side, and the "Fields" tab is selected

  3. Click on "+ New Field" in the top right

    Click the image to view it enlarged

  4. In the modal that pops up, ensure that the "Data type" of the field is set to "End user", fill in the rest of your field as necessary (e.g. give it a "Name"), and press "Save" to create it

Now that the field exists in your Planhat tenant, you can populate it for each Company with a End User belonging to that Company.

(2) Include the custom field within a Workflow Template

Now you can include this custom "End User" type field within Workflow Templates. This will be a dynamic reference, meaning that it will be filled in with an actual value (an End User / External User) in individual Company Workflow records.

There are a couple of pre-requisites for you to have this option:

  1. The Workflow Template itself needs to be shared to Portals (i.e. available for Portals), as we discussed above

  2. The specific task step where you want to include this dynamic reference must itself also be shared to Portals (also mentioned above)

Once you have done this, you'll be able to select your field as a task step owner.

Click the image to view it enlarged

(3) Ensure the relevant End Users have been added to Portals as External Users

The End User in the field also needs to exist as an External User in the Portal, so when the Workflow is created it can be populated with an existing External User.

You can read about manually adding External Users to Portals here. It's also possible to automatically add External Users to Portals via Portal Templates, which we discuss in a more advanced process later in this article.

πŸ“Œ Important to note

If the End User has not been added to the Portal as an External User before you create the Workflow for that Company, the "Owner" field will not be populated for the task step. It is only automatically populated if the End User in the field in your Planhat tenant is also an External User in the Company's Portal.

Bringing it all together in a worked example

Prerequisites

  • A custom field has been created on the Company model of type End User

  • A (Company Project) Workflow Template has been created and has been shared to Portals and also the relevant individual steps have been shared to Portals

    Click the image to view it enlarged

  • The "Owner" of the relevant task steps in the Workflow Template is set to the custom field on the Company model of type End User

  • This custom field is populated in your Planhat tenant for your choice of Company

  • The Company already has a Portal created for it

    Click the image to view it enlarged

  • The End User who's in the custom field in the Planhat tenant has already been added as an External User in that Company's Portal

    Click the image to view it enlarged

Running the process

  1. Create a new Workflow for that Company using that Workflow Template

  2. Within Planhat, you will see that the newly-created Workflow has the relevant External User assigned as the "Owner" of those steps

    Click the image to view it enlarged

  3. In this particular worked example, the Workflow Template isn't part of a Portal Template, and so the Workflow itself hasn't been automatically added to the Portal, although it is available to be added to the Portal. Therefore, add it to the Portal manually, via a Workflow 360 Page (as described in a separate article here). As you can see in the screenshot below, the "Owner" field is automatically populated with the External User here in the Portal too

    Click the image to view it enlarged


Including Workflow Templates within Portal Templates

Portal Templates (configured within the Portal Manager) enable you to automatically populate Portals with content (Sections and Pages) and Internal/External Users. To learn all about Portal Templates, check out our separate article here.

Click the image to view it enlarged

"Custom Template Sections" are created specifically in a Portal Template (rather than being selected for inclusion in a Portal Template), and are copied (rather than mirrored) into each Portal built from that Portal Template. You can choose to include Workflow Templates within these custom Template Sections. You can select from Workflow Templates that have been shared to Portals (as we discussed earlier in this article).

Setting this up means that when you create a Portal for a Company, it will automatically include a Workflow from that Workflow Template (positioned as per your configuration in the Portal Template).

  • If the Company already has a Workflow from that Workflow Template, that will be added to the Portal

  • If the Company doesn't yet have a Workflow from that Workflow Template, the Workflow will be created and added to the Portal

This on its own is super useful, but what's even better is that you can combine it with the dynamic External User task owners we discussed earlier - we'll go through this next.

Bringing it all together in a worked example

We are going to build on the previous worked example.

Prerequisites

  • You need all the prerequisites listed in the previous example (here)

  • In addition:

    • The Workflow Template needs to be included within a Section in the Portal Template

    • In the "Access" tab of the Portal Template, for "Default sharing: External End Users", you need to select an End User Global Filter that will include the relevant End Users (the ones populating your custom task owner field - whether that's a broad filter such as "All End Users", or a more specific filter such as "CS Ops") so that they are automatically created as External Users when the Portal is created for a Company

Running the process

  1. Create a new Portal for a Company for whom this specific Portal Template will be applied

    • Portal Templates are applied like Health Scores, in that the first Portal Template in the list (from top to bottom) with "Criteria" (configured within the Portal Template) that matches that Company will be applied

    Click the image to view it enlarged

  2. That's it! You will see that the Portal is created to that Portal Template (with its content, including that Workflow being automatically created from the Workflow Template), the appropriate End Users are automatically added as External Users, and the appropriate External User is automatically populated as the "Owner" of the relevant task steps!

Click the image to view it enlarged

As you can see, although there is a bit of setup required here, once that's done, running the process is very quick and easy, and automating these elements saves you time and ensures consistency/accuracy of data, by removing manual steps.

Did this answer your question?