Setting Up a New Connector in the Connector Studio

Objective

After completing this lesson, you will be able to set up a new connector in the Connector Studio

Introduction

In today's rapidly evolving digital landscape, businesses require seamless integration between diverse applications to provide a holistic view of customer data. The SAP Customer Data Platform (CDP) addresses this need through the Connector Studio — a powerful, low-code/no-code solution designed to streamline the creation of integration pathways between the CDP and RESTful systems or applications. This lesson focuses on understanding the key concepts of application connectors and the Connector Studio, paving the way for configuring new connectors.

Understanding Application Connectors

At its core, an application connector acts as a bridge that facilitates communication between the SAP CDP and external REST API systems. By using these connectors, organizations can seamlessly transfer data, trigger events, and perform actions across disparate systems, enriching the CDP with valuable customer insights. The connectors developed in the Connector Studio rely on REST applications and the JSON format, ensuring flexibility and compatibility with a broad range of applications.

Consultants setting up these connectors should have a solid grasp of APIs, JSON, and authorization to efficiently harness their potential. This understanding is crucial for both inbound events, which involve data ingestion into the CDP, and outbound actions that allow the CDP to interact with external systems.

Application Connectors in the Connector Studio of SAP Customer Data Platform are grouped in various categories on the left side of the page; the connectors themselves are listed on the right side.

Exploring the Connector Studio

The Connector Studio presents a clear, organized view of the application connectors created within the platform, along with any pre-configured out-of-the-box connectors. These are categorized for streamlined navigation, helping users quickly access the tools they need. Access to the Connector Studio is conveniently located in the top bar menu, making it an integral part of the user's workflow.

Users can perform key actions in Connector Studio through a connector's Actions menu. These include enabling or disabling connectors, editing configurations, and deleting unwanted connectors. Such functionality provides users with full control over their integration processes, promoting a highly customizable approach to managing data flows.

Configuring a New Connector: A Step-by-Step Approach

In this section, we will explore the process of setting up a new connector in SAP Customer Data Platform (CDP) using the Connector Studio. This guide will provide a detailed walkthrough of configuring a REST API connector, ensuring a seamless integration with your application.

By following these steps, you will create a template for a REST API application, which can later be connected through the Application Library and polled at the required frequency. This not only enhances your ability to manage data effectively but also empowers you to build robust, custom integrations tailored to your organization's unique needs.

Prerequisites

Before we delve into configuring a new connector, it's essential that you have a solid understanding of APIs and JSON. Knowledge of API authorization and the specific data and APIs of the application you wish to integrate with CDP is also crucial. With these prerequisites in place, you'll be well-equipped to create a custom connector that meets your organization's needs.

Step 1: Details

Begin by navigating to the Connector Studio from the Entity dropdown menu and selecting New Connector. In this initial step, you'll enter the connector’s general details, such as its name and the category it falls under. This information help you organize and easily identify your connector within the Application Library. This screenshot will guide you through the interface, highlighting where to input the necessary information.

On the Details tab, you can enter the name, description, category, API version, and API documentation URL for the new connector.

Step 2: API Connection

The next step involves setting up the API connection. Here, you'll provide the necessary details to connect the CDP to the application. This includes specifying API endpoints and authorization credentials. This step is crucial as it forms the backbone of communication between your CDP and the external application. The screenshot below highlights the API connection fields and explains the data required for each section.

On the API Connection tab, you can enter the base URL, authentication method and details.

Step 3: Resources

With the API connection configured, proceed to define resources. Resources refer to the REST verbs and endpoints, such as GET or POST requests and specific data paths like /users. This step allows you to set up how data will be retrieved from or sent to the application. The screenshot provided shows a typical configuration example, helping you visualize this setup.

On the Resources tab, you can add the REST API resources. With each resource, you can specify the HTTP method, endpoint URL, the intent of either data consumption or production, request parameters of the endpoint, if any, the response schema in JSON format, etc.

Step 4: Events / Actions

Next, articulate the resources as events or actions within the CDP. This involves mapping the API operations to specific events or actions that can be configured by an administrator when setting up an application instance. This step ensures that the data flow aligns with business logic and operational needs. Refer to the screenshot depicting a sample mapping of REST verbs to CDP events for clarity.

On the Events/Actions tab, you can map the REST API resources to either Events or Actions.

Step 5: Publish

Finally, review and publish the entire connector configuration. This phase allows you to verify that all elements are correctly set up before deployment. In this step, you can also copy connector JSONs for future reference or deployment in other environments. The screenshot below illustrates the publish step, offering tips on reviewing and finalizing your connector setup.

On the Publish tab, you can review the previous configuration and the verification results. On the right side, you can check and copy the configuration details in JSON format.

Upon completing these steps, your new connector is ready to facilitate seamless data exchange between your application and SAP CDP. Following this structured approach ensures a reliable and efficient integration process, enhancing your ability to leverage customer data effectively. Adjust and customize each step as necessary to tailor the connector to your specific requirements.

The new connector is created in the specified category and ready for data integration connection in the Application Library.

Setting up a new Connector – Video

In this video, we'll guide you through creating a template for a REST API application, which you can seamlessly integrate with your CDP via the Application Library. Before starting, ensure you've got a robust understanding of REST APIs, JSON, and API authorizations. By the end of this demo, you'll have become proficient in establishing new connectors, thus optimizing your interactions with varied applications.

Lesson Summary

This lesson emphasizes the importance of connectors as vital tools for integrating external RESTful systems with CDP, enabling seamless data exchange and enhancing customer insights. Users will navigate to the Connector Studio, understanding its functionality, and learn a step-by-step approach to setting up new connectors. Key highlights include establishing API connections, defining resources, mapping events/actions, and publishing configurations to tailor integrations to organizational needs.

Log in to track your progress & complete quizzes