Skip to main content

 

 

 

 
 
Service Studio version:
 
 
OutSystems

Use Integration Builder

Template:OutSystems/Documentation_KB/ContentCollaboration
  • Edit
    Collaborate with us
    Edit this page on GitHub
  • The sections below walk you through the several stages of creating, publishing, and deploying an integration:

    • Create an integration using Integration Builder and use it in your OutSystems app
    • Deploy your OutSystems app using LifeTime and configure the integration in the new environment

    Creating and using an integration

    To create an integration using Integration Builder and use that integration in an OutSystems application you must perform the following general steps:

    1. Log in to Integration Builder with your development environment URL and your username and password.
    2. Create a new integration for an external system (for example, SAP) and configure its settings.
    3. Publish the integration in your OutSystems environment.
    4. Create a connection for the integration in your OutSystems environment.
    5. Use the Server Actions exposed by the integration in your OutSystems application.

    The following sections provide more details about these steps.

    Log in to Integration Builder

    To log in to Integration Builder do the following:

    1. Open Integration Builder, available at https://integrationbuilder.outsystems.com.

      Integration Builder login page

    2. In the Environment field, enter the address of your OutSystems development environment.

      For security and governance reasons, you can only connect to a development environment. Integration Builder publishes integrations to the environment you enter on the login page.

    3. Enter your IT user credentials.

    4. Click Log in.

    On your first login, Integration Builder greets you with an onboarding guide. To see the guide again, select ? > Reset onboarding and go to the homepage of Integration Builder.

    Create and configure a new integration

    1. In the Integration Builder homepage, click New integration.

    2. Select the service provider that's the data source of your integration (for example, SAP).

      Choosing a provider in Integration Builder

    3. Follow the wizard steps to configure the integration. These steps vary according to the integration you're creating. They can be the following:

      • Authorize Integration Builder to access the external system (Salesforce) or provide a service specification (SAP OData).
      • Select the objects that you want to interact with in your OutSystems applications.
      • Define a few basic settings for the generated integration, like application and module names, and application icon.
      • Define if you want to generate an open integration, editable in Service Studio, losing the ability to change it in the future using Integration Builder.
    4. After configuring the integration, review its configuration. You can go back to a previous step and change any values.

    Publish the integration

    In the "Review integration" step, click Publish to publish the integration modules to your OutSystems environment. This operation might take a few minutes.

    Publishing an integration in Integration Builder

    Integration Builder also publishes some dependencies along with the integration. Check Apps installed in your OutSystems environment for more information.

    If an error occurs when publishing, Integration Builder displays a Download application package link to download the application OAP file. You can download this application package and publish it manually in your development environment.

    Create a connection for the integration

    After creating an integration you must associate it with a connection before being able to use it. Connections store external system credentials in the context of an OutSystems environment, and they're used in runtime by the integration.

    You can create a new connection or use an existing one. Use Integration Manager to create connections and associate them with integrations.

    Creating a connection requires administrator permissions in the external system.
    If you don't have administration permissions, you need to request some parameters from the external system administrator. Integration Builder can help you during this process by sending an email to the administrator with the all the information they need.

    To create a connection do the following:

    1. After publishing an integration, click Go to connections. The browser navigates to Integration Manager, an app that Integration Builder also deployed to your OutSystems environment along with the integration.

      Alternatively, open Integration Manager directly by navigating to https://<your_environment>/OSIntegrationManager/, select the Connections tab, and click on the integration you want to configure.

    2. In the Select a connection drop-down, click New Connection.

      Selecting a connection in Integration Manager

    3. To connect the external system select one the following:

      • For SAP OData with administrator permissions, enter a connection name and the basic elements for accessing the external system, then select Create connection.

      • For Salesforce, SharePoint Online, Microsoft Dataverse or Microsoft Dynamics 365 with administrator permissions in the external system, enter a connection name and the basic elements for accessing the external system, then select Create connection.

      • For Salesforce, SharePoint Online, or Microsoft Dataverse without administrator permissions in the external system, Integration Builder can send an email to the administrator requesting the information you need. Once you have the information, enter it into Integration Builder, and select Create connection.

    After creating a connection, associate it to the integration do the following:

    1. In Integration Manager, select the My integrations tab.

      The My integrations tab in Integration Manager

    2. In the Integration name column, click the link of the integration you want to associate with the connection.

    3. Select the connection you want to use in the Select a connection drop-down.

    Use the integration in Service Studio

    1. In Service Studio, open the application module of the OutSystems application where you want to use the integration.

    2. Open Manage Dependencies and select the service module of your integration on the right. The service module has a "_IS" suffix by default.

      Add a dependency to the service module Server Actions

    3. Add a dependency for the Service Actions you want to call in your application.

    4. Click Apply.

    5. Add calls to the Server Actions exposed by the integration module to your application logic. Check Structure of generated integrations for more information on the available elements in the generated integration.

    Configuring your integration after deployment

    After deploying your application to another environment using LifeTime (for example, from DEV to QA environment), you must associate a connection to the integration in the new environment using Integration Manager.

    Integration Manager is deployed to every OutSystems environment as a dependency of your integration. Check the dependencies deployed with your integration.

    Do the following:

    1. Open Integration Manager in the target environment by navigating to https://<target_environment>/OSIntegrationManager/ and select the My integrations tab.

    2. Create a new connection for the integration you deployed, or select an existing connection. Check Create a connection for the integration for more information.

    Apps installed in your OutSystems environment

    In addition to the integration application, Integration Builder also publishes the following dependencies to your OutSystems environment when you publish an integration:

    Integration Builder Utils
    Contains utility actions used by modules generated by Integration Builder.
    Integration Manager
    Application that manages authentication for integrations created with Integration Builder. Check where Integration Manager fits in the Integration Builder architecture.

    Note: You shouldn't use any of the public APIs available in Integration Builder Utils or Integration Manager. These modules are maintained by OutSystems and future releases may change their public APIs.

    Articles in this Section

    • Was this article helpful?