TIBCO Scribe® Online Connector For SAP

Use the TIBCO Scribe® Online Connector for SAP to create source or target Connections through the NetWeaver Gateway, using the Open Data Protocol (OData) standard.

Connector Specifications

This Connector supports version 2.0 of the OData service. To verify that this Connector works with the OData service your system uses, contact your SAP Administrator.


Agent Types

On Premise X
Cloud X

Replication Services


Integration Services

Source X
Target X

Migration Services

Source X
Target X


Integration X
Request-Reply X

Note:  This Connector is available from the TIBCO Scribe® Online Marketplace. See Marketplace TIBCO Scribe® Certified Connectors for more information.

Selecting An Agent Type For SAP

Refer to TIBCO Scribe® Online Agents for information on available Agent types and how to select the best Agent for your Solution.

Connecting To SAP

Note: Best practice is to create Connections with credentials that limit permissions in the target system, following the principle of least privilege. Using Administrator level credentials in a Connection provides Administrator level access to the target system for TIBCO Scribe® Online users. Depending on the entities supported, a TIBCO Scribe® Online user could alter user accounts in the target system.

  1. Select More > Connections from the menu.
  2. From the Connections page select Add to open the Add a New Connection dialog.
  3. Select the Connector from the drop-down list in the Connection Type field, and then enter the following information for this Connection:
    • Name — This can be any meaningful name, up to 25 characters.
    • Alias — An alias for this Connection name. The alias is generated from the Connection name, and can be up to 25 characters. The Connection alias can include letters, numbers, and underscores. Spaces and special characters are not accepted. You can change the alias. For more information, see Connection Alias.
    • OData Service URL — Address of any acceptable URL where the SAP OData service is located.
    • User — Name of the user who has rights to access the SAP OData service.
    • Password — Password for this User.

      Note: The User and Password values are optional if your SAP OData service does not require authentication. For more information on OData, see your endpoint provider.

    • Cross-Site Forgery Protection — Protection mechanism that defines the actions that can be performed on your SAP OData service. Select one of:
      • CSRF Token Check — Associates a unique token with each user session based on the token exchange principle. This is the default method for the OData Standard Mode.

        Note: If the token fails with your SAP OData service, contact your SAP Administrator.

      • CSRF Header Parameter Check — Includes an additional parameter in the HTTP header X-Requested-With=XMLHttpRequest. This mechanism provides downward compatibility for SAP Gateway Services prior to Version 2.0 Support Package 03.

        Note: If your SAP service has not been set up to use the CSRF Header Parameter Check mechanism, the following error occurs when your Solution executes: CSRF token validation failed.

        If this error occurs, use the CSRF Token Check mechanism, instead.

  4. Select Test to ensure that the Agent can connect to your database. Be sure to test the Connection against all Agents that use this Connection. See Testing Connections.
  5. Select OK to save the Connection.

Metadata Notes

Consider the following information about the metadata associated with the SAP Connector.


Connection metadata must have unique entity, relationship, and field names. If your Connection metadata has duplicate names, review the source system to determine if the duplicates can be renamed.

Hierarchical Data

Hierarchical relationships, such as grandparent, parent, grandchild relationships are not supported. See Hierarchical Data for examples.

SAP Metadata

Only supported OData data types appear in TIBCO Scribe® Online. The following data types are not supported by this Connector:

Complex Types Field Names

In the SAP Connector, complex types are displayed in the Fields list as: ComplextypeFieldname

For example, the City field of Customeraddress appears as:


This Connector supports SAP-specific annotations at the entity-set level and the property level.

Entity-Set Level

Annotation Name Default Value Meaning


Description of the entity set.



New entities can be created in this set.



Values for this property can be changed. If this value is false, it must be false for all properties within that set.

If this value could change for an entity, use the field-control annotation, instead.



Entities can be deleted from this set.



Accessibility of this entity. Values are:

  True — Entity can be accessed directly.

  False — Entity can only be accessed from within a relationship with another entity. For example, SalesOrdersItems entities can only be accessed as a child relation of the SalesOrders entity.

Property Level

Annotation Name Default value Meaning


Descriptive text, suitable for labels and captions.


Text suitable for tool tips.



Client sets the values for this property. Values are:

  True — Client sets the values.

  False — Server sets the values.



Values for this property can be changed. If this is false for an entity set, it must be false for all properties within that set.

If this value may change for an entity, use the field-control annotation, instead.



Entity can be used in the $orderby system query option.



Entity can be used in the $filter system query option.


Property contains the currency code or unit of measure for a numeric value.



Property contains the number of significant decimal places for a numeric value.


Property defines the field contents and whether the field should be hidden on user interfaces. Values are:

  0 — Hidden, should not be visible.

  1 — Read-only, cannot be changed.

  3 — Optional, may contain a null value.

  7 — Mandatory, must contain a value.

SAP Connector As IS/MS Source

Consider the following when using the SAP Connector as an IS/MS source.

When a datetime is configured on the Query Block on the Block Properties Net Change Tab to query for new and updated records, that configuration is treated as an additional filter. The Net Change datetime filter is applied as an AND after any other filters specified on the Block Properties Filter Tab. TIBCO Scribe® Online builds a query combining both the Net Change filter and the filters on the Filter tab. See Net Change And Filters for an example.

Some Connectors for TIBCO Scribe® Online only support one filter. For those Connectors you can use either Net Change or one filter on the Filter tab, not both.

Note: The Net Change date is ignored when previewing data on the Preview tab. Filters on the Block Properties Filters tab are used to filter the data on the Preview tab.

Supported Source Operations

If the following operations are available with your SAP service, the SAP source Connector supports:

SAP Connector As IS/MS Target

Consider the following when using the SAP Connector as an IS/MS target.

Supported Target Operations

If the following operations are available with your SAP service, the SAP target Connector supports the following operations:

Update Operations

TIBCO Scribe® Online supports the Update Merge and Update Replace operations that are supported by SAP. However, SAP support for these operations varies by OData version and some of these operations may not be implemented for your SAP service.

The Update Replace and Update Merge Blocks support up to and including OData protocol version 3. If you try to use an operation that is not implemented in your SAP service, you may see an error message.

Unsupported Operations

The following are not supported by the Connector:

TIBCO Scribe® Online API Considerations

To create Connections with the TIBCO Scribe® Online API, the SAP Connector requires the following information:

Connector Name


Connector ID


TIBCO Scribe® Online Connection Properties

In addition, this Connector uses the Connection properties shown in the following table.

Note: Connection property names are case-sensitive.

Name Data Type Required Secured Usage


























More Information

For additional information on this Connector, refer to the Knowledge Base and Discussions in the TIBCO Community.