Skip to main content





How to set up Workflow Builder

The goal of this document is to guide IT users through the Workflow Builder installation process.


To use Workflow Builder, make sure you meet the following prerequisites:

Your environment

  • Your environment is associated with an OutSystems Edition that isn't the Free Edition. You can't use a Personal Environment with Workflow Builder.

  • Your development environment must use Platform Server 11.7.2 (January 2020) or later to run Workflow Builder. To allow your users to reuse OutSystems Entities from your environment, the minimum version of Platform Server is 11.9 (July 2020). Refer to the release notes for more information.

  • Ensure your development environment allows inbound traffic from in port 443 to communicate with Workflow Builder. The Workflow Builder will use the environment's public DNS hostname to communicate. Refer to the Workflow Builder network requirements for detailed information.

If your infrastructure is on OutSystems Cloud and you didn't configure an internal network for the environment, you already meet this prerequisite.

Your user

  • You must have an IT user with Create Applications and Change and Deploy Application permissions for the environment.

Your device

You can access Workflow Builder with the latest versions of the following desktop browsers only:

  • Edge
  • Firefox
  • Google Chrome
  • Safari

Log in for the first time

Before logging in for the first time, make sure you have IT user accounts for your users in your OutSystems infrastructure. Learn how to create IT users in OutSystems.

When you log in to Workflow Builder for the first time you enter the following welcome screen:

Workflow Builder login page

To log in to Workflow Builder, perform the following steps.

  1. Enter the address of your OutSystems development environment in the Environment field.

    Use a non-production environment with Workflow Builder, preferably your development environment.
    When you publish an app in Workflow Builder, it publishes the app in the environment you entered in the login.

  2. Enter your username and password.

  3. Click Login.

Register your infrastructure

As a first user from your organization logging in, you first need to register your environment. The registration procedures vary, depending on your OutSystems platform version.

Initial steps

To begin registering your infrastructure in Workflow Builder, perform the following steps:

  1. Click Register environment.

    Workflow Builder welcome screen

  2. Read the Workflow Builder disclaimer and GDPR information carefully. To proceed, click Accept and continue.

  3. Check your OutSystems Platform Server release version.

    1. If your release is between 11.7.2 and 11.8.0, proceed to the Platform Server releases 11.7.2 until 11.8.0 section.
    2. If your release is 11.8.0 or later, proceed to the Platform Server release 11.8.0 onwards section.

Platform Server release 11.8.0 onwards

For OutSystems releases later than 11.8.0 (April 2020), Workflow Builder collects all data from your infrastructure automatically, including Activation Code.

  1. Check the information displayed, and click Register.

  2. Proceed to the Final steps section.

Platform Server releases 11.7.2 until 11.8.0

For Platform Server releases between 11.7.2 and 11.8.0 (April 2020), perform the following steps:

  1. Enter your activation code, and click Register. Check how to Find the Activation Code of your infrastructure.

  2. Workflow Builder collects all data from your infrastructure automatically. Check the information displayed, and click Register.

Final steps

After collecting the activation code and related data from your infrastructure, your environment is successfully registered. A new installation begins in the background for the Case Management framework.

Case Management framework

At this point, the installation of Case Management framework starts automatically. Case Management framework is an OutSystems solution, a set of pre-built functions from which the Workflow Builder relies on to work correctly, and to be able to publish an app directly to the registered environment. For more information refer to the Case Management framework documentation.

Case Management framework is only installed in the registered environment.

In case the Case Management framework fails to install, you have the possibility to download it and install it directly in your environment as any other OutSystems app, through your Service Center.

At this stage, you need to set up the governance model according to the instructions in the following sections.

Governance model setup

You can invite business developers to leverage the Workflow Builder to build workflow apps for their everyday needs. Setting up the governance model defines what users can do, and what shared services or components they can use. Check How to set up the users governance model for more information.