Introduction

Enzo Server
  Installation
  Quick Start

  Core Features
    Async Calls
    ConnectionStrings
    Edge Cache
    HTTP Access
    Scheduling
    Views

  Advanced Capabilities
    Change Data Capture

  Administration
    Configuration Settings
    Logins & ACL
    Auditing
    Current Executions
    Linked Server
    SSL

  Adapters
    Azure Bus
    Azure IoT Hub
    Azure Key Vault
    Azure Storage
    Couchbase
    CSV
    DB (RDBMS)
    Files
    Flight Aware
    FTP
    Geonames
    Insteon
    Loggly
    Messaging (SMS/SMTP)
    MongoDB
    Motus
    MSAD
    MSMQ
    Pipeline
    Pressero
    RabbitMQ
    SalesForce
    Shard
    SharePoint
    SQL Server
    Threading
    Twilio
    Twitter
    VellemanDMX
    Weather (Underground)
    Whiparound
    WMI
    Xls (Excel)
    ZIP


  SDK
    Overview
    Installation
    DevHost
    Create A Simple Adapter
    Handler Columns

    Advanced SDK Concepts
      Handler Decorators
      Dynamic Columns
      Table & Table Enumerators
      Virtual Tables

/adapters/xls




XLS (Excel)


This adapter allows you to read from Excel files.


Configuration Settings



Name Description Default
Boolean _isDefault Make this the default configuration. Defaults to true if configName is already the default.
String name The name of the configuration
String sheetName The name of the sheet (if any)
String columns List of columns to return
String range The range inside the sheet (leave blank for entire sheet)
Boolean firstRowNames True if the first row contains column names
String defaultPath The full path to the Excel document
String defaultPassword The password of the Excel document
Boolean treatAsText Treats all data as text to avoid data type conflicts
String userId Default User ID for network login
String password Default password for network login

Handlers



ListWorksheets
Worksheets
List the worksheets in an Excel Workbook (XLS, XLSX, XLSB, XLSM). details 

Arguments

Name Description Default
fileName Full path of the Excel document (xls); leave null to use the defaultPath setting.

SQL Call

exec xls.listXls 
exec xls.listXls '\\some_server\some_share\filename'


Http Call

/bsc/xls/listworksheets

Output Columns

String WorkSheet
ReadXls
xls
Read the specified worksheet's rows and columns from an Excel Workbook (XLS, XLSX, XLSB, XLSM). details 

Arguments

Name Description Default
definitionName Name of previously stored definition
fileName Full path of the Excel document; leave null to use the defaultPath setting.
sheetName If NULL uses the default sheetName setting or the first sheet if that is also NULL
range Excel notation for column and row range, e.g. 'A1:B50' - 50 rows, 'A1:D' - all rows.
maxRows Maximum number of rows to return (0 for all rows) 0
where Where clause (used for EXEC calls only)

SQL Call

SELECT * FROM xls.xls@xlconfig
exec xls.readXls 'xlconfig'
exec xls.readXls 'xlconfig', 'filename'
exec xls.readXls 'xlconfig', 'filename', 'myWorkSheet', 'A:ZZ', 100
exec xls.readXls 'xlconfig', 'filename', 'myWorkSheet', 'A:ZZ'


Http Call

/bsc/xls/readxls

Output Columns

This call does not return data.