Cinchy Platform Documentation
Cinchy v5.6
Cinchy v5.6
  • Data Collaboration Overview
  • Release Notes
    • Release Notes
      • 5.0 Release Notes
      • 5.1 Release Notes
      • 5.2 Release Notes
      • 5.3 Release Notes
      • 5.4 Release Notes
      • 5.5 Release Notes
      • 5.6 Release Notes
  • Getting Help
  • Cinchy Glossary
  • Frequently Asked Questions
  • Deployment Guide
    • Deployment Installation Guides
      • Deployment Planning Overview and Checklist
        • Deployment Architecture Overview
          • Kubernetes Deployment Architecture
          • IIS Deployment Architecture
        • Deployment Prerequisites
          • Single Sign-On (SSO) Integration
            • Enabling TLS 1.2
            • Configuring ADFS
            • AD Group Integration
      • Kubernetes Deployment Installation
        • Disabling your Kubernetes Applications
        • Changing your File Storage Configuration
        • Configuring AWS IAM for Connections
        • Using Self-Signed SSL Certs (Kubernetes Deployments)
        • Deploying the CLI (Kubernetes)
      • IIS Deployment Platform Installation
    • Upgrade Guides
      • Upgrading Cinchy Versions
        • Cinchy Upgrade Utility
        • Kubernetes Upgrades
          • v5.1 (Kubernetes)
          • v5.2 (Kubernetes)
          • v5.3 (Kubernetes)
          • v5.4 (Kubernetes)
          • v5.5 (Kubernetes)
          • v5.6 (Kubernetes)
          • Upgrading AWS EKS Kubernetes Version
          • Updating the Kubernetes Image Registry
          • Upgrading AKS (Azure Kubernetes Service)
        • IIS Upgrades
          • v4.21 (IIS)
          • v4.x to v5.x (IIS)
          • v5.1 (IIS)
          • v5.2 (IIS)
          • v5.3 (IIS)
          • v5.4 (IIS)
          • v5.5 (IIS)
          • v5.6 (IIS)
      • Upgrading from v4 to v5
  • Guides for Using Cinchy
    • User Guides
      • Overview of the Data Browser
      • The Admin Panel
      • User Preferences
        • Personal Access Tokens
      • Table Features
      • Data Management
      • Queries
      • Version Management
        • Versioning Best Practices
      • Commentary
    • Builder Guides
      • Best Practices
      • Creating Tables
        • Attaching Files
        • Columns
        • Data Controls
          • Data Entitlements and Access Controls
          • Data Erasure
          • Data Compression
        • Formatting Rules
        • Indexing and Partitioning
        • Linking Data
        • Table and Column GUIDs
        • System Tables
      • Deleting Tables
        • Restoring Tables, Columns, and Rows
      • Saved Queries
      • CinchyDXD Utility
        • Building the Data Experience (CinchyDXD)
        • Packaging the Data Experience (CinchyDXD)
        • Installing the Data Experience (CinchyDXD)
        • Updating the Data Experience (CinchyDXD)
        • Repackaging the Data Experience (CinchyDXD)
        • Reinstalling the Data Experience (CinchyDXD)
      • Multi-Lingual Support
      • Integration Guides
    • Administrator Guide
    • Additional Guides
      • Monitoring and Logging on Kubernetes
        • Grafana
        • Opensearch Dashboards
          • Setting up Alerts
        • Monitoring via ArgoCD
      • Maintenance
      • System Properties
      • Enable Data At Rest Encryption
      • MDQE
      • Application Experiences
        • Network Map
          • Custom Node Results
          • Custom Results in the Network Map
        • Setting Up Experiences
  • API Guide
    • API Overview
      • API Authentication
      • API Saved Queries
      • ExecuteCQL
      • Webhook Ingestion
  • CQL
    • The Basics of CQL
      • CQL Examples
      • CQL Functions Master List
      • CQL Statements Overview
        • Cinchy DML Statements
        • Cinchy DDL Statements
      • Cinchy Supported Functions
        • Cinchy Functions
        • Cinchy System Values
        • Cinchy User Defined Functions
          • Table-Valued Functions
          • Scalar-Valued Functions
        • Conversion Functions
        • Date and Time Types and Functions
          • Return System Date and Time Values
          • Return Date and Time Parts
          • Return Date and Time Values From Their Parts
          • Return Date and Time Difference Values
          • Modify Date and Time Values
          • Validate Date and Time Values
        • Logical Functions
        • Mathematical Functions
        • String Functions
        • Geometry and Geography Data Type and Functions
          • OGC Methods on Geometry & Geography Instances
          • Extended Methods on Geometry & Geography Instances
        • Full Text Search Functions
        • Connections Functions
        • JSON Functions
  • Meta Forms
    • Introduction to Meta-Forms
    • Meta-Forms Deployment Installation Guide
      • Deploying Meta-Forms (Kubernetes)
      • Deploying Meta-Forms (IIS)
    • Forms Data Types
    • Meta-Forms Builders Guides
      • Creating a Dynamic Meta-Form (Using Tables)
      • Creating a Dynamic Meta-Form Example (Using Form Designer)
      • Adding Links to a Form
      • Rich Text Editing in Forms
  • Data Syncs
    • Getting Started with Data Syncs
    • Installation & Maintenance
      • Prerequisites
      • Installing Connections
      • Installing the Worker/Listener
      • Installing the CLI and the Maintenance CLI
    • Building Data Syncs
      • Types of Data Syncs
      • Common Design Patterns
      • Sync Behaviour
      • Columns and Mappings
        • Calculated Column Examples
      • Listener Configuration
      • Advanced Settings
        • Filters
        • Parameters
        • Auth Requests
        • Request Headers
        • Post Sync Scripts
        • Pagination
      • Batch Data Sync Example
      • Real-Time Sync Example
      • Scheduling a Data Sync
      • Connection Functions
    • CLI Commands List
    • Error Logging and Troubleshooting
    • Supported Data Sync Sources
      • Cinchy Event Broker/CDC
        • Cinchy Event Broker/CDC XML Config Example
      • Cinchy Table
        • Cinchy Table XML Config Example
      • Cinchy Query
        • Cinchy Query XML Config Example
      • Copper
      • DB2 (Query and Table)
      • Dynamics 2015
      • Dynamics
      • DynamoDB
      • File Based Sources
        • Binary File
        • Delimited File
        • Excel
        • Fixed Width File
        • Parquet
      • Kafka Topic
        • Kafka Topic Example Config
        • Apache AVRO Data Format
      • LDAP
      • MongoDB Collection
        • MongoDB Collection Source Example
      • MongoDB Collection (Cinchy Event Triggered)
      • MS SQL Server (Query and Table)
      • ODBC Query
      • Oracle (Query and Table)
      • Polling Event
        • Polling Event Example Config
      • REST API
      • REST API (Cinchy Event Triggered)
      • SAP SuccessFactors
      • Salesforce Object (Bulk API)
      • Salesforce Platform Event
      • Salesforce Push Topic
      • Snowflake
        • Snowflake Source Example Config
      • SOAP 1.2 Web Service
    • Supported Data Sync Destinations
      • Cinchy Table
      • DB2 Table
      • Dynamics
      • Kafka Topic
      • MongoDB Collection
      • MS SQL Server Table
      • Oracle Table
      • REST API
      • Salesforce Object
      • Snowflake Table
      • SOAP 1.2 Web Service
    • Supported Real-Time Sync Stream Sources
      • Cinchy Event Broker/CDC
      • Data Polling
      • Kafka Topic
      • MongoDB
      • Salesforce Push Topic
      • Salesforce Platform Event
  • Other Resources
    • Angular SDK
    • JavaScript SQK
Powered by GitBook
On this page
  • 1. Overview
  • 2. Destination Tab
  • 4. Next Steps

Was this helpful?

Export as PDF
  1. Data Syncs
  2. Supported Data Sync Destinations

SOAP 1.2 Web Service

PreviousSnowflake TableNextSupported Real-Time Sync Stream Sources

Last updated 2 years ago

Was this helpful?

1. Overview

SOAP (Simple Object Access Protocol) is an XML-based protocol for accessing web services over HTTP.

SOAP allows applications running on different operating systems to communicate using different technologies and programming languages. You can use SOAP APIs to create, retrieve, update or delete records, such as passwords, accounts, leads, and custom objects, from a server.

Prior to setting up your data sync destination,

The SOAP 1.2 Web Service destination supports batch and real-time syncs.

2. Destination Tab

The following table outlines the mandatory and optional parameters you will find on the Destination tab (Image 1).

The following parameters will help to define your data sync destination and how it functions.

Parameter
Description
Example

Destination

Mandatory. Select your destination from the drop down menu.

SOAP 1.2 Web Service

The section is where you define which source columns you want to sync to which destination columns. You can repeat the values for multiple columns. When specifying the Target Column in the Column Mappings section, all names are case-sensitive.

Parameter
Description
Example

Source Column

Mandatory. The name of your column as it appears in the source.

Name

Target Column

Mandatory. The name of your column as it appears in the destination.

Name

The API Specification section will default with a mandatory Insert Specification field, however you are also able to add fields for Request Headers, SOAP Body, and Variables to Extract. Insert Specification When specifying the Target Column in the Column Mappings section, all names are case-sensitive.

Parameter
Description
Example

Endpoint URL

Envelope Namespace

soapenv

Namespace - Name

The name of your SOAP namespace tags in your request and response. By default, the Connections UI will populate this field with "soapenv", however you can delete this value andor add additional values, as needed. This value appears as "soap" in the snippet below.

These should be the values immediately after "xmlns:"

soap

Namespaces - Value

Request Header

You can add in Request Headers by

SOAP Body

Parameter
Description
Example

XML

The SOAP body is a sub-element of the SOAP envelope, which contains information intended for the ultimate recipient of the message. This field is expecting you to specify the SOAP Body.

Variables to Extract

You may choose to specify variables to extract from your SOAP response.

Parameter
Description
Example

Name

The name of the variable you wish to extract.

Value

Path in Response

The path to the above variable.

soapenv:Envelope/soapenv:Body/m:NumberToWordsResponse/m:NumberToWordsResult[1]

SOAP 1.2 Source

This section should be used if you have a set of data from a SOAP API that you need to reconcile against; therefore it should always be used when doing Full-File syncs. You can follow to set up this section.

4. Next Steps

  • If you are running a batch sync, click Jobs > Start a Job to begin your sync.

Mandatory. The URL for the the

Has

This is required to be true if the SOAP API response contains an attachment outside of the SOAP response message.

The namespace prefix to use for the SOAP request elements. This value will default to "soapenv" as associated with the following schema: You can append the default value, if you wish. For example, setting the value to "foo" would result in the soap request being prefixed with the "foo" namespace.

The URL describing this namespace in the response. By default, the Connections UI will populate this field with "", however you can delete this value andor add additional values, as needed. In the below snippet this value is ""

""

You have the option to add a destination filter to your data sync. Please review the documentation here for more information on

Define your. Note that if you are doing a Full-File sync, the API Specification > SOAP 1.2 Source section should be filled in.

Add in your , if required.

Define your .

If you are running a real-time sync, and enable it to begin your sync.

<foo:Envelope xmlns:foo="...">
	<foo:Body>
		[Request XML]
	</foo:Body>
</foo:Envelope
<?xml version="1.0" encoding="utf-8"?>
<soapenv:Envelope
	xmlns:="http://schemas.xmlsoap.org/soap/envelope/">
	<soap:Body>
		<m:NumberToWordsResponse
			xmlns:m="http://www.dataaccess.com/webservicesserver/">
			<m:NumberToWordsResult>four million four hundred and seventy three thousand two hundred and thirty nine </m:NumberToWordsResult>
		</m:NumberToWordsResponse>
	</soap:Body>
</soap:Envelope>
<?xml version="1.0" encoding="utf-8"?>
<soapenv:Envelope
	xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
	<soap:Body>
		<m:NumberToWordsResponse
			xmlns:m=>
			<m:NumberToWordsResult>four million four hundred and seventy three thousand two hundred and thirty nine </m:NumberToWordsResult>
		</m:NumberToWordsResponse>
	</soap:Body>
</soapenv:Envelope>
<NumberToWords xmlns="http://www.dataaccess.com/webservicesserver/">
    <ubiNum>500</ubiNum>
</NumberToWords>
Sync Behaviour
Post Sync Scripts
set up your Listener Config
SOAP 1.2 Web Service API endpoint
https://www.dataaccess.com/webservicesserver/NumberConversion.wso
Mtom Response
See this diagram for more information.
https://schemas.xmlsoap.org/soap/envelope/
http://schemas.xmlsoap.org/soap/envelope/
http://www.dataaccess.com/webservicesserver/
http://www.dataaccess.com/webservicesserver/
ensure that you've configured your Source.
reviewing the documentation here.
the values outlined on this page
Permissions
Column Mapping
Image 2: Define your Destination
destination filters.