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
  • 1. Overview
  • 2. Considerations
  • 3. Info Tab
  • 4. Source Tab
  • 5. Schema
  • 6. Run the Job

Was this helpful?

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

Excel

This page details how to set up a data sync using a Microsoft Excel Worksheet as a source.

PreviousFixed Width FileNextExcel Source XML Example

Last updated 2 years ago

Was this helpful?

1. Overview

Microsoft Excel is a commonly spreadsheet program for managing and analyzing numerical data.You can use Microsoft Excel as a source for your Data Syncs by following the instructions below.

Excel can be used as a source for Batch Syncs.

2. Considerations

  • Binary data types are not supported for Excel Files.

3. Info Tab

  1. If you plan to upload an Excel file locally, you must set the Parameters value in the Info tab (Image 1). You can set this to whatever you wish; it will be referenced again in the Path value of the Source tab.

4. Source Tab

  1. In the Source tab, fill in the values using the table below as a guide.

Parameter
Value
Example

Source

The source location of your file. This can be either Local, S3, or Azure Blob Storage. If you select Local, make sure that you have properly set your Parameter and Path. Once you run your job, you will be able to upload your Excel file.

Local

sheetName

The name of the sheet within the Excel file

Sample

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.

0

path

The path to the Excel source file to load. This should be set to reference the same value from the Parameters section in the Info tab along with the '@' symbol.

@file

Auth Type

This field defines the authentication type for your data sync. Cinchy supports "Access Key" and "IAM" role. When selecting "Access Key", you must provide the key and key secret. When selecting "IAM role", a new field will appear for you to paste in the role's Amazon Resource Name (ARN). You also must ensure that:

Note: This field was added in Cinchy v5.6

5. Schema

Binary data types are not supported for Excel Files.

6. Run the Job

  1. Once you set up your source, target, and job behaviour, click Jobs > Start Job. This will prompt you to upload your Excel file in the pop-up box if you selected Local Upload (Image 3).

  1. Click Start.

  2. When complete, you will see a similar validation screen like the below (Image 4).

The role to have at least read access to the source

The Connections pods' role must specified in the data sync config

Add in your applicable column(s) (Image 2). for further details on each column type.

See the documentation here
must be configured
have permission to assume the role
Image 1: Define the Parameter
Image 2: The parameters for a standard column
Image 3: Upload file
Image 4: Data Sync validation