SAP Help Portal
SAP Open Connectors
Refine
Getting Started
Release Notes
Connectors
Formulas
Common Resources
OCNQL
IT and Security
Bulk
Events
Best Practices
Table of Contents
Table of Contents
Toggle navigation
SAP Open Connectors
Refine
Getting Started
Release Notes
Connectors
Formulas
Common Resources
OCNQL
IT and Security
Bulk
Events
Best Practices
Refine
Getting Started
Release Notes
Connectors
Formulas
Common Resources
OCNQL
IT and Security
Bulk
Events
Best Practices
Home
Glossary
Getting Started
Get to Know SAP Open Connectors
Take a Tour
Resources
FAQ
What data does SAP Open Connectors store?
How do I reset my password?
How Does Cursor Pagination Work?
Do I need to refresh the SAP Open Connectors Tokens?
What is a connector token and how do I find it?
What is a connector instance?
Can SAP Open Connectors work with an OData-type API?
Is it possible to enable polling for child resources such as /incidents/{incidentId}/comments?
How can I configure a custom IDP at the account level?
What is the limit for polling configurations that a single instance can have?
What is the time limit on a API request?
Resources and Terminology
Platform Reference
User Profile
Authentication
Authorization Headers, Organization Secret, and User Secret
Base URL
Error Codes
Pagination
Technical Restrictions
Release Notes
Production Release Notes
Production Release Notes - Version vhotfix-ENG-3652
Production Release Notes - Version v2.208.1959
Production Release Notes - Version v2.208.1948
Production Release Notes - Version vhotfix-SDR-4262
Production Release Notes - Version v2.208.1928
Production Release Notes - Version vhotfix-ENG-2384-stg
Production Release Notes - Version v2.208.1908
Production Release Notes - Version v2.208.1901
Production Release Notes - Version v2.208.1827
Production Release Notes - Version vhotfix-ENG-2109
Production Release Notes - Version vhotfix-ENG-1344-2
Production Release Notes - Version v2.208.1803
Production Release Notes - Version v2.208.1794
Production Release Notes - Version v2.208.1771
Production Release Notes - Version v2.208.1754
Production Release Notes - Version v2.208.1741
Production Release Notes - Version v2.208.1696
Production Release Notes - Version v2.208.1683
Production Release Notes - Version vhotfix-ENG-804
Production Release Notes - Version v2.208.1644
Production Release Notes - Version v2.208.1630
Production Release Notes - Version vhotfix-ENG-345
Production Release Notes - Version vhotfix-CU-1084
Production Release Notes - Version vhotfix-EL-8104
Production Release Notes - Version vhotfix-SRE-673
Production Release Notes - Version v2.208.1537
Production Release Notes - Version vhotfix-SDR-3374_branch
Production Release Notes - Version vhotfix-EL-7869
Production Release Notes - Version v2.208.1477
Production Release Notes - Version v2.208.1455
Production Release Notes - Version v2.208.1443
Production Release Notes - Version vhotfix-EL-7657
Production Release Notes - Version v2.208.1410
Production Release Notes - Version v2.208.1395
Production Release Notes - Version v2.208.1385
Production Release Notes - Version vhotfix-EL-7239
Production Release Notes - Version vhotfix-SDR-3036
Production Release Notes - Version vhotfix-SDR-2944
Production Release Notes - Version v2.208.1332
Production Release Notes - Version v2.208.1289
Production Release Notes - Version v2.208.1277
Production Release Notes - Version v2.208.1264
Production Release Notes - Version v2.208.1257
Production Release Notes - Version vhotfix-EL-6234
Production Release Notes - Version vhotfix-EL-6164
Production Release Notes - Version v2.208.1199
Production Release Notes - Version v2.208.1179
Production Release Notes - Version v2.208.1166
Production Release Notes - Version vhotfix-EL-5823
Production Release Notes - Version v2.208.1136
Production Release Notes - Version v2.208.1126
Production Release Notes - Version v2.208.1116
Production Release Notes - Version v2.208.1093
Production Release Notes - Version v2.208.1048
Production Release Notes - Version vhotfix-EL-5156-2
Production Release Notes - Version vhotfix-EL-5310
Production Release Notes - Version v2.208.1045
Production Release Notes - Version v2.208.1012
Production Release Notes - Version v2.208.1002
Production Release Notes - Version v2.208.988
Production Release Notes - Version v2.208.960
Production Release Notes - Version v2.208.956
Production Release Notes - Version v2.208.940
Production Release Notes - Version v2.208.930
Production Release Notes - Version v2.208.903
Production Release Notes - Version v1867
Production Release Notes - Version v2.208.856
Production Release Notes - Version v2.208.841
Production Release Notes - Version vEL3450
Production Release Notes - Version v2.208.756
Production Release Notes - Version v2.208.746
Production Release Notes - Version SDR1109
Production Release Notes - Version v2.208.628
Production Release Notes - Version v2.208.584
Production Release Notes - Version v2.208.570
Production Release Notes - Version v2.208.529
Production Release Notes - Version v2.208.498
Production Release Notes - Version v2.208.405
Production Release Notes - Version vPR1134
Production Release Notes - Version vRVCL1062
Production Release Notes - Version v2.208.307
Production Release Notes - Version v2.208.229
Production Release Notes - Version v2.208.195
Production Release Notes - Version v2.208.162
Production Release Notes - Version v2.208.119
Production Release Notes - Version v2.208.78.2
Production Release Notes - Version v2.208.45
Production Release Notes - Version v2.208.6
Production Release Notes - Version 2.207
Production Release Notes - Version v.EL2134
Release Notes - Version 2.206
Release Notes - Version 2.205
Release Notes - Version 2.204
Release Notes - Version 2.203
Release Notes - Version 2.202
Release Notes - Version 2.201
Staging Release Notes
Staging Release Notes - Version v2.208.1984
Staging Release Notes - Version v2.208.1970
Staging Release Notes - Version v2.208.1959
Staging Release Notes - Version v2.208.1948
Staging Release Notes - Version v2.208.1935
Staging Release Notes - Version v2.208.1928
Staging Release Notes - Version 2.207
Staging Release Notes - Version v2.208.1924
Staging Release Notes - Version v2.208.1908
Staging Release Notes - Version v2.208.1901
Staging Release Notes - Version v2.208.1827
Staging Release Notes - Version v2.208.1820
Staging Release Notes - Version v2.208.1811
Staging Release Notes - Version v2.208.1803
Staging Release Notes - Version v2.208.1788
Staging Release Notes - Version v2.208.1778
Staging Release Notes - Version v2.208.1777
Staging Release Notes - Version v2.208.1760
Staging Release Notes - Version v2.208.1754
Staging Release Notes - Version v2.208.1741
Staging Release Notes - Version v2.208.1721
Staging Release Notes - Version v2.208.1719
Staging Release Notes - Version v2.208.1696
Staging Release Notes - Version v2.208.1682
Staging Release Notes - Version v2.208.1671
Staging Release Notes - Version v2.208.1644
Staging Release Notes - Version v2.208.1636
Staging Release Notes - Version v2.208.1630
Staging Release Notes - Version v2.208.1620
Staging Release Notes - Version v2.208.1609
Staging Release Notes - Version v2.208.1575
Staging Release Notes - Version v2.208.1565
Staging Release Notes - Version v2.208.1537
Staging Release Notes - Version v2.208.1531
Staging Release Notes - Version v2.208.1519
Staging Release Notes - Version v2.208.1514
Staging Release Notes - Version v2.208.1493
Staging Release Notes - Version v2.208.1477
Staging Release Notes - Version v2.208.1471
Staging Release Notes - Version v2.208.1455
Staging Release Notes - Version v2.208.1443
Staging Release Notes - Version v2.208.1437
Staging Release Notes - Version v2.208.1417
Staging Release Notes - Version vhotfix-SDR-3177-staging
Staging Release Notes - Version v2.208.1409
Staging Release Notes - Version v2.208.1395
Staging Release Notes - Version v2.208.1381
Staging Release Notes - Version v2.208.1361
Staging Release Notes - Version v2.208.1349
Staging Release Notes - Version v2.208.1340
Staging Release Notes - Version v2.208.1332
Staging Release Notes - Version v2.208.1331
Staging Release Notes - Version v2.208.1323
Staging Release Notes - Version v2.208.1303
Staging Release Notes - Version v2.208.1289
Staging Release Notes - Version v2.208.1277
Staging Release Notes - Version v2.208.1264
Staging Release Notes - Version v2.208.1253
Staging Release Notes - Version v2.208.1235
Staging Release Notes - Version vhotfix-EL-6380
Staging Release Notes - Version vhotfix-ENGG-7
Staging Release Notes - Version v2.208.1216
Staging Release Notes - Version v2.208.1204
Staging Release Notes - Version v2.208.1196
Staging Release Notes - Version v2.208.1175
Staging Release Notes - Version v2.208.1166
Staging Release Notes - Version v2.208.1164
Staging Release Notes - Version v2.208.1150
Staging Release Notes - Version v2.208.1136
Staging Release Notes - Version vhotfix-EL-5549
Staging Release Notes - Version v2.208.1106
Staging Release Notes - Version v2.208.1089
Staging Release Notes - Version v2.208.1075
Staging Release Notes - Version v2.208.1070
Staging Release Notes - Version v2.208.1058
Staging Release Notes - Version v2.208.1048
Staging Release Notes - Version v2.208.1042
Staging Release Notes - Version v2.208.1012
Staging Release Notes - Version v2.208.988
Staging Release Notes - Version v2.208.978
Staging Release Notes - Version v2.208.967
Staging Release Notes - Version v2.208.960
Staging Release Notes - Version v2.208.956
Staging Release Notes - Version v2.208.940
Staging Release Notes - Version v2.208.930
Staging Release Notes - Version v2.208.926
Staging Release Notes - Version v2.208.903
Staging Release Notes - Version v2.208.889
Staging Release Notes - Version v2.208.875
Staging Release Notes - Version v2.208.849
Staging Release Notes - Version v2.208.841
Staging Release Notes - Version v2.208.834
Staging Release Notes - Version v2.208.806
Staging Release Notes - Version v2.208.781
Staging Release Notes - Version v2.208.761
Staging Release Notes - Version v2.208.756
Staging Release Notes - Version v2.208.746
Staging Release Notes - Version v2.208.744
Staging Release Notes - Version v2.208.739
Staging Release Notes - Version v2.208.708
Staging Release Notes - Version v2.208.694
Staging Release Notes - Version v2.208.663
Staging Release Notes - Version v2.208.645
Staging Release Notes - Version v2.208.628
Staging Release Notes - Version v2.208.620
Staging Release Notes - Version v2.208.568
Staging Release Notes - Version v2.208.540
Staging Release Notes - Version v2.208.529
Staging Release Notes - Version v2.208.527
Staging Release Notes - Version v2.208.508
Staging Release Notes - Version v2.208.498
Staging Release Notes - Version v2.208.484
Staging Release Notes - Version v2.208.464
Staging Release Notes - Version v2.208.441
Staging Release Notes - Version v2.208.405
Staging Release Notes - Version v2.208.393
Staging Release Notes - Version v2.208.379
Staging Release Notes - Version v2.208.354
Staging Release Notes - Version v2.208.344
Staging Release Notes - Version v2.208.328
Staging Release Notes - Version v2.208.307
Staging Release Notes - Version v2.208.297
Staging Release Notes - Version v2.208.282
Staging Release Notes - Version v2.208.259
Staging Release Notes - Version v2.208.242
Staging Release Notes - Version v2.208.229
Staging Release Notes - Version v2.208.218
Staging Release Notes - Version v2.208.205
Staging Release Notes - Version v2.208.194
Staging Release Notes - Version v2.208.176
Staging Release Notes - Version v2.208.139
Staging Release Notes - Version v2.208.119
Staging Release Notes - Version v2.208.100
Staging Release Notes - Version v2.208.78
Staging Release Notes - Version v2.208.45
Staging Release Notes - Version v2.208.6
Staging Release Notes - Version 2.207
Release Notes - Version 2.206
Release Notes - Version 2.205
Release Notes - Version 2.204
Release Notes - Version 2.203
Release Notes - Version 2.202
Release Notes - Version 2.201
Release Notes - Version 2.200
Staging Release Notes - Version v2.208.2330
Connectors
Connectors Docs Catalog
Working with Connectors
Introduction to Connectors
View Connector API Docs
Import and Export Connectors
Authenticate a Connector Instance (UI)
Authenticate a Connector Instance with Events (UI)
Authenticate a Connector Instance (API)
Authenticate a Connector Instance with Events (API)
About Authenticating Connector Instances
Connectors: Build
Building Custom Connectors
Connector Builder Overview
Intro: Building a Connector with Connector Builder
1: Information Tab
1b: Additional Information Tab Explanation
2: Setup Properties
3: Setup Authentication
4: Setup Configuration and Parameters
5: Setup Hooks
6: Setup Events
7: Resources
Creating a Generic 'Forwarding' API
Resource Types
Knowledgebase
Connectors TLS v1.2/Two-Way SSL
Requirements for Adding Webhook Support
Handling Non-Standard Cursor Pagination
Setting Parameters on Every Call with a Few Exceptions
GET {objectName}/metadata
Request Root Key and Response Root Key
Custom Auth with Token Refresh
Using Custom SSL Certificates
How to Preserve Data from the Vendor Response with a Set Root Key
How to Verify Basic Authorization Credentials Prior to Authenticating an Instance
How to Reference User Configuration Parameters
Creating a New Resource that Uploads a File
Connectors: Learn More
Validate Connector Instances
Sandbox Procurement
Shopify Sandbox
Dynamics 365 Operations Sandbox
Magento 2.0 Sandbox
Amazon Marketplace
Knowledgebase
Revoking an OAuth Token and Reauthenticating an Connector Instance
Google Drive - What ID Can Be Used To Get The Root Folder of Documents Hub Connectors?
Disabling and Enabling Connector Instances
Using JSON with an XML-only Service
Connectwise - How to Set Incident Priority
Salesforce Sales Cloud - Querying Numeric Fields
Marketo: Error Handling for Failure to Create Duplicate Leads
Microsoft Dynamics CRM - 500 Errors While Authenticating a Connector Instance
How to Export an Element Instance
Quickbooks Online - Uploading Invoice Attachments
How to get your bulk call back in gzip format
Dropbox - Creating New File Links
Adobe Sign - Resolving Provisioning Issues Through the UI
Resetting 2FA Phone Number via API
File Compression for Streaming Data Download
OAuth Proxies
How to Use OAuth Proxies with SAP Open Connectors
Callback URLs for OAuth Proxies
Authentication
Automatic Disabling of Connector Instances after Failed Token Refresh
Customizing Pre-Built Elements
Request/Response Headers
Adding Endpoints, Resources, and Models
Webhook and Polling Events
Available Fields Returned by a Poller
Debugging and Error Handling/Messages
Formulas
Formula Template
Build Formula Templates
Formula Triggers
Formula Step Types
Formula Variables
Formula Template Examples
Upgrading a Formula to the V3 Engine
Formula Readmes and Descriptions
Formula Instances
Create Formula Instances
Formula as a Resource (FaaR)
Use a Formula as a Resource
Knowledgebase
Javascript in Formulas
How to Use Bulk Within a Formula
Retrying with amqpRequest Step
How can I pass data between formula steps?
Can you send notifications to a webhook in a formula step?
Automatic Cleanup of Temporary Formula Instances
Replaying Formula Executions Via API
Formula Data Context Example
Searching Formula Executions
Formulas - How to Aggregate Loop Step Results
Formula Instance Deactivation Criteria
Headers in a httpRequest Formula Step
Debugging limits on Large Formula Steps
Introduction to Formulas
Common Resources
Defining Common Resources and Transformations
Introduction to Common Resources
Creating and Managing Common Resources
Mapping and Transforming Fields
Transforming Common resources Fields with the API
Migrating Resources and Transformations Between Environments
Using Custom JS to Make an HTTP Request
Using Common Resource Templates
Common Resource Templates
Customer
Vendors
Product Bills
Expense Bills
Product Invoices
Expense Invoices
Product Purchase Orders
Expense Purchase Orders
Sales Orders
AR Payments
Ledger Accounts
Knowledgebase
Custom JavaScript Transformations on Common Resources
How do I Create a Transformation with an Array?
JS Transformations: How Do I Use the transformedObject Variable?
How can Sub-resources be Transformed?
What API can be used to update an existing transformation?
Transformation Settings for common resources
Common Resources V2 Engine
Introducing Common Resources v2 Engine
Common Resources UI and Automapper
Common Resources Automapper Templates
Common Resources Tracelogging
OCNQL
Querying with OCNQL
How Do You Escape Spaces in Field Names When Querying
IT and Security
Configuring Single Sign-On (SSO)
Security
Manage Security Settings
Data Protection & Privacy
Data Protection and Privacy Overview
Encryption Key Management
Data Backups and Collections
Documents Connectors - Tag and Path Names are Saved in our Database
Access Control
Roles
Bulk
About Bulk
Using Bulk
Bulk FAQ
Best Practices for Bulk Queries
Retrieving Bulk Results with Special Characters
Events
Working with Events
Events Overview
Authenticate a Connector Instance with Events (UI)
Authenticate a Connector Instance with Events (API)
Triggering Events
Hash Verification
Knowledgebase
Event Retry and Queueing
Asynchronous API Requests
What Should You Check if Your Poller Returns No Events
Reset Last Poll Date
Why Would a Polling Job Fail to Return Events?
How to add filtering to Event Polling configurations
Configure Polling Interval at Resource Level
Resuming Polling Jobs after Auto-Disable
Best Practices
Getting the Most Recent Version of Swagger
Clearing UI Local Storage
How the Instance Configuration of "filter.response.nulls" Works
Monitor the Health of Connectors
Custom Objects and Dynamic APIs
Configuring your System to Allow Access through a Range of IPs (Safelisting)
SAP Open Connectors FAQ
On-premise Software Installation Support
Home
Connectors
Connectors Docs Catalog
SFTP
SFTP
SFTP is available in the documents hub.
Connector Information
Details
Authentication
Basic
Events
Not supported
Bulk
Not supported
Common Resources and Transformations
Supported
SFTP Authenticate a Connector
SFTP API Documentation
Tips & FAQ
(1)
SFTP - Using a Private Key for Authentication
()