Skip to main content

 

 

 

 

 

 

 

 
 
OutSystems

How Integration Builder works

Template:OutSystems/Documentation_KB/ContentCollaboration
  • Edit
    Collaborate with us
    Edit this page on GitHub
  • Integration Builder is a Software as a Service (SaaS) tool that connects to your OutSystems environment.

    Integration Builder generates integrations for different external systems according to the configuration you provide. Each integration needs an associated connection that specifies the authentication used in runtime by the integration in an OutSystems environment.

    After creating an integration and setting up a connection, use Service Studio to add calls to the Service Actions provided by the integration in your OutSystems apps.

    Architecture overview

    Integration Builder architecture diagram

    The main components involved in the Integration Builder architecture are the following:

    • Integration Builder generates integrations that connect to external systems and publishes them to your OutSystems environment.

    • Integration Manager is an OutSystems application that Integration Builder publishes to your OutSystems environment when you publish an integration. It manages connections and their association with integrations.
      Integration Manager communicates with Integration Builder to keep the status of integrations consistent and to get initial integration configurations. This happens in every environment to which you deploy the integrations.

    • An integration is an OutSystems application generated by Integration Builder containing Server Actions to interact with an external system, according to the configurations you provide. Learn more about the structure of generated integrations.

    • A connection is where you define the credentials or the type of authentication used in runtime to connect with an external system. Connections are defined in each OutSystems environment.
      Different external systems offer different ways of integrating with them. While some external systems support a basic authentication mechanism like Basic Authentication, other systems implement more complex authentication flows like OAuth.

    • End users access an OutSystems app that you developed and published on your environment. This app calls Service Actions exposed by the integration to interact with the external system.

    Users

    Integration Builder authenticates IT users by contacting your environment to validate the user credentials.

    To use Integration Builder you must have an IT user that has the correct permissions for the environment.

    All IT users in your infrastructure that have these permissions can access and edit all integrations created and managed by Integration Builder.

    Every OutSystems developer that can create applications in an OutSystems environment enrolled in the program can log in to Integration Builder. Every developer can see and modify all integrations created and managed by Integration Builder.

    Dependencies

    Integrations created using Integration Builder include dependencies to the following Integration Builder apps:

    • Integration Builder Utils

    • Common Shared Services

    • Secret Manager Local Service

    • Integration Manager

    • [Only for SharePoint Online integration] SharePoint Integration Utils

    Updating dependencies

    To update dependencies, the IT user must have Change and Deploy Applications or higher permission assigned as a default role for the development environment.

    If you want to disallow a sub-set of Integration Builder users from updating dependencies, in LifeTime, change the IT user permissions for those users in one of the following ways:

    • Assign these users the Open and Debug Applications permission for each dependency app. Learn more about assigning roles for an app.

      or

    • Add these users to a team with Open and Debug Applications permission for each dependency app. Learn more about assigning roles with a team.

    • Was this article helpful?