v5.0 - v5.5 Data Sync Documentation
  • Overview
  • Release Notes
    • V4.5
    • V4.6
    • v4.7
    • v4.8
    • v4.9
    • v4.10
    • v4.12
    • v4.13
  • v4 Connections Installation Guide
    • v5 Connections and CLI Installation Guide
  • v4 Worker/Listener Installation Guide
    • v5 Worker/Listener Installation Guide
  • Upgrades & Config Changes
  • Builder Guide
    • Overview
    • Types of Data Syncs
    • Subscribing to Event Streams
      • Supported Stream Sources
        • Amazon Simple Queue Service (SQS)
        • Cinchy Change Data Capture
        • Data Polling
        • Kafka Topic
        • MongoDB
        • Salesforce
          • Push Topic
          • Platform Event
    • Configuring a Data Sync
      • Connections Experience & XML Config Reference
        • Info
          • Parameters
            • String Escape
        • Source Config Reference
          • Schema Columns
            • Calculated Column Examples
          • Auth Requests
          • Request Headers
          • Pagination
          • Source Filter
        • Target Destination Config Reference
          • Column Mappings
          • Target Destination Filter
        • Sync Behaviour
        • Post Sync
        • Permissions
        • Jobs
        • Connections Usage Example
      • Data Validation
      • Transformations
        • StringReplacement
      • Supported Data Sources
        • File Based Source
          • Binary File
            • Binary File Data Source Example
          • Delimited File
            • Delimited File Data Source XML Example
          • Fixed Width File
          • Excel
            • Excel Source XML Example
        • Cinchy Event Broker/CDC
          • Cinchy Event Broker/CDC XML Config Example
        • Cinchy Table
          • Cinchy Table XML Config Example
        • Cinchy Query
          • Cinchy Query Data Source Example
        • Copper
        • DB2
        • Dynamics 2015
        • Dynamics
        • DynamoDB
        • Kafka Topic
          • Apache AVRO Data Format
          • Kafka Topic Source Example
        • LDAP
        • MongoDB Collection
          • MongoDB Collection Source XML Example
        • MongoDB Collection (Cinchy Event Triggered)
        • MS SQL Server Query
        • MS SQL Server Table
        • ODBC Table
        • ODBC Query
        • Oracle Table
        • Oracle Query
        • Parquet
        • Polling Event
          • Polling Event Example
        • REST API (Cinchy Event Triggered)
        • REST API
          • REST API XML Example
        • SAP SuccessFactors
        • Salesforce Object (Bulk API)
        • Salesforce Platform Event
        • Salesforce Push Topic
        • Snowflake
          • Snowflake Source XML Example
        • SOAP 1.2 Web Service
      • Supported Sync Targets
        • Cinchy Table
        • DB2 Table
        • Dynamics
        • Kafka Topic
        • MongoDB Collection (Column Based)
        • MS SQL Server Table
        • Oracle Table
        • REST API
        • Salesforce
        • Salesforce Object
        • Snowflake Table
          • Snowflake Table Target XML Example
        • SOAP 1.2 Web Service
    • Common Design Patterns
    • Testing a Data Sync
    • Promoting a Data Sync
    • Scheduling a Data Sync
    • CLI Command List
    • Connections Functions
    • Monitoring
  • Cinchy Platform Documentation
Powered by GitBook
On this page
  • Table of Contents
  • 1. Connections UI Example
  • 2. XML Example
  • 2.1 Blank XML Example
  • 2.2 Populated XML Example

Was this helpful?

  1. Builder Guide
  2. Configuring a Data Sync
  3. Supported Data Sources
  4. File Based Source
  5. Binary File

Binary File Data Source Example

This page gives an example config for using a binary file as a source

PreviousBinary FileNextDelimited File

Last updated 2 years ago

Was this helpful?

Table of Contents

Table of Contents

1. Connections UI Example

2. XML Example

This example XML uses the following values:

Value
Description
Example

SOURCE

The source of your binary file. This can either be a local upload, Amazon S3, or Azure Blob Storage.

"PATH"

PATH

The path to the source file to load.

"@filepath"

headerRowsToIgnore

The number of records from the top of the file to ignore before the data starts (includes column header).

"1"

footerRowsToIgnore

The number of records from the bottom of the file to ignore before the data starts (includes column header).

"1"

ENCODING

The encoding of the file, defaults to UTF8 if not specified, but also supports UTF8_BOM, ASCII, and UTF16

"UTF8"

SOURCE_COLUMN_NAME

The name(s) of your source column(s)

"Name"

DATA_TYPE

The data type of your source column

"Text"

WHITESPACE

This checkbox is an option if your data type is selected as "text"

"true"

IS_MANDATORY

Whether the column is mandatory or not

"false"

VALIDATE_DATA

Whether the column data needs to be validated or not

"false"

PARSE

How you want to parse your content. Either Byte Length, Trailing Byte Sequence, or Succeeding Byte Sequence

"ByteLength"

lengLENGTH

The content length in number of bytes.

"9"

2.1 Blank XML Example

     <BinaryDataSource source="SOURCE" path="PATH" headerRowsToIgnore="" footerRowsToIgnore="" encoding="ENCODING">
        <Schema>
            <Column name="SOURCE_COLUMN_NAME" dataType="DATA_TYPE" trimWhitespace="WHITESPACE" isMandatory="IS_MANDATARY" validateData="VALIDATE_DATA" parseContentBy="PARSE" length="LENGTH"/>
        </Schema>
    </BinaryDataSource>

2.2 Populated XML Example

     <BinaryDataSource source="PATH" path="@filePath" headerRowsToIgnore="1" footerRowsToIgnore="1" encoding="UTF8">
        <Schema>
            <Column name="Name" dataType="Text" trimWhitespace="true" isMandatory="false" validateData="false" parseContentBy="ByteLength" length="9"/>
        </Schema>
    </BinaryDataSource>

#1.-connections-ui-example
#2.-xml-example
Image 1: How the configuration of a Binary File source looks in the UI