Skip to main content




Service Studio version:

How to set up Integration Builder

  • Edit
    Collaborate with us
    Edit this page on GitHub
  • Integration Builder is a Software as a Service (SaaS) that connects to your OutSystems environment to authenticate and validate user connections. Integration Builder works with Integration Manager to keep the status of your integrations current, so it needs to be able to connect with the environments to which you deploy the integrations. In addition, Integration Builder is available in all OutSystems editions.

    Integration Builder connects to your environments


    • The IT user you use to log in to Integration Builder must have the Change and Deploy Applications permission level and the Create Applications specific permission for the development environment. Check Understanding the permission model for IT users for more information.

    • Use the latest version of any of the following desktop browsers: Edge, Firefox, Google Chrome, or Safari.

    • All environments, except for the LifeTime environment, must:

    Keep in mind:

    • Each integration may have additional requirements. To verify, check the specific integration documentation.

    • When using Integration Builder with Multiple Database Catalogs (MDC), and publishing to a development environment, a prompt displays for you to download your solution. Currently Integration Builder is unable to publish to a development environment. You can then use Service Center to publish your integration solution

    Registering your infrastructure

    Before using Integration Builder, register the infrastructure in Integration Builder by following these steps:

    1. Access, enter the development environment address, and click Next. OutSystems checks the environment exists.

    2. Enter your IT username and password, and then click Log in. OutSystems verifies the user has the correct permissions.

    3. On the Welcome screen, click Set up Integration Builder. The Integration Builder Disclaimer page displays.

    4. On the Integration Builder Disclaimer page, review the terms and conditions, and click Accept and Continue. OutSystems checks your infrastructure.

    5. If your development environment uses Platform Server 11.7.6 or lower, enter your Activation Code and click Register and Continue.

      To get your activation code, go to https://<dev-environment-address>/ServiceCenter, then click Administration > Licensing, and copy your Activation Code.

    After these steps, IT users for the infrastructure can start using Integration Builder.

    Installing dependencies

    Integrations created using Integration Builder need other apps to work properly. After registering your infrastructure, a Setup widget at the bottom right prompts you to install some of these dependencies.

    To install dependencies, follow these steps:

    Install dependencies

    1. Click the Setup widget to expand it.

    2. Click Install dependencies to start installing the dependencies.

    After these steps Integration Builder stars installing the dependencies listed.

    Installing dependencies

    Setting up on-premises environments

    When using an on-premises infrastructure with Integration Builder, you need to setup the addresses of the other environments where you'll deploy the integrations after finishing development. For example, for a standard infrastructure, Integration Builder must be able to connect to the development, quality assurance, and production environments but doesn't need to connect to the LifeTime.

    After you develop and publish the first integration, the Setup widget at the bottom right prompts you to add the environment addresses.

    To set up the environments, follow these steps:

    1. Click the Setup widget to expand it, and the click on Setup environments.

    2. Click Add environment.

    3. Enter a name for the environment and its URL, then click Add environment. The URL is the environment address.

    4. Repeat step 2 and 3 until you have added all your non-LifeTime environments.

    • Was this article helpful?