SAP Cloud Platform Open Connectors

Introduction to Common Resources

With common resource (common objects), you can transform fields provided by your service providers to a single, normalized resource at SAP. This allows you to take advantage of our one-to-many integration approach where you write to a single common object to integrate the transformed resources from your various service providers.

Note: common objects are not available for connectors in the Cloud Storage & Documents and Messaging hubs.

Example

A frequent example is to create a common object to represent your /contacts for various CRMs, and then transform the /contacts resources from those CRMs. You know that you want your contacts to look a certain way, regardless of the CRM system. You want firstName, lastName, and email. But some connectors call FirstName something else, like FirstName, F_Name, or properties.firstname. You need to create a single common object with fields named firstName, lastName, and email. Then you can map all of the like fields from other connectors to the fields in your common object. We transform those mapped fields, so you can write to a single API to integrate many services.

This example shows fields in the /Contact resource from Salesforce mapped to fields in a common object called myContacts.

VDR example

You can use common objects to do more than normalize resource names. You can transform data types, so when a resource returns a string and you need a date, SAP transforms the data. Using our JavaScript Editor, you can create logic to manage complex problems. For example, you can write a simple script to combine fields like firstName and lastName into a single field called name. Or tackle even more complicated issues like transforming a number based priority value (1-10) to a descriptor based value (low, medium, or high).

Understanding Levels

You define the fields in common objects within a hierarchy that includes three levels: organization, account, and instance. Only users at the organization level can create common objects, while users at other levels can configure the common objects for specific transformations.

  • The organization is the highest level. A common object built at this level represents a template that you can use for all accounts within your organization.
  • The account is the next highest level. Accounts typically represent your customers. Transformations at the account level are shared by all users associated with a specific account.
  • The instance is the most granular level. Transformations that you or other users create at this level apply only to a specific connector instance.

Definitions

To help you understand common objects, review the definitions in this section.

common resource
A stand-alone resource, created and defined by a user with the intention of creating a one-to-many transformation.
normalize
Relates to transforming information from vendors to a common language within SAP. In relation to common objects, normalization is the transformation of related fields and objects in multiple connector resources to a single definition of the field or object within a common object.
field
Data within a resource. Fields mapped between a common object and an connector instance result in a transformation of the connector fields.
map
The process of associating objects within a vendor's resource to objects in a common object so the vendor objects can be transformed.
resource
An object or entity that can be accessed via a URI request. Similar resources, such as Accounts, Contacts, and Customers appear in multiple APIs. common objects at SAP normalize these varied resources.
transformation
The result of mapping an API provider resource to a common object.
connector instance resource
The resources available to the connector instance through its API. You map the data from the connector instance resources to the data in your common object to create a transformation.