Configure data sources

Data integration

Experience Manager Forms Data Integration allows you to configure and connect to disparate data sources. The following types are supported out-of-the-box. However, with little customization, you can integrate other data sources as well.

  • RESTful web services
  • SOAP-based web services
  • OData services

Data integration supports OAuth2.0, Basic Authentication, and API Key authentication types out-of-the-box, and allows implementing custom authentication for accessing web services. While RESTful, SOAP-based, and OData services are configured in Experience Manager as a Cloud Service and connector for Experience Manager user profile are configured in Experience Manager web console.

NOTE

Experience Manager Forms does not support relational database.

Configure folder for cloud service configurations

Configuration for cloud services folder is required for configuring cloud services for RESTful, SOAP, and OData services.

All cloud service configurations in Experience Manager are consolidated in the /conf folder in Experience Manager repository. By default, the conf folder contains the global folder where you can create cloud service configurations. However, you must manually enable it for cloud configurations. You can also create additional folders in conf to create and organize cloud service configurations.

To configure the folder for cloud service configurations:

  1. Go to Tools > General > Configuration Browser.

  2. Do the following to enable the global folder for cloud configurations or skip this step to create and configure another folder for cloud service configurations.

    1. In the Configuration Browser, select the global folder and tap Properties.

    2. In the Configuration Properties dialog, enable Cloud Configurations.

    3. Tap Save & Close to save the configuration and exit the dialog.

  3. In the Configuration Browser, tap Create.

  4. In the Create Configuration dialog, specify a title for the folder and enable Cloud Configurations.

  5. Tap Create to create the folder enabled for cloud service configurations.

Configure RESTful web services

RESTful web service can be described using Swagger specifications in JSON or YAML format in a Swagger definition file. To configure RESTful web service in Experience Manager as a Cloud Service, ensure that you have either the Swagger file on your file system or the URL where the file is hosted.

Do the following to configure RESTful services:

  1. Go to Tools > Cloud Services > Data Sources. Tap to select the folder where you want to create a cloud configuration.

    See Configure folder for cloud service configurations for information about creating and configuring a folder for cloud service configurations.

  2. Tap Create to open the Create Data Source Configuration wizard. Specify a name and optionally a title for the configuration, select RESTful Service from the Service Type drop-down, optionally browse and select a thumbnail image for the configuration, and tap Next.

  3. Specify the following details for the RESTful service:

    • Select URL or File from the Swagger Source drop-down, and accordingly specify the Swagger URL to the Swagger definition file or upload the Swagger file from your local file system.

    • Based on the Swagger Source input, the following fields are pre-populated with values:

      • Scheme: The transfer protocols used by the REST API. The number of scheme types that display in the drop-down list depend on the schemes defined in the Swagger source.
      • Host: The domain name or IP address of the host that serves the REST API. It is a mandatory field.
      • Base Path: The URL prefix for all API paths. It is an optional field.
        If necessary, edit the pre-populated values for these fields.
    • Select the authentication type — None, OAuth2.0, Basic Authentication, API Key, or Custom Authentication — to access the RESTful service, and accordingly provide details for authentication.

    If you select API Key as the authentication type, specify the value for the API key. The API key can be sent as a request header or as a query parameter. Select one of these options from the Location drop-down list and specify the name of the header or the query parameter in the Parameter Name field accordingly.

  4. Tap Create to create the cloud configuration for the RESTful service.

Configure SOAP web services

SOAP-based web services are described using Web Services Description Language (WSDL) specifications. Experience Manager Forms do not support RPC style WSDL model.

To configure SOAP-based web service in Experience Manager as a Cloud Service, ensure that you have the WSDL URL for the web service, and do the following:

  1. Go to Tools > Cloud Services > Data Sources. Tap to select the folder where you want to create a cloud configuration.

    See Configure folder for cloud service configurations for information about creating and configuring a folder for cloud service configurations.

  2. Tap Create to open the Create Data Source Configuration wizard. Specify a name and optionally a title for the configuration, select SOAP Web Service from the Service Type drop-down, optionally browse and select a thumbnail image for the configuration, and tap Next.

  3. Specify the following for the SOAP web service:

    • WSDL URL for the web service.

    • Service Endpoint. Specify a value in this field to override the service endpoint mentioned in WSDL.

    • Select the authentication type — None, OAuth2.0, Basic Authentication, or Custom Authentication — to access the SOAP service, and accordingly provide the details for authentication.

  4. Tap Create to create the cloud configuration for the SOAP web service.

Enable the use of import statements in SOAP web services WSDL

You can specify a regular expression that serves as the filter for absolute URLs that are allowed as import statements in SOAP web services WSDL. By default, there is no value in this field. As a result, Experience Manager blocks all import statements available in WSDL. If you specify .* as the value in this field, Experience Manager allows all import statements.

Set the importAllowlistPattern property of the Form Data Model SOAP Web Services Import Allowlist configuration to specify the regular expression. The following JSON file displays a sample:

{
  "importAllowlistPattern": ".*"
}

To set values of a configuration, Generate OSGi Configurations using the AEM SDK, and deploy the configuration to your Cloud Service instance.

Configure OData services

An OData service is identified by its service root URL. To configure an OData service in Experience Manager as a Cloud Service, ensure that you have service root URL for the service, and do the following:

NOTE

For step-by-step guide to configure Microsoft Dynamics 365, online or on-premises, see Microsoft Dynamics OData Configuration.

  1. Go to Tools > Cloud Services > Data Sources. Tap to select the folder where you want to create a cloud configuration.

    See Configure folder for cloud service configurations for information about creating and configuring a folder for cloud service configurations.

  2. Tap Create to open the Create Data Source Configuration wizard. Specify a name and optionally a title for the configuration, select OData Service from the Service Type drop-down, optionally browse and select a thumbnail image for the configuration, and tap Next.

  3. Specify the following details for the OData service:

    • Service Root URL for the OData service to be configured.
    • Select the authentication type — None, OAuth2.0, Basic Authentication, API Key, or Custom Authentication — to access the OData service, and accordingly provide the details for authentication.

    If you select API Key as the authentication type, specify the value for the API key. The API key can be sent as a request header or as a query parameter. Select one of these options from the Location drop-down list and specify the name of the header or the query parameter in the Parameter Name field accordingly.

    NOTE

    You must select OAuth 2.0 authentication type to connect with Microsoft Dynamics services using OData endpoint as the service root.

  4. Tap Create to create the cloud configuration for the OData service.

Next steps

You have configured the data sources. Next you can create a Form Data Model or if you have already created a Form Data Model without a data source, you can associate it with the data sources you just configured. See Create form data model for details.

On this page

Adobe Summit Banner

A virtual event April 27-28.

Expand your skills and get inspired.

Register for free
Adobe Summit Banner

A virtual event April 27-28.

Expand your skills and get inspired.

Register for free
Adobe Maker Awards Banner

Time to shine!

Apply now for the 2021 Adobe Experience Maker Awards.

Apply now
Adobe Maker Awards Banner

Time to shine!

Apply now for the 2021 Adobe Experience Maker Awards.

Apply now