5️⃣
Cinchy Platform Documentation
Cinchy v5.8
Cinchy v5.8
  • Data Collaboration Overview
  • Release notes
    • Release notes
      • 5.9 release notes
      • 5.8 Release Notes
      • 5.7 Release Notes
      • 5.6 Release Notes
      • 5.5 Release Notes
      • 5.4 Release Notes
      • 5.3 Release Notes
      • 5.2 Release Notes
      • 5.1 Release Notes
      • 5.0 Release Notes
  • Support
  • Glossary
  • FAQ
  • Deployment guide
    • Deploying Cinchy
      • Plan your deployment
        • Deployment architecture
          • Kubernetes architecture
          • IIS architecture
        • Deployment prerequisites
          • Single Sign-On (SSO) integration
            • Enable TLS 1.2
            • Configure ADFS
            • AD Group Integration
      • Kubernetes
        • Disable your Kubernetes applications
        • Change your file storage configuration
        • Configure AWS IAM for Connections
        • Use Self-Signed SSL Certs (Kubernetes)
        • Deploy the CLI (Kubernetes)
      • IIS
  • Upgrade guide
    • Upgrade Cinchy
      • Cinchy Upgrade Utility
      • Kubernetes upgrades
        • v5.1 (Kubernetes)
        • v5.2 (Kubernetes)
        • v5.3 (Kubernetes)
        • v5.4 (Kubernetes)
        • v5.5 (Kubernetes)
        • v5.6 (Kubernetes)
        • v5.7 (Kubernetes)
        • v5.8 (Kubernetes)
        • Upgrade AWS EKS Kubernetes version
        • Update the Kubernetes Image Registry
        • Upgrade Azure Kubernetes Service (AKS)
      • 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)
        • v5.7 (IIS)
        • v5.8 (IIS)
      • Upgrading from v4 to v5
  • Guides for using Cinchy
    • User Guide
      • Data Browser overview
      • The Admin panel
      • User preferences
        • Personal access tokens
      • Table features
      • Data management
      • Queries
      • Version management
        • Versioning best practices
      • Commentary
    • Builder Guide
      • Best practices
      • Create tables
        • Attach files
        • Columns
        • Data controls
          • Data entitlements
          • Data erasure
          • Data compression
        • Formatting rules
        • Indexing & partitioning
        • Linking data
        • Table and column GUIDs
        • System tables
      • Delete tables
        • Restore tables, columns, and rows
      • Saved queries
      • CinchyDXD
        • Overview
        • DXD workflow
        • Package the data experience
        • Install the data experience
        • Release package
        • Changelog
        • References
          • Cinchy DXD CLI reference
          • Data Experience Definitions table
          • Data Experience Reference table
      • Multilingual support
      • Integration guides
    • Administrator Guide
    • Additional guides
      • Monitor and Log on Kubernetes
        • Grafana
        • OpenSearch dashboards
          • Set up Alerts
        • Monitor via ArgoCD
      • Maintenance
      • Cinchy Secrets Manager
      • GraphQL (Beta)
      • System properties
      • Enable Data At Rest Encryption (DARE)
      • Application experiences
        • Network map
          • Custom node results
          • Custom results in the Network Map
        • Set up experiences
  • API Guide
    • API overview
      • API authentication
      • API saved queries
      • ExecuteCQL
      • Webhook ingestion
  • CQL
    • Overview
      • CQL examples
      • CQL statements overview
        • Cinchy DML statements
        • Cinchy DDL statements
      • Cinchy supported functions
        • Cinchy functions
        • Cinchy system values
        • Cinchy User Defined Functions (UDFs)
          • 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
        • Math 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
    • CQL functions reference list
  • Meta-Forms
    • Introduction
    • Install Meta-Forms
      • Deploy Meta-Forms (Kubernetes)
      • Deploy Meta-Forms (IIS)
    • Forms data types
    • Meta-Forms Builder Guide
      • Create a dynamic meta-form with tables
      • Create a dynamic meta-form example with Form Designer
      • Add links to a form
      • Rich text editing in forms
  • Data syncs
    • Get started with data syncs
    • IIS installation
      • Install Connections
      • Install the Worker/Listener
      • Install the Connections CLI
    • Build data syncs
      • Data sync types
      • Design patterns
      • Sync actions
      • Columns and mappings
        • Calculated column examples
      • Advanced settings
        • Filters
        • Variables
        • Auth requests
        • Request headers
        • Post sync scripts
        • Pagination
      • Batch data sync example
      • Real-time sync example
      • Schedule a data sync
      • Connection functions
    • 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
      • Mongo event
      • MongoDB collection (Cinchy event)
      • MS SQL Server (query and table)
      • ODBC Query
      • Oracle (query and table)
      • Polling event
        • Polling event example config
      • REST API
      • REST API (Cinchy event)
      • SAP SuccessFactors
      • Salesforce Object (Bulk API)
      • Salesforce platform event
      • Salesforce push topic
      • Snowflake
        • Snowflake source example config
      • SOAP 1.2 web service
      • SOAP 1.2 web service (Cinchy Event Triggered)
    • Data sync destinations
      • Cinchy Table
      • DB2 table
      • Dynamics
      • Kafka Topic
      • MongoDB collection
      • MS SQL Server table
      • Oracle table
      • REST API
      • Salesforce
      • Snowflake table
      • SOAP 1.2 web service
    • Real-time sync stream sources
      • The Listener Config table
      • Cinchy Event Broker/CDC
      • Data Polling
      • Kafka Topic
      • MongoDB
      • Salesforce Push Topic
      • Salesforce Platform Event
    • CLI commands list
    • Troubleshooting
  • Other Resources
    • Angular SDK
    • JavaScript SQK
Powered by GitBook
On this page
  • Overview
  • Destination tab
  1. Data syncs
  2. Data sync destinations

SOAP 1.2 web service

PreviousSnowflake tableNextReal-time sync stream sources

Last updated 1 year ago

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.

Before you set up your data sync destination, make sure to configure your Source.

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

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

Mandatory. The URL of the SOAP 1.2 Web Service API endpoint

https://www.dataaccess.com/webservicesserver/NumberConversion.wso

Has MTOM Response

This is required to be true if the SOAP API response contains an attachment outside of the SOAP response message. See this diagram for more information.

Envelope Namespace

The namespace prefix to use for the SOAP request elements. This value will default to soapenv as associated with the following schema: https://schemas.xmlsoap.org/soap/envelope/ 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.

foo:Envelope xmlns:foo="...">

foo:Body>
	[Request XML]
/foo:Body>

/foo:Envelope | 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, but you can delete this value or add additional values, as needed. This value appears as "soap" in the snippet below.

These should be the values immediately after "xmlns:"\

?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>

| soap | | Namespaces - Value |

The URL describing this namespace in the response. By default, the Connections UI will populate this field with http://schemas.xmlsoap.org/soap/envelope/, however you can delete this value or add additional values, as needed. In the below snippet this value is "http://www.dataaccess.com/webservicesserver/"\

?xml version="1.0" encoding="utf-8"?>
soapenv:Envelope
xmlns:soap="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>
/soapenv:Envelope>

| "http://www.dataaccess.com/webservicesserver/" |

Request Header

You can add in Request Headers by reviewing the documentation here.

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.

NumberToWords xmlns="http://www.dataaccess.com/webservicesserver/">

ubiNum>500/ubiNum>

/NumberToWords> |

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 the values outlined on this page to set up this section.

## Next steps

  • Define your Sync Actions. 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 Post Sync Scripts, if required.

  • If you are running a real-time sync, set up your Listener Config and enable it to begin your sync.

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

  1. Namespace Value

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

Define your .

Permissions
destination filters.
Column Mapping
Image 2: Define your Destination