Excel Connector

Excel Connector



Establishing a Connection

Connecting to Excel Data Sources

The StarfishETL Excel Connector allows connecting to local Excel resources.   Browse to your desired Excel file on your local machine or on your network.  Please use UNC and not drive letter when browsing the network.




Connection String Options

The connection string properties are the various options that can be used to establish a connection. This section provides a complete list of the options you can configure in the connection string for this provider. Click the links for further details.

For more information on connecting, see Establishing a Connection.
Allow FormulaWhether or not to treat values starting with an equals (=) sign as formulas during inserts and updates.
Auth KeyThe authentication secret used to request and obtain the OAuth Access Token.
Auth SchemeThe type of authentication to use when connecting to remote services.
Auth TokenThe authentication token used to request and obtain the OAuth Access Token.
Auto CacheAutomatically caches the results of SELECT queries into a cache database specified by either CacheLocation or both of CacheConnection and CacheProvider .
AWS Access KeyYour AWS account access key. This value is accessible from your AWS security credentials page.
AWS RegionThe hosting region for your Amazon Web Services.
AWS Role ARNThe Amazon Resource Name of the role to use when authenticating.
AWS Secret KeyYour AWS account secret key. This value is accessible from your AWS security credentials page.
Azure Access KeyThe storage key associated with your Azure Blob storage account.
Azure AccountThe name of your Azure Blob storage account.
Azure EnvironmentThe Azure Environment to use when establishing a connection.
Azure Shared Access SignatureA shared access key signature that may be used for authentication.
Azure TenantThe Microsoft Online tenant being used to access data. If not specified, your default tentant will be used.
Buffer ChangesIndicates whether to hold changes to the data in memory until the connection is closed.
Cache ConnectionThe connection string for the cache database. This property is always used in conjunction with CacheProvider . Setting both properties will override the value set for CacheLocation for caching data.
Cache LocationSpecifies the path to the cache when caching to a file.
Cache MetadataThis property determines whether or not to cache the table metadata to a file store.
Cache ProviderThe name of the provider to be used to cache data.
Cache ToleranceThe tolerance for stale data in the cache specified in seconds when using AutoCache .
Callback URLThe OAuth callback URL to return to when authenticating. This value must match the callback URL you specify in your app settings.
Connection Life TimeThe maximum lifetime of a connection in seconds. Once the time has elapsed, the connection object is disposed.
Custom HeadersOther headers as determined by the user (optional).
Custom Url ParamsThe custom query string to be included in the request.
Define TablesMap Excel ranges to table names.
Directory Retrieval DepthLimit the subfolders recursively scanned when IncludeSubdirectories is enabled.
Empty Value ModeIndicates whether to read the empty values as empty or as null.
Excel FileThe location of an Excel file.
Firewall PasswordA password used to authenticate to a proxy-based firewall.
Firewall PortThe TCP port for a proxy-based firewall.
Firewall ServerThe name or IP address of a proxy-based firewall.
Firewall TypeThe protocol used by a proxy-based firewall.
Firewall UserThe user name to use to authenticate with a proxy-based firewall.
Has Cross Sheet ReferencesIndicates how cross sheet references are handled.
HeaderIndicates whether the first row should be used as a column header.
Ignore Calc ErrorIndicates whether to ignore errors that occurred during the calculation.
Include FilesComma-separated list of file extensions to include into the set of the files modeled as tables.
Include SubdirectoriesWhether to read files from nested folders. In the case of a name collision, table names are prefixed by the underscore-separated folder names.
Initiate OAuthSet this property to initiate the process to obtain or refresh the OAuth access token when you connect.
Kerberos Keytab FileThe Keytab file containing your pairs of Kerberos principals and encrypted keys.
LocationA path to the directory that contains the schema files defining tables, views, and stored procedures.
LogfileA filepath which designates the name and location of the log file.
Log ModulesCore modules to be included in the log file.
Max Log File CountA string specifying the maximum file count of log files. When the limit is hit, a new log is created in the same folder with the date and time appended to the end and the oldest log file will be deleted.
Max Log File SizeA string specifying the maximum size in bytes for a log file (for example, 10 MB). When the limit is hit, a new log is created in the same folder with the date and time appended to the end.
Max RowsLimits the number of rows returned rows when no aggregation or group by is used in the query. This helps avoid performance issues at design time.
MFA Serial NumberThe serial number of the MFA device if one is being used.
MFA TokenThe temporary token available from your MFA device.
Null Value ModeIndicates whether to read empty cells as null or as empty.
Null ValuesA comma separated list which will be replaced with nulls if there are found in the CSV file.
OAuth Access TokenThe access token for connecting using OAuth.
OAuth Access Token SecretThe OAuth access token secret for connecting using OAuth.
OAuth Access Token URLThe URL to retrieve the OAuth access token from.
OAuth Authorization URLThe authorization URL for the OAuth service.
OAuth Client IdThe client ID assigned when you register your application with an OAuth authorization server.
OAuth Client SecretThe client secret assigned when you register your application with an OAuth authorization server.
OAuth Expires InThe lifetime in seconds of the OAuth AccessToken.
OAuth Grant TypeThe grant type for the OAuth flow.
OAuth ParamsA comma-separated list of other parameters to submit in the request for the OAuth access token in the format paramname=value.
OAuth Refresh TokenThe OAuth refresh token for the corresponding OAuth access token.
OAuth Refresh Token URLThe URL to refresh the OAuth token from.
OAuth Request Token URLThe URL the service provides to retrieve request tokens from. This is required in OAuth 1.0.
OAuth Settings LocationThe location of the settings file where OAuth values are saved when InitiateOAuth is set to GETANDREFRESH or REFRESH. Alternatively, this can be held in memory by specifying a value starting with memory://.
OAuth Token TimestampThe Unix epoch timestamp in milliseconds when the current Access Token was created.
OAuth VerifierThe verifier code returned from the OAuth authorization URL.
OAuth VersionThe version of OAuth being used.
OfflineUse offline mode to get the data from the cache instead of the live source.
Oracle NamespaceThe Oracle Cloud Object Storage namespace to use.
OrientationIndicates whether the data in Excel is laid out horizontally or vertically.
OtherThese hidden properties are used only in specific use cases.
PasswordThe password used to authenticate the user.
Pool Idle TimeoutThe allowed idle time for a connection before it is closed.
Pool Max SizeThe maximum connections in the pool.
Pool Min SizeThe minimum number of connections in the pool.
Pool Wait TimeThe max seconds to wait for an available connection.
Project IdThe id of the project where your Google Cloud Storage instance resides.
Proxy Auth SchemeThe authentication type to use to authenticate to the ProxyServer proxy.
Proxy Auto DetectThis indicates whether to use the system proxy settings or not. This takes precedence over other proxy settings, so you'll need to set ProxyAutoDetect to FALSE in order use custom proxy settings.
Proxy ExceptionsA semicolon separated list of destination hostnames or IPs that are exempt from connecting through the ProxyServer .
Proxy PasswordA password to be used to authenticate to the ProxyServer proxy.
Proxy PortThe TCP port the ProxyServer proxy is running on.
Proxy ServerThe hostname or IP address of a proxy to route HTTP traffic through.
Proxy SSL TypeThe SSL type to use when connecting to the ProxyServer proxy.
Proxy UserA user name to be used to authenticate to the ProxyServer proxy.
Pseudo ColumnsThis property indicates whether or not to include pseudo columns as columns to the table.
ReadonlyYou can use this property to enforce read-only access to Excel from the provider.
RecalculateIndicates whether to recalculate all formulas when data is read.
RegionThe hosting region for your S3-like Web Services.
Row Scan DepthThe maximum number of rows to scan to look for the columns available in a table.
RTKThe runtime key used for licensing.
Sharepoint URLThe URL required for the Sharepoint cloud storage service provider.
Show Empty RowsIndicates whether or not the empty rows should be pushed.
SSH Auth ModeThe authentication method to be used to log on to an SFTP server.
SSH Client CertA certificate to be used for authenticating the user.
SSH Client Cert PasswordThe password of the SSHClientCert certificate if it has one.
SSH Client Cert TypeThe type of SSHClientCert certificate.
SSL Client CertThe TLS/SSL client certificate store for SSL Client Authentication (2-way SSL).
SSL Client Cert PasswordThe password for the TLS/SSL client certificate.
SSL Client Cert SubjectThe subject of the TLS/SSL client certificate.
SSL Client Cert TypeThe type of key store containing the TLS/SSL client certificate.
SSL Server CertThe certificate to be accepted from the server when connecting using TLS/SSL.
Support Enhanced SQLThis property enhances SQL functionality beyond what can be supported through the API directly, by enabling in-memory client-side processing.
TablesThis property restricts the tables reported to a subset of the available tables. For example, Tables=TableA,TableB,TableC.
TimeoutThe value in seconds until the timeout error is thrown, canceling the operation.
Type Detection SchemeDetermines how the provider detects the data types of columns.
URIThe Uniform Resource Identifier (URI) for the Excel resource location.
URLThe URL of the cloud storage service provider.
Use Connection PoolingThis property enables connection pooling.
UserThe Excel user account used to authenticate.
Use Virtual HostingIf true (default), buckets will be referenced in the request using the hosted-style request: http://yourbucket.s3.amazonaws.com/yourobject. If set to false, the bean will use the path-style request: http://s3.amazonaws.com/yourbucket/yourobject. Note that this property will be set to false, in case of an S3 based custom service when the CustomURL is specified.
VerbosityThe verbosity level that determines the amount of detail included in the log file.
ViewsRestricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC.



Parameter
Description
Excel File



    • Related Articles

    • Salesforce Connector

      Salesforce Destination Be aware that if you are importing into a Salesforce Sandbox, the size is limited. If you import somewhere around 150,000 records, you will run out of space. You should only import what is necessary for testing. Standard Input ...
    • Hubspot Connector

      Hubspot Connector Note: As of September 8, 2020 the Hubspot API does not allow external applications to write into their Quoting module.  See below. Overview The StarfishETL Hubspot Connector enables you to easily connect to Hubspot for integrations ...
    • File System Connector

      File System Origin The File System Connector reads all files from a folder specified in the Directory field. The Username and Password fields are not used. Filter can be used to filter for certain file names/extensions. To search for all files with ...
    • Act! Connector

      ACT! Premium Cloud: StarfishETL supports two-way integration. ACT! On-Prem: Starfish does not have a native Act! connector for versions less than Act v18 so we read directly from the database. Configuration Options Connect Act Premium (v18+) using ...
    • Sharepoint Connector

      If connecting to Sharepoint using Single Sign-on (SSO) You might see this error if not connected appropriately - "[500] Could not execute the specified command: unrecognized response when getting SharePoint online security cookies, please check your ...