Skip to main content




Service Studio version:

SAP OData integration

  • Edit
    Collaborate with us
    Edit this page on GitHub
  • The SAP OData integration allows you to perform operations on SAP entities and call SAP actions from your OutSystems applications.


    Verify the following:

    Service specification

    Integration Builder accepts SAP service specifications in EDMX format (an XML-based format) or in JSON format.

    You can upload the specification file (including dragging-and-dropping the file), or copy and paste the text for the whole specification into the appropriate text box when creating an SAP OData integration.

    For more information, see Obtaining the SAP service specification.

    The information present in the EDMX and JSON file formats is not exactly the same. If you have any issues while importing a specific specification using one of the supported formats, try importing the service again using a different format.

    Selecting SAP objects

    In the integration creation wizard you must choose which SAP entities and actions to consider in the new integration:

    Select the SAP entities you want to interact with in OutSystems, selecting also the attributes of these entities. Integration Builder creates Server Actions to perform CRUD (create, read, update, delete) operations.

    Integration Builder creates actions for all the entity operations available on the service specification. However, depending on the exact service, some CRUD operations may not be available because they're not present in the service specification.

    Actions available in the SAP service you want to invoke from OutSystems applications.

    Authentication methods

    SAP connections support the following authentication methods through Integration Manager:

    • Basic authentication — This is the type of authentication normally used with service accounts. You must provide an SAP username, the corresponding password, and your SAP server domain.

    • Sandbox API authentication — The sandbox API uses a key to authenticate requests. If you're using an SAP sandbox with Integration Builder, enter the authentication key provided by SAP.

    When using one of these authentication methods, you must associate a connection with the integration after deploying it to a different environment. Use the Integration Manager application that was also deployed in the target environment for this purpose. For more information see Create a connection for the integration.

    You can also implement other authentication methods. Use the AdditionalHeaders input parameter of the Server Actions exposed by the integration.

    Supported OData versions

    Integration Builder supports both OData 2.0 and OData 4.0 specifications. It must know the correct version of the specification because search queries have a different format depending on the OData version. Additionally, DateTime attributes also have a different format in different OData versions.

    When Integration Builder can't determine the OData version from the service specification, it asks you to select the correct version.

    It's very important that you select the correct OData version when importing the service specification. Selecting the incorrect OData version causes runtime issues.

    Use the integration in Service Studio

    For more information, see how to use the integration in Service Studio.

    Articles in this Section

    • Was this article helpful?